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": "5fbe3dfd-290e-466b-90f2-e5f9c226231f",
  "tenantId": "60ccff45-6d19-4d0f-864f-bf4d4861b411",
  "messageTypeId": "9723083e-f99f-49ad-a381-3ca9f27df7dc",
  "messageTypeLookupKey": "sample string 4",
  "userId": "70fd3294-ab50-46f1-8140-0cf6a926cfd0",
  "userGroupId": "3d0fe4fe-bcb7-4709-85c4-edf180d024a0",
  "deviceId": "f14509d1-5580-4943-9dc4-fda0067d5217",
  "deviceGroupId": "9df21272-34df-4234-9718-939dbc2a091b",
  "applicationId": "f19a9837-5f9c-42d0-b1f5-09ad3a4c3cbd",
  "applicationVersionId": "921411e8-8ebf-4412-afb8-932ed012f6d8",
  "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": "f3d083f0-0097-4030-8eb0-47d920c8030c",
  "messageAuditMessageAuditTypeId": "d136ba18-d343-4a43-8275-324057b5ad06",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-08-27T04:32:33.5645008+00:00",
  "messageAuditUpdatedDateUtc": "2026-08-27T04:32:33.5645008+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-08-27T04:32:33.5645008+00:00",
  "updatedDateUtc": "2026-08-27T04:32:33.5645008+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-08-27T04:32:33.5645008+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-08-27T04:32:33.5645008+00:00</UpdatedDateUtc>
  <ApplicationId>f19a9837-5f9c-42d0-b1f5-09ad3a4c3cbd</ApplicationId>
  <ApplicationVersionId>921411e8-8ebf-4412-afb8-932ed012f6d8</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>9df21272-34df-4234-9718-939dbc2a091b</DeviceGroupId>
  <DeviceId>f14509d1-5580-4943-9dc4-fda0067d5217</DeviceId>
  <MessageAuditCreatedDateUtc>2026-08-27T04:32:33.5645008+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>f3d083f0-0097-4030-8eb0-47d920c8030c</MessageAuditId>
  <MessageAuditMessageAuditTypeId>d136ba18-d343-4a43-8275-324057b5ad06</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-08-27T04:32:33.5645008+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>5fbe3dfd-290e-466b-90f2-e5f9c226231f</MessageId>
  <MessageTypeId>9723083e-f99f-49ad-a381-3ca9f27df7dc</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>60ccff45-6d19-4d0f-864f-bf4d4861b411</TenantId>
  <UserGroupId>3d0fe4fe-bcb7-4709-85c4-edf180d024a0</UserGroupId>
  <UserId>70fd3294-ab50-46f1-8140-0cf6a926cfd0</UserId>
</MessageRepresentation>