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)

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:

  • 400 Bad Request : {“Message”: “”DocumentGUID” value required”}
  • 401 Unauthorised : {“Message”: “Invalid MisKey”}
  • 401 Unauthorised : {“Message”: “Invalid HardwareHash”}
  • 401 Unauthorised : {“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”}