Cyan Web API - Version 1


GET api/messages?{senderSessionId}&{senderSessionSequence}

            Gets a Message.
            

Request Information

Parameters

NameDescriptionAdditional 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": "73d33553-8bcc-4365-9e13-5140cbc4c901",
  "tenantId": "73674544-06c3-4882-8563-82ecf576fe0a",
  "messageTypeId": "d52972c5-8fa5-4962-b788-e47676972905",
  "messageTypeLookupKey": "sample string 4",
  "userId": "9366217c-0402-46bb-8677-611930793c07",
  "userGroupId": "7f78c320-33b1-419c-9234-8168faaf3bec",
  "deviceId": "6519ac80-0f88-4f2d-ab94-2897869bd47b",
  "deviceGroupId": "7f7982e7-78fc-4542-babc-505de181c5de",
  "applicationId": "d2aeac7d-ea56-4727-9999-a0ee41adce6a",
  "applicationVersionId": "16e1ec58-b5fc-4544-a774-bc72cc7f64b4",
  "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": "3838dcfc-95c5-430f-a1fe-5467cfc7744b",
  "messageAuditMessageAuditTypeId": "7209c3e3-e237-44f4-b577-b04ed50eadf2",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-11-04T08:34:54.6871898+00:00",
  "messageAuditUpdatedDateUtc": "2026-11-04T08:34:54.6871898+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-11-04T08:34:54.6871898+00:00",
  "updatedDateUtc": "2026-11-04T08:34:54.6871898+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-11-04T08:34:54.6871898+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-11-04T08:34:54.6871898+00:00</UpdatedDateUtc>
  <ApplicationId>d2aeac7d-ea56-4727-9999-a0ee41adce6a</ApplicationId>
  <ApplicationVersionId>16e1ec58-b5fc-4544-a774-bc72cc7f64b4</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>7f7982e7-78fc-4542-babc-505de181c5de</DeviceGroupId>
  <DeviceId>6519ac80-0f88-4f2d-ab94-2897869bd47b</DeviceId>
  <MessageAuditCreatedDateUtc>2026-11-04T08:34:54.6871898+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>3838dcfc-95c5-430f-a1fe-5467cfc7744b</MessageAuditId>
  <MessageAuditMessageAuditTypeId>7209c3e3-e237-44f4-b577-b04ed50eadf2</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-11-04T08:34:54.6871898+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>73d33553-8bcc-4365-9e13-5140cbc4c901</MessageId>
  <MessageTypeId>d52972c5-8fa5-4962-b788-e47676972905</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>73674544-06c3-4882-8563-82ecf576fe0a</TenantId>
  <UserGroupId>7f78c320-33b1-419c-9234-8168faaf3bec</UserGroupId>
  <UserId>9366217c-0402-46bb-8677-611930793c07</UserId>
</MessageRepresentation>