PrintQueueApi

Method	HTTP request	Description
CancelAllActivePrintJobs	POST /api/web/v1/prints/{printerId}/cancelAllActivePrints	Cancel all active jobs for a given printer.
DeletePrintJob	DELETE /api/web/v1/prints/{printJobId}	Delete the given print job.
GetPaginatedPrintJobs	POST /api/web/v1/prints/paginated	View print jobs in paginated form.
GetPrintJob	GET /api/web/v1/prints/{printJobId}	Get the given print job.
GetPrintJobs	GET /api/web/v1/prints	List all print jobs.

CancelAllActivePrintJobs

void CancelAllActivePrintJobs (string printerId)

Cancel all active jobs for a given printer.

This API cancels the ongoing job on printer. This should be used if any job is stuck on printer i.e. the printer is not processing the job anymore and is stuck in busy state for more than 5 minutes.

Using the CancelAllActivePrintJobsWithHttpInfo variant

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

Parameters

Name	Type	Description	Notes
printerId	string	Printer Id. This can be obtained from the id value in the response of Return a Specified Printer API call.

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Authorization information is missing or invalid	-
404	The specified resource was not found	-
500	Unexpected error	-

DeletePrintJob

void DeletePrintJob (string printJobId)

Delete the given print job.

Example

Using the DeletePrintJobWithHttpInfo variant

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

Parameters

Name	Type	Description	Notes
printJobId	string	Print ID

Return type

void (empty response body)

Authorization

AdminAPIAuthentication

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Authorization information is missing or invalid	-
404	The specified resource was not found	-
500	Unexpected error	-

GetPaginatedPrintJobs

PrintQueuePaging GetPaginatedPrintJobs (SearchParms searchParms)

View print jobs in paginated form.

Example

Using the GetPaginatedPrintJobsWithHttpInfo variant

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

Parameters

Name	Type	Description	Notes
searchParms	SearchParms

Return type

PrintQueuePaging

Authorization

AdminAPIAuthentication

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Authorization information is missing or invalid	-
500	Unexpected error	-

GetPrintJob

PrintJob GetPrintJob (string printJobId)

Get the given print job.

Example

Using the GetPrintJobWithHttpInfo variant

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

Parameters

Name	Type	Description	Notes
printJobId	string	Print ID

Return type

PrintJob

Authorization

AdminAPIAuthentication

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Authorization information is missing or invalid	-
404	The specified resource was not found	-
500	Unexpected error	-

GetPrintJobs

List<PrintJob> GetPrintJobs ()

List all print jobs.

Example

Using the GetPrintJobsWithHttpInfo 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<PrintJob>

Authorization

AdminAPIAuthentication

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Authorization information is missing or invalid	-
500	Unexpected error	-