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": "c175dcb1-f087-4489-a4c8-0aea4151bc76",
  "tenantId": "59ffe04c-08ca-4b9d-aa79-3ea85c3439be",
  "messageTypeId": "e7d0d888-7198-4ba4-bdea-327956ac0593",
  "messageTypeLookupKey": "sample string 4",
  "userId": "a43cba32-b742-44dc-933f-aad887d01331",
  "userGroupId": "a8a1a8a3-3900-464c-bd15-e375bb778f9a",
  "deviceId": "6b43d071-2980-4a8a-b41f-9284d4687eaa",
  "deviceGroupId": "d0aaeddc-806a-43d7-947a-b9548d45ee17",
  "applicationId": "6b100355-482b-4e53-9a9e-f7653e1a4e4c",
  "applicationVersionId": "61f95193-5ee4-4608-a81e-19e8ec19aef0",
  "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": "e204d6fc-6d1e-4111-ab0f-e310ddb097eb",
  "messageAuditMessageAuditTypeId": "f508cd4a-7aba-4218-8413-724b91cd4b6c",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-09-13T07:27:59.747502+00:00",
  "messageAuditUpdatedDateUtc": "2025-09-13T07:27:59.747502+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-09-13T07:27:59.747502+00:00",
  "updatedDateUtc": "2025-09-13T07:27:59.747502+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>2025-09-13T07:27:59.747502+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-09-13T07:27:59.747502+00:00</UpdatedDateUtc>
  <ApplicationId>6b100355-482b-4e53-9a9e-f7653e1a4e4c</ApplicationId>
  <ApplicationVersionId>61f95193-5ee4-4608-a81e-19e8ec19aef0</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>d0aaeddc-806a-43d7-947a-b9548d45ee17</DeviceGroupId>
  <DeviceId>6b43d071-2980-4a8a-b41f-9284d4687eaa</DeviceId>
  <MessageAuditCreatedDateUtc>2025-09-13T07:27:59.747502+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>e204d6fc-6d1e-4111-ab0f-e310ddb097eb</MessageAuditId>
  <MessageAuditMessageAuditTypeId>f508cd4a-7aba-4218-8413-724b91cd4b6c</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-09-13T07:27:59.747502+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>c175dcb1-f087-4489-a4c8-0aea4151bc76</MessageId>
  <MessageTypeId>e7d0d888-7198-4ba4-bdea-327956ac0593</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>59ffe04c-08ca-4b9d-aa79-3ea85c3439be</TenantId>
  <UserGroupId>a8a1a8a3-3900-464c-bd15-e375bb778f9a</UserGroupId>
  <UserId>a43cba32-b742-44dc-933f-aad887d01331</UserId>
</MessageRepresentation>