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": "08558988-01f6-48eb-8292-69d6e6b9328e",
  "tenantId": "8995034d-41e5-4c66-b59c-5160c3a76ebf",
  "messageTypeId": "505094ff-dfea-412d-8878-22ce7c578da8",
  "messageTypeLookupKey": "sample string 4",
  "userId": "1ed4d5fb-0bd5-4cf3-bdba-2a40e2de7fae",
  "userGroupId": "fbd9e38b-9ebf-4d51-bf98-e5405fd6dd7d",
  "deviceId": "aa92d27d-a00d-45a1-87eb-0008589cf263",
  "deviceGroupId": "9b736152-37d1-4ee2-85ba-378a60409fff",
  "applicationId": "72d9ebda-1ec8-40d7-8ee4-e059af2fbb98",
  "applicationVersionId": "7ce6a47a-1790-4982-b014-dfd7245900e5",
  "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": "578fabd3-cbf1-4503-9e45-91b532a87eba",
  "messageAuditMessageAuditTypeId": "a3bb010a-caae-49d0-b50d-b86ea5866455",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-04-21T01:52:51.803598+00:00",
  "messageAuditUpdatedDateUtc": "2025-04-21T01:52:51.803598+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-04-21T01:52:51.803598+00:00",
  "updatedDateUtc": "2025-04-21T01:52:51.803598+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-04-21T01:52:51.803598+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-04-21T01:52:51.803598+00:00</UpdatedDateUtc>
  <ApplicationId>72d9ebda-1ec8-40d7-8ee4-e059af2fbb98</ApplicationId>
  <ApplicationVersionId>7ce6a47a-1790-4982-b014-dfd7245900e5</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>9b736152-37d1-4ee2-85ba-378a60409fff</DeviceGroupId>
  <DeviceId>aa92d27d-a00d-45a1-87eb-0008589cf263</DeviceId>
  <MessageAuditCreatedDateUtc>2025-04-21T01:52:51.803598+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>578fabd3-cbf1-4503-9e45-91b532a87eba</MessageAuditId>
  <MessageAuditMessageAuditTypeId>a3bb010a-caae-49d0-b50d-b86ea5866455</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-04-21T01:52:51.803598+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>08558988-01f6-48eb-8292-69d6e6b9328e</MessageId>
  <MessageTypeId>505094ff-dfea-412d-8878-22ce7c578da8</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>8995034d-41e5-4c66-b59c-5160c3a76ebf</TenantId>
  <UserGroupId>fbd9e38b-9ebf-4d51-bf98-e5405fd6dd7d</UserGroupId>
  <UserId>1ed4d5fb-0bd5-4cf3-bdba-2a40e2de7fae</UserId>
</MessageRepresentation>