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": "0fccf90a-f5b3-486d-af83-34ed9a68554d",
  "tenantId": "cdbb66b4-76b1-41bf-9ab2-e7c4f2fefd72",
  "messageTypeId": "d0f3fcd5-54e5-4a5b-9f9b-6f4d436fe0f9",
  "messageTypeLookupKey": "sample string 4",
  "userId": "4706535d-9490-48fa-a6df-dd45bd545f50",
  "userGroupId": "ee46a285-0457-43f2-aa97-72750708bb73",
  "deviceId": "436c4f44-be16-46f1-8c74-bae92c6382de",
  "deviceGroupId": "dae831ac-63bb-4f3a-9da8-bdd979633854",
  "applicationId": "208021fe-6126-4146-b11b-bc6b982acd73",
  "applicationVersionId": "9e45b3bd-9947-405a-8d52-4e46da478e75",
  "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": "01915fe2-1849-41ae-b7a4-2195b7c8ca5b",
  "messageAuditMessageAuditTypeId": "6170bac7-389e-49f9-9e9c-3a89f359ba39",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-05-31T11:15:20.6477804+00:00",
  "messageAuditUpdatedDateUtc": "2025-05-31T11:15:20.6477804+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-05-31T11:15:20.6477804+00:00",
  "updatedDateUtc": "2025-05-31T11:15:20.6477804+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-05-31T11:15:20.6477804+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-05-31T11:15:20.6477804+00:00</UpdatedDateUtc>
  <ApplicationId>208021fe-6126-4146-b11b-bc6b982acd73</ApplicationId>
  <ApplicationVersionId>9e45b3bd-9947-405a-8d52-4e46da478e75</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>dae831ac-63bb-4f3a-9da8-bdd979633854</DeviceGroupId>
  <DeviceId>436c4f44-be16-46f1-8c74-bae92c6382de</DeviceId>
  <MessageAuditCreatedDateUtc>2025-05-31T11:15:20.6477804+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>01915fe2-1849-41ae-b7a4-2195b7c8ca5b</MessageAuditId>
  <MessageAuditMessageAuditTypeId>6170bac7-389e-49f9-9e9c-3a89f359ba39</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-05-31T11:15:20.6477804+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>0fccf90a-f5b3-486d-af83-34ed9a68554d</MessageId>
  <MessageTypeId>d0f3fcd5-54e5-4a5b-9f9b-6f4d436fe0f9</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>cdbb66b4-76b1-41bf-9ab2-e7c4f2fefd72</TenantId>
  <UserGroupId>ee46a285-0457-43f2-aa97-72750708bb73</UserGroupId>
  <UserId>4706535d-9490-48fa-a6df-dd45bd545f50</UserId>
</MessageRepresentation>