Update the status of the device to reflect the current state. The status is transient so it overwrites the last recorded status.
URL:
POST http://api.aurelon.com/api/v2/device/status
Request Headers:
Content-Type : application/json
MisKey : see Authentication
HardwareHash : see Authentication
SerialNumber : see Authentication
ApplicationVersion : see Authentication
Request Body:
JSON object containing:
- DeviceGUID – required string – the Device GUID
- Status – required string – one of “Error”, “Idle”, “Offline”, “Printing”, “Aborting”, “Sleeping”, “Calibrating”
- Message – string – Free form human readable status message
- Temperature – number – heater temperature in celsius
- ConnectionState – string – status from the PING messages, one of “Online”, “Offline”, “Unstable”
- ConnectionMessage – string – Free form human readable connection status message
- RemainingInks – array of objects – Objects containing for each ink:
- InkIndex – required number – sequence index of the ink
- InkName – required string – Name of the ink color
- Level – required number – Current amount of ml of the tank, <0 indicates unknown
- MaxLevel – required number – Max amount of ml of the tank
- QueueLength – required object – Containing one of the following:
- Length – number – Length of jobs in units for a roll to roll device
- Area – number – Area of the jobs in units-sq for a rigid device
- Sheets – number – Amount of sheets for a sheet-fed device
Example:
{ "DeviceGUID": "af4da7ba-23be-11e5-850d-f3773dfc73c9", "Status": "Sleeping", "Message": "", "ConnectionState": "Unstable", "ConnectionState": "The connection with the printer is not stable.", "Temperature": 30, "RemainingInks": [ { "InkName": "Magenta", "Level": 606, "MaxLevel": 775 }, { "InkName": "Light magenta", "Level": 624, "MaxLevel": 775 }, { "InkName": "Light cyan", "Level": 661, "MaxLevel": 775 }, { "InkName": "Cyan", "Level": 565, "MaxLevel": 775 }, { "InkName": "Latex Optimizer", "Level": 668, "MaxLevel": 775 }, { "InkName": "Yellow", "Level": 575, "MaxLevel": 775 }, { "InkName": "Black", "Level": 589, "MaxLevel": 775 }, { "InkName": "CleanKit", "Level": 75, "MaxLevel": 100 } ] }
Response:
Content type application/json containing the result of the operation.
Success:
200 OK : “Device status successfully updated”
Error:
- 401 Unauthorized : {“Message”:”Invalid HardwareHash”}
- 401 Unauthorized : {“Message”: “Invalid MisKey”}
- 404 Not Found : {“Message”: “DeviceGUID is not found”}
- 401 Unauthorized : {“Message”: “”MisKey” or “HardwareHash”, “SerialNumber” and “ApplicationVersion” header are required”}
- 400 Bad Request : {“Message”: “DeviceGUID” value required”}
- 500 Internal Server Error : {“Message”:”Internal Server Error”}