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": "652bc23d-93df-4f3f-93fc-8827b5e4a14f",
  "tenantId": "4af65d5e-9538-4c09-aed4-44b6d60d879b",
  "messageTypeId": "fa244f9a-5433-42d3-84f7-cb71514bbbf3",
  "messageTypeLookupKey": "sample string 4",
  "userId": "8c66cdaf-deaa-4513-ab77-d0d67510e955",
  "userGroupId": "9e1593bc-ffb4-48b6-a0ba-67c1005dee23",
  "deviceId": "9053b39a-a2ca-40c2-b60b-4beaf03a43c5",
  "deviceGroupId": "70dabac1-e2f6-41bf-b653-1c046b77ab84",
  "applicationId": "68a99ed0-d07c-4ada-ba76-a247bbb8ec5a",
  "applicationVersionId": "c3bc9763-72cf-45fd-b88e-1366884644d9",
  "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": "39d27144-65be-44c2-a299-d648347bcaa7",
  "messageAuditMessageAuditTypeId": "bb3ad012-a52a-4d3b-8e59-1dd500b9db64",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-02-12T02:17:39.8724989+00:00",
  "messageAuditUpdatedDateUtc": "2026-02-12T02:17:39.8724989+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-02-12T02:17:39.8724989+00:00",
  "updatedDateUtc": "2026-02-12T02:17:39.8724989+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-02-12T02:17:39.8724989+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-02-12T02:17:39.8724989+00:00</UpdatedDateUtc>
  <ApplicationId>68a99ed0-d07c-4ada-ba76-a247bbb8ec5a</ApplicationId>
  <ApplicationVersionId>c3bc9763-72cf-45fd-b88e-1366884644d9</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>70dabac1-e2f6-41bf-b653-1c046b77ab84</DeviceGroupId>
  <DeviceId>9053b39a-a2ca-40c2-b60b-4beaf03a43c5</DeviceId>
  <MessageAuditCreatedDateUtc>2026-02-12T02:17:39.8724989+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>39d27144-65be-44c2-a299-d648347bcaa7</MessageAuditId>
  <MessageAuditMessageAuditTypeId>bb3ad012-a52a-4d3b-8e59-1dd500b9db64</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-02-12T02:17:39.8724989+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>652bc23d-93df-4f3f-93fc-8827b5e4a14f</MessageId>
  <MessageTypeId>fa244f9a-5433-42d3-84f7-cb71514bbbf3</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>4af65d5e-9538-4c09-aed4-44b6d60d879b</TenantId>
  <UserGroupId>9e1593bc-ffb4-48b6-a0ba-67c1005dee23</UserGroupId>
  <UserId>8c66cdaf-deaa-4513-ab77-d0d67510e955</UserId>
</MessageRepresentation>