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": "f0a8a935-4b1f-46c4-aca6-0370ae05c3d5",
  "tenantId": "9450aa27-d866-4d86-ba74-dc9d2cc3120c",
  "messageTypeId": "bd3432b0-91ad-4570-949b-1dd06a58d28e",
  "messageTypeLookupKey": "sample string 4",
  "userId": "fc62b641-ce7f-4625-b30d-5650ed16ad47",
  "userGroupId": "70dfbf58-beff-4b36-afb7-f2e79ce3b733",
  "deviceId": "71112cdf-68c1-40f9-8372-f5d640587c76",
  "deviceGroupId": "6cb88434-ed54-497f-95f3-01e742ffad1f",
  "applicationId": "b27f40ae-6b41-44f0-bdc7-98d36376391b",
  "applicationVersionId": "58f1769c-ccd9-4583-bd20-d1a330d877b0",
  "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": "d9266bd5-3fad-4043-9f8c-1b5d80b38847",
  "messageAuditMessageAuditTypeId": "ff111fca-f51c-4942-8277-b806663f7f7f",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-06-22T01:24:29.1491285+00:00",
  "messageAuditUpdatedDateUtc": "2026-06-22T01:24:29.1491285+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-06-22T01:24:29.1491285+00:00",
  "updatedDateUtc": "2026-06-22T01:24:29.1491285+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-22T01:24:29.1491285+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-22T01:24:29.1491285+00:00</UpdatedDateUtc>
  <ApplicationId>b27f40ae-6b41-44f0-bdc7-98d36376391b</ApplicationId>
  <ApplicationVersionId>58f1769c-ccd9-4583-bd20-d1a330d877b0</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>6cb88434-ed54-497f-95f3-01e742ffad1f</DeviceGroupId>
  <DeviceId>71112cdf-68c1-40f9-8372-f5d640587c76</DeviceId>
  <MessageAuditCreatedDateUtc>2026-06-22T01:24:29.1491285+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>d9266bd5-3fad-4043-9f8c-1b5d80b38847</MessageAuditId>
  <MessageAuditMessageAuditTypeId>ff111fca-f51c-4942-8277-b806663f7f7f</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-06-22T01:24:29.1491285+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>f0a8a935-4b1f-46c4-aca6-0370ae05c3d5</MessageId>
  <MessageTypeId>bd3432b0-91ad-4570-949b-1dd06a58d28e</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>9450aa27-d866-4d86-ba74-dc9d2cc3120c</TenantId>
  <UserGroupId>70dfbf58-beff-4b36-afb7-f2e79ce3b733</UserGroupId>
  <UserId>fc62b641-ce7f-4625-b30d-5650ed16ad47</UserId>
</MessageRepresentation>