PUT Portal Accounts by Id

Developer Tools

PUT api/v1/{EMRSystem}/PortalAccounts/{PortalAccountId}

Updates an existing 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

PortalAccountId

The portal account identifier.

string

Required

 
Body Parameters
The portal account update request view model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

PortalUserPassword

Gets or sets the portal user password.

string

None.

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].

string

None.

UserId

Gets or sets the user identifier.

string

Required

UserType

Gets or sets the type of the user.

UserType

None.

 

Response Information

 
Resource Description
Http response containing http status code indicating success or failure.
None
 
Response Codes

Http Status Code 204 – Indicates that the request was processed successfully.

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
{
  "PortalUserPassword": "sample string 1",
  "PasswordHint": "sample string 2",
  "PasswordResetQuestion": "sample string 3",
  "PasswordResetAnswer": "sample string 4",
  "EmailAddress": "sample string 5",
  "ReceiveEmailNotifications": true,
  "UserId": "sample string 7",
  "UserType": "EMR",
  "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
<PortalAccountUpdateRequestViewModel 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>
  <EmailAddress>sample string 5</EmailAddress>
  <PasswordHint>sample string 2</PasswordHint>
  <PasswordResetAnswer>sample string 4</PasswordResetAnswer>
  <PasswordResetQuestion>sample string 3</PasswordResetQuestion>
  <PortalUserPassword>sample string 1</PortalUserPassword>
  <ReceiveEmailNotifications>true</ReceiveEmailNotifications>
  <UserId>sample string 7</UserId>
  <UserType>EMR</UserType>
</PortalAccountUpdateRequestViewModel>

Submit a Comment

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

 

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