Skip to main content

PrintersApi

MethodHTTP requestDescription
CreatePrinterPOST /api/web/v1/printersCreates a printer.
DeletePrinterDELETE /api/web/v1/printers/{printerId}Deletes a printer by ID.
DeletePrinterWithTenantIdDELETE /api/web/v1/printers/{printerId}/{tenantId}Deletes a lost printer by printer id and lost tenant ID.
GetPrintersGET /api/web/v2/printersGets all printers.
PrintersSummaryGET /api/web/v1/printers/summaryRetrieve count of registered printers
ReadPrinterGET /api/web/v1/printers/{printerId}Return a specified printer.
ReadPrinterByDeviceIdGET /api/web/v2/printers/{deviceId}Return a specified printer using printer device id.
ReadPrinterPreferencesGET /api/web/v1/printers/{printerId}/preferencesGet the preferences for the specified printer.
ReadPrintersGET /api/web/v1/printersGets all printers.
ReplacePrinterPUT /api/web/v1/printers/{printerId}Update the specified printer.
ReplacePrinterPreferencesPUT /api/web/v1/printers/{printerId}/preferencesUpdate the preferences for the specified printer.

CreatePrinter​

ResourceIdResponse CreatePrinter (Printer printer)

Creates a printer.

Using the CreatePrinterWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
printerPrinter

Return type​

ResourceIdResponse

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
202Accepted-
400Bad request-
401Authorization information is missing or invalid-
409Conflict, printer already exists with the given Name or Device ID.-
500Unexpected error-

DeletePrinter​

void DeletePrinter (string printerId)

Deletes a printer by ID.

Example​

Using the DeletePrinterWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
printerIdstringThe 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​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected error-

DeletePrinterWithTenantId​

void DeletePrinterWithTenantId (string printerId, string tenantId)

Deletes a lost printer by printer id and lost tenant ID.

Example​

Using the DeletePrinterWithTenantIdWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
printerIdstringPrinter ID
tenantIdstringPrinter ID

Return type​

void (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details​

Status codeDescriptionResponse headers
200OK-

GetPrinters​

List<Printer> GetPrinters ()

Gets all printers.

Example​

Using the GetPrintersWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

This endpoint does not need any parameter.

Return type​

List<Printer>

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
500Unexpected error-

PrintersSummary​

PrinterSummaryResponse PrintersSummary ()

Retrieve count of registered printers

Example​

Using the PrintersSummaryWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

This endpoint does not need any parameter.

Return type​

PrinterSummaryResponse

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200Successfully retreived printer summary-
400Bad request-
401Authorization information is missing or invalid-
500Unexpected error-

ReadPrinter​

Printer ReadPrinter (string printerId)

Return a specified printer.

Example​

Using the ReadPrinterWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
printerIdstringThe unique 32-36 character id obtained from the Get All Printers request. Example - 0b0db90a-6091-416f-8559-2f2181e941c3

Return type​

Printer

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected error-

ReadPrinterByDeviceId​

Printer ReadPrinterByDeviceId (string deviceId)

Return a specified printer using printer device id.

Example​

Using the ReadPrinterByDeviceIdWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
deviceIdstringThe unique 16 character id obtained from the printer LCD. Example - F71523262A998271

Return type​

Printer

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected error-

ReadPrinterPreferences​

PrinterPreferences ReadPrinterPreferences (string printerId)

Get the preferences for the specified printer.

Example​

Using the ReadPrinterPreferencesWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
printerIdstringThe unique 32-36 character id obtained from the Get All Printers request. Example - 0b0db90a-6091-416f-8559-2f2181e941c3

Return type​

PrinterPreferences

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected error-

ReadPrinters​

List<Printer> ReadPrinters (string fields = null, bool? withStatus = null)

Gets all printers.

Example​

Using the ReadPrintersWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
fieldsstringThe model properties to return.[optional]
withStatusbool?Indicates if the current status of each printer is retrieved. Defaults to false if not specified.[optional]

Return type​

List<Printer>

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
500Unexpected error-

ReplacePrinter​

void ReplacePrinter (string printerId, Printer printer)

Update the specified printer.

Example​

Using the ReplacePrinterWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
printerIdstringThe unique 32-36 character id obtained from the Get All Printers request. Example - 0b0db90a-6091-416f-8559-2f2181e941c3
printerPrinter

Return type​

void (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected error-

ReplacePrinterPreferences​

void ReplacePrinterPreferences (string printerId, PrinterPreferences printerPreferences)

Update the preferences for the specified printer.

Example​

Using the ReplacePrinterPreferencesWithHttpInfo variant​

This returns an ApiResponse object which contains the response data, status code and headers.

Parameters​

NameTypeDescriptionNotes
printerIdstringThe unique 32-36 character id obtained from the Get All Printers request. Example - 0b0db90a-6091-416f-8559-2f2181e941c3
printerPreferencesPrinterPreferences

Return type​

void (empty response body)

Authorization​

AdminAPIAuthentication

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json

HTTP response details​

Status codeDescriptionResponse headers
200OK-
400Bad request-
401Authorization information is missing or invalid-
404The specified resource was not found-
500Unexpected error-