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": "3483c62e-458e-434c-ae8f-dc41500a9cb1",
  "tenantId": "fe8981b5-828e-4858-9d2c-6f6a0078c91a",
  "messageTypeId": "ee174e79-30c7-4513-80ce-23de7ac4e431",
  "messageTypeLookupKey": "sample string 4",
  "userId": "1714bbe0-9a1e-4e61-8a5a-6d290ce9207c",
  "userGroupId": "72490723-650c-4301-8e7c-4d9254c313cd",
  "deviceId": "501e45c5-8e05-40c3-9e1b-ebdbc7f373d9",
  "deviceGroupId": "d10c03cd-9a95-45fb-89ed-5169c9774d55",
  "applicationId": "295c30a0-73a9-4ae6-840c-832499be5775",
  "applicationVersionId": "2d921b95-31c9-4589-9b35-5d4ce66def63",
  "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": "103049bb-3f5f-48b6-be18-64155822b766",
  "messageAuditMessageAuditTypeId": "386a0fb6-f874-4b26-93a8-ab8022fd00e3",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-09-23T03:21:37.7186962+00:00",
  "messageAuditUpdatedDateUtc": "2026-09-23T03:21:37.7186962+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-09-23T03:21:37.7186962+00:00",
  "updatedDateUtc": "2026-09-23T03:21:37.7186962+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-09-23T03:21:37.7186962+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-09-23T03:21:37.7186962+00:00</UpdatedDateUtc>
  <ApplicationId>295c30a0-73a9-4ae6-840c-832499be5775</ApplicationId>
  <ApplicationVersionId>2d921b95-31c9-4589-9b35-5d4ce66def63</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>d10c03cd-9a95-45fb-89ed-5169c9774d55</DeviceGroupId>
  <DeviceId>501e45c5-8e05-40c3-9e1b-ebdbc7f373d9</DeviceId>
  <MessageAuditCreatedDateUtc>2026-09-23T03:21:37.7186962+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>103049bb-3f5f-48b6-be18-64155822b766</MessageAuditId>
  <MessageAuditMessageAuditTypeId>386a0fb6-f874-4b26-93a8-ab8022fd00e3</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-09-23T03:21:37.7186962+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>3483c62e-458e-434c-ae8f-dc41500a9cb1</MessageId>
  <MessageTypeId>ee174e79-30c7-4513-80ce-23de7ac4e431</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>fe8981b5-828e-4858-9d2c-6f6a0078c91a</TenantId>
  <UserGroupId>72490723-650c-4301-8e7c-4d9254c313cd</UserGroupId>
  <UserId>1714bbe0-9a1e-4e61-8a5a-6d290ce9207c</UserId>
</MessageRepresentation>