Job PDF Endpoint

This returns the job details PDF.

GET https://cabinetry.online/api/job/{jobid}/pdf/details

The PDF is generated asynchronously and may not be available immediately after any change to the job including editing items in the job or submitting it. In this case this endpoint will return a 429 status code and should be polled no more than once every minute until it returns a 200 status code.

Parameters

Field Type Default Description
jobid integer ID of the job to download

Response

The response is either:

  1. a PDF document identical to the PDF downloaded through the application
  2. if the PDF is currently being generated, a short text response indicating this with a Retry-After header indicating how long to wait before requesting the PDF again

Response status codes

HTTP status code Meaning
200 Success, data was retrieved successfully
400 Invalid request
403 UnAuthorized Access, Record is not accessible by this user
429 PDF is not available yet, please try again later

Examples

If the PDF is not ready yet:

GET https://cabinetry.online/api/job/1234567/pdf/details

HTTP/1.1 429 Too Many Requests
Retry-After: 60

Your PDF is currently being generated. Please refresh the page shortly to view your document.