v1

latestOpenAPI 3.0.12026-07-1410045.5 KB

Printouts

Retrieve Printouts

This API returns a list of Printouts.

get/almaws/v1/task-lists/printouts

Query parameters

letterstring

Printout Name. Optional.

statusstring

Printout status. Optional. Valid values are: Printed, Pending, Canceled.

printer_idstring

Printout Printer

printout_idstring

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

limitinteger

Limits the number of results. Optional. Valid values are 0-100. Default value: 10.

offsetinteger

Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned.

Response

OK - This method returns an object based on rest_printouts.xsd. See here

total_record_countinteger

The total number of printouts.

Example response

{
  "printout": [
    {
      "date": "2019-11-07T08:08:38.614Z",
      "id": "129313760000121",
      "letter": "<div> Welcome to...</div>",
      "printer": {
        "desc": "printer name",
        "value": "Printout Queue."
      },
      "printout": "Testing",
      "size": "3.6kb",
      "source": "Implementor, Ex Libris",
      "status": {
        "desc": "Pending",
        "value": "Pending"
      }
    }
  ]
}