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": "883aac52-eab5-4b00-9624-4f92ddf39b8d",
  "tenantId": "c33e2934-12bf-4685-9e2f-42e59e4136e7",
  "messageTypeId": "671f6d72-e707-4cf2-b737-6181b8bbff31",
  "messageTypeLookupKey": "sample string 4",
  "userId": "6b80906b-a0ce-473c-8759-9f8781584ec5",
  "userGroupId": "af622d77-ddfc-4730-9eed-bcf618d908f7",
  "deviceId": "45dbc5f7-22a6-4d66-af61-e5ab4f074513",
  "deviceGroupId": "c882341a-9032-4038-bd9c-9d9db7e3811c",
  "applicationId": "44270aee-85ed-4655-ac9c-58dbfc65ac16",
  "applicationVersionId": "739ab7b1-de2b-44ac-ab29-ab0983661993",
  "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": "e7169c25-05d3-4767-ade1-8a5d1be5677a",
  "messageAuditMessageAuditTypeId": "e07cdc0a-cd15-4157-acca-8738392df09b",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-10-23T07:33:30.7938463+00:00",
  "messageAuditUpdatedDateUtc": "2026-10-23T07:33:30.7938463+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-10-23T07:33:30.7938463+00:00",
  "updatedDateUtc": "2026-10-23T07:33:30.7938463+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-10-23T07:33:30.7938463+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-10-23T07:33:30.7938463+00:00</UpdatedDateUtc>
  <ApplicationId>44270aee-85ed-4655-ac9c-58dbfc65ac16</ApplicationId>
  <ApplicationVersionId>739ab7b1-de2b-44ac-ab29-ab0983661993</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>c882341a-9032-4038-bd9c-9d9db7e3811c</DeviceGroupId>
  <DeviceId>45dbc5f7-22a6-4d66-af61-e5ab4f074513</DeviceId>
  <MessageAuditCreatedDateUtc>2026-10-23T07:33:30.7938463+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>e7169c25-05d3-4767-ade1-8a5d1be5677a</MessageAuditId>
  <MessageAuditMessageAuditTypeId>e07cdc0a-cd15-4157-acca-8738392df09b</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-10-23T07:33:30.7938463+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>883aac52-eab5-4b00-9624-4f92ddf39b8d</MessageId>
  <MessageTypeId>671f6d72-e707-4cf2-b737-6181b8bbff31</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>c33e2934-12bf-4685-9e2f-42e59e4136e7</TenantId>
  <UserGroupId>af622d77-ddfc-4730-9eed-bcf618d908f7</UserGroupId>
  <UserId>6b80906b-a0ce-473c-8759-9f8781584ec5</UserId>
</MessageRepresentation>