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": "75c868f3-f21f-458b-8d33-44b864367200",
  "tenantId": "3d3de80c-0e31-4f35-a14f-f9e44442bfde",
  "messageTypeId": "8d5f200f-07ab-47d6-861d-b6b325b08435",
  "messageTypeLookupKey": "sample string 4",
  "userId": "069964f1-24b7-438c-a9bf-ae9d14cdf00b",
  "userGroupId": "705b1788-51f4-4c41-a5ca-499812626327",
  "deviceId": "f34f5ad6-db76-42cf-bbcc-9bc93e6b1e70",
  "deviceGroupId": "dcb12cf2-f9f4-4ff0-9260-329d1dd6a9f6",
  "applicationId": "ff72d91c-917d-4fb5-aa57-575dcf5aaa95",
  "applicationVersionId": "251a47ed-27c5-46a9-9f03-dac3fb951613",
  "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": "09ee4e24-7cfd-48c8-b5e0-bde3728a4435",
  "messageAuditMessageAuditTypeId": "a696bbec-fc56-43ee-ba30-efed44695d16",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-12-14T16:02:49.6712166+00:00",
  "messageAuditUpdatedDateUtc": "2025-12-14T16:02:49.6712166+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-12-14T16:02:49.6712166+00:00",
  "updatedDateUtc": "2025-12-14T16:02:49.6712166+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-12-14T16:02:49.6712166+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-12-14T16:02:49.6712166+00:00</UpdatedDateUtc>
  <ApplicationId>ff72d91c-917d-4fb5-aa57-575dcf5aaa95</ApplicationId>
  <ApplicationVersionId>251a47ed-27c5-46a9-9f03-dac3fb951613</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>dcb12cf2-f9f4-4ff0-9260-329d1dd6a9f6</DeviceGroupId>
  <DeviceId>f34f5ad6-db76-42cf-bbcc-9bc93e6b1e70</DeviceId>
  <MessageAuditCreatedDateUtc>2025-12-14T16:02:49.6712166+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>09ee4e24-7cfd-48c8-b5e0-bde3728a4435</MessageAuditId>
  <MessageAuditMessageAuditTypeId>a696bbec-fc56-43ee-ba30-efed44695d16</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-12-14T16:02:49.6712166+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>75c868f3-f21f-458b-8d33-44b864367200</MessageId>
  <MessageTypeId>8d5f200f-07ab-47d6-861d-b6b325b08435</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>3d3de80c-0e31-4f35-a14f-f9e44442bfde</TenantId>
  <UserGroupId>705b1788-51f4-4c41-a5ca-499812626327</UserGroupId>
  <UserId>069964f1-24b7-438c-a9bf-ae9d14cdf00b</UserId>
</MessageRepresentation>