API Docs
Retrieve Printouts
Contents
This API returns a list of Printouts.
Resource URL
GET /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 |
limit | xs:int | Optional. Default: 10 | Limits the number of results. Optional. Valid values are 0-100. Default value: 10. |
offset | xs:int | Optional. Default: 0 | Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned. |
Body Parameters
None
Output
This method returns a Printouts object. See doc
Possible Error Codes
| Code | Message |
|---|---|
| 401666|40166410 | Invalid parameter. |