POST Public/BulkMessageStatus

Request Information

URI Parameters

None.

Body Parameters

PatientComms.API.Public.DTOs.Request.BulkMessageStatusRequest

Name	Type	Additional information
APIKey	globally unique identifier	Required
Username	string	Required
CustomerSiteId	string	String length: inclusive between 0 and 100
MinutesAgo	integer	None.
Since	date	None.

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "97d0218d-bc53-408e-b89f-2134b0f9445b",
  "Username": "sample string 2",
  "CustomerSiteId": "sample string 3",
  "MinutesAgo": 1,
  "Since": "2025-12-17T21:49:05.1833051+00:00"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PatientComms.API.Public.DTOs.Response.BulkMessageStatusResponse

Name	Type	Additional information
StatusId	integer	None.
Status	string	None.
Success	boolean	None.
Errors	Dictionary of string [key] and string [value]	None.
MessageStatuses	Collection of PatientComms.API.Public.DTOs.Response.MessageStatusItem	None.

Response Formats

application/json, text/json

Sample:

{
  "StatusId": 1,
  "Status": "sample string 2",
  "Success": true,
  "Errors": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "MessageStatuses": [
    {
      "MessageId": 1,
      "MessageStatus": 2,
      "Status": "sample string 3",
      "LastUpdated": "2025-12-17T21:49:05.1833051+00:00",
      "ReplyMessage": "sample string 5",
      "Credits": 1,
      "ReplyReceived": "2025-12-17T21:49:05.1833051+00:00",
      "ReplyFrom": 1
    },
    {
      "MessageId": 1,
      "MessageStatus": 2,
      "Status": "sample string 3",
      "LastUpdated": "2025-12-17T21:49:05.1833051+00:00",
      "ReplyMessage": "sample string 5",
      "Credits": 1,
      "ReplyReceived": "2025-12-17T21:49:05.1833051+00:00",
      "ReplyFrom": 1
    }
  ]
}

application/xml, text/xml

Sample:

<BulkMessageStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Public.DTOs.Response">
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Public.DTOs">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Errors>
  <Status xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Public.DTOs">sample string 2</Status>
  <StatusId xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Public.DTOs">1</StatusId>
  <Success xmlns="http://schemas.datacontract.org/2004/07/PatientComms.API.Public.DTOs">true</Success>
  <MessageStatuses>
    <MessageStatusItem>
      <Credits>1</Credits>
      <LastUpdated>2025-12-17T21:49:05.1833051+00:00</LastUpdated>
      <MessageId>1</MessageId>
      <MessageStatus>2</MessageStatus>
      <ReplyFrom>1</ReplyFrom>
      <ReplyMessage>sample string 5</ReplyMessage>
      <ReplyReceived>2025-12-17T21:49:05.1833051+00:00</ReplyReceived>
      <Status>sample string 3</Status>
    </MessageStatusItem>
    <MessageStatusItem>
      <Credits>1</Credits>
      <LastUpdated>2025-12-17T21:49:05.1833051+00:00</LastUpdated>
      <MessageId>1</MessageId>
      <MessageStatus>2</MessageStatus>
      <ReplyFrom>1</ReplyFrom>
      <ReplyMessage>sample string 5</ReplyMessage>
      <ReplyReceived>2025-12-17T21:49:05.1833051+00:00</ReplyReceived>
      <Status>sample string 3</Status>
    </MessageStatusItem>
  </MessageStatuses>
</BulkMessageStatusResponse>