GET api/SecureMessagesToPatient/{id}

Gets a secure message.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Unique ID of the message.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

MessageToPatientModel
NameDescriptionTypeAdditional information
Id

Unique ID of the message.

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

Message sent date (Read only).

string

None.

HasAttachments

Indicates if a secure message has attachments.

boolean

None.

Attachments

Returns a list of attachments of a message.

Collection of IdNamePairModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "091a9285-ddcc-4b7a-a87c-4753ac9ed191",
  "CreationDate": "sample string 2",
  "Priority": "sample string 3",
  "Status": "sample string 4",
  "Read": true,
  "SecureRecipientId": "faa311e5-ef39-4801-9396-3b4ad87fe92a",
  "SecureRecipientName": "sample string 7",
  "Subject": "sample string 8",
  "Body": "sample string 9",
  "SentDate": "sample string 10",
  "HasAttachments": true,
  "Attachments": [
    {
      "Id": 1,
      "Name": "sample string 2"
    },
    {
      "Id": 1,
      "Name": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<MessageToPatientModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models.SecureMessages">
  <Attachments xmlns:d2p1="http://schemas.datacontract.org/2004/07/GlobalPortal.Mobile.Api.Models">
    <d2p1:IdNamePairModel>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:IdNamePairModel>
    <d2p1:IdNamePairModel>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:IdNamePairModel>
  </Attachments>
  <Body>sample string 9</Body>
  <CreationDate>sample string 2</CreationDate>
  <HasAttachments>true</HasAttachments>
  <Id>091a9285-ddcc-4b7a-a87c-4753ac9ed191</Id>
  <Priority>sample string 3</Priority>
  <Read>true</Read>
  <SecureRecipientId>faa311e5-ef39-4801-9396-3b4ad87fe92a</SecureRecipientId>
  <SecureRecipientName>sample string 7</SecureRecipientName>
  <SentDate>sample string 10</SentDate>
  <Status>sample string 4</Status>
  <Subject>sample string 8</Subject>
</MessageToPatientModel>