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": "38dfa589-20ba-4911-8c2a-ec483cce8973",
  "tenantId": "860e263d-cb1f-4b00-a8eb-01e7878b3abf",
  "messageTypeId": "d65914cc-d287-42da-802b-7ebdd7e86bf4",
  "messageTypeLookupKey": "sample string 4",
  "userId": "c09b69bb-193c-4acf-95d2-8b81b7494368",
  "userGroupId": "1374e2bc-2442-4533-9dec-d3ea31e8df6e",
  "deviceId": "dc0aa8d5-055e-4c56-ab8f-2ad1bc27d954",
  "deviceGroupId": "7c999d79-97a0-4ad6-8260-d387e298c1b9",
  "applicationId": "52705c8c-9f27-408b-9889-7bb1fc28009e",
  "applicationVersionId": "6b008ebc-11be-4f7e-b391-f9f103ae2df1",
  "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": "6eeb24cf-bc49-485d-873b-61dafe164e81",
  "messageAuditMessageAuditTypeId": "4a44dc95-b9a9-4625-8ee0-d601a914455c",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-05-25T17:22:52.4796674+00:00",
  "messageAuditUpdatedDateUtc": "2026-05-25T17:22:52.4796674+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-05-25T17:22:52.4796674+00:00",
  "updatedDateUtc": "2026-05-25T17:22:52.4796674+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-05-25T17:22:52.4796674+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-05-25T17:22:52.4796674+00:00</UpdatedDateUtc>
  <ApplicationId>52705c8c-9f27-408b-9889-7bb1fc28009e</ApplicationId>
  <ApplicationVersionId>6b008ebc-11be-4f7e-b391-f9f103ae2df1</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>7c999d79-97a0-4ad6-8260-d387e298c1b9</DeviceGroupId>
  <DeviceId>dc0aa8d5-055e-4c56-ab8f-2ad1bc27d954</DeviceId>
  <MessageAuditCreatedDateUtc>2026-05-25T17:22:52.4796674+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>6eeb24cf-bc49-485d-873b-61dafe164e81</MessageAuditId>
  <MessageAuditMessageAuditTypeId>4a44dc95-b9a9-4625-8ee0-d601a914455c</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-05-25T17:22:52.4796674+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>38dfa589-20ba-4911-8c2a-ec483cce8973</MessageId>
  <MessageTypeId>d65914cc-d287-42da-802b-7ebdd7e86bf4</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>860e263d-cb1f-4b00-a8eb-01e7878b3abf</TenantId>
  <UserGroupId>1374e2bc-2442-4533-9dec-d3ea31e8df6e</UserGroupId>
  <UserId>c09b69bb-193c-4acf-95d2-8b81b7494368</UserId>
</MessageRepresentation>