1. Home
  2. Knowledge Base
  3. Documents
Searching...

Documents

Add Document

Adds a document along with its optional metadata and optional thumbnail. The DocumentGUID is returned in the response.
 
URL:
POST http://api.aurelon.com/api/v2/document
 
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:
  • DocumentGUID – optional – the Document GUID, when specified this GUID is used and if it exists a new revision of the same document is added and made current.
    • Name – required – document name
  • Type – required – content type of the document
  • Meta – JSON object containing the metadata about the document
  • Dimensions – Size of the document in units

 
 
Form data 2: optional

    • Name: Original name of the document
    • Content-Type: application/octet-stream
  • Binary content of the document

 
Form data 3: optional

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

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

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

 
Error:

  • 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
  • 401 Unauthorized : {“Message”:”Invalid MisKey”}
  • 415 Unsupported Media Type : {“Message”:”This request is not properly formatted”}
  • 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
  • 500 Internal Server Error : {“Message”:”Internal Server Error”}

 

Get Document List

Get a filtered list of all the documents in the organization
 
URL:
POST http://api.aurelon.com/api/v2/document/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
  • 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

[{
   “DocumentGUID”: “3dfd53fd-2d6b-11e6-853c-793ef2c92c66”,
   “Document”: “Ducky.tif”,
   “Jobs”: [
“29F9ED80-F45D-4A2B-B067-BDD638D1E6FD”,
“29680F35-4C41-4025-8915-3C688DABD456”
   ],
   “Devices”: [
       “03ca4950-0f14-4e58-9bf9-a036c2e1b316”,
       “0cc6bcfe-8ada-4c4a-852a-952d720d3b51”
   ],
   “Media”: [“Roll 10 inch”, “Roll 17 inch”],
   “MediaType”: [“SemiMatte 250g/m2”],
   “Queue”: [ “AD3AFA36-BF8B-4AE7-9553-206A0AD339B8” ],
   “Status”: “InProgress”,
   “Users”: [“wendell.lucas”],
   “Producer”: “Hotfolder”,
   “Progress”: 70
}, {
   “DocumentGUID”: “a7dcef15-7283-4eb1-ac96-94a6d5e859bd”,
   “Document”: “Lemonade.jpg”,
   “Jobs”: [
“65eec7e8-c05b-429c-8b8a-8ce16fc55010”,
      “d43e9158-39c1-46b9-98b3-3418126e5255”
   }],
   “Media”: [“100 inch roll”],
   “MediaType”: [“Paper 250g 09.05.2016”],
   “Queue”: [],
   “Status”: “Completed”,
   “Users”: [“julia.bailey”],
   “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”}
  • 400 Bad Request : {“Message”:””DocumentGUID” value required”}
  • 415 Unsupported Media Type : {“Message”:”Expected type: application/json”}
  • 500 Internal Server Error : {“Message”:”Internal Server Error”}

Set Document Thumbnail

Add or replaces a thumbnail of an existing document. The thumbnail needs to be a RGB or RGBA PNG.
 
URL:
POST: http://api.aurelon.com/api/v2/document/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:
  • DocumentGUID – required – the Document GUID
  • PageNumber – integer number from 1 to page count the page of the document the thumbnail belongs to.

 
Ex:
{“DocumentGUID”:”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”:”Document thumbnail successfully saved”}

 
Error:

  • 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
  • 401 Unauthorized : {“Message”:”Invalid MisKey”}
  • 404 Not Found : {“Message”:”DocumentGUID 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 Document Thumbnail

Get thumbnail of a page of the document
 
URL:
GET http://api.aurelon.com/api/v2/document/<DocumentGUID>/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 : Document Page PNG thumbnail

 
Error:

  • 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
  • 401 Unauthorized : {“Message”:”Invalid MisKey”}
  • 404 Not Found : {“Message”:”DocumentGUID is not found”}
  • 400 Bad Request : {“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”}
Updated on May 19, 2022

Was this article helpful?

Yes No