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": "2e432913-7ecf-4264-904d-3cc18a41e807",
  "tenantId": "e8c2c670-18a3-421e-86e4-509696e81566",
  "messageTypeId": "75d282b0-02bb-401b-bbf4-4a53cdecb52b",
  "messageTypeLookupKey": "sample string 4",
  "userId": "eeb658a8-8841-4394-931a-0716a07db89f",
  "userGroupId": "041f7f7f-c9a0-4b50-a368-73a671df30aa",
  "deviceId": "8c36a8a7-1add-43ae-94b2-4f133eb24aec",
  "deviceGroupId": "53caf4f8-a5a1-4524-91b4-ae3032850265",
  "applicationId": "5695954d-193d-4449-86d0-e49c50254bf7",
  "applicationVersionId": "d3dc9942-1977-49c1-bf38-c63c64fbdaa7",
  "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": "0eaab240-1437-4f74-97c7-87cf17418132",
  "messageAuditMessageAuditTypeId": "2cf9ad08-acb5-4c7c-9a19-2fa54fd318d7",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-11-12T15:31:00.5917005+00:00",
  "messageAuditUpdatedDateUtc": "2025-11-12T15:31:00.5917005+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-11-12T15:31:00.5917005+00:00",
  "updatedDateUtc": "2025-11-12T15:31:00.5917005+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-11-12T15:31:00.5917005+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-11-12T15:31:00.5917005+00:00</UpdatedDateUtc>
  <ApplicationId>5695954d-193d-4449-86d0-e49c50254bf7</ApplicationId>
  <ApplicationVersionId>d3dc9942-1977-49c1-bf38-c63c64fbdaa7</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>53caf4f8-a5a1-4524-91b4-ae3032850265</DeviceGroupId>
  <DeviceId>8c36a8a7-1add-43ae-94b2-4f133eb24aec</DeviceId>
  <MessageAuditCreatedDateUtc>2025-11-12T15:31:00.5917005+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>0eaab240-1437-4f74-97c7-87cf17418132</MessageAuditId>
  <MessageAuditMessageAuditTypeId>2cf9ad08-acb5-4c7c-9a19-2fa54fd318d7</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-11-12T15:31:00.5917005+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>2e432913-7ecf-4264-904d-3cc18a41e807</MessageId>
  <MessageTypeId>75d282b0-02bb-401b-bbf4-4a53cdecb52b</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>e8c2c670-18a3-421e-86e4-509696e81566</TenantId>
  <UserGroupId>041f7f7f-c9a0-4b50-a368-73a671df30aa</UserGroupId>
  <UserId>eeb658a8-8841-4394-931a-0716a07db89f</UserId>
</MessageRepresentation>