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": "ea99cd58-cfd9-4214-9a13-494dd61a5033",
  "tenantId": "4e06e62e-b1af-4608-97df-11dbff93f7cc",
  "messageTypeId": "17df44a1-c66f-4ad6-aefa-e6fda922dd66",
  "messageTypeLookupKey": "sample string 4",
  "userId": "beae12b6-a153-4cc6-a593-68ffcf39f627",
  "userGroupId": "eaf1ada3-9b2f-4a2e-9ab5-abd550b518d1",
  "deviceId": "d522afa8-6adf-4556-8436-4f9656d61b88",
  "deviceGroupId": "1cf19af2-d5a1-4881-8089-1c38c18f2128",
  "applicationId": "21d45ada-c3cc-4453-acce-3cf2ad00074f",
  "applicationVersionId": "1230ce40-b8b4-4fdd-ab1d-431b583ee934",
  "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": "b8d8078d-d485-4fd0-912d-da11616c23ae",
  "messageAuditMessageAuditTypeId": "0c448d08-ff2d-41c0-a78c-936fd5bb9d70",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-03-26T06:58:23.1490283+00:00",
  "messageAuditUpdatedDateUtc": "2026-03-26T06:58:23.1490283+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-03-26T06:58:23.1490283+00:00",
  "updatedDateUtc": "2026-03-26T06:58:23.1490283+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-03-26T06:58:23.1490283+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-03-26T06:58:23.1490283+00:00</UpdatedDateUtc>
  <ApplicationId>21d45ada-c3cc-4453-acce-3cf2ad00074f</ApplicationId>
  <ApplicationVersionId>1230ce40-b8b4-4fdd-ab1d-431b583ee934</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>1cf19af2-d5a1-4881-8089-1c38c18f2128</DeviceGroupId>
  <DeviceId>d522afa8-6adf-4556-8436-4f9656d61b88</DeviceId>
  <MessageAuditCreatedDateUtc>2026-03-26T06:58:23.1490283+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>b8d8078d-d485-4fd0-912d-da11616c23ae</MessageAuditId>
  <MessageAuditMessageAuditTypeId>0c448d08-ff2d-41c0-a78c-936fd5bb9d70</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-03-26T06:58:23.1490283+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>ea99cd58-cfd9-4214-9a13-494dd61a5033</MessageId>
  <MessageTypeId>17df44a1-c66f-4ad6-aefa-e6fda922dd66</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>4e06e62e-b1af-4608-97df-11dbff93f7cc</TenantId>
  <UserGroupId>eaf1ada3-9b2f-4a2e-9ab5-abd550b518d1</UserGroupId>
  <UserId>beae12b6-a153-4cc6-a593-68ffcf39f627</UserId>
</MessageRepresentation>