PrintersApi
| Method | HTTP request | Description |
|---|---|---|
| createPrinter | POST /api/web/v1/printers | Creates a printer. |
| deletePrinter | DELETE /api/web/v1/printers/{printerId} | Deletes a printer by ID. |
| deletePrinterWithTenantId | DELETE /api/web/v1/printers/{printerId}/{tenantId} | Deletes a lost printer by printer id and lost tenant ID. |
| getPrinters | GET /api/web/v2/printers | Gets all printers. |
| getPrintersWithGroupRestriction | GET /api/web/v2/printers/restricted | Gets printers with group restriction. |
| printersSummary | GET /api/web/v1/printers/summary | Retrieve count of registered printers |
| readPrinter | GET /api/web/v1/printers/{printerId} | Return a specified printer. |
| readPrinterByDeviceId | GET /api/web/v2/printers/{deviceId} | Return a specified printer using printer device id. |
| readPrinterPreferences | GET /api/web/v1/printers/{printerId}/preferences | Get the preferences for the specified printer. |
| readPrinters | GET /api/web/v1/printers | Gets all printers. |
| replacePrinter | PUT /api/web/v1/printers/{printerId} | Update the specified printer. |
| replacePrinterPreferences | PUT /api/web/v1/printers/{printerId}/preferences | Update the preferences for the specified printer. |
| updatePrinterV2 | PUT /api/web/v2/printers/{printerId} | Update the specified printer. |
createPrinter
ResourceIdResponse createPrinter(printer)
Creates a printer.
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 | - |
deletePrinter
deletePrinter(printerId)
Deletes a printer by ID.
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 |
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 |
|---|---|---|
| 200 | OK | - |
| 400 | Bad request | - |
| 401 | Authorization information is missing or invalid | - |
| 404 | The specified resource was not found | - |
| 500 | Unexpected error | - |
deletePrinterWithTenantId
deletePrinterWithTenantId(printerId, tenantId)
Deletes a lost printer by printer id and lost tenant ID.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| printerId | String | Printer ID | |
| tenantId | String | Printer ID |
Return type
null (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
getPrinters
List<Printer> getPrinters()
Gets all printers.
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 | - |
| 500 | Unexpected error | - |
getPrintersWithGroupRestriction
List<Printer> getPrintersWithGroupRestriction()
Gets printers with group restriction.
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 | - |
printersSummary
PrinterSummaryResponse printersSummary()
Retrieve count of registered printers
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 | Successfully retreived printer summary | - |
| 400 | Bad request | - |
| 401 | Authorization information is missing or invalid | - |
| 500 | Unexpected error | - |
readPrinter
Printer readPrinter(printerId)
Return a specified printer.
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 |
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 | - |
readPrinterByDeviceId
Printer readPrinterByDeviceId(deviceId)
Return a specified printer using printer device id.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| deviceId | String | 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 | - |
readPrinterPreferences
PrinterPreferences readPrinterPreferences(printerId)
Get the preferences for the specified printer.
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 |
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 | - |
readPrinters
List<Printer> readPrinters(fields, withStatus)
Gets all printers.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| fields | String | The model properties to return. This parameter is NOT supported in Instant ID as a Service and will not impact the returned list. | [optional] |
| withStatus | Boolean | Indicates if the current status of each printer is retrieved. Defaults to false if not specified. This parameter is NOT supported in Instant ID as a Service and will not impact the returned list. | [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 | - |
replacePrinter
replacePrinter(printerId, printer)
Update the specified printer.
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 | |
| printer | Printer |
Return type
null (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 | - |
replacePrinterPreferences
replacePrinterPreferences(printerId, printerPreferences)
Update the preferences for the specified printer.
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 | |
| printerPreferences | PrinterPreferences |
Return type
null (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 | - |
updatePrinterV2
Printer updatePrinterV2(printerId, updatePrinterV2Request)
Update the specified printer.
Example
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| printerId | String | The unique 32–36 character id obtained from the Get All Printers request. | |
| updatePrinterV2Request | UpdatePrinterV2Request |
Return type
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 | - |