PrintersApi
Method | HTTP request | Description |
---|---|---|
create_printer | POST /api/web/v1/printers | Creates a printer. |
delete_printer | DELETE /api/web/v1/printers/{printerId} | Deletes a printer by ID. |
delete_printer_with_tenant_id | DELETE /api/web/v1/printers/{printerId}/{tenantId} | Deletes a lost printer by printer id and lost tenant ID. |
get_printers | GET /api/web/v2/printers | Gets all printers. |
printers_summary | GET /api/web/v1/printers/summary | Retrieve count of registered printers |
read_printer | GET /api/web/v1/printers/{printerId} | Return a specified printer. |
read_printer_by_device_id | GET /api/web/v2/printers/{deviceId} | Return a specified printer using printer device id. |
read_printer_preferences | GET /api/web/v1/printers/{printerId}/preferences | Get the preferences for the specified printer. |
read_printers | GET /api/web/v1/printers | Gets all printers. |
replace_printer | PUT /api/web/v1/printers/{printerId} | Update the specified printer. |
replace_printer_preferences | PUT /api/web/v1/printers/{printerId}/preferences | Update the preferences for the specified printer. |
create_printer
ResourceIdResponse create_printer(printer)
Creates a printer.
- Api Key Authentication (AdminAPIAuthentication):
Parameters
Name | Type | Description | Notes |
---|---|---|---|
printer | Printer |
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 | - |
409 | Conflict, printer already exists with the given Name or Device ID. | - |
500 | Unexpected error | - |
delete_printer
delete_printer(printer_id)
Deletes a printer by ID.
Example
- 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 |
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 |
---|---|---|
200 | OK | - |
400 | Bad request | - |
401 | Authorization information is missing or invalid | - |
404 | The specified resource was not found | - |
500 | Unexpected error | - |
delete_printer_with_tenant_id
delete_printer_with_tenant_id(printer_id, tenant_id)
Deletes a lost printer by printer id and lost tenant ID.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
Name | Type | Description | Notes |
---|---|---|---|
printer_id | str | Printer ID | |
tenant_id | str | Printer ID |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
Status code | Description | Response headers |
---|---|---|
200 | OK | - |
get_printers
List[Printer] get_printers()
Gets all printers.
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 | - |
500 | Unexpected error | - |
printers_summary
PrinterSummaryResponse printers_summary()
Retrieve count of registered printers
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 | Successfully retreived printer summary | - |
400 | Bad request | - |
401 | Authorization information is missing or invalid | - |
500 | Unexpected error | - |
read_printer
Printer read_printer(printer_id)
Return a specified printer.
Example
- 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 |
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 | - |
read_printer_by_device_id
Printer read_printer_by_device_id(device_id)
Return a specified printer using printer device id.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
Name | Type | Description | Notes |
---|---|---|---|
device_id | str | The unique 16 character id obtained from the printer LCD. Example - F71523262A998271 |
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 | - |
read_printer_preferences
PrinterPreferences read_printer_preferences(printer_id)
Get the preferences for the specified printer.
Example
- 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 |
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 | - |
read_printers
List[Printer] read_printers(fields=fields, with_status=with_status)
Gets all printers.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
Name | Type | Description | Notes |
---|---|---|---|
fields | str | The model properties to return. | [optional] |
with_status | bool | Indicates if the current status of each printer is retrieved. Defaults to false if not specified. | [optional] |
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 | - |
500 | Unexpected error | - |
replace_printer
replace_printer(printer_id, printer)
Update the specified printer.
Example
- 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 | |
printer | Printer |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- 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 | - |
replace_printer_preferences
replace_printer_preferences(printer_id, printer_preferences)
Update the preferences for the specified printer.
Example
- 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 | |
printer_preferences | PrinterPreferences |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: application/json
- 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 | - |