API Docs
Act on Printouts
Contents
This API performs an action on printouts: mark as printed or canceled. 10,000 records can be handled in one requests. Only printouts which were updated will be returned.
Resource URL
POST /almaws/v1/task-lists/printouts
API Description
URL Parameters
None
Querystring Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
letter | xs:string | Optional. Default: ALL | Printout Name. Optional. |
status | xs:string | Optional. Default: ALL | Printout status. Optional. Valid values are: Printed, Pending, Canceled. |
printer_id | xs:string | Optional. Default: ALL | Printout Printer |
printed_by | xs:string | Optional. Default: ALL | Printed by: ALL/ME. This field is relevant when using the API from within Cloud Apps. |
printout_id | xs:string | Optional. Default: ALL | A list of Printout IDs (for example: 123,456,778) from 1 to the limit of 100 Optional. Use of this option overrides all of the filtering parameters |
op | xs:string | Required | The operation to perform on the printout. Currently, the options are: 'mark_as_printed','mark_as_canceled' |
Body Parameters
None
Output
This method returns a Printouts object. See doc
Possible Error Codes
| Code | Message |
|---|---|
| 401666|40166410 | Invalid parameter. |