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": "3f6b8e64-8571-4994-a5a6-c3c56feb7973",
  "tenantId": "8a5a18ed-c763-4fa4-90ee-802db1812118",
  "messageTypeId": "996c1468-3c49-4907-a325-da4c03aa1d7a",
  "messageTypeLookupKey": "sample string 4",
  "userId": "eb91c769-16db-411a-9eb1-d496385d6e69",
  "userGroupId": "3684ce73-0eec-480a-b220-934afd288712",
  "deviceId": "2c45d6d3-0a90-459c-9ec4-b7aaeb4c3794",
  "deviceGroupId": "5a2d0a51-38fa-47da-ac76-6428827090d1",
  "applicationId": "0ef67f35-121e-4c11-8e68-a24e786e02df",
  "applicationVersionId": "fa45d3bc-dc2d-4e06-b311-5b928b8c22d0",
  "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": "cd0d118b-36cc-43b5-a631-3e5855806945",
  "messageAuditMessageAuditTypeId": "14763cd0-5427-4403-bb0f-632bf75f4d52",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-09-18T11:47:18.2766126+00:00",
  "messageAuditUpdatedDateUtc": "2025-09-18T11:47:18.2766126+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-09-18T11:47:18.2766126+00:00",
  "updatedDateUtc": "2025-09-18T11:47:18.2766126+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-18T11:47:18.2766126+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-09-18T11:47:18.2766126+00:00</UpdatedDateUtc>
  <ApplicationId>0ef67f35-121e-4c11-8e68-a24e786e02df</ApplicationId>
  <ApplicationVersionId>fa45d3bc-dc2d-4e06-b311-5b928b8c22d0</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>5a2d0a51-38fa-47da-ac76-6428827090d1</DeviceGroupId>
  <DeviceId>2c45d6d3-0a90-459c-9ec4-b7aaeb4c3794</DeviceId>
  <MessageAuditCreatedDateUtc>2025-09-18T11:47:18.2766126+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>cd0d118b-36cc-43b5-a631-3e5855806945</MessageAuditId>
  <MessageAuditMessageAuditTypeId>14763cd0-5427-4403-bb0f-632bf75f4d52</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-09-18T11:47:18.2766126+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>3f6b8e64-8571-4994-a5a6-c3c56feb7973</MessageId>
  <MessageTypeId>996c1468-3c49-4907-a325-da4c03aa1d7a</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>8a5a18ed-c763-4fa4-90ee-802db1812118</TenantId>
  <UserGroupId>3684ce73-0eec-480a-b220-934afd288712</UserGroupId>
  <UserId>eb91c769-16db-411a-9eb1-d496385d6e69</UserId>
</MessageRepresentation>