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": "7e6f21f0-cdd3-42da-af53-21af6b94c9ce",
  "tenantId": "1fdd6285-50d3-487e-990a-94a80d2c1a04",
  "messageTypeId": "31117af0-c512-4cdd-a4fa-bbe3b75830ce",
  "messageTypeLookupKey": "sample string 4",
  "userId": "fe90d0a8-45bf-432c-8e80-33fb75198999",
  "userGroupId": "936b8f4d-5527-4d86-8d3a-fcfa1e0b6de5",
  "deviceId": "8363fd7c-1aef-493e-8c3a-fb6354eabc84",
  "deviceGroupId": "b5105c74-2a93-4731-bd2c-5b128b0ef7d8",
  "applicationId": "2772d960-65c2-4a47-86b3-856cecb2a7f7",
  "applicationVersionId": "95db8fe8-18c3-427a-b4bd-14e2c0710675",
  "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": "41144eb3-6184-4586-ab20-291746847bee",
  "messageAuditMessageAuditTypeId": "7d192ee1-55e8-4f72-adf9-f2402f3a6ea4",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-05-11T10:12:12.2251903+00:00",
  "messageAuditUpdatedDateUtc": "2026-05-11T10:12:12.2251903+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-05-11T10:12:12.2251903+00:00",
  "updatedDateUtc": "2026-05-11T10:12:12.2251903+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>2026-05-11T10:12:12.2251903+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-05-11T10:12:12.2251903+00:00</UpdatedDateUtc>
  <ApplicationId>2772d960-65c2-4a47-86b3-856cecb2a7f7</ApplicationId>
  <ApplicationVersionId>95db8fe8-18c3-427a-b4bd-14e2c0710675</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>b5105c74-2a93-4731-bd2c-5b128b0ef7d8</DeviceGroupId>
  <DeviceId>8363fd7c-1aef-493e-8c3a-fb6354eabc84</DeviceId>
  <MessageAuditCreatedDateUtc>2026-05-11T10:12:12.2251903+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>41144eb3-6184-4586-ab20-291746847bee</MessageAuditId>
  <MessageAuditMessageAuditTypeId>7d192ee1-55e8-4f72-adf9-f2402f3a6ea4</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-05-11T10:12:12.2251903+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>7e6f21f0-cdd3-42da-af53-21af6b94c9ce</MessageId>
  <MessageTypeId>31117af0-c512-4cdd-a4fa-bbe3b75830ce</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>1fdd6285-50d3-487e-990a-94a80d2c1a04</TenantId>
  <UserGroupId>936b8f4d-5527-4d86-8d3a-fcfa1e0b6de5</UserGroupId>
  <UserId>fe90d0a8-45bf-432c-8e80-33fb75198999</UserId>
</MessageRepresentation>