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": "3c06ce2e-7667-47e0-a375-6629ffb0f29f",
  "tenantId": "1c9b0dbd-5014-401e-8343-92aa18ce978c",
  "messageTypeId": "442cf747-c741-4cb2-80ee-646f35b6bd96",
  "messageTypeLookupKey": "sample string 4",
  "userId": "1a89911c-ca2a-4d50-8c37-9b688224f7ba",
  "userGroupId": "1b640d6c-62f8-4bb5-9a0d-e5641b2ac64a",
  "deviceId": "f653fac8-9744-497e-bd2d-0ca9b5ccde7c",
  "deviceGroupId": "9d7faa6c-f549-4739-a5c6-975183e85614",
  "applicationId": "ddfd3737-7f08-4844-b891-692ad95cb50c",
  "applicationVersionId": "079f82f8-c943-47d1-901c-b99dfeb9826c",
  "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": "daf73402-7011-496a-b224-4ecc9601be64",
  "messageAuditMessageAuditTypeId": "abaf1a18-7541-4022-afcd-d6fa1ee0f3e5",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-03-05T03:00:01.6635498+00:00",
  "messageAuditUpdatedDateUtc": "2026-03-05T03:00:01.6635498+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-03-05T03:00:01.6635498+00:00",
  "updatedDateUtc": "2026-03-05T03:00:01.6635498+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-03-05T03:00:01.6635498+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-03-05T03:00:01.6635498+00:00</UpdatedDateUtc>
  <ApplicationId>ddfd3737-7f08-4844-b891-692ad95cb50c</ApplicationId>
  <ApplicationVersionId>079f82f8-c943-47d1-901c-b99dfeb9826c</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>9d7faa6c-f549-4739-a5c6-975183e85614</DeviceGroupId>
  <DeviceId>f653fac8-9744-497e-bd2d-0ca9b5ccde7c</DeviceId>
  <MessageAuditCreatedDateUtc>2026-03-05T03:00:01.6635498+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>daf73402-7011-496a-b224-4ecc9601be64</MessageAuditId>
  <MessageAuditMessageAuditTypeId>abaf1a18-7541-4022-afcd-d6fa1ee0f3e5</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-03-05T03:00:01.6635498+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>3c06ce2e-7667-47e0-a375-6629ffb0f29f</MessageId>
  <MessageTypeId>442cf747-c741-4cb2-80ee-646f35b6bd96</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>1c9b0dbd-5014-401e-8343-92aa18ce978c</TenantId>
  <UserGroupId>1b640d6c-62f8-4bb5-9a0d-e5641b2ac64a</UserGroupId>
  <UserId>1a89911c-ca2a-4d50-8c37-9b688224f7ba</UserId>
</MessageRepresentation>