POST api/SecureMessagesToPractice
Sends a secure message to the practice or saves it as a draft, depending of the value of Status in the model. A status of Sent will send the message. A status of Draft will save it as a draft.
Request Information
URI Parameters
None.
Body Parameters
Model used to send secure message to the practice from patient.
MessageToPracticeModelName | Description | Type | Additional information |
---|---|---|---|
Id |
Unique ID of the message (Read only). |
globally unique identifier |
None. |
CreationDate |
Date of creation of the message. |
string |
None. |
Priority |
Priority of the message. Possible values are: Normal, High, Low. |
string |
None. |
Status |
Status of the message. Possible values are Draft, Sent. |
string |
None. |
Read |
Indicates if message is read. |
boolean |
None. |
SecureRecipientId |
Unique ID of the recipient of the message. |
globally unique identifier |
None. |
SecureRecipientName |
Name of the secure recipient. |
string |
None. |
Subject |
Subject of the message. |
string |
None. |
Body |
Body of the message. |
string |
None. |
SentDate |
Date when the message was sent (Read only). |
string |
None. |
Request Formats
application/json, text/json
{ "Id": "31666f6b-a55e-4fa7-8afe-d3594c35b71b", "CreationDate": "sample string 2", "Priority": "sample string 3", "Status": "sample string 4", "Read": true, "SecureRecipientId": "4ca72834-9fe1-42e8-a389-79ab2729e75d", "SecureRecipientName": "sample string 7", "Subject": "sample string 8", "Body": "sample string 9", "SentDate": "sample string 10" }
application/xml, text/xml
<MessageToPracticeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.SecureMessages"> <Body>sample string 9</Body> <CreationDate>sample string 2</CreationDate> <Id>31666f6b-a55e-4fa7-8afe-d3594c35b71b</Id> <Priority>sample string 3</Priority> <Read>true</Read> <SecureRecipientId>4ca72834-9fe1-42e8-a389-79ab2729e75d</SecureRecipientId> <SecureRecipientName>sample string 7</SecureRecipientName> <SentDate>sample string 10</SentDate> <Status>sample string 4</Status> <Subject>sample string 8</Subject> </MessageToPracticeModel>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
MessageToPracticeModelName | Description | Type | Additional information |
---|---|---|---|
Id |
Unique ID of the message (Read only). |
globally unique identifier |
None. |
CreationDate |
Date of creation of the message. |
string |
None. |
Priority |
Priority of the message. Possible values are: Normal, High, Low. |
string |
None. |
Status |
Status of the message. Possible values are Draft, Sent. |
string |
None. |
Read |
Indicates if message is read. |
boolean |
None. |
SecureRecipientId |
Unique ID of the recipient of the message. |
globally unique identifier |
None. |
SecureRecipientName |
Name of the secure recipient. |
string |
None. |
Subject |
Subject of the message. |
string |
None. |
Body |
Body of the message. |
string |
None. |
SentDate |
Date when the message was sent (Read only). |
string |
None. |
Response Formats
application/json, text/json
{ "Id": "b506c5d4-633f-4b04-9e4a-5a0eaccf28fd", "CreationDate": "sample string 2", "Priority": "sample string 3", "Status": "sample string 4", "Read": true, "SecureRecipientId": "7f44d483-9e3e-46f4-916c-b5a5eb5cefe6", "SecureRecipientName": "sample string 7", "Subject": "sample string 8", "Body": "sample string 9", "SentDate": "sample string 10" }
application/xml, text/xml
<MessageToPracticeModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.SecureMessages"> <Body>sample string 9</Body> <CreationDate>sample string 2</CreationDate> <Id>b506c5d4-633f-4b04-9e4a-5a0eaccf28fd</Id> <Priority>sample string 3</Priority> <Read>true</Read> <SecureRecipientId>7f44d483-9e3e-46f4-916c-b5a5eb5cefe6</SecureRecipientId> <SecureRecipientName>sample string 7</SecureRecipientName> <SentDate>sample string 10</SentDate> <Status>sample string 4</Status> <Subject>sample string 8</Subject> </MessageToPracticeModel>