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": "35d1a965-46c6-4994-aa33-bd47a1692afa",
  "tenantId": "de708fda-0e9e-476d-83ab-b757ed7d0097",
  "messageTypeId": "abcf1932-eb49-4134-ac9a-8f1d1856f60e",
  "messageTypeLookupKey": "sample string 4",
  "userId": "40788bd4-8655-4bf9-8c7e-4a8cd14598ae",
  "userGroupId": "36d957ff-5bb6-4bef-88e8-788741aad214",
  "deviceId": "583ec4bb-fd67-469b-8a86-7d6d4ae39bd4",
  "deviceGroupId": "3670ad74-5a31-4367-89b4-a365cd606467",
  "applicationId": "0a3922e6-98eb-45c2-85c2-949aa4a83a68",
  "applicationVersionId": "81d2c62e-5477-42ce-a309-feb6126f60c4",
  "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": "ec47597f-935f-479e-9001-6c79cef1aa99",
  "messageAuditMessageAuditTypeId": "4d215b09-2e05-48dc-8b82-537c139f3e45",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-01-30T22:14:35.0386899+00:00",
  "messageAuditUpdatedDateUtc": "2026-01-30T22:14:35.0386899+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-01-30T22:14:35.0386899+00:00",
  "updatedDateUtc": "2026-01-30T22:14:35.0386899+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-01-30T22:14:35.0386899+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-01-30T22:14:35.0386899+00:00</UpdatedDateUtc>
  <ApplicationId>0a3922e6-98eb-45c2-85c2-949aa4a83a68</ApplicationId>
  <ApplicationVersionId>81d2c62e-5477-42ce-a309-feb6126f60c4</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>3670ad74-5a31-4367-89b4-a365cd606467</DeviceGroupId>
  <DeviceId>583ec4bb-fd67-469b-8a86-7d6d4ae39bd4</DeviceId>
  <MessageAuditCreatedDateUtc>2026-01-30T22:14:35.0386899+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>ec47597f-935f-479e-9001-6c79cef1aa99</MessageAuditId>
  <MessageAuditMessageAuditTypeId>4d215b09-2e05-48dc-8b82-537c139f3e45</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-01-30T22:14:35.0386899+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>35d1a965-46c6-4994-aa33-bd47a1692afa</MessageId>
  <MessageTypeId>abcf1932-eb49-4134-ac9a-8f1d1856f60e</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>de708fda-0e9e-476d-83ab-b757ed7d0097</TenantId>
  <UserGroupId>36d957ff-5bb6-4bef-88e8-788741aad214</UserGroupId>
  <UserId>40788bd4-8655-4bf9-8c7e-4a8cd14598ae</UserId>
</MessageRepresentation>