GET api/email-communication-queue?maxAttempts={maxAttempts}&start={start}&limit={limit}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| maxAttempts | integer |
Default value is -1 |
|
| start | integer |
Default value is 0 |
|
| limit | integer |
Default value is 25 |
Body Parameters
None.
Response Information
Resource Description
EmailCommunicationQueueModel| Name | Description | Type | Additional information |
|---|---|---|---|
| EmailCommunicationQueueId | globally unique identifier |
None. |
|
| KrocCenterId | globally unique identifier |
None. |
|
| CommunicationTypeId | globally unique identifier |
None. |
|
| CustomerId | globally unique identifier |
None. |
|
| Priority | integer |
None. |
|
| SendFrom | string |
None. |
|
| SendTo | string |
None. |
|
| Message | string |
None. |
|
| Attachments | AttachmentDescriptor |
None. |
|
| QueueDateTime | date |
None. |
|
| Attempts | integer |
None. |
|
| KrocCenterName | string |
None. |
|
| CommunicationTypeName | string |
None. |
|
| CustomerLastName | string |
None. |
|
| CustomerFirstName | string |
None. |
|
| CustomerBarcode | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"EmailCommunicationQueueId": "daf53fca-8629-483f-9092-3f188e86176a",
"KrocCenterId": "9a850aea-3760-4f8b-9c15-161cb6ce9964",
"CommunicationTypeId": "9f2de649-8115-494e-8fb8-265047910f2a",
"CustomerId": "5a0276dd-313d-40fe-94c3-fa1a9dca071f",
"Priority": 4,
"SendFrom": "sample string 5",
"SendTo": "sample string 6",
"Message": "sample string 7",
"Attachments": {
"Attachment": null
},
"QueueDateTime": "2025-01-21T22:58:24.2842665-08:00",
"Attempts": 9,
"KrocCenterName": "sample string 10",
"CommunicationTypeName": "sample string 11",
"CustomerLastName": "sample string 12",
"CustomerFirstName": "sample string 13",
"CustomerBarcode": "sample string 14"
}
application/xml, text/xml
Sample:
<EmailCommunicationQueueModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CCMS.Models.DTO">
<Attachments xmlns:d2p1="http://schemas.datacontract.org/2004/07/CCMS.Models">
<d2p1:Attachment i:nil="true" />
</Attachments>
<Attempts>9</Attempts>
<CommunicationTypeId>9f2de649-8115-494e-8fb8-265047910f2a</CommunicationTypeId>
<CommunicationTypeName>sample string 11</CommunicationTypeName>
<CustomerBarcode>sample string 14</CustomerBarcode>
<CustomerFirstName>sample string 13</CustomerFirstName>
<CustomerId>5a0276dd-313d-40fe-94c3-fa1a9dca071f</CustomerId>
<CustomerLastName>sample string 12</CustomerLastName>
<EmailCommunicationQueueId>daf53fca-8629-483f-9092-3f188e86176a</EmailCommunicationQueueId>
<KrocCenterId>9a850aea-3760-4f8b-9c15-161cb6ce9964</KrocCenterId>
<KrocCenterName>sample string 10</KrocCenterName>
<Message>sample string 7</Message>
<Priority>4</Priority>
<QueueDateTime>2025-01-21T22:58:24.2842665-08:00</QueueDateTime>
<SendFrom>sample string 5</SendFrom>
<SendTo>sample string 6</SendTo>
</EmailCommunicationQueueModel>