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": "c85dec91-c9f8-4857-9bc1-d76d148617a3",
  "tenantId": "b90afc70-fc28-4cc9-862c-7ea34e994bca",
  "messageTypeId": "7bd9b10c-5443-47e0-bbd7-16b4bac10d4b",
  "messageTypeLookupKey": "sample string 4",
  "userId": "c424149f-c46a-4ae8-83c9-e942a475f96f",
  "userGroupId": "367c1b51-a066-454e-bf8e-f8bb6e892214",
  "deviceId": "ab36657c-3531-496b-a9ea-2233b0161be1",
  "deviceGroupId": "cde63f2a-9822-4790-b46a-7b2e48533116",
  "applicationId": "7a5227d9-6f40-4bde-aba7-461d370445b0",
  "applicationVersionId": "8bb3815b-ffc6-4daf-b9bf-d4637dd40790",
  "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": "7a70aeab-b36b-4f3f-8231-793a82c1e235",
  "messageAuditMessageAuditTypeId": "d410527d-c8a0-4613-85a7-a8503f3d8459",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-12-11T20:38:27.1792402+00:00",
  "messageAuditUpdatedDateUtc": "2025-12-11T20:38:27.1792402+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-12-11T20:38:27.1792402+00:00",
  "updatedDateUtc": "2025-12-11T20:38:27.1792402+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-11T20:38:27.1792402+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-12-11T20:38:27.1792402+00:00</UpdatedDateUtc>
  <ApplicationId>7a5227d9-6f40-4bde-aba7-461d370445b0</ApplicationId>
  <ApplicationVersionId>8bb3815b-ffc6-4daf-b9bf-d4637dd40790</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>cde63f2a-9822-4790-b46a-7b2e48533116</DeviceGroupId>
  <DeviceId>ab36657c-3531-496b-a9ea-2233b0161be1</DeviceId>
  <MessageAuditCreatedDateUtc>2025-12-11T20:38:27.1792402+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>7a70aeab-b36b-4f3f-8231-793a82c1e235</MessageAuditId>
  <MessageAuditMessageAuditTypeId>d410527d-c8a0-4613-85a7-a8503f3d8459</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-12-11T20:38:27.1792402+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>c85dec91-c9f8-4857-9bc1-d76d148617a3</MessageId>
  <MessageTypeId>7bd9b10c-5443-47e0-bbd7-16b4bac10d4b</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>b90afc70-fc28-4cc9-862c-7ea34e994bca</TenantId>
  <UserGroupId>367c1b51-a066-454e-bf8e-f8bb6e892214</UserGroupId>
  <UserId>c424149f-c46a-4ae8-83c9-e942a475f96f</UserId>
</MessageRepresentation>