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": "33ee2c1b-9cee-4564-bb8a-0c8f20200f83",
  "tenantId": "1bf79677-cdba-4857-9399-123954ac6af4",
  "messageTypeId": "cc6a4b0b-b247-45e4-a8dd-f248516e00bf",
  "messageTypeLookupKey": "sample string 4",
  "userId": "b81e8f9c-c1c4-4769-b2df-189a280b525e",
  "userGroupId": "11b6feee-389d-4ade-a304-f096c7c07268",
  "deviceId": "85a1ee61-e794-4966-a6dc-bb2f0e4422f4",
  "deviceGroupId": "623611b6-d5dd-45fb-807d-47ee61713e9f",
  "applicationId": "f6fab8d3-e096-4bc2-8e19-b9dbf235dfc7",
  "applicationVersionId": "4053976b-eaac-4656-bfe6-4ced443f2265",
  "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": "62e3288d-7502-443f-aa78-31ec93fc5949",
  "messageAuditMessageAuditTypeId": "3339d5c9-81fd-4a74-bc41-00cb0232e4d1",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-07-21T12:59:21.8504553+00:00",
  "messageAuditUpdatedDateUtc": "2026-07-21T12:59:21.8504553+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-07-21T12:59:21.8504553+00:00",
  "updatedDateUtc": "2026-07-21T12:59:21.8504553+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-07-21T12:59:21.8504553+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-07-21T12:59:21.8504553+00:00</UpdatedDateUtc>
  <ApplicationId>f6fab8d3-e096-4bc2-8e19-b9dbf235dfc7</ApplicationId>
  <ApplicationVersionId>4053976b-eaac-4656-bfe6-4ced443f2265</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>623611b6-d5dd-45fb-807d-47ee61713e9f</DeviceGroupId>
  <DeviceId>85a1ee61-e794-4966-a6dc-bb2f0e4422f4</DeviceId>
  <MessageAuditCreatedDateUtc>2026-07-21T12:59:21.8504553+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>62e3288d-7502-443f-aa78-31ec93fc5949</MessageAuditId>
  <MessageAuditMessageAuditTypeId>3339d5c9-81fd-4a74-bc41-00cb0232e4d1</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-07-21T12:59:21.8504553+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>33ee2c1b-9cee-4564-bb8a-0c8f20200f83</MessageId>
  <MessageTypeId>cc6a4b0b-b247-45e4-a8dd-f248516e00bf</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>1bf79677-cdba-4857-9399-123954ac6af4</TenantId>
  <UserGroupId>11b6feee-389d-4ade-a304-f096c7c07268</UserGroupId>
  <UserId>b81e8f9c-c1c4-4769-b2df-189a280b525e</UserId>
</MessageRepresentation>