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": "438a8608-0ddb-478a-83f6-b8c5f90273f1",
  "tenantId": "5fb43f8a-3caf-4efe-b99f-adb3e72009ca",
  "messageTypeId": "2d29af92-78ab-4c7c-940c-39556f6a2de1",
  "messageTypeLookupKey": "sample string 4",
  "userId": "36e9f036-49e6-46a7-bfb2-f2355778c677",
  "userGroupId": "b3cc4a80-ff11-4cd8-a1de-dd89e0ac3863",
  "deviceId": "b8e91d36-9aca-450a-b40b-3fa811ae6269",
  "deviceGroupId": "20d8fbac-5878-4dfa-ab07-9de53e36964a",
  "applicationId": "97c2d2de-7b21-4d57-ba70-95265dac3db2",
  "applicationVersionId": "03b74d6a-6491-42fa-841e-aff080a6cce6",
  "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": "f3e0c219-ae34-497a-9629-bfdc319b88da",
  "messageAuditMessageAuditTypeId": "6abc3807-9919-4b1a-85dc-564e8aaae1fc",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-12-22T14:14:48.844276+00:00",
  "messageAuditUpdatedDateUtc": "2025-12-22T14:14:48.844276+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-12-22T14:14:48.844276+00:00",
  "updatedDateUtc": "2025-12-22T14:14:48.844276+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-12-22T14:14:48.844276+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-12-22T14:14:48.844276+00:00</UpdatedDateUtc>
  <ApplicationId>97c2d2de-7b21-4d57-ba70-95265dac3db2</ApplicationId>
  <ApplicationVersionId>03b74d6a-6491-42fa-841e-aff080a6cce6</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>20d8fbac-5878-4dfa-ab07-9de53e36964a</DeviceGroupId>
  <DeviceId>b8e91d36-9aca-450a-b40b-3fa811ae6269</DeviceId>
  <MessageAuditCreatedDateUtc>2025-12-22T14:14:48.844276+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>f3e0c219-ae34-497a-9629-bfdc319b88da</MessageAuditId>
  <MessageAuditMessageAuditTypeId>6abc3807-9919-4b1a-85dc-564e8aaae1fc</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-12-22T14:14:48.844276+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>438a8608-0ddb-478a-83f6-b8c5f90273f1</MessageId>
  <MessageTypeId>2d29af92-78ab-4c7c-940c-39556f6a2de1</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>5fb43f8a-3caf-4efe-b99f-adb3e72009ca</TenantId>
  <UserGroupId>b3cc4a80-ff11-4cd8-a1de-dd89e0ac3863</UserGroupId>
  <UserId>36e9f036-49e6-46a7-bfb2-f2355778c677</UserId>
</MessageRepresentation>