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": "9ceafc54-d91e-493f-b504-21a8b8f4292c",
  "tenantId": "0975398d-850e-4690-aba7-310aca9daa2c",
  "messageTypeId": "86d2187e-ce3b-46f1-a213-846543c8f7e7",
  "messageTypeLookupKey": "sample string 4",
  "userId": "bdf41a4c-bc9e-498c-bc87-73296777c157",
  "userGroupId": "4ae03036-ce48-41be-8120-975e1a73a61e",
  "deviceId": "a30e0563-fe54-40ae-a065-ba472542f7c9",
  "deviceGroupId": "3bb7fe92-b82c-4a91-9a6e-1cb5b51ac5ad",
  "applicationId": "0893b787-bf69-4030-b8a9-fe2f09ae68ff",
  "applicationVersionId": "1aefbd93-27c7-4b5e-8c5f-4521157104ec",
  "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": "62803fa1-8e8f-44d4-a06d-005f5b513da2",
  "messageAuditMessageAuditTypeId": "e0fd44f2-0b7d-41cf-b59d-5bf39596a91d",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2024-08-30T00:17:29.2225193+00:00",
  "messageAuditUpdatedDateUtc": "2024-08-30T00:17:29.2225193+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2024-08-30T00:17:29.2225193+00:00",
  "updatedDateUtc": "2024-08-30T00:17:29.2225193+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>2024-08-30T00:17:29.2225193+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2024-08-30T00:17:29.2225193+00:00</UpdatedDateUtc>
  <ApplicationId>0893b787-bf69-4030-b8a9-fe2f09ae68ff</ApplicationId>
  <ApplicationVersionId>1aefbd93-27c7-4b5e-8c5f-4521157104ec</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>3bb7fe92-b82c-4a91-9a6e-1cb5b51ac5ad</DeviceGroupId>
  <DeviceId>a30e0563-fe54-40ae-a065-ba472542f7c9</DeviceId>
  <MessageAuditCreatedDateUtc>2024-08-30T00:17:29.2225193+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>62803fa1-8e8f-44d4-a06d-005f5b513da2</MessageAuditId>
  <MessageAuditMessageAuditTypeId>e0fd44f2-0b7d-41cf-b59d-5bf39596a91d</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2024-08-30T00:17:29.2225193+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>9ceafc54-d91e-493f-b504-21a8b8f4292c</MessageId>
  <MessageTypeId>86d2187e-ce3b-46f1-a213-846543c8f7e7</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>0975398d-850e-4690-aba7-310aca9daa2c</TenantId>
  <UserGroupId>4ae03036-ce48-41be-8120-975e1a73a61e</UserGroupId>
  <UserId>bdf41a4c-bc9e-498c-bc87-73296777c157</UserId>
</MessageRepresentation>