User Manual

3.4 Find Printer by ID

Updated on

Find Printer by ID

Compatibility: from Durst Analytics v1.4.0

Find a specific printer by its ID

GET /api/v1/printers/{id}

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

1.2. Response

Type
Name
Description
Schema
Body
id required
Internal ID from printer, to be used with queries
integer (int64)
Body
inkLevelPercent required Current Ink Level of the printer in percent as JSON map (Colorname: Double value)
< string, number (double) > map
Body
name required
Name of the printer
string
Body
serialNumber required
Serial number of the printer
string
Body
status required
Current status of the printer
enum (Running, Idle, Setup, Breakdown)

2. Responses

HTTP Code Description Schema
200 OK Printer
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}

5. Example HTTP Response

Response 200

{
  "id": 1,
  "serialNumber": "1234567",
  "name": "TAU 330 RSC",
  "status": "Running",
  "inkLevelPercent": {
    "LightCyan": 40,
    "Cyan": 40,
    "Yellow": 40,
    "Magenta": 80,
    "Black": 80,
    "LightMagenta": 60
  }
}
Previous Article 3.3 List available Printers
Next Article 3.5 Get a Printers Error Messages
Still Need Help? Contact Us