GET api/IncomingSecureMessages/{id}
Get information about an incoming secure message.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Incoming secure message's unique ID. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
IncomingSecureMessageModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
ID of the incoming secure message. |
globally unique identifier |
None. |
| AccountId |
Account Id of the incoming secure message. |
globally unique identifier |
None. |
| PatientId |
Patient Id. |
globally unique identifier |
None. |
| PatientExternalId |
Patient External ID. |
string |
None. |
| PatientPrefix |
Patient prefix. |
string |
None. |
| PatientFirstName |
Patient first name. |
string |
None. |
| PatientMiddleName |
Patient middle name. |
string |
None. |
| PatientLastName |
Patient last name. |
string |
None. |
| PatientSuffix |
Patient suffix. |
string |
None. |
| PatientFullName |
Patient full name. |
string |
None. |
| FromRepresentative |
From representative. |
boolean |
None. |
| PatientEmailAddress |
Patient email address. |
string |
None. |
| DoctorExternalId |
Doctor External ID. |
string |
None. |
| CreationDate |
Creation date. |
date |
None. |
| Priority |
Priority should be (Normal, High, Low). |
string |
None. |
| Status |
Status is always Sent for incoming secure messages. |
string |
None. |
| MessageRead |
Message read. |
boolean |
None. |
| SecureRecipientExternalId |
Secure recipient's unique ID on integrating system (Required).. |
string |
None. |
| SecureRecipientName |
Secure recipient name. |
string |
None. |
| Subject |
Subject. |
string |
None. |
| Body |
Body. |
string |
None. |
| SentDate |
Sent date. |
date |
None. |
| DeletedByUser |
If this incoming secure message was deleted by an user . |
boolean |
None. |
| DeletedByPatient |
If this incoming secure message was deleted by a patient . |
boolean |
None. |
| Type |
Type should be (General, AmendmentRequest, AppointmentRequest, RefillRequest, FileSharing). |
string |
None. |
| MessageAttachmentIds |
List of message attachment Ids |
Collection of integer |
None. |
Response Formats
application/json, text/json
{
"id": "99f32e10-738c-4b17-844f-5f19cd88f815",
"accountId": "d3bca4e1-9ac5-4d07-a7dd-7518e22d88f2",
"patientId": "badd324f-16aa-4f84-9c93-54e77cbf0127",
"patientExternalId": "sample string 4",
"patientPrefix": "sample string 5",
"patientFirstName": "sample string 6",
"patientMiddleName": "sample string 7",
"patientLastName": "sample string 8",
"patientSuffix": "sample string 9",
"patientFullName": "sample string 10",
"fromRepresentative": true,
"patientEmailAddress": "sample string 12",
"doctorExternalId": "sample string 13",
"creationDate": "2026-08-28T05:32:52.8229793+00:00",
"priority": "sample string 15",
"status": "sample string 16",
"messageRead": true,
"secureRecipientExternalId": "sample string 18",
"secureRecipientName": "sample string 19",
"subject": "sample string 20",
"body": "sample string 21",
"sentDate": "2026-08-28T05:32:52.8229793+00:00",
"deletedByUser": true,
"deletedByPatient": true,
"type": "sample string 24",
"messageAttachmentIds": [
1,
2
]
}
application/xml, text/xml
<IncomingSecureMessageModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.IncomingSecureMessages">
<AccountId>d3bca4e1-9ac5-4d07-a7dd-7518e22d88f2</AccountId>
<Body>sample string 21</Body>
<CreationDate>2026-08-28T05:32:52.8229793+00:00</CreationDate>
<DeletedByPatient>true</DeletedByPatient>
<DeletedByUser>true</DeletedByUser>
<DoctorExternalId>sample string 13</DoctorExternalId>
<FromRepresentative>true</FromRepresentative>
<Id>99f32e10-738c-4b17-844f-5f19cd88f815</Id>
<MessageAttachmentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</MessageAttachmentIds>
<MessageRead>true</MessageRead>
<PatientEmailAddress>sample string 12</PatientEmailAddress>
<PatientExternalId>sample string 4</PatientExternalId>
<PatientFirstName>sample string 6</PatientFirstName>
<PatientFullName>sample string 10</PatientFullName>
<PatientId>badd324f-16aa-4f84-9c93-54e77cbf0127</PatientId>
<PatientLastName>sample string 8</PatientLastName>
<PatientMiddleName>sample string 7</PatientMiddleName>
<PatientPrefix>sample string 5</PatientPrefix>
<PatientSuffix>sample string 9</PatientSuffix>
<Priority>sample string 15</Priority>
<SecureRecipientExternalId>sample string 18</SecureRecipientExternalId>
<SecureRecipientName>sample string 19</SecureRecipientName>
<SentDate>2026-08-28T05:32:52.8229793+00:00</SentDate>
<Status>sample string 16</Status>
<Subject>sample string 20</Subject>
<Type>sample string 24</Type>
</IncomingSecureMessageModel>