User Manual

3.5 Get a Printers Error Messages

Updated on

Find Printer by ID

Compatibility: from Durst Analytics v1.4.0

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 string
Body
operator required
Operator which was logged in, when the error occured integer (int32)

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": "2020-09-21T12:38:04Z",
    "errorNr": 10023,
    "errorMessage": "Head media distance is not adjustable",
    "operator": "Operator A"
  },
  {
    "dateTime": "2020-09-21T13:46:03Z",
    "errorNr": 10023,
    "errorMessage": "Head media distance is not adjustable",
    "operator": "Operator B"
  },
  {
    "dateTime": "2020-09-22T09:36:18Z",
    "errorNr": 20431,
    "errorMessage": "Failed to switch UV lamp on or off",
    "operator": "Operator A"
  },
  {
    "dateTime": "2020-09-22T14:44:53Z",
    "errorNr": 20141,
    "errorMessage": "Failed to switch headvoltage power on or off",
    "operator": "Operator A"
  }
]
Previous Article 3.4 Find Printer by ID
Next Article 3.6 Get a Printers Ink Consumption
Still Need Help? Contact Us