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": "d836a7d7-677a-4ef1-8234-bfb2c60190ce",
  "tenantId": "b5cbab05-cd9a-4096-b393-3b2f78e07b33",
  "messageTypeId": "6efcdca8-795d-4a3e-ab4c-ae43ae3140dc",
  "messageTypeLookupKey": "sample string 4",
  "userId": "d1eb583d-76ac-4cab-afb5-0cd6a04271ef",
  "userGroupId": "fe606506-f093-4ce4-a290-a1cd5d919fe9",
  "deviceId": "50086d2d-53aa-4eb0-8f2e-2e14711ace4a",
  "deviceGroupId": "84227f10-1c63-48d7-aa89-cce91f103085",
  "applicationId": "d664a3e2-dc43-47ed-a3a4-932aa4172fdc",
  "applicationVersionId": "32260ef3-1cb0-4d71-adc5-f48b764fc0e9",
  "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": "b7629b88-ad92-4e23-b2c6-216f88fbd2e5",
  "messageAuditMessageAuditTypeId": "df006c4c-f102-4e90-bfa3-814bec3dc789",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-01-15T22:28:21.2472534+00:00",
  "messageAuditUpdatedDateUtc": "2026-01-15T22:28:21.2472534+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-01-15T22:28:21.2472534+00:00",
  "updatedDateUtc": "2026-01-15T22:28:21.2472534+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-15T22:28:21.2472534+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-01-15T22:28:21.2472534+00:00</UpdatedDateUtc>
  <ApplicationId>d664a3e2-dc43-47ed-a3a4-932aa4172fdc</ApplicationId>
  <ApplicationVersionId>32260ef3-1cb0-4d71-adc5-f48b764fc0e9</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>84227f10-1c63-48d7-aa89-cce91f103085</DeviceGroupId>
  <DeviceId>50086d2d-53aa-4eb0-8f2e-2e14711ace4a</DeviceId>
  <MessageAuditCreatedDateUtc>2026-01-15T22:28:21.2472534+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>b7629b88-ad92-4e23-b2c6-216f88fbd2e5</MessageAuditId>
  <MessageAuditMessageAuditTypeId>df006c4c-f102-4e90-bfa3-814bec3dc789</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-01-15T22:28:21.2472534+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>d836a7d7-677a-4ef1-8234-bfb2c60190ce</MessageId>
  <MessageTypeId>6efcdca8-795d-4a3e-ab4c-ae43ae3140dc</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>b5cbab05-cd9a-4096-b393-3b2f78e07b33</TenantId>
  <UserGroupId>fe606506-f093-4ce4-a290-a1cd5d919fe9</UserGroupId>
  <UserId>d1eb583d-76ac-4cab-afb5-0cd6a04271ef</UserId>
</MessageRepresentation>