API Docs

__METHOD= POST . __PATH= /almaws/v1/task-lists/printouts .

Act on Printouts

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

ParameterTypeRequiredDescription
letterxs:stringOptional. Default: ALLPrintout Name. Optional.
statusxs:stringOptional. Default: ALLPrintout status. Optional. Valid values are: Printed, Pending, Canceled.
printer_idxs:stringOptional. Default: ALLPrintout Printer
printed_byxs:stringOptional. Default: ALLPrinted by: ALL/ME. This field is relevant when using the API from within Cloud Apps.
printout_idxs:stringOptional. Default: ALLA 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
opxs:stringRequiredThe 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

CodeMessage
401666|40166410Invalid parameter.