BasicPrintApi
| Method | HTTP request | Description |
|---|---|---|
| call_print | POST /api/web/v1/printers/{printerId}/print | Perform basic print job. |
| cancel_print | DELETE /api/web/v1/printers/print/{printStatusId} | Cancel an executing print job. |
| get_print_counts | GET /api/web/v1/printcounts | Get counts for different prints. |
| get_print_status | GET /api/web/v1/printers/print/{printStatusId} | Retrieve print job status. |
| update_print | PATCH /api/web/v1/printers/print/{printStatusId} | Updates an executing print job. |
call_print
PrintOperationResponse call_print(printer_id, basic_print_request)
Perform basic print job.
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| printer_id | str | The unique 32-36 character id obtained from the Get All Printers request. Example - 0b0db90a-6091-416f-8559-2f2181e941c3 | |
| basic_print_request | BasicPrintRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Accepted | - |
| 400 | Bad request | - |
| 401 | Authorization information is missing or invalid | - |
| 404 | The specified resource was not found | - |
| 500 | Unexpected error | - |
cancel_print
cancel_print(print_status_id)
Cancel an executing print job.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| print_status_id | str | Print ID |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | No Content | - |
| 400 | Bad request | - |
| 401 | Authorization information is missing or invalid | - |
| 404 | The specified resource was not found | - |
| 500 | Unexpected error | - |
get_print_counts
PrintCountResponse get_print_counts()
Get counts for different prints.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Ok | - |
| 400 | Bad request | - |
| 401 | Authorization information is missing or invalid | - |
| 404 | The specified resource was not found | - |
| 500 | Unexpected error | - |
get_print_status
BasicPrintResponse get_print_status(print_status_id)
Retrieve print job status.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| print_status_id | str | Print ID |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Ok | - |
| 400 | Bad request | - |
| 401 | Authorization information is missing or invalid | - |
| 404 | The specified resource was not found | - |
| 500 | Unexpected error | - |
update_print
PrintOperationResponse update_print(print_status_id, basic_print_update_request)
Updates an executing print job.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| print_status_id | str | Print ID | |
| basic_print_update_request | BasicPrintUpdateRequest |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 202 | Accepted | - |
| 400 | Bad request | - |
| 401 | Authorization information is missing or invalid | - |
| 404 | The specified resource was not found | - |
| 500 | Unexpected error | - |