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": "b84361cb-74bb-4052-8e44-f00e2624ebf0",
  "tenantId": "599f4980-fd41-4a84-9562-5c125a4113eb",
  "messageTypeId": "f5a5cdd3-4c82-454b-b7b5-9a8ea76fe0da",
  "messageTypeLookupKey": "sample string 4",
  "userId": "3a6056c9-092d-472e-bcbc-2dd241829659",
  "userGroupId": "30df2489-62b6-4c95-a260-7bb772043b9f",
  "deviceId": "eb731032-3ca6-4cf6-b359-3a8d45cb7231",
  "deviceGroupId": "4b61dee2-28f5-483d-948e-b985eb7873b6",
  "applicationId": "93774b44-a698-44b7-b228-23b0651e3311",
  "applicationVersionId": "ab257976-9732-403c-9dc6-2e1119932655",
  "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": "c7a838b1-a702-461c-adac-d56537f16cf1",
  "messageAuditMessageAuditTypeId": "3acb5af7-ec2b-4fc8-82ee-06463a2d9b53",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-02-04T01:52:19.4335462+00:00",
  "messageAuditUpdatedDateUtc": "2026-02-04T01:52:19.4335462+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-02-04T01:52:19.4335462+00:00",
  "updatedDateUtc": "2026-02-04T01:52:19.4335462+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-02-04T01:52:19.4335462+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-02-04T01:52:19.4335462+00:00</UpdatedDateUtc>
  <ApplicationId>93774b44-a698-44b7-b228-23b0651e3311</ApplicationId>
  <ApplicationVersionId>ab257976-9732-403c-9dc6-2e1119932655</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>4b61dee2-28f5-483d-948e-b985eb7873b6</DeviceGroupId>
  <DeviceId>eb731032-3ca6-4cf6-b359-3a8d45cb7231</DeviceId>
  <MessageAuditCreatedDateUtc>2026-02-04T01:52:19.4335462+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>c7a838b1-a702-461c-adac-d56537f16cf1</MessageAuditId>
  <MessageAuditMessageAuditTypeId>3acb5af7-ec2b-4fc8-82ee-06463a2d9b53</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-02-04T01:52:19.4335462+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>b84361cb-74bb-4052-8e44-f00e2624ebf0</MessageId>
  <MessageTypeId>f5a5cdd3-4c82-454b-b7b5-9a8ea76fe0da</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>599f4980-fd41-4a84-9562-5c125a4113eb</TenantId>
  <UserGroupId>30df2489-62b6-4c95-a260-7bb772043b9f</UserGroupId>
  <UserId>3a6056c9-092d-472e-bcbc-2dd241829659</UserId>
</MessageRepresentation>