GET queue?maxCount={maxCount}
Get a queue of documents to print
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
maxCount |
The maximum number of items this call will produce |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Returns a list of documents to print
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Id": 0, "FileName": "Filename.pdf", "Status": 2, "FreeTextStatus": "Printing page 1/4", "Pages": [ { "TrayIdentifier": "uniquetraykey1", "PrinterIdentifier": "uniqueprinterkey", "PageNumber": 1 }, { "TrayIdentifier": "uniquetraykey2", "PrinterIdentifier": "uniqueprinterkey", "PageNumber": 2 } ] }, { "Id": 0, "FileName": "Filename2.pdf", "Status": 2, "FreeTextStatus": "Printing page 2/4", "Pages": [ { "TrayIdentifier": "uniquetraykey2", "PrinterIdentifier": "uniqueprinterkey2", "PageNumber": 1 }, { "TrayIdentifier": "uniquetraykey3", "PrinterIdentifier": "uniqueprinterkey2", "PageNumber": 2 } ] } ]
application/xml, text/xml
Sample:
<ArrayOfQueuedDocumentModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <QueuedDocumentModel> <Id>0</Id> <FileName>Filename.pdf</FileName> <Status>BeingPrinted</Status> <FreeTextStatus>Printing page 1/4</FreeTextStatus> <Pages> <QueuedPageModel> <TrayIdentifier>uniquetraykey1</TrayIdentifier> <PrinterIdentifier>uniqueprinterkey</PrinterIdentifier> <PageNumber>1</PageNumber> </QueuedPageModel> <QueuedPageModel> <TrayIdentifier>uniquetraykey2</TrayIdentifier> <PrinterIdentifier>uniqueprinterkey</PrinterIdentifier> <PageNumber>2</PageNumber> </QueuedPageModel> </Pages> </QueuedDocumentModel> <QueuedDocumentModel> <Id>0</Id> <FileName>Filename2.pdf</FileName> <Status>BeingPrinted</Status> <FreeTextStatus>Printing page 2/4</FreeTextStatus> <Pages> <QueuedPageModel> <TrayIdentifier>uniquetraykey2</TrayIdentifier> <PrinterIdentifier>uniqueprinterkey2</PrinterIdentifier> <PageNumber>1</PageNumber> </QueuedPageModel> <QueuedPageModel> <TrayIdentifier>uniquetraykey3</TrayIdentifier> <PrinterIdentifier>uniqueprinterkey2</PrinterIdentifier> <PageNumber>2</PageNumber> </QueuedPageModel> </Pages> </QueuedDocumentModel> </ArrayOfQueuedDocumentModel>