Cyan Web API - Version 1

GET api/messages?{senderSessionId}&{senderSessionSequence}

            Gets a Message.

Request Information

Parameters

Name	Description	Additional information
senderSessionId		Define this parameter in the request URI.
senderSessionSequence		Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "messageId": "6e1ad178-0f69-4a48-b30b-a8fec77cc959",
  "tenantId": "8f859c46-b634-4822-8936-ba6c8221097d",
  "messageTypeId": "e495a5b0-2d3c-4ece-995d-0b18d4b53797",
  "messageTypeLookupKey": "sample string 4",
  "userId": "3f64dea3-9b12-4f5f-8a9b-e212181fc9ab",
  "userGroupId": "f30c4ebc-eb9a-4e5a-9638-77f4f3bbbc09",
  "deviceId": "e420fa90-2dc1-4cf4-a1f1-7f112f6f1b1e",
  "deviceGroupId": "bd5a1669-4e79-4e00-98e3-c5b557d9c2f8",
  "applicationId": "5678eba3-de29-43a9-a009-54c1d061a8b4",
  "applicationVersionId": "c361a0ad-8d24-4f79-8fa3-221330eb0abb",
  "senderSessionId": "sample string 5",
  "senderSessionSequence": 1,
  "senderCorrelationId": "sample string 6",
  "senderGroup": "sample string 7",
  "senderNote": "sample string 8",
  "body": "sample string 9",
  "storeEncryptedPassword": true,
  "storeHashedPassword": true,
  "messageAuditId": "b11cb455-b402-4d18-a149-1efe55977c70",
  "messageAuditMessageAuditTypeId": "76efdb43-0d12-496d-8475-2ab5654c36bf",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-11-16T07:15:25.4079149+00:00",
  "messageAuditUpdatedDateUtc": "2025-11-16T07:15:25.4079149+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-11-16T07:15:25.4079149+00:00",
  "updatedDateUtc": "2025-11-16T07:15:25.4079149+00:00"
}

application/xml, text/xml

Sample:

<MessageRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <CreatedDateUtc>2025-11-16T07:15:25.4079149+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-11-16T07:15:25.4079149+00:00</UpdatedDateUtc>
  <ApplicationId>5678eba3-de29-43a9-a009-54c1d061a8b4</ApplicationId>
  <ApplicationVersionId>c361a0ad-8d24-4f79-8fa3-221330eb0abb</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>bd5a1669-4e79-4e00-98e3-c5b557d9c2f8</DeviceGroupId>
  <DeviceId>e420fa90-2dc1-4cf4-a1f1-7f112f6f1b1e</DeviceId>
  <MessageAuditCreatedDateUtc>2025-11-16T07:15:25.4079149+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>b11cb455-b402-4d18-a149-1efe55977c70</MessageAuditId>
  <MessageAuditMessageAuditTypeId>76efdb43-0d12-496d-8475-2ab5654c36bf</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-11-16T07:15:25.4079149+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>6e1ad178-0f69-4a48-b30b-a8fec77cc959</MessageId>
  <MessageTypeId>e495a5b0-2d3c-4ece-995d-0b18d4b53797</MessageTypeId>
  <MessageTypeLookupKey>sample string 4</MessageTypeLookupKey>
  <ResubmitCount>19</ResubmitCount>
  <SenderCorrelationId>sample string 6</SenderCorrelationId>
  <SenderGroup>sample string 7</SenderGroup>
  <SenderNote>sample string 8</SenderNote>
  <SenderSessionId>sample string 5</SenderSessionId>
  <SenderSessionSequence>1</SenderSessionSequence>
  <StoreEncryptedPassword>true</StoreEncryptedPassword>
  <StoreHashedPassword>true</StoreHashedPassword>
  <TenantId>8f859c46-b634-4822-8936-ba6c8221097d</TenantId>
  <UserGroupId>f30c4ebc-eb9a-4e5a-9638-77f4f3bbbc09</UserGroupId>
  <UserId>3f64dea3-9b12-4f5f-8a9b-e212181fc9ab</UserId>
</MessageRepresentation>