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": "4db9d957-a555-4849-b467-db9bfb923b21",
  "tenantId": "1193d32e-8387-4d3d-b606-cd9e1071ebc7",
  "messageTypeId": "0b1067b0-78a7-4b62-bd08-851fa9cad8a8",
  "messageTypeLookupKey": "sample string 4",
  "userId": "fc4ff886-f249-4971-92be-258eb0b1dfa4",
  "userGroupId": "6ccc7a38-61ce-47ff-8e75-2288b3f8997a",
  "deviceId": "86c5b858-1e44-47d8-88f8-e8119c0350bc",
  "deviceGroupId": "73fedb4f-3cab-4429-bd17-c859584231f7",
  "applicationId": "ad354b90-67e9-4e88-822f-598fed34e695",
  "applicationVersionId": "f1a75bdc-046e-477f-8f64-465896cf3486",
  "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": "6dc1f2b7-755f-4776-8b22-1b6a3094a0e8",
  "messageAuditMessageAuditTypeId": "04fe62bc-cc02-4656-9a31-75fe75ab69ba",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-04-02T02:20:10.1180811+00:00",
  "messageAuditUpdatedDateUtc": "2026-04-02T02:20:10.1180811+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-04-02T02:20:10.1180811+00:00",
  "updatedDateUtc": "2026-04-02T02:20:10.1180811+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-04-02T02:20:10.1180811+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-04-02T02:20:10.1180811+00:00</UpdatedDateUtc>
  <ApplicationId>ad354b90-67e9-4e88-822f-598fed34e695</ApplicationId>
  <ApplicationVersionId>f1a75bdc-046e-477f-8f64-465896cf3486</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>73fedb4f-3cab-4429-bd17-c859584231f7</DeviceGroupId>
  <DeviceId>86c5b858-1e44-47d8-88f8-e8119c0350bc</DeviceId>
  <MessageAuditCreatedDateUtc>2026-04-02T02:20:10.1180811+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>6dc1f2b7-755f-4776-8b22-1b6a3094a0e8</MessageAuditId>
  <MessageAuditMessageAuditTypeId>04fe62bc-cc02-4656-9a31-75fe75ab69ba</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-04-02T02:20:10.1180811+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>4db9d957-a555-4849-b467-db9bfb923b21</MessageId>
  <MessageTypeId>0b1067b0-78a7-4b62-bd08-851fa9cad8a8</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>1193d32e-8387-4d3d-b606-cd9e1071ebc7</TenantId>
  <UserGroupId>6ccc7a38-61ce-47ff-8e75-2288b3f8997a</UserGroupId>
  <UserId>fc4ff886-f249-4971-92be-258eb0b1dfa4</UserId>
</MessageRepresentation>