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": "e13398d6-f56d-4764-ae78-ea8ea9954169",
  "tenantId": "2b6fb092-c2cc-43c8-982a-ff62ace8a381",
  "messageTypeId": "ad61d19b-ef9e-4857-9800-090a3db88d57",
  "messageTypeLookupKey": "sample string 4",
  "userId": "cc3b7b13-fac0-4ae1-ac18-24f35d44f61b",
  "userGroupId": "a3c4b718-90bd-4a1b-abc4-19c120e98bc6",
  "deviceId": "2ea3227a-db62-4c0b-82c7-80c176be29e5",
  "deviceGroupId": "eb4bd8a9-b2fc-422b-924f-fdf65fc6bbe1",
  "applicationId": "2716817a-6ccf-4670-91c1-c210bbca49e1",
  "applicationVersionId": "f04ab969-b4e3-4cd3-a8c5-c8cd886d3d66",
  "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": "8ed78e28-c0e0-46a6-a8e8-dcc2d2282e5c",
  "messageAuditMessageAuditTypeId": "e2b612d8-c191-4de6-b8f2-30d95933fe6c",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-02-08T20:45:26.032494+00:00",
  "messageAuditUpdatedDateUtc": "2026-02-08T20:45:26.032494+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-02-08T20:45:26.032494+00:00",
  "updatedDateUtc": "2026-02-08T20:45:26.032494+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-02-08T20:45:26.032494+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-02-08T20:45:26.032494+00:00</UpdatedDateUtc>
  <ApplicationId>2716817a-6ccf-4670-91c1-c210bbca49e1</ApplicationId>
  <ApplicationVersionId>f04ab969-b4e3-4cd3-a8c5-c8cd886d3d66</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>eb4bd8a9-b2fc-422b-924f-fdf65fc6bbe1</DeviceGroupId>
  <DeviceId>2ea3227a-db62-4c0b-82c7-80c176be29e5</DeviceId>
  <MessageAuditCreatedDateUtc>2026-02-08T20:45:26.032494+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>8ed78e28-c0e0-46a6-a8e8-dcc2d2282e5c</MessageAuditId>
  <MessageAuditMessageAuditTypeId>e2b612d8-c191-4de6-b8f2-30d95933fe6c</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-02-08T20:45:26.032494+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>e13398d6-f56d-4764-ae78-ea8ea9954169</MessageId>
  <MessageTypeId>ad61d19b-ef9e-4857-9800-090a3db88d57</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>2b6fb092-c2cc-43c8-982a-ff62ace8a381</TenantId>
  <UserGroupId>a3c4b718-90bd-4a1b-abc4-19c120e98bc6</UserGroupId>
  <UserId>cc3b7b13-fac0-4ae1-ac18-24f35d44f61b</UserId>
</MessageRepresentation>