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": "b3a698e4-9b85-4176-ade0-89ab95e04977",
  "tenantId": "681bdbe3-cf63-4706-bc5c-8a36106794df",
  "messageTypeId": "3df25f89-e772-4040-974c-914d0630472f",
  "messageTypeLookupKey": "sample string 4",
  "userId": "dd588ef8-a9ac-4700-8562-3b3e532858e4",
  "userGroupId": "1a3d5cc3-a9fb-460c-b486-b3e5e493ec67",
  "deviceId": "080b9358-935b-404a-a951-0ae08a6d9232",
  "deviceGroupId": "bd99a5d7-cfce-4146-9f00-90e34d8b95ec",
  "applicationId": "d230cec1-0e8c-42a0-95a3-72ff80a04ae1",
  "applicationVersionId": "a12ac0f6-c4c1-4d4b-a9c0-a46a26d25497",
  "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": "31ac2879-d81a-43d7-8287-a7a9df6b99da",
  "messageAuditMessageAuditTypeId": "c8fda387-45b2-4b0a-bd97-39667f07e43a",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-11-12T13:20:24.5734747+00:00",
  "messageAuditUpdatedDateUtc": "2025-11-12T13:20:24.5734747+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-11-12T13:20:24.5734747+00:00",
  "updatedDateUtc": "2025-11-12T13:20:24.5734747+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-12T13:20:24.5734747+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-11-12T13:20:24.5734747+00:00</UpdatedDateUtc>
  <ApplicationId>d230cec1-0e8c-42a0-95a3-72ff80a04ae1</ApplicationId>
  <ApplicationVersionId>a12ac0f6-c4c1-4d4b-a9c0-a46a26d25497</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>bd99a5d7-cfce-4146-9f00-90e34d8b95ec</DeviceGroupId>
  <DeviceId>080b9358-935b-404a-a951-0ae08a6d9232</DeviceId>
  <MessageAuditCreatedDateUtc>2025-11-12T13:20:24.5734747+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>31ac2879-d81a-43d7-8287-a7a9df6b99da</MessageAuditId>
  <MessageAuditMessageAuditTypeId>c8fda387-45b2-4b0a-bd97-39667f07e43a</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-11-12T13:20:24.5734747+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>b3a698e4-9b85-4176-ade0-89ab95e04977</MessageId>
  <MessageTypeId>3df25f89-e772-4040-974c-914d0630472f</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>681bdbe3-cf63-4706-bc5c-8a36106794df</TenantId>
  <UserGroupId>1a3d5cc3-a9fb-460c-b486-b3e5e493ec67</UserGroupId>
  <UserId>dd588ef8-a9ac-4700-8562-3b3e532858e4</UserId>
</MessageRepresentation>