User Tools

Site Tools


api_printjobstatus
printos.io/status

The API allows you to retrieve the status of up to 20 print jobs matching specified criteria.

Protocol: HTTP (Port 80) or HTTPS (SSL, Port 443). 
Method: POST. 
Content-Type: application/x-www-form-urlencoded

Parameters:

Name Type Description
username String The same username you use to submit a print job
password String The same password you use to submit a print job
destination String Return print jobs of specified destination.
(Optional) startpos Integer Ignore the first startpos number of records. This is useful when you want to retrieve more than 20 print jobs.
startid Integer Specifying the ID criteria. Set the start of the ID range
endid Integer Specifying the ID criteria. Set the end of the ID range
starttime YYYY-MM-DD HH:mm:ss Specifying the time criteria. Set the starting time
endtime YYYY-MM-DD HH:mm:ss Specifying the time criteria. Set the ending time
zone Integer Specifying the time criteria. Set the time zone. For example, Australia/Canberra is 10

Note: You must at least specify one set of criteria. (Either startid/endid, or starttime/endtime/zone. Currently, we do not support more than 1 set of criteria)

Response:

A JSON object with 2 elements (null element does not present in the response):

Name Type Description
pass Boolean Indicating if the job is submitted successfully
error String The error message if submission failed. Otherwise null.
status JSON Array An array of objects if submission succeeded, otherwise null. Each object has three properties:
Name Type Description
id Integer The id of the print job
received 0 or 1 Indicating if the printer has received this job (1 for received, 0 for not received)
active 0 or 1 Showing if the job is active.
error Integer 0: No error. 1: JSON Format Error 2: Tag error 3: Printer Error 1337: Other error
printed 0 or 1 Showing if the job is printed.
status String The status of the job. “Completed” indicates success. See Debugging for more information.
api_printjobstatus.txt · Last modified: 2017/07/14 11:01 (external edit)