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": "00c052d8-bad9-4d6a-9a19-a904892ec75b",
  "tenantId": "eea99c6d-02d5-4521-ab4d-85c52c5ba1df",
  "messageTypeId": "ad667617-1362-464f-bc2f-160ef08b7c23",
  "messageTypeLookupKey": "sample string 4",
  "userId": "a67fee40-268f-486d-8cd5-233c9d9e5bc0",
  "userGroupId": "7b6211a2-fc64-4488-874b-c0562747e416",
  "deviceId": "50825ac8-ffdc-40b6-8eba-8a8a22dbdeb2",
  "deviceGroupId": "f4f7bc22-946a-4dff-a493-09dff93666c1",
  "applicationId": "7061dad8-733d-4665-b4ed-74131ff43e7a",
  "applicationVersionId": "d140e3f6-5fb4-456b-8f1e-95b92129c0d6",
  "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": "2ddd6885-ab5d-46ab-9d99-86bc7819ba1f",
  "messageAuditMessageAuditTypeId": "9027e6d6-438c-4817-b4d1-f0e37e778e28",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-10-19T17:37:06.218303+00:00",
  "messageAuditUpdatedDateUtc": "2025-10-19T17:37:06.218303+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-10-19T17:37:06.218303+00:00",
  "updatedDateUtc": "2025-10-19T17:37:06.218303+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-10-19T17:37:06.218303+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-10-19T17:37:06.218303+00:00</UpdatedDateUtc>
  <ApplicationId>7061dad8-733d-4665-b4ed-74131ff43e7a</ApplicationId>
  <ApplicationVersionId>d140e3f6-5fb4-456b-8f1e-95b92129c0d6</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>f4f7bc22-946a-4dff-a493-09dff93666c1</DeviceGroupId>
  <DeviceId>50825ac8-ffdc-40b6-8eba-8a8a22dbdeb2</DeviceId>
  <MessageAuditCreatedDateUtc>2025-10-19T17:37:06.218303+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>2ddd6885-ab5d-46ab-9d99-86bc7819ba1f</MessageAuditId>
  <MessageAuditMessageAuditTypeId>9027e6d6-438c-4817-b4d1-f0e37e778e28</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-10-19T17:37:06.218303+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>00c052d8-bad9-4d6a-9a19-a904892ec75b</MessageId>
  <MessageTypeId>ad667617-1362-464f-bc2f-160ef08b7c23</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>eea99c6d-02d5-4521-ab4d-85c52c5ba1df</TenantId>
  <UserGroupId>7b6211a2-fc64-4488-874b-c0562747e416</UserGroupId>
  <UserId>a67fee40-268f-486d-8cd5-233c9d9e5bc0</UserId>
</MessageRepresentation>