User Manual

3.6 Get a Printers Ink Consumption

Updated on

Get a Printers Ink Consumption

Compatibility: from Durst Analytics v1.4.0

Get the ink consumption from a printer in a specific time range

POST /api/v1/printers/{id}/inkConsumption

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
{color} required Overall ink consumption (time range) in liter per color (Colorname: Double value)
Example: "Yellow": 25.881807607935944
< string, number (double) > map

2. Responses

HTTP Code Description Schema
200 OK Ink Consumption Map
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}/inkConsumption

Request Body

{
  "startDate": "2020-01-11T12:00:00.000Z",
  "endDate": "2020-09-22T11:59:59.000Z"
}

5. Example HTTP Response

Response 200

{
  "LightMagenta": 11.505533663630032,
  "LightCyan": 10.316530724360216,
  "Black": 16.283655920325767,
  "Yellow": 25.881807607935944,
  "Magenta": 32.8839967710602,
  "Cyan": 26.140266589721424
}
Previous Article 3.5 Get a Printers Error Messages
Next Article 3.7 Get a Printers Jobs
Still Need Help? Contact Us