PUT queue/{id}/status
Updates the status of a queued document
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The ID of the queued document |
integer |
Required |
Body Parameters
the model containing update params
QueuedDocumentUpdateModelName | Description | Type | Additional information |
---|---|---|---|
Status | QueuedDocumentStatus |
None. |
|
FreeTextStatus | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Status": 0, "FreeTextStatus": "sample string 1" }
application/xml, text/xml
Sample:
<QueuedDocumentUpdateModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Status>ToPrint</Status> <FreeTextStatus>sample string 1</FreeTextStatus> </QueuedDocumentUpdateModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
the updated queued document
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 } ] }
application/xml, text/xml
Sample:
<QueuedDocumentModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <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>