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": "3a3d69d5-c78e-4399-a995-b2713b207fff",
  "tenantId": "14071a74-e453-4e70-9bae-600af1732584",
  "messageTypeId": "3f49757d-7bb4-43f8-a60f-a8c106fbc897",
  "messageTypeLookupKey": "sample string 4",
  "userId": "975fd062-df73-418c-927d-d3ba097e635f",
  "userGroupId": "ac1134b1-d24c-4d80-8fa8-f1152036329f",
  "deviceId": "5f2e9dbe-a576-4597-9183-527dbdf5eae7",
  "deviceGroupId": "9df04b77-5194-46c5-be62-caa0ca6bd991",
  "applicationId": "e56972bd-cca0-4556-a71c-5c689b955efc",
  "applicationVersionId": "ab86b4b6-7853-4b60-bcf3-f63a22141fb6",
  "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": "853b19b0-0816-44cd-9bcb-d887334f6c21",
  "messageAuditMessageAuditTypeId": "c86ae00a-7f2a-4962-904b-586baef323a4",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-09-05T05:37:08.1865195+00:00",
  "messageAuditUpdatedDateUtc": "2026-09-05T05:37:08.1865195+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-09-05T05:37:08.1865195+00:00",
  "updatedDateUtc": "2026-09-05T05:37:08.1865195+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-05T05:37:08.1865195+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-09-05T05:37:08.1865195+00:00</UpdatedDateUtc>
  <ApplicationId>e56972bd-cca0-4556-a71c-5c689b955efc</ApplicationId>
  <ApplicationVersionId>ab86b4b6-7853-4b60-bcf3-f63a22141fb6</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>9df04b77-5194-46c5-be62-caa0ca6bd991</DeviceGroupId>
  <DeviceId>5f2e9dbe-a576-4597-9183-527dbdf5eae7</DeviceId>
  <MessageAuditCreatedDateUtc>2026-09-05T05:37:08.1865195+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>853b19b0-0816-44cd-9bcb-d887334f6c21</MessageAuditId>
  <MessageAuditMessageAuditTypeId>c86ae00a-7f2a-4962-904b-586baef323a4</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-09-05T05:37:08.1865195+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>3a3d69d5-c78e-4399-a995-b2713b207fff</MessageId>
  <MessageTypeId>3f49757d-7bb4-43f8-a60f-a8c106fbc897</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>14071a74-e453-4e70-9bae-600af1732584</TenantId>
  <UserGroupId>ac1134b1-d24c-4d80-8fa8-f1152036329f</UserGroupId>
  <UserId>975fd062-df73-418c-927d-d3ba097e635f</UserId>
</MessageRepresentation>