POST Portal Accounts

Developer Tools

POST api/v1/{EMRSystem}/PortalAccounts

Activates (creates) a Portal Account.

HTTP Method

POST

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 activate create request view model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

ActivationInfo

Gets or sets the patient identifier.

ActivationCodeInfoViewModel

Required

PortalUserId

Gets or sets the portal user identifier.

string

Required

PortalUserPassword

Gets or sets the portal user password.

string

Required

PasswordHint

Gets or sets the password hint.

string

None.

PasswordResetQuestion

Gets or sets the password reset question.

string

None.

PasswordResetAnswer

Gets or sets the password reset answer.

string

None.

EmailAddress

Gets or sets the email address.

string

None.

ReceiveEmailNotifications

Gets or sets a value indicating whether [receive email notifications].

boolean

None.

 

Response Information

 
Resource Description
Http response containing newly created Portal Account Id.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.

 
Response Codes

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

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
{
  "ActivationInfo": {
    "ActivationCode": "sample string 1",
    "BirthDateTime": "2018-02-15T15:40:04.4517138Z",
    "EmailAddress": "sample string 2",
    "HomePhone": "sample string 3",
    "LastFourOfSSN": "sample string 4",
    "MedicalRecordNumber": "sample string 5",
    "SSN": "sample string 6",
    "Zip": "sample string 7"
  },
  "PortalUserId": "sample string 1",
  "PortalUserPassword": "sample string 2",
  "PasswordHint": "sample string 3",
  "PasswordResetQuestion": "sample string 4",
  "PasswordResetAnswer": "sample string 5",
  "EmailAddress": "sample string 6",
  "ReceiveEmailNotifications": true,
  "Domain": "sample string 8",
  "LoginId": "sample string 9",
  "Password": "sample string 10",
  "EmrInstance": "sample string 11",
  "ApplicationName": "sample string 12",
  "ApplicationKey": "sample string 13"
}
Sample Message
<PortalAccountActivateCreateRequestViewModel xmlns:i="https://www.w3.org/2001/XMLSchema-instance" xmlns="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models">
  <ApplicationKey>sample string 13</ApplicationKey>
  <ApplicationName>sample string 12</ApplicationName>
  <Domain>sample string 8</Domain>
  <EmrInstance>sample string 11</EmrInstance>
  <LoginId>sample string 9</LoginId>
  <Password>sample string 10</Password>
  <ActivationInfo xmlns:d2p1="https://schemas.datacontract.org/2004/07/Sansoro.Shared.SansoroServiceBus.Models.BaseViewModels">
    <d2p1:ActivationCode>sample string 1</d2p1:ActivationCode>
    <d2p1:BirthDateTime>2018-02-15T09:40:04.4517138-06:00</d2p1:BirthDateTime>
    <d2p1:EmailAddress>sample string 2</d2p1:EmailAddress>
    <d2p1:HomePhone>sample string 3</d2p1:HomePhone>
    <d2p1:LastFourOfSSN>sample string 4</d2p1:LastFourOfSSN>
    <d2p1:MedicalRecordNumber>sample string 5</d2p1:MedicalRecordNumber>
    <d2p1:SSN>sample string 6</d2p1:SSN>
    <d2p1:Zip>sample string 7</d2p1:Zip>
  </ActivationInfo>
  <EmailAddress>sample string 6</EmailAddress>
  <PasswordHint>sample string 3</PasswordHint>
  <PasswordResetAnswer>sample string 5</PasswordResetAnswer>
  <PasswordResetQuestion>sample string 4</PasswordResetQuestion>
  <PortalUserId>sample string 1</PortalUserId>
  <PortalUserPassword>sample string 2</PortalUserPassword>
  <ReceiveEmailNotifications>true</ReceiveEmailNotifications>
</PortalAccountActivateCreateRequestViewModel>

Submit a Comment

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

 

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