Print History and Print API Updates

URL Changes

Seagull has changed the URLs of the four existing Printers URLs, as shown in the table below. Though there are four new URLs, the original URLs are still active and available and there should be no disruption with existing API calls.

API Description Command Old URL New URL
Get Printer Records /api/printers /api/devices/printers
Gets information about the specified printer (i.e., Get a printer record) /api/printers/{printerId} /api/devices/printers/{printerId}
Gets active or recently finished print-job records from the specified print queue /api/printers/{printerId}/queue /api/devices/printers/{printerId}/jobs
Gets information about an active or recently finished print job /api/printers/{printerId}/queue/{printJobId} /api/devices/printers/{printerId}/jobs/{jobId}

 

New Endpoints

Seagull added three new APIs to enable users to access print history.

Retrieve printed items

/api/printhistory/items

Gets a collection of job records. The contents of the returned collection depends on the query parameters that server a filter (e.g., "jobId=2022-08-30/1")

Retrieve print-history job record

/api/printhistory/jobs

Gets information about print-job history

Retrieve a print-history job record

/api/printhistory/jobs/{jobId}

Gets information about a job history, identified by its job id.