PUT Portal Accounts

Developer Tools

PUT api/v1/{EMRSystem}/PortalAccounts

Authenticates a Portal Account.

HTTP Method

PUT

Applicable Emissary Products

Interactive Workflow

Allscripts

In Dev

Athena

In Dev

Cerner

In Dev

Meditech

In Dev

Sandbox

In Dev

Don't see the data field you are looking for?

Request Information

URI Parameters

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EMRSystem

The emr system.

EMRsystem

Required

 
Body Parameters
The portal account authenticate request view model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

PortalUserId

Gets or sets the portal user identifier.

string

Required

PortalUserPassword

Gets or sets the portal user password.

string

None.

DeviceId

Gets or sets the device identifier.

string

None.

UserAgent

Gets or sets the user agent.

string

None.

 

Response Information

 
Resource Description
Http response containing the authenticated information.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

PortalUserId

Gets or sets the portal user identifier.

string

None.

PatientId

Gets or sets the patient identifier.

string

None.

PortalAccountId

Gets or sets the portal account identifier.

string

None.

PortalAccountName

Gets or sets the name of the portal account.

string

None.

LoginSuccessful

Gets or sets a value indicating whether [login successful].

boolean

None.

PasswordExpired

Gets or sets a value indicating whether [password expired].

boolean

None.

LoginError

Gets or sets the login error.

string

None.

ReadOnlyServer

Gets or sets a value indicating whether [read only server].

boolean

None.

 
Response Codes

Http Status Code 201 – Returns Sansoro.Shared.SansoroServiceBus.Models.PortalAccountAuthenticateResponseViewModel

Http Status Code 400 – Indicates that the request did not contain all the required fields.

Http Status Code 500 – Indicates that an internal server error occurred during processing of the request.

Http Status Code 502 – Indicates that a request made to the underlying EMR server could not be completed.

 
Response Formats
Sample Message
Download Json Schema
{
  "PortalUserId": "sample string 1",
  "PortalUserPassword": "sample string 2",
  "DeviceId": "sample string 3",
  "UserAgent": "sample string 4",
  "Domain": "sample string 5",
  "LoginId": "sample string 6",
  "Password": "sample string 7",
  "EmrInstance": "sample string 8",
  "ApplicationName": "sample string 9",
  "ApplicationKey": "sample string 10"
}
Sample Message
<PortalAccountAuthenticateRequestViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <ApplicationKey>sample string 10</ApplicationKey>
  <ApplicationName>sample string 9</ApplicationName>
  <Domain>sample string 5</Domain>
  <EmrInstance>sample string 8</EmrInstance>
  <LoginId>sample string 6</LoginId>
  <Password>sample string 7</Password>
  <DeviceId>sample string 3</DeviceId>
  <PortalUserId>sample string 1</PortalUserId>
  <PortalUserPassword>sample string 2</PortalUserPassword>
  <UserAgent>sample string 4</UserAgent>
</PortalAccountAuthenticateRequestViewModel>

Submit a Comment

Your email address will not be published. Required fields are marked *

 

Don't see the data field you are looking for?