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": "54b88ef7-53a3-4f0e-ace0-4109fd220048",
  "tenantId": "ed7d299b-6e09-4ed0-abf6-080e8c24828e",
  "messageTypeId": "fee6523c-8bbd-4c26-a181-167d3e5adc40",
  "messageTypeLookupKey": "sample string 4",
  "userId": "e771f565-9461-4d48-bd1e-d7e247d2e172",
  "userGroupId": "4add5063-810b-4fbf-b184-d6d6c9ec3939",
  "deviceId": "dd37d2bc-4bf7-4f9f-b1ab-9cc1a7d970f8",
  "deviceGroupId": "c814aced-2bac-4672-a257-d59d668e2ce4",
  "applicationId": "cc778f94-6440-4ad5-bf13-9ea8fa5fb80e",
  "applicationVersionId": "40bda39d-8c4d-40ee-8520-732bdce7faa6",
  "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": "4fad333b-9c04-4f40-986b-1769aad1bdcd",
  "messageAuditMessageAuditTypeId": "a6b71ad8-2050-46fa-bca6-9f7d72fbb1da",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-01-22T22:58:32.3083311+00:00",
  "messageAuditUpdatedDateUtc": "2026-01-22T22:58:32.3083311+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-01-22T22:58:32.3083311+00:00",
  "updatedDateUtc": "2026-01-22T22:58:32.3083311+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-22T22:58:32.3083311+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-01-22T22:58:32.3083311+00:00</UpdatedDateUtc>
  <ApplicationId>cc778f94-6440-4ad5-bf13-9ea8fa5fb80e</ApplicationId>
  <ApplicationVersionId>40bda39d-8c4d-40ee-8520-732bdce7faa6</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>c814aced-2bac-4672-a257-d59d668e2ce4</DeviceGroupId>
  <DeviceId>dd37d2bc-4bf7-4f9f-b1ab-9cc1a7d970f8</DeviceId>
  <MessageAuditCreatedDateUtc>2026-01-22T22:58:32.3083311+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>4fad333b-9c04-4f40-986b-1769aad1bdcd</MessageAuditId>
  <MessageAuditMessageAuditTypeId>a6b71ad8-2050-46fa-bca6-9f7d72fbb1da</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-01-22T22:58:32.3083311+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>54b88ef7-53a3-4f0e-ace0-4109fd220048</MessageId>
  <MessageTypeId>fee6523c-8bbd-4c26-a181-167d3e5adc40</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>ed7d299b-6e09-4ed0-abf6-080e8c24828e</TenantId>
  <UserGroupId>4add5063-810b-4fbf-b184-d6d6c9ec3939</UserGroupId>
  <UserId>e771f565-9461-4d48-bd1e-d7e247d2e172</UserId>
</MessageRepresentation>