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": "dc88af32-eee3-4343-9812-0ae84d9dd10e",
  "tenantId": "e2f28586-d154-4531-a892-93714941a400",
  "messageTypeId": "b64590db-6eed-4caa-9d33-e38dd5532547",
  "messageTypeLookupKey": "sample string 4",
  "userId": "047a5f9e-d2be-4bd9-8964-4255f126c22c",
  "userGroupId": "5b9d69a6-c172-4971-9d50-ee9450cd22f6",
  "deviceId": "b955d791-0548-4c10-92d1-aaaec5818ad8",
  "deviceGroupId": "c1074fe5-ea3a-4bd9-aa57-2688e7bbca14",
  "applicationId": "dbeb901a-d02d-4567-8df3-dbcd59c1f226",
  "applicationVersionId": "64b2ab44-8c70-41d8-bbb4-cc41ba4dc99e",
  "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": "828e25f5-2276-491e-93db-5c13255f8500",
  "messageAuditMessageAuditTypeId": "e8829c7f-6100-4b16-84f9-1d11365981a4",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-06-05T18:19:52.0979233+00:00",
  "messageAuditUpdatedDateUtc": "2026-06-05T18:19:52.0979233+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-06-05T18:19:52.0979233+00:00",
  "updatedDateUtc": "2026-06-05T18:19:52.0979233+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-06-05T18:19:52.0979233+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-05T18:19:52.0979233+00:00</UpdatedDateUtc>
  <ApplicationId>dbeb901a-d02d-4567-8df3-dbcd59c1f226</ApplicationId>
  <ApplicationVersionId>64b2ab44-8c70-41d8-bbb4-cc41ba4dc99e</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>c1074fe5-ea3a-4bd9-aa57-2688e7bbca14</DeviceGroupId>
  <DeviceId>b955d791-0548-4c10-92d1-aaaec5818ad8</DeviceId>
  <MessageAuditCreatedDateUtc>2026-06-05T18:19:52.0979233+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>828e25f5-2276-491e-93db-5c13255f8500</MessageAuditId>
  <MessageAuditMessageAuditTypeId>e8829c7f-6100-4b16-84f9-1d11365981a4</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-06-05T18:19:52.0979233+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>dc88af32-eee3-4343-9812-0ae84d9dd10e</MessageId>
  <MessageTypeId>b64590db-6eed-4caa-9d33-e38dd5532547</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>e2f28586-d154-4531-a892-93714941a400</TenantId>
  <UserGroupId>5b9d69a6-c172-4971-9d50-ee9450cd22f6</UserGroupId>
  <UserId>047a5f9e-d2be-4bd9-8964-4255f126c22c</UserId>
</MessageRepresentation>