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": "aeed45cf-744d-4962-b40e-44da5f3c110b",
  "tenantId": "7b880114-ab54-4ba4-9dda-ea8f59473687",
  "messageTypeId": "1b80e076-d6f8-498f-9f06-b705c49b8e05",
  "messageTypeLookupKey": "sample string 4",
  "userId": "c23b1ae5-3240-4c36-b735-38c0459db162",
  "userGroupId": "8562df69-73ec-4ac8-801c-18c985abfab8",
  "deviceId": "1e84ea32-3896-42f3-b3ca-59a93b972c5b",
  "deviceGroupId": "c8300a93-12c4-48f2-b35d-fafe785da038",
  "applicationId": "3bddd71a-089b-4396-b0cd-c58343d56efd",
  "applicationVersionId": "94f5b178-b737-4b3c-bbfb-e8141d359d18",
  "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": "7c33fa83-2a91-4501-9fb7-89c0c92dcc5f",
  "messageAuditMessageAuditTypeId": "794f23b9-469e-4e57-b808-61a32b989500",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-03-30T06:40:22.4142249+00:00",
  "messageAuditUpdatedDateUtc": "2026-03-30T06:40:22.4142249+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-03-30T06:40:22.4142249+00:00",
  "updatedDateUtc": "2026-03-30T06:40:22.4142249+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-03-30T06:40:22.4142249+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-03-30T06:40:22.4142249+00:00</UpdatedDateUtc>
  <ApplicationId>3bddd71a-089b-4396-b0cd-c58343d56efd</ApplicationId>
  <ApplicationVersionId>94f5b178-b737-4b3c-bbfb-e8141d359d18</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>c8300a93-12c4-48f2-b35d-fafe785da038</DeviceGroupId>
  <DeviceId>1e84ea32-3896-42f3-b3ca-59a93b972c5b</DeviceId>
  <MessageAuditCreatedDateUtc>2026-03-30T06:40:22.4142249+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>7c33fa83-2a91-4501-9fb7-89c0c92dcc5f</MessageAuditId>
  <MessageAuditMessageAuditTypeId>794f23b9-469e-4e57-b808-61a32b989500</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-03-30T06:40:22.4142249+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>aeed45cf-744d-4962-b40e-44da5f3c110b</MessageId>
  <MessageTypeId>1b80e076-d6f8-498f-9f06-b705c49b8e05</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>7b880114-ab54-4ba4-9dda-ea8f59473687</TenantId>
  <UserGroupId>8562df69-73ec-4ac8-801c-18c985abfab8</UserGroupId>
  <UserId>c23b1ae5-3240-4c36-b735-38c0459db162</UserId>
</MessageRepresentation>