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": "bdb94014-eb99-4c92-b836-863837e9a5f6",
  "tenantId": "9175a103-ce2c-4a4d-ae06-c0a4f9f1faae",
  "messageTypeId": "83c8f24b-29d6-4978-9f0f-778c4f6d7401",
  "messageTypeLookupKey": "sample string 4",
  "userId": "0774f597-8234-4054-98bd-4dc1c8065bd6",
  "userGroupId": "01d16f04-1c3a-4e12-849a-d315da0e94a7",
  "deviceId": "9d783294-6f79-4c91-b3ee-dcd4aade3b40",
  "deviceGroupId": "6aa9a9b1-d4aa-4918-aaa1-4ae424726b9b",
  "applicationId": "bc7e2a94-23b9-40ac-aaae-cee7366d0034",
  "applicationVersionId": "e4b6ef41-2c70-48ae-8a01-363417b055b9",
  "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": "d4f43095-1aff-4488-82db-80bae23b2548",
  "messageAuditMessageAuditTypeId": "5dec0519-85de-4947-b606-8363eda2df16",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-03-19T03:12:27.4948787+00:00",
  "messageAuditUpdatedDateUtc": "2026-03-19T03:12:27.4948787+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-03-19T03:12:27.4948787+00:00",
  "updatedDateUtc": "2026-03-19T03:12:27.4948787+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-03-19T03:12:27.4948787+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-03-19T03:12:27.4948787+00:00</UpdatedDateUtc>
  <ApplicationId>bc7e2a94-23b9-40ac-aaae-cee7366d0034</ApplicationId>
  <ApplicationVersionId>e4b6ef41-2c70-48ae-8a01-363417b055b9</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>6aa9a9b1-d4aa-4918-aaa1-4ae424726b9b</DeviceGroupId>
  <DeviceId>9d783294-6f79-4c91-b3ee-dcd4aade3b40</DeviceId>
  <MessageAuditCreatedDateUtc>2026-03-19T03:12:27.4948787+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>d4f43095-1aff-4488-82db-80bae23b2548</MessageAuditId>
  <MessageAuditMessageAuditTypeId>5dec0519-85de-4947-b606-8363eda2df16</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-03-19T03:12:27.4948787+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>bdb94014-eb99-4c92-b836-863837e9a5f6</MessageId>
  <MessageTypeId>83c8f24b-29d6-4978-9f0f-778c4f6d7401</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>9175a103-ce2c-4a4d-ae06-c0a4f9f1faae</TenantId>
  <UserGroupId>01d16f04-1c3a-4e12-849a-d315da0e94a7</UserGroupId>
  <UserId>0774f597-8234-4054-98bd-4dc1c8065bd6</UserId>
</MessageRepresentation>