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": "f02c2c27-6c06-46a5-9b88-b37b57082263",
  "tenantId": "b6ef4f6b-71ca-4c0e-96b6-0694dddf1afa",
  "messageTypeId": "e432548d-98c8-429c-ba42-34b7a52ccc3b",
  "messageTypeLookupKey": "sample string 4",
  "userId": "71274824-55bd-49b1-962a-dccc666e2668",
  "userGroupId": "6ea60bb0-f4ca-4e72-b309-173d4312bd56",
  "deviceId": "0b5e9279-67f9-454b-b54c-b819e168e1ca",
  "deviceGroupId": "cf19c60d-9fd5-44c8-b5c5-20521286b7a9",
  "applicationId": "65f592e1-9444-4829-93ce-2ff69e24f19e",
  "applicationVersionId": "bb383f64-b4ba-4b4a-a103-73ebb65f2f1b",
  "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": "f2020657-e7f2-4e5f-a32f-c7a96c8ab271",
  "messageAuditMessageAuditTypeId": "6727539c-c714-4415-9e6e-3622c2609559",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-04-24T23:47:55.5978725+00:00",
  "messageAuditUpdatedDateUtc": "2026-04-24T23:47:55.5978725+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-04-24T23:47:55.5978725+00:00",
  "updatedDateUtc": "2026-04-24T23:47:55.5978725+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-04-24T23:47:55.5978725+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-04-24T23:47:55.5978725+00:00</UpdatedDateUtc>
  <ApplicationId>65f592e1-9444-4829-93ce-2ff69e24f19e</ApplicationId>
  <ApplicationVersionId>bb383f64-b4ba-4b4a-a103-73ebb65f2f1b</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>cf19c60d-9fd5-44c8-b5c5-20521286b7a9</DeviceGroupId>
  <DeviceId>0b5e9279-67f9-454b-b54c-b819e168e1ca</DeviceId>
  <MessageAuditCreatedDateUtc>2026-04-24T23:47:55.5978725+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>f2020657-e7f2-4e5f-a32f-c7a96c8ab271</MessageAuditId>
  <MessageAuditMessageAuditTypeId>6727539c-c714-4415-9e6e-3622c2609559</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-04-24T23:47:55.5978725+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>f02c2c27-6c06-46a5-9b88-b37b57082263</MessageId>
  <MessageTypeId>e432548d-98c8-429c-ba42-34b7a52ccc3b</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>b6ef4f6b-71ca-4c0e-96b6-0694dddf1afa</TenantId>
  <UserGroupId>6ea60bb0-f4ca-4e72-b309-173d4312bd56</UserGroupId>
  <UserId>71274824-55bd-49b1-962a-dccc666e2668</UserId>
</MessageRepresentation>