User Manual

3.3 List available Printers

Updated on

List available Printers

Compatibility: from Durst Analytics v1.4.0

Get a list of all available printers in the system.

GET /api/v1/printers

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

1.2. Response

Type
Name
Description
Schema
Body
id required
Internal ID from printer, to be used with queries
integer (int64)
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 Printers
401 Unauthorized No Content
403 Forbidden No Content
404 Not Found No Content

3. Produces

*/*

4. Example HTTP Request

Request path

/api/v1/printers

5. Example HTTP Response

Response 200

[
  {
    "id": 1,
    "serialNumber": "1234567",
    "name": "TAU 330 RSC",
    "status": "Running"
  },
  {
    "id": 2,
    "serialNumber": "1234568",
    "name": "Delta WT 250",
    "status": "Idle"
  },
  {
    "id": 3,
    "serialNumber": "1234569",
    "name": "P5 250 HS",
    "status": "Setup"
  }
]
Previous Article 3.2 Login
Next Article 3.4 Find Printer by ID
Still Need Help? Contact Us