u
This commit is contained in:
46
docs/api/routes/printerjob.get.md
Normal file
46
docs/api/routes/printerjob.get.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# `GET /printerjob`
|
||||
|
||||
Protected. Requires a valid session cookie (`credentials: 'include'`).
|
||||
|
||||
List printer jobs
|
||||
|
||||
Lists printer jobs for the selected company, optionally filtered by agent printer or state.
|
||||
|
||||
## Query parameters
|
||||
|
||||
| Param | Required | Type | Description |
|
||||
|-------|----------|------|-------------|
|
||||
| `agentprinterId` | no | integer | Optional agent printer ID filter |
|
||||
| `state` | no | string | Optional job state filter |
|
||||
|
||||
## Response `200`
|
||||
|
||||
List of printer jobs
|
||||
|
||||
```json
|
||||
{
|
||||
"printerjobs": [
|
||||
{
|
||||
"id": 1,
|
||||
"agentprinterId": 1,
|
||||
"printeragentId": 1,
|
||||
"type": "zpl",
|
||||
"state": "pending",
|
||||
"data": "…",
|
||||
"createdAt": "2026-08-10T00:00:00.000Z",
|
||||
"completedAt": "2026-08-10T00:00:00.000Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Errors
|
||||
|
||||
| Status | Description |
|
||||
|--------|-------------|
|
||||
| 400 | No company selected — `{"error":"…"}` |
|
||||
| 401 | Unauthorized — `{"error":"…"}` |
|
||||
|
||||
---
|
||||
|
||||
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._
|
||||
Reference in New Issue
Block a user