59 lines
1.2 KiB
Markdown
59 lines
1.2 KiB
Markdown
# `PUT /printeragent`
|
|
|
|
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
|
|
|
Create printer agent
|
|
|
|
Creates an unpaired printer agent for the selected company.
|
|
The pairingpin is randomly generated server-side and returned in the response.
|
|
|
|
|
|
## Body (JSON)
|
|
|
|
| Field | Required | Type | Description |
|
|
|-------|----------|------|-------------|
|
|
| `name` | yes | string | |
|
|
| `sort` | no | integer | |
|
|
| `enabled` | no | boolean | |
|
|
|
|
```json
|
|
{
|
|
"name": "Bar printer"
|
|
}
|
|
```
|
|
|
|
## Response `200`
|
|
|
|
Created printer agent with generated pairingpin
|
|
|
|
```json
|
|
{
|
|
"printeragent": {
|
|
"id": 1,
|
|
"companyId": 1,
|
|
"name": "…",
|
|
"token": "…",
|
|
"pairingpin": "…",
|
|
"pairedAt": "…",
|
|
"agentversion": "…",
|
|
"lastseenAt": "…",
|
|
"updatedAt": "…",
|
|
"sort": 1,
|
|
"enabled": true
|
|
}
|
|
}
|
|
```
|
|
|
|
## Errors
|
|
|
|
| Status | Description |
|
|
|--------|-------------|
|
|
| 400 | No company selected or invalid input — `{"error":"…"}` |
|
|
| 401 | Unauthorized — `{"error":"…"}` |
|
|
| 403 | Not authorized — `{"error":"…"}` |
|
|
| 404 | Company not found — `{"error":"…"}` |
|
|
|
|
---
|
|
|
|
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|