1. Home
  2. Knowledge Base
  3. Set Job Thumbnail

Set Job Thumbnail

Add or replaces a thumbnail of an existing job. The thumbnail needs to be a RGB or RGBA PNG.

URL:

POST: http://api.aurelon.com/api/v2/job/thumbnail

Request Headers:

Content-Type : multipart/form-data
MisKey : see Authentication
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication

Request Body:

Form data 1: required

  • Name: JsonString
  • Content-Type: application/Json
  • JSON object containing:
    • JobGUID – required – the Job GUID
    • PageNumber – integer number from 1 to page count the page of the job the thumbnail belongs to.
      Example:

      {"JobGUID":"00092EA6-fb01-11e5-9b85-793ef2c92c66","PageNumber":1}

Form data 2: required

  • Name: Thumbnail.png
  • Content-Type: image/png
  • Binary content of the PNG

Response:

Content type application/json containing the result of the operation.

Success:

200 OK : {“Message”:”Job thumbnail successfully saved”}

Error:

  • 401 Unauthorised : {“Message”:”Invalid HardwareHash”}
  • 401 Unauthorized : {“Message”:”Invalid MisKey”}
  • 404 Not Found : {“Message”:”JobGUID is not found”}
  • 415 Unsupported Media Type : {“Message”:”This request is not properly formatted”}
  • 401 Unauthorized : {“Message”:””MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
  • 400 Bad Request : {“Message”:””DocumentGUID” value required”}
  • 500 Internal Server Error : {“Message”:”Internal Server Error”}
Updated on May 19, 2022

Was this article helpful?