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.

MessageToPracticeModel

Name	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

Sample:

{
  "Id": "e544d5c6-dc3e-46aa-aa93-305048d39bb6",
  "CreationDate": "sample string 2",
  "Priority": "sample string 3",
  "Status": "sample string 4",
  "Read": true,
  "SecureRecipientId": "6cbf7f5f-cb19-4c5d-a2d6-8df5c6e0333e",
  "SecureRecipientName": "sample string 7",
  "Subject": "sample string 8",
  "Body": "sample string 9",
  "SentDate": "sample string 10"
}

application/xml, text/xml

Sample:

<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>e544d5c6-dc3e-46aa-aa93-305048d39bb6</Id>
  <Priority>sample string 3</Priority>
  <Read>true</Read>
  <SecureRecipientId>6cbf7f5f-cb19-4c5d-a2d6-8df5c6e0333e</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:

Sample not available.

Response Information

Resource Description

MessageToPracticeModel

Name	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

Sample:

{
  "Id": "58a2c2e7-172d-4d2a-98b8-a49a7f147aaf",
  "CreationDate": "sample string 2",
  "Priority": "sample string 3",
  "Status": "sample string 4",
  "Read": true,
  "SecureRecipientId": "56055437-6231-4aa4-b7f6-0e43d27d0b06",
  "SecureRecipientName": "sample string 7",
  "Subject": "sample string 8",
  "Body": "sample string 9",
  "SentDate": "sample string 10"
}

application/xml, text/xml

Sample:

<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>58a2c2e7-172d-4d2a-98b8-a49a7f147aaf</Id>
  <Priority>sample string 3</Priority>
  <Read>true</Read>
  <SecureRecipientId>56055437-6231-4aa4-b7f6-0e43d27d0b06</SecureRecipientId>
  <SecureRecipientName>sample string 7</SecureRecipientName>
  <SentDate>sample string 10</SentDate>
  <Status>sample string 4</Status>
  <Subject>sample string 8</Subject>
</MessageToPracticeModel>