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": "ad1e4dc4-a62d-4164-bc68-dea235a8ef08",
  "tenantId": "2233a672-c26a-476b-a5c7-9124f965dfa4",
  "messageTypeId": "bf268edd-1f2a-49e5-a3bb-f6ab8725db49",
  "messageTypeLookupKey": "sample string 4",
  "userId": "d7c6db16-c4ed-426d-837f-1ce6429050ba",
  "userGroupId": "a510886f-3638-4639-8422-db1d5e124ded",
  "deviceId": "e648dbf5-2e70-4d58-97ba-34ad80a13c04",
  "deviceGroupId": "01671c8f-0e3e-44dd-9817-7c512485c711",
  "applicationId": "4f4a74f2-4953-4dc2-aaac-1808af0856a7",
  "applicationVersionId": "b4167080-8c6b-49dc-87de-bca1e8ab735d",
  "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": "9924c248-3f47-4560-9fa5-14a34ce2658e",
  "messageAuditMessageAuditTypeId": "fe7b587a-4802-4bc4-8766-7ffb3a0e7de5",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-08-02T05:31:41.5762258+00:00",
  "messageAuditUpdatedDateUtc": "2026-08-02T05:31:41.5762258+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-08-02T05:31:41.5762258+00:00",
  "updatedDateUtc": "2026-08-02T05:31:41.5762258+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-02T05:31:41.5762258+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-08-02T05:31:41.5762258+00:00</UpdatedDateUtc>
  <ApplicationId>4f4a74f2-4953-4dc2-aaac-1808af0856a7</ApplicationId>
  <ApplicationVersionId>b4167080-8c6b-49dc-87de-bca1e8ab735d</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>01671c8f-0e3e-44dd-9817-7c512485c711</DeviceGroupId>
  <DeviceId>e648dbf5-2e70-4d58-97ba-34ad80a13c04</DeviceId>
  <MessageAuditCreatedDateUtc>2026-08-02T05:31:41.5762258+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>9924c248-3f47-4560-9fa5-14a34ce2658e</MessageAuditId>
  <MessageAuditMessageAuditTypeId>fe7b587a-4802-4bc4-8766-7ffb3a0e7de5</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-08-02T05:31:41.5762258+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>ad1e4dc4-a62d-4164-bc68-dea235a8ef08</MessageId>
  <MessageTypeId>bf268edd-1f2a-49e5-a3bb-f6ab8725db49</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>2233a672-c26a-476b-a5c7-9124f965dfa4</TenantId>
  <UserGroupId>a510886f-3638-4639-8422-db1d5e124ded</UserGroupId>
  <UserId>d7c6db16-c4ed-426d-837f-1ce6429050ba</UserId>
</MessageRepresentation>