BasicPrintApi
| Method | HTTP request | Description |
|---|---|---|
| cancelPrint | DELETE /api/web/v1/printers/print/{printStatusId} | Cancel an executing print job. |
| getPrintCounts | GET /api/web/v1/printcounts | Get counts for different prints. |
| getPrintStatus | GET /api/web/v1/printers/print/{printStatusId} | Retrieve print job status. |
| POST /api/web/v1/printers/{printerId}/print | Perform basic print job. | |
| updatePrint | PATCH /api/web/v1/printers/print/{printStatusId} | Updates an executing print job. |
cancelPrint
cancelPrint(printStatusId)
Cancel an executing print job.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| printStatusId | String | Print ID |
Return type
null (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 | - |
getPrintCounts
PrintCountResponse getPrintCounts()
Get counts for different prints.
Example
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 | - |
getPrintStatus
BasicPrintResponse getPrintStatus(printStatusId)
Retrieve print job status.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| printStatusId | String | 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 | - |
print
PrintOperationResponse print(printerId, basicPrintRequest)
Perform basic print job.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| printerId | String | The unique 32-36 character id obtained from the Get All Printers request. Example - 0b0db90a-6091-416f-8559-2f2181e941c3 | |
| basicPrintRequest | 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 | - |
updatePrint
PrintOperationResponse updatePrint(printStatusId, basicPrintUpdateRequest)
Updates an executing print job.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| printStatusId | String | Print ID | |
| basicPrintUpdateRequest | 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 | - |