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": "a02e52e2-410d-4a24-9563-71b75448e3b0",
  "tenantId": "3cf541f8-da17-4b9d-92b1-f276fa53ea7c",
  "messageTypeId": "c9a0bcf9-c124-47c7-a8ce-aeeaebca4dd2",
  "messageTypeLookupKey": "sample string 4",
  "userId": "e7b71fe4-1bdf-4632-a038-2c64072df11e",
  "userGroupId": "e2789e1b-6861-472b-8d83-bf2a3b2a17f5",
  "deviceId": "2d52c12f-4dad-4665-bb49-f0a486c594ba",
  "deviceGroupId": "0652bf9a-288a-4408-942c-642219a67b48",
  "applicationId": "e21be821-17a5-475c-a94f-f51483dce762",
  "applicationVersionId": "16e62d68-80ab-4368-a618-d3fe187f79d9",
  "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": "c1199438-10bb-4431-a374-d5453c94ccd7",
  "messageAuditMessageAuditTypeId": "cb11f33e-8596-4cb1-af8f-0549cef4cf0d",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-03-09T06:46:44.4087919+00:00",
  "messageAuditUpdatedDateUtc": "2026-03-09T06:46:44.4087919+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-03-09T06:46:44.4087919+00:00",
  "updatedDateUtc": "2026-03-09T06:46:44.4087919+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-09T06:46:44.4087919+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-03-09T06:46:44.4087919+00:00</UpdatedDateUtc>
  <ApplicationId>e21be821-17a5-475c-a94f-f51483dce762</ApplicationId>
  <ApplicationVersionId>16e62d68-80ab-4368-a618-d3fe187f79d9</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>0652bf9a-288a-4408-942c-642219a67b48</DeviceGroupId>
  <DeviceId>2d52c12f-4dad-4665-bb49-f0a486c594ba</DeviceId>
  <MessageAuditCreatedDateUtc>2026-03-09T06:46:44.4087919+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>c1199438-10bb-4431-a374-d5453c94ccd7</MessageAuditId>
  <MessageAuditMessageAuditTypeId>cb11f33e-8596-4cb1-af8f-0549cef4cf0d</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-03-09T06:46:44.4087919+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>a02e52e2-410d-4a24-9563-71b75448e3b0</MessageId>
  <MessageTypeId>c9a0bcf9-c124-47c7-a8ce-aeeaebca4dd2</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>3cf541f8-da17-4b9d-92b1-f276fa53ea7c</TenantId>
  <UserGroupId>e2789e1b-6861-472b-8d83-bf2a3b2a17f5</UserGroupId>
  <UserId>e7b71fe4-1bdf-4632-a038-2c64072df11e</UserId>
</MessageRepresentation>