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": "55b83651-8b13-4b1b-a29e-cc437e24c958",
  "tenantId": "d117793d-8a04-49c8-9a2c-02e1aa7599da",
  "messageTypeId": "d3ce4ba2-edf2-4d5f-9163-41ec852209b0",
  "messageTypeLookupKey": "sample string 4",
  "userId": "2d1faf3f-4840-4c28-ae81-54d06427ee62",
  "userGroupId": "d6bf1202-5707-4f5b-8931-d7e48e31c0c1",
  "deviceId": "99945069-9336-489c-bb0b-cd7b11a18594",
  "deviceGroupId": "358c9a66-67fb-4cc7-a104-26963be8aea1",
  "applicationId": "90d5337e-62cd-4823-a611-3d278b98b750",
  "applicationVersionId": "b4d91faa-6511-41d6-8cef-2fd678be56c3",
  "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": "74a9d736-8dce-46cf-b638-87c2d3e3b72a",
  "messageAuditMessageAuditTypeId": "dee4d1ce-73f3-446a-978b-79cdb3846ce7",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-07-17T09:20:16.6137973+00:00",
  "messageAuditUpdatedDateUtc": "2025-07-17T09:20:16.6137973+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-07-17T09:20:16.6137973+00:00",
  "updatedDateUtc": "2025-07-17T09:20:16.6137973+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-07-17T09:20:16.6137973+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-07-17T09:20:16.6137973+00:00</UpdatedDateUtc>
  <ApplicationId>90d5337e-62cd-4823-a611-3d278b98b750</ApplicationId>
  <ApplicationVersionId>b4d91faa-6511-41d6-8cef-2fd678be56c3</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>358c9a66-67fb-4cc7-a104-26963be8aea1</DeviceGroupId>
  <DeviceId>99945069-9336-489c-bb0b-cd7b11a18594</DeviceId>
  <MessageAuditCreatedDateUtc>2025-07-17T09:20:16.6137973+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>74a9d736-8dce-46cf-b638-87c2d3e3b72a</MessageAuditId>
  <MessageAuditMessageAuditTypeId>dee4d1ce-73f3-446a-978b-79cdb3846ce7</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-07-17T09:20:16.6137973+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>55b83651-8b13-4b1b-a29e-cc437e24c958</MessageId>
  <MessageTypeId>d3ce4ba2-edf2-4d5f-9163-41ec852209b0</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>d117793d-8a04-49c8-9a2c-02e1aa7599da</TenantId>
  <UserGroupId>d6bf1202-5707-4f5b-8931-d7e48e31c0c1</UserGroupId>
  <UserId>2d1faf3f-4840-4c28-ae81-54d06427ee62</UserId>
</MessageRepresentation>