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": "1e2f9a37-bd63-4fba-9b58-c1fca60bba3b",
  "tenantId": "d3e0008f-8008-4eaa-b38f-858dbc8ca544",
  "messageTypeId": "ca8af313-41bd-4a4b-9055-649a0b7d96b3",
  "messageTypeLookupKey": "sample string 4",
  "userId": "0256b271-b850-4ec1-8d2c-412fa22bb387",
  "userGroupId": "5e8504f6-21b9-4ca5-a5be-f832bd325be5",
  "deviceId": "5b174642-b02e-44e5-9f2d-310b3ae0048d",
  "deviceGroupId": "3235e7a7-98f2-4276-8650-d337c6679fb7",
  "applicationId": "442269cb-f1c7-4c9e-b4d6-fa6a876c04d3",
  "applicationVersionId": "cbe71462-1922-4f13-98af-5b63012f7f86",
  "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": "cf5852b3-3ab4-4898-b623-fa4ca2b89f7f",
  "messageAuditMessageAuditTypeId": "2970fb23-863b-432b-a235-934cdec1243b",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-09-11T07:17:36.1685056+00:00",
  "messageAuditUpdatedDateUtc": "2026-09-11T07:17:36.1685056+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-09-11T07:17:36.1685056+00:00",
  "updatedDateUtc": "2026-09-11T07:17:36.1685056+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-11T07:17:36.1685056+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-09-11T07:17:36.1685056+00:00</UpdatedDateUtc>
  <ApplicationId>442269cb-f1c7-4c9e-b4d6-fa6a876c04d3</ApplicationId>
  <ApplicationVersionId>cbe71462-1922-4f13-98af-5b63012f7f86</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>3235e7a7-98f2-4276-8650-d337c6679fb7</DeviceGroupId>
  <DeviceId>5b174642-b02e-44e5-9f2d-310b3ae0048d</DeviceId>
  <MessageAuditCreatedDateUtc>2026-09-11T07:17:36.1685056+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>cf5852b3-3ab4-4898-b623-fa4ca2b89f7f</MessageAuditId>
  <MessageAuditMessageAuditTypeId>2970fb23-863b-432b-a235-934cdec1243b</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-09-11T07:17:36.1685056+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>1e2f9a37-bd63-4fba-9b58-c1fca60bba3b</MessageId>
  <MessageTypeId>ca8af313-41bd-4a4b-9055-649a0b7d96b3</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>d3e0008f-8008-4eaa-b38f-858dbc8ca544</TenantId>
  <UserGroupId>5e8504f6-21b9-4ca5-a5be-f832bd325be5</UserGroupId>
  <UserId>0256b271-b850-4ec1-8d2c-412fa22bb387</UserId>
</MessageRepresentation>