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": "711dd02b-d812-42a7-a191-3e3f8d46c52e",
  "tenantId": "84e37bc0-48be-415d-8b33-31fd0cb2a543",
  "messageTypeId": "219cf055-5930-489b-9e0c-18e92d5b5724",
  "messageTypeLookupKey": "sample string 4",
  "userId": "053d1288-7cc5-4cec-86c7-70218e92e3b7",
  "userGroupId": "d8815faf-8654-4b01-a8e6-a67df24c1e96",
  "deviceId": "9a7d4867-d9d8-4214-b829-e8a8e0e78f3b",
  "deviceGroupId": "5a1f9720-4e13-43f3-8bbb-0b521a51d9f8",
  "applicationId": "59dbff38-3dd4-47e3-ae69-a19bc617eb66",
  "applicationVersionId": "4b9dd153-754c-4b64-b7fe-8928ef3b7382",
  "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": "5bf7ceb0-170f-4d57-ae00-a03b1826e6e7",
  "messageAuditMessageAuditTypeId": "1e572137-a2f2-48d2-a37c-372c9c4ff7d4",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-11-23T18:14:11.3775597+00:00",
  "messageAuditUpdatedDateUtc": "2025-11-23T18:14:11.3775597+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-11-23T18:14:11.3775597+00:00",
  "updatedDateUtc": "2025-11-23T18:14:11.3775597+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-11-23T18:14:11.3775597+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-11-23T18:14:11.3775597+00:00</UpdatedDateUtc>
  <ApplicationId>59dbff38-3dd4-47e3-ae69-a19bc617eb66</ApplicationId>
  <ApplicationVersionId>4b9dd153-754c-4b64-b7fe-8928ef3b7382</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>5a1f9720-4e13-43f3-8bbb-0b521a51d9f8</DeviceGroupId>
  <DeviceId>9a7d4867-d9d8-4214-b829-e8a8e0e78f3b</DeviceId>
  <MessageAuditCreatedDateUtc>2025-11-23T18:14:11.3775597+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>5bf7ceb0-170f-4d57-ae00-a03b1826e6e7</MessageAuditId>
  <MessageAuditMessageAuditTypeId>1e572137-a2f2-48d2-a37c-372c9c4ff7d4</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-11-23T18:14:11.3775597+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>711dd02b-d812-42a7-a191-3e3f8d46c52e</MessageId>
  <MessageTypeId>219cf055-5930-489b-9e0c-18e92d5b5724</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>84e37bc0-48be-415d-8b33-31fd0cb2a543</TenantId>
  <UserGroupId>d8815faf-8654-4b01-a8e6-a67df24c1e96</UserGroupId>
  <UserId>053d1288-7cc5-4cec-86c7-70218e92e3b7</UserId>
</MessageRepresentation>