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": "391e7fb8-a5c3-4c6e-b871-3250e063118b",
  "tenantId": "164b0607-aae5-4c87-ae82-5af444ef9c48",
  "messageTypeId": "9c7bd8a2-4820-4456-a09c-34c4c63caf53",
  "messageTypeLookupKey": "sample string 4",
  "userId": "d40aae4a-129e-483e-a286-a68f6e0bb45f",
  "userGroupId": "e76bcc24-b0d7-45d4-8ff9-fcdd6ee7a9ce",
  "deviceId": "ac847353-7d61-4aa3-ad6a-d41fb6630095",
  "deviceGroupId": "71c3a121-19cc-43b0-b67a-970389463cfb",
  "applicationId": "b0da30c6-5749-4535-89a7-b7708795b424",
  "applicationVersionId": "3543a59d-df6f-4472-9a8b-d4c9adae7b05",
  "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": "ae5a6044-1a60-42ce-909c-c5749a7a9627",
  "messageAuditMessageAuditTypeId": "6a867d6f-e212-4e64-b223-be8a2fe412e6",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-08-15T17:27:07.3873664+00:00",
  "messageAuditUpdatedDateUtc": "2026-08-15T17:27:07.3873664+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-08-15T17:27:07.3873664+00:00",
  "updatedDateUtc": "2026-08-15T17:27:07.3873664+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-08-15T17:27:07.3873664+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-08-15T17:27:07.3873664+00:00</UpdatedDateUtc>
  <ApplicationId>b0da30c6-5749-4535-89a7-b7708795b424</ApplicationId>
  <ApplicationVersionId>3543a59d-df6f-4472-9a8b-d4c9adae7b05</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>71c3a121-19cc-43b0-b67a-970389463cfb</DeviceGroupId>
  <DeviceId>ac847353-7d61-4aa3-ad6a-d41fb6630095</DeviceId>
  <MessageAuditCreatedDateUtc>2026-08-15T17:27:07.3873664+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>ae5a6044-1a60-42ce-909c-c5749a7a9627</MessageAuditId>
  <MessageAuditMessageAuditTypeId>6a867d6f-e212-4e64-b223-be8a2fe412e6</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-08-15T17:27:07.3873664+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>391e7fb8-a5c3-4c6e-b871-3250e063118b</MessageId>
  <MessageTypeId>9c7bd8a2-4820-4456-a09c-34c4c63caf53</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>164b0607-aae5-4c87-ae82-5af444ef9c48</TenantId>
  <UserGroupId>e76bcc24-b0d7-45d4-8ff9-fcdd6ee7a9ce</UserGroupId>
  <UserId>d40aae4a-129e-483e-a286-a68f6e0bb45f</UserId>
</MessageRepresentation>