Compatibility: from Durst Analytics v1.4.0
Version 2.17.14 Changes
- errorNr [integer (32)]:Some machines now provide an error string instead of an integer. To remain compatible with older systems, the string is internally hashed into an integer.
- errorCode [string]:New field that contains the original error string directly (no mapping required).
- operator [string]:Field removed.
Get the error list of a specific printer in a specific time range
POST /api/v1/printers/{id}/errors
1. Parameters
1.1. Request
| Type | Name | Description | Schema |
|---|---|---|---|
| Header | x-auth-token required | The Token to be used in the HTTP Header as x-auth-token for all Requests | string |
| Query | id required | The ID of the Printer | integer |
| Body | startDate required | Start date as ISO 8601 date string Example: "2020-09-21T12:00:00.000Z" |
string (date-time) |
| Body | endDate required | End date as ISO 8601 date string Example: "2020-09-25T18:00:00.000Z" |
string (date-time) |
1.2. Response
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | dateTime required | Datetime as ISO 8601 date string when the error occurred Example: "2020-09-22T09:36:18Z" | string (date-time) |
| Body | errorMessage required | Printer internal error message | string |
| Body | errorNr required | Printer internal error number | integer (int32) |
| Body | errorCode required | Original error string directly (no mapping required) | string |
| Body | operator (removed with 2.17.14) | Operator which was logged in, when the error occured (will not be populated in the future) | string |
2. Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | OK | Error |
| 401 | Unauthorized | No Content |
| 403 | Forbidden | No Content |
| 404 | Not Found | No Content |
3. Produces
*/*
4. Example HTTP Request
Request path
/api/v1/printers/{id}/errors
Request Body
{
"startDate": "2020-09-21T12:00:00.000Z",
"endDate": "2020-09-22T18:00:00.000Z"
}
5. Example HTTP Response
Response 200
[
{
"dateTime": "2023-08-31T00:06:14Z",
"errorNr": 1006289511,
"errorCode": "FW|MIB|237|",
"errorMessage": "Media Input Board | Ionizer fault | Ionizer at right position in error state."
}
]