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": "4ceabae1-a1ce-42a6-a1ee-e3e3f7028596",
  "tenantId": "83fd4216-238a-4699-b323-1891ed526f0c",
  "messageTypeId": "8fa45d1a-77f0-47d0-bc49-35382ea69caf",
  "messageTypeLookupKey": "sample string 4",
  "userId": "2704bb14-f866-477e-8868-5e29bf267e01",
  "userGroupId": "bd54e395-3167-4fba-bd08-fb1de7f9a866",
  "deviceId": "98011cf2-a52d-430b-a507-40c3016c73de",
  "deviceGroupId": "fd1a6b4c-4de4-472c-bb34-6f49715fb76d",
  "applicationId": "e95d1ecd-a52b-4ce6-86f1-bf372197f239",
  "applicationVersionId": "86fd8537-d0db-4e41-92d4-802ecc079cbf",
  "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": "191992c2-e1e5-4e48-af43-2ecf63389320",
  "messageAuditMessageAuditTypeId": "68aae174-641a-49ed-88bb-693abe973122",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-06-08T03:53:19.7292565+00:00",
  "messageAuditUpdatedDateUtc": "2026-06-08T03:53:19.7292565+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-06-08T03:53:19.7292565+00:00",
  "updatedDateUtc": "2026-06-08T03:53:19.7292565+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>2026-06-08T03:53:19.7292565+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-08T03:53:19.7292565+00:00</UpdatedDateUtc>
  <ApplicationId>e95d1ecd-a52b-4ce6-86f1-bf372197f239</ApplicationId>
  <ApplicationVersionId>86fd8537-d0db-4e41-92d4-802ecc079cbf</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>fd1a6b4c-4de4-472c-bb34-6f49715fb76d</DeviceGroupId>
  <DeviceId>98011cf2-a52d-430b-a507-40c3016c73de</DeviceId>
  <MessageAuditCreatedDateUtc>2026-06-08T03:53:19.7292565+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>191992c2-e1e5-4e48-af43-2ecf63389320</MessageAuditId>
  <MessageAuditMessageAuditTypeId>68aae174-641a-49ed-88bb-693abe973122</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-06-08T03:53:19.7292565+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>4ceabae1-a1ce-42a6-a1ee-e3e3f7028596</MessageId>
  <MessageTypeId>8fa45d1a-77f0-47d0-bc49-35382ea69caf</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>83fd4216-238a-4699-b323-1891ed526f0c</TenantId>
  <UserGroupId>bd54e395-3167-4fba-bd08-fb1de7f9a866</UserGroupId>
  <UserId>2704bb14-f866-477e-8868-5e29bf267e01</UserId>
</MessageRepresentation>