Queues

`GET /v3/queues`

Get a list of queues

Name

Type

Description

protocol

string

To filter queues by protocol

Available values : air, ipps, lpr, raw

state

string

To filter queues by the state

Available values : online, offline, all

Default value : online

include

string

Available values : client

CODE

Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Grant_type: client_credentials
Scopes: [ queues ]

Response body:
{
  "queues": [
    {
      "id": 0,
      "name": "string",
      "type": "follow",
      "private": true,
      "availableProtocols": [
        "air"
      ],
      "printerId": 0,
      "client": {
        "interaction": {
          "project": true,
          "paymentAccount": true
        }
      }
    }
  ],
  "count": 0,
  "ippsPort": 0,
  "airPrintPort": 0
}

`GET /v3/queues/name:{name}`

Get queue info.

CODE

Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Grant_type: client_credentials
Scopes: [ queues ]

Response body:
{
  "id": 0,
  "name": "string",
  "type": "follow",
  "private": true,
  "availableProtocols": [
    "air"
  ],
  "printerId": 0,
  "client": {
    "interaction": {
      "project": true,
      "paymentAccount": true
    }
  }
}

`GET /v3/queues/{filter}/users`

Get list of the users which has right to use given queue

CODE

Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Grant_type: client_credentials
Scopes: [ queues ]

Response body:
[
  {
    "id": 0,
    "username": "string",
    "fullname": "string"
  }
]

`POST /v3/queues/{id}/printers`

Assign Printer to the queue

CODE

Headers:
Content-Type: application/json
Authentication: Bearer %access_token%

Authentication:
Grant_type: client_credentials
Scopes: [ queues ]

Request body:
{
  "printer": 0
}