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": "7601372b-d41f-4000-89a3-3ad7635265e1",
  "tenantId": "92f0480f-6db6-4292-a5b6-367b689df439",
  "messageTypeId": "d00cac70-17f2-4290-91b4-3e3f56c23881",
  "messageTypeLookupKey": "sample string 4",
  "userId": "f89be833-995e-4a99-8494-4d469d6ac3c2",
  "userGroupId": "264ff2b1-8b58-441d-94f1-a9d45614245c",
  "deviceId": "025387c7-91d6-4bd1-9258-55a947984ed8",
  "deviceGroupId": "1adb4f5c-7f1a-4582-8f5b-e7452eef5787",
  "applicationId": "20bac524-7f94-426e-818e-f536d5657dc7",
  "applicationVersionId": "07b48c14-9063-48d5-969e-d4fc7a7f19b1",
  "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": "544d6e5c-479e-41c3-9f82-f59f003c4aa0",
  "messageAuditMessageAuditTypeId": "f0ad32f0-32ad-4411-8d7d-90619caf41f9",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-01-25T23:30:11.6117444+00:00",
  "messageAuditUpdatedDateUtc": "2026-01-25T23:30:11.6117444+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-01-25T23:30:11.6117444+00:00",
  "updatedDateUtc": "2026-01-25T23:30:11.6117444+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-01-25T23:30:11.6117444+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-01-25T23:30:11.6117444+00:00</UpdatedDateUtc>
  <ApplicationId>20bac524-7f94-426e-818e-f536d5657dc7</ApplicationId>
  <ApplicationVersionId>07b48c14-9063-48d5-969e-d4fc7a7f19b1</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>1adb4f5c-7f1a-4582-8f5b-e7452eef5787</DeviceGroupId>
  <DeviceId>025387c7-91d6-4bd1-9258-55a947984ed8</DeviceId>
  <MessageAuditCreatedDateUtc>2026-01-25T23:30:11.6117444+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>544d6e5c-479e-41c3-9f82-f59f003c4aa0</MessageAuditId>
  <MessageAuditMessageAuditTypeId>f0ad32f0-32ad-4411-8d7d-90619caf41f9</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-01-25T23:30:11.6117444+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>7601372b-d41f-4000-89a3-3ad7635265e1</MessageId>
  <MessageTypeId>d00cac70-17f2-4290-91b4-3e3f56c23881</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>92f0480f-6db6-4292-a5b6-367b689df439</TenantId>
  <UserGroupId>264ff2b1-8b58-441d-94f1-a9d45614245c</UserGroupId>
  <UserId>f89be833-995e-4a99-8494-4d469d6ac3c2</UserId>
</MessageRepresentation>