Jobs

Jobs Sync

Synchronize list of active jobs in a RIP
 
URL:
POST http://api.aurelon.com/api/v2/job/sync
 
Request Headers:
Content-Type : application/json
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
 
Request Body:
JSON object containing:

  • ComputerGUID – required – the Computer GUID
  • JobsList required – Array of active JobGUIDs at the RIP

 
Response:
Content type application/json containing the result of the operation.
 
Success:

  • 200 OK : “Job status successfully synchronized”

 
Error:

  • 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
  • 404 Not Found : {“Message”:”ComputerGUID is not found”}
  • 415 Unsupported Media Type : {“Message”:”Expected type: application/json”}
  • 401 Unauthorized : {“Message”: “”HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
  • 400 Bad Request : {“Message”:””ComputerGUID” value required”}
  • 400 Bad Request : {“Message”:””JobsList” value required”}
  • 500 Internal Server Error : {“Message”:”Internal Server Error”}

 

Add/Update Job

Adds a job or updates a job as specified by JobGUID in the body. The information regarding the job will be extracted from the Job.xml.
 
URL:
POST: http://api.aurelon.com/api/v2/job
 
Request Headers:
Content-Type : application/xml
MisKey : see Authentication
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
 
Request Body:
Job XML (see Job XML specification)
 
Response:
Content type application/json containing the result of the operation.
 
Success:

  • 200 OK : “Job successfully saved”

 
Error:

  • 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
  • 401 Unauthorized : {“Message”:”Invalid MisKey”}
  • 404 Not Found : {“Message”:”DeviceGUID is not found”}
  • 415 Unsupported Media Type : {“Message”:”Expected type: application/xml”}
  • 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
  • 400 Bad Request : {“Message”:””DeviceGUID” value required in xml”}
  • 500 Internal Server Error : {“Message”:”Internal Server Error”}

 
Example of Job XML: here

Add Job with Document

Adds a job build from a job.xml and 1 document. This call will replace the link the embedded document with the DocumentGUID that is assigned to the document. The DocumentGUID is returned in the response.
 
URL:
POST: http://api.aurelon.com/api/v2/job
 
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: Job.xml
    • Content-Type: application/xml

 

 
Form data 2: required

    • Name: Original name of the document
    • Content-Type: application/pdf or image/<format>
  • Binary content of the document

 
Response:
Content type application/json containing the result of the operation.
 
Success:

  • 200 OK : {“Message”:”Job successfully saved”, “DocumentGUID”:”00000000-0000-0000-0000-000000000000″}

 
Error:

  • 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
  • 401 Unauthorized : {“Message”:”Invalid MisKey”}
  • 404 Not Found : {“Message”:”DeviceGUID 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”:””DeviceGUID” value required in xml”}
  • 500 Internal Server Error : {“Message”:”Internal Server Error”}

 
Example of Job XML: here

Update Job Status

The information regarding the job will be extracted from the Job.xml.
 
URL:
POST: http://api.aurelon.com/api/v2/job/status
 
Request Headers:
Content-Type : application/json
MisKey : see Authentication
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
 
Request Body:
JSON object containing:

  • JobGUID – required – the Job GUID
    • StatusSpooler one of “Waiting”, “Hold”, “Warning”, “Spooling”, “Processing”, “Canceling”, “Ready”, “Deleting”, “NotSupported”
  • Progress – integer number from 0 to 100 indicating the printing progress percentage.
  • ProgressLabel – string with additional progress information

 
Ex:
{“JobGUID”:”00092EA6-fb01-11e5-9b85-793ef2c92c66″,”StatusSpooler”:”Processing”,”Progress”:30}
 
Response:
Content type application/json containing the result of the operation.
 
Success:

  • 200 OK : “Job successfully saved”

 
Error:

  • 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
  • 401 Unauthorized : {“Message”:”Invalid MisKey”}
  • 404 Not Found : {“Message”:”JobGUID is not found”}
  • 415 Unsupported Media Type : {“Message”:”Expected type: application/json”}
  • 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
  • 400 Bad Request : {“Message”:””JobGUID” value required”}
  • 500 Internal Server Error : {“Message”:”Internal Server Error”}

 

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.

 
Ex:
{“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 Unauthorized : {“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”}

Get Job List

Get a filtered list of all the jobs in the organization
 
URL:
POST http://api.aurelon.com/api/v2/job/list
 
Request Headers:
Content-Type : application/json
MisKey : see Authentication
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
 
Request Body:
JSON object containing one or more of the following filters:

  • SerialNumber
  • Job
  • JobGUID
  • DocumentGUID
  • Device
  • DeviceGUID
  • MediaType
  • MediaSize
  • Queue
  • User
  • Producer
  • StatusList – an array with the following statuses (Error, Waiting, InProgress, Completed, Canceled, Deleted, PrintRequest, NotSupported).

Where the following statuses differentiate between active and complete jobs:

  • Active jobs (Error, Waiting, InProgress, Canceled, PrintRequest and NotSupported statuses)
  • Completed job (Completed, Deleted)

 
Ex:
{“SerialNumber”:336484,”StatusList”:[“Waiting”,”Error”],”Producer”:”Editor”}
 
Response:
Return the company jobs filtered by request body filter
 
Success:

  • 200 OK : Return jobs list

[{
           “JobGUID”: “88de5c02-cce6-411f-950f-be309caa4439”,
           “JobName”: “acox3”,
           “Documents”: [{
               “DocumentGUID”: “f6f2e084-d649-4ba7-ade3-f616657b8c8f”,
               “Name”: “acox.jpg”
           }],
           “Device”: “Epson Stylus Pro 4800”,
           “DeviceGUID”: “e9af1259-5da3-46a7-bc00-84839d1f3dd6”,
           “CreatedDate”: “2016-05-18T06:59:36.727”,
           “MediaType”: “ProofMaster Contract Proofing Media SemiGloss 265g”,
           “MediaSize”: “Roll 17 inch”,
           “QueueGUID”: null,
           “QueueName”: null,
           “Status”: “Completed”,
           “User”: “karl.dunn”,
           “Producer”: “Layout”,
           “Progress”: null
       }, {
           “JobGUID”: “cc14e944-1e6b-4274-a9b2-38e5721f8f81”,
           “JobName”: “apocalypse_2-wallpaper-1920×1080”,
           “Documents”: [{
               “DocumentGUID”: “44555edc-4a25-418f-8c04-1b8311c002a3”,
               “Value”: “apocalypse_2-wallpaper-1920×1080.jpg”
           }],
           “Device”: “Epson Stylus Pro 4800”,
           “DeviceGUID”: “ab100a61-9c81-4e1e-aa97-6b07f4046c7a”,
           “CreatedDate”: “2016-05-18T06:57:24.427”,
           “MediaType”: “ProofMaster Contract Proofing Media SemiGloss 265g”,
           “MediaSize”: “Roll 17 inch”,
           “QueueGUID”: null,
           “QueueName”: null,
           “Status”: “Deleted”,
           “User”: “lisa.santiago”,
           “Producer”: “Layout”,
           “Progress”: 0
       }]
 
Error:

  • 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
  • 401 Unauthorized : {“Message”:”Invalid MisKey”}
  • 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
  • 415 Unsupported Media Type : {“Message”:”Expected type: application/json”}
  • 500 Internal Server Error : {“Message”:”Internal Server Error”}

Get Job Status

Get job status information
 
URL:
GET http://api.aurelon.com/api/v2/job/<JobGUID>/status
 
Request Headers:
MisKey : see Authentication
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
 
Response:
Return information for the job specify by JobGUID.
 
Success:

  • 200 OK : Return job info

{
   “Info”: {
       “DeviceGUID”: “9B5A192A-272f-11e6-853c-793ef2c92c66”,
       “DeviceName”: “PDF CMYK A3+”,
       “QueueGUID”: null,
       “QueueName”: null,
       “Job”: “Ducky”,
       “Status”: “Completed”,
       “User”: “a.f.d”,
       “Pages”: 1,
       “Copies”: 1,
       “Size”: “9.0 MB”,
       “Message”: “”,
       “PrintMode”: “16pt_C1S > CMYK_GRACoL_600x600”,
       “PrinterProfile”: “Standard”,
       “DriverSettings”: “X_resolution=DPI=600, \r\nY_resolution=,600 , \r\nInkSet=INK=CMYK “,
       “Preview”: “https://hub-datacollection./jobs/3dfd53fd-2d6b-11e6-853c-793ef2c92c66/00e2b84a-295e-11e6-853c-793ef2c92c66_thumbnail.png”
   },
   “Documents”: [“Ducky.tif”, “Sticker.tif”, “Tutti-Frutti-9.jpg”],
   “Time”: {
       “ProcessingTime”: “00:00:28”,
       “PrintingOrCuttingTime”: “00:00:06”
   },
   “Journal”: [{
       “Date”: “2016-06-03T07:37:46Z”,
       “Duration”: “00:00:06”,
       “Process”: “Spooler”,
       “Message”: null
   }, {
       “Date”: “2016-06-03T07:37:22Z”,
       “Duration”: “00:00:28”,
       “Process”: “RIP”,
       “Message”: null
   }],
   “Inks”: [{
       “Name”: “Cyan”,
       “ConsumedInk”: null,
       “Cost”: null
   }, {
       “Name”: “Magenta”,
       “ConsumedInk”: null,
       “Cost”: null
   }, {
       “Name”: “Yellow”,
       “ConsumedInk”: null,
       “Cost”: null
   }, {
       “Name”: “Black”,
       “ConsumedInk”: null,
       “Cost”: null
   }],
   “Media”: {
       “MediaSize”: “A3+”,
       “MediaType”: “16pt_C1S”,
       “UsedMediaLength”: null,
       “UsedMediaAreaGross”: 1.72,
       “Efficiency”: 9.7,
       “Cost”: null,
       “UsedMediaSheets”: “1 pieces”,
       “JobMediaPriceListName”: null
   },
   “Nest”: null
}
 
Error:

  • 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
  • 401 Unauthorized : {“Message”:”Invalid MisKey”}
  • 404 Not Found : {“Message”:”JobGUID is not found”}
  • 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
  • 500 Internal Server Error : {“Message”:”Internal Server Error”}

Get Job

Get job XML
 
URL:
GET http://api.aurelon.com/api/v2/job/<JobGUID>
 
Request Headers:
MisKey : see Authentication
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
 
Response:
Content type is application/xml and contains the XML of the job. Or content type application/json when with the error content.
 
Success:

  • 200 OK : Job XML

 
Error:

  • 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
  • 401 Unauthorized : {“Message”:”Invalid MisKey”}
  • 404 Not Found : {“Message”:”JobGUID is not found”}
  • 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
  • 500 Internal Server Error : {“Message”:”Internal Server Error”}

Get Job Thumbnail

Get thumbnail of a page of the job
 
URL:
GET http://api.aurelon.com/api/v2/job/<JobGUID>/thumbnail/<PageNumber>
 
Request Headers:
MisKey : see Authentication
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
 
Response:
Content type is image/png and contains the PNG of the page thumbnail. Or content type application/json when with the error content.
 
Success:

  • 200 OK : Job Page PNG thumbnail

 
Error:

  • 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
  • 401 Unauthorized : {“Message”:”Invalid MisKey”}
  • 404 Not Found : {“Message”:”JobGUID is not found”}
  • 404 Not Found : {“Message”:”PageNumber is not found”}
  • 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
  • 500 Internal Server Error : {“Message”:”Internal Server Error”}

 

Get Job Estimate

Get estimate of the job
 
URL:
GET http://api.aurelon.com/api/v2/job/<JobGUID>/estimate
 
Request Headers:
MisKey : see Authentication
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
 
Response:
Content type is application/json and contains the Job estimate data. Or content type application/json when with the error content.
 
Success:

  • 200 OK : Job estimate json

 
Error:

  • 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
  • 401 Unauthorized : {“Message”:”Invalid MisKey”}
  • 404 Not Found : {“Message”:”JobGUID is not found”}
  • 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}

500 Internal Server Error : {“Message”:”Internal Server Error”}

Updated on March 12, 2019

Was this article helpful?