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": "5a4e926b-2c04-4fc4-9c27-d9e34a4848f0",
  "tenantId": "f0839d95-7cae-43dc-8df9-f35b6391f865",
  "messageTypeId": "69fdb42b-b1db-4335-9859-4993cdc0d8ab",
  "messageTypeLookupKey": "sample string 4",
  "userId": "e5e3fdf1-34eb-44ab-aa20-361cb133bc95",
  "userGroupId": "cefedae1-583e-4e4a-99bb-0125590bc53c",
  "deviceId": "0e4b8781-1c8e-49c7-a16d-189506de6699",
  "deviceGroupId": "ea9e86bb-fd50-4cc6-b2e9-75cd5c9bfe52",
  "applicationId": "48494b84-534e-42c6-9353-81050e5c2611",
  "applicationVersionId": "5b973b7f-48f3-40c8-b39e-f4db889a003b",
  "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": "00faa7f4-6483-4584-888e-0dedf29b4d04",
  "messageAuditMessageAuditTypeId": "04d599e2-f6b4-4cc4-9fa9-970bbd226579",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-07-16T04:39:22.8663969+00:00",
  "messageAuditUpdatedDateUtc": "2026-07-16T04:39:22.8663969+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-07-16T04:39:22.8663969+00:00",
  "updatedDateUtc": "2026-07-16T04:39:22.8663969+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-07-16T04:39:22.8663969+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-07-16T04:39:22.8663969+00:00</UpdatedDateUtc>
  <ApplicationId>48494b84-534e-42c6-9353-81050e5c2611</ApplicationId>
  <ApplicationVersionId>5b973b7f-48f3-40c8-b39e-f4db889a003b</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>ea9e86bb-fd50-4cc6-b2e9-75cd5c9bfe52</DeviceGroupId>
  <DeviceId>0e4b8781-1c8e-49c7-a16d-189506de6699</DeviceId>
  <MessageAuditCreatedDateUtc>2026-07-16T04:39:22.8663969+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>00faa7f4-6483-4584-888e-0dedf29b4d04</MessageAuditId>
  <MessageAuditMessageAuditTypeId>04d599e2-f6b4-4cc4-9fa9-970bbd226579</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-07-16T04:39:22.8663969+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>5a4e926b-2c04-4fc4-9c27-d9e34a4848f0</MessageId>
  <MessageTypeId>69fdb42b-b1db-4335-9859-4993cdc0d8ab</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>f0839d95-7cae-43dc-8df9-f35b6391f865</TenantId>
  <UserGroupId>cefedae1-583e-4e4a-99bb-0125590bc53c</UserGroupId>
  <UserId>e5e3fdf1-34eb-44ab-aa20-361cb133bc95</UserId>
</MessageRepresentation>