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": "451c01ac-598c-4763-ad52-47dd25a390c4",
  "tenantId": "440d83c5-ca6f-4bf8-b987-49627c4a6141",
  "messageTypeId": "897f09e5-0686-46d3-85e4-7a8e2e65de67",
  "messageTypeLookupKey": "sample string 4",
  "userId": "893b7827-a11a-48f8-8d20-a72edd9aa1c0",
  "userGroupId": "95bcc7bf-7dad-409f-afaa-9eaa0d038e2c",
  "deviceId": "356de0d2-3cd8-44d6-ab1c-01d3a940f9bc",
  "deviceGroupId": "ad8826b7-52cc-45bc-b9e6-c9a11476ac71",
  "applicationId": "80f8e7f1-1692-453a-99e6-3cf64918d18b",
  "applicationVersionId": "66c87cf1-490b-48df-92b5-b1108f6eadeb",
  "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": "cbd07a34-4ac4-4f72-84c8-737d9e9fde28",
  "messageAuditMessageAuditTypeId": "e7824081-35f7-41d6-8d5c-81b7eaa8bdf9",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-12-08T01:08:12.1615619+00:00",
  "messageAuditUpdatedDateUtc": "2025-12-08T01:08:12.1615619+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-12-08T01:08:12.1615619+00:00",
  "updatedDateUtc": "2025-12-08T01:08:12.1615619+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-08T01:08:12.1615619+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-12-08T01:08:12.1615619+00:00</UpdatedDateUtc>
  <ApplicationId>80f8e7f1-1692-453a-99e6-3cf64918d18b</ApplicationId>
  <ApplicationVersionId>66c87cf1-490b-48df-92b5-b1108f6eadeb</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>ad8826b7-52cc-45bc-b9e6-c9a11476ac71</DeviceGroupId>
  <DeviceId>356de0d2-3cd8-44d6-ab1c-01d3a940f9bc</DeviceId>
  <MessageAuditCreatedDateUtc>2025-12-08T01:08:12.1615619+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>cbd07a34-4ac4-4f72-84c8-737d9e9fde28</MessageAuditId>
  <MessageAuditMessageAuditTypeId>e7824081-35f7-41d6-8d5c-81b7eaa8bdf9</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-12-08T01:08:12.1615619+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>451c01ac-598c-4763-ad52-47dd25a390c4</MessageId>
  <MessageTypeId>897f09e5-0686-46d3-85e4-7a8e2e65de67</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>440d83c5-ca6f-4bf8-b987-49627c4a6141</TenantId>
  <UserGroupId>95bcc7bf-7dad-409f-afaa-9eaa0d038e2c</UserGroupId>
  <UserId>893b7827-a11a-48f8-8d20-a72edd9aa1c0</UserId>
</MessageRepresentation>