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": "08c16fc8-7f6d-4e0e-abca-f643ea10c8b8",
  "tenantId": "7ce6e125-0292-4734-a6d7-5be73a57e7a1",
  "messageTypeId": "2f7b01aa-fee6-4b5a-adde-fbd3f39c3cfd",
  "messageTypeLookupKey": "sample string 4",
  "userId": "6dfb0bc8-c1f9-4ad4-b128-ba55942b6239",
  "userGroupId": "ac5d6b67-11a7-4e5b-83ef-d5de61ecc76d",
  "deviceId": "2fa2f062-f618-4cc3-8e20-75450f25ab6e",
  "deviceGroupId": "6c7f63cf-02bf-427d-8a1b-3c6eed037720",
  "applicationId": "e62e1f74-196c-4edf-86c2-d2b3a0a8e6e8",
  "applicationVersionId": "6a6f458b-fd5c-4856-b701-d31edb8e36db",
  "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": "54636f01-21bf-470e-9507-f5c4c3d15791",
  "messageAuditMessageAuditTypeId": "8693a3b7-275b-4d03-902f-9841f4b5cf61",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-04-09T10:32:56.5884477+00:00",
  "messageAuditUpdatedDateUtc": "2026-04-09T10:32:56.5884477+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-04-09T10:32:56.5884477+00:00",
  "updatedDateUtc": "2026-04-09T10:32:56.5884477+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-04-09T10:32:56.5884477+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-04-09T10:32:56.5884477+00:00</UpdatedDateUtc>
  <ApplicationId>e62e1f74-196c-4edf-86c2-d2b3a0a8e6e8</ApplicationId>
  <ApplicationVersionId>6a6f458b-fd5c-4856-b701-d31edb8e36db</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>6c7f63cf-02bf-427d-8a1b-3c6eed037720</DeviceGroupId>
  <DeviceId>2fa2f062-f618-4cc3-8e20-75450f25ab6e</DeviceId>
  <MessageAuditCreatedDateUtc>2026-04-09T10:32:56.5884477+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>54636f01-21bf-470e-9507-f5c4c3d15791</MessageAuditId>
  <MessageAuditMessageAuditTypeId>8693a3b7-275b-4d03-902f-9841f4b5cf61</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-04-09T10:32:56.5884477+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>08c16fc8-7f6d-4e0e-abca-f643ea10c8b8</MessageId>
  <MessageTypeId>2f7b01aa-fee6-4b5a-adde-fbd3f39c3cfd</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>7ce6e125-0292-4734-a6d7-5be73a57e7a1</TenantId>
  <UserGroupId>ac5d6b67-11a7-4e5b-83ef-d5de61ecc76d</UserGroupId>
  <UserId>6dfb0bc8-c1f9-4ad4-b128-ba55942b6239</UserId>
</MessageRepresentation>