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": "2e8e46c3-5aee-46fb-9497-82b607a75c4d",
  "tenantId": "fbcfdad2-a8b5-479a-9cf0-cead71c8b7a8",
  "messageTypeId": "688cbe2b-c505-4514-9805-6d53fa2e20b5",
  "messageTypeLookupKey": "sample string 4",
  "userId": "ac0fda21-26b0-4ccf-945c-ebdc48b2d5c7",
  "userGroupId": "7ffdc3c1-44a0-46f3-9869-450e0833ce34",
  "deviceId": "28d6c6f1-2167-414e-9e2b-8427c3df8ca8",
  "deviceGroupId": "b8d31bc8-0616-408f-8e77-e47611271bf3",
  "applicationId": "c05bd2a4-e963-4e8d-ad9e-3a651b771ad4",
  "applicationVersionId": "53e4a621-d822-4fd0-81d4-1c2c3a354a7e",
  "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": "34a15dc5-a5e8-48d7-ac5b-fb1a1d88389b",
  "messageAuditMessageAuditTypeId": "49fbaeb7-e9f6-4d0b-b8bb-e0449edc28c8",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-09-10T19:06:38.4110634+00:00",
  "messageAuditUpdatedDateUtc": "2026-09-10T19:06:38.4110634+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-09-10T19:06:38.4110634+00:00",
  "updatedDateUtc": "2026-09-10T19:06:38.4110634+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-09-10T19:06:38.4110634+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-09-10T19:06:38.4110634+00:00</UpdatedDateUtc>
  <ApplicationId>c05bd2a4-e963-4e8d-ad9e-3a651b771ad4</ApplicationId>
  <ApplicationVersionId>53e4a621-d822-4fd0-81d4-1c2c3a354a7e</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>b8d31bc8-0616-408f-8e77-e47611271bf3</DeviceGroupId>
  <DeviceId>28d6c6f1-2167-414e-9e2b-8427c3df8ca8</DeviceId>
  <MessageAuditCreatedDateUtc>2026-09-10T19:06:38.4110634+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>34a15dc5-a5e8-48d7-ac5b-fb1a1d88389b</MessageAuditId>
  <MessageAuditMessageAuditTypeId>49fbaeb7-e9f6-4d0b-b8bb-e0449edc28c8</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-09-10T19:06:38.4110634+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>2e8e46c3-5aee-46fb-9497-82b607a75c4d</MessageId>
  <MessageTypeId>688cbe2b-c505-4514-9805-6d53fa2e20b5</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>fbcfdad2-a8b5-479a-9cf0-cead71c8b7a8</TenantId>
  <UserGroupId>7ffdc3c1-44a0-46f3-9869-450e0833ce34</UserGroupId>
  <UserId>ac0fda21-26b0-4ccf-945c-ebdc48b2d5c7</UserId>
</MessageRepresentation>