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": "b4910d9f-8d80-4595-bd1c-0b791123242a",
  "tenantId": "5f1c208d-34e5-448b-80f1-384f65727293",
  "messageTypeId": "c4d3bebf-e110-4734-a603-d69d28667b26",
  "messageTypeLookupKey": "sample string 4",
  "userId": "4c760023-f13a-4e2e-8e5d-62a490b2bf47",
  "userGroupId": "01a79dbb-f6db-4fd4-a3f7-cb9b1e2f4e7d",
  "deviceId": "cc28df7c-3cf0-4a53-8515-f713620b7b6c",
  "deviceGroupId": "83065616-a4b7-40a3-92c5-b613fa46e74d",
  "applicationId": "942f5e9c-aee6-4906-ac88-f218df611354",
  "applicationVersionId": "2ec0d4cd-d52d-47e8-b512-dd9af6603025",
  "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": "a859896d-8e6e-4388-a3c5-e1009ff38747",
  "messageAuditMessageAuditTypeId": "a6e966f0-1de7-4a5d-b920-a5cf31917007",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-07-05T15:44:52.8965489+00:00",
  "messageAuditUpdatedDateUtc": "2025-07-05T15:44:52.8965489+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-07-05T15:44:52.8965489+00:00",
  "updatedDateUtc": "2025-07-05T15:44:52.8965489+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>2025-07-05T15:44:52.8965489+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-07-05T15:44:52.8965489+00:00</UpdatedDateUtc>
  <ApplicationId>942f5e9c-aee6-4906-ac88-f218df611354</ApplicationId>
  <ApplicationVersionId>2ec0d4cd-d52d-47e8-b512-dd9af6603025</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>83065616-a4b7-40a3-92c5-b613fa46e74d</DeviceGroupId>
  <DeviceId>cc28df7c-3cf0-4a53-8515-f713620b7b6c</DeviceId>
  <MessageAuditCreatedDateUtc>2025-07-05T15:44:52.8965489+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>a859896d-8e6e-4388-a3c5-e1009ff38747</MessageAuditId>
  <MessageAuditMessageAuditTypeId>a6e966f0-1de7-4a5d-b920-a5cf31917007</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-07-05T15:44:52.8965489+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>b4910d9f-8d80-4595-bd1c-0b791123242a</MessageId>
  <MessageTypeId>c4d3bebf-e110-4734-a603-d69d28667b26</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>5f1c208d-34e5-448b-80f1-384f65727293</TenantId>
  <UserGroupId>01a79dbb-f6db-4fd4-a3f7-cb9b1e2f4e7d</UserGroupId>
  <UserId>4c760023-f13a-4e2e-8e5d-62a490b2bf47</UserId>
</MessageRepresentation>