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.
Print	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

void CancelPrint (string printStatusId)

Cancel an executing print job.

Using the CancelPrintWithHttpInfo variant

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

Parameters

Name	Type	Description	Notes
printStatusId	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
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

Using the GetPrintCountsWithHttpInfo 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

PrintCountResponse

Authorization

AdminAPIAuthentication

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 (string printStatusId)

Retrieve print job status.

Example

Using the GetPrintStatusWithHttpInfo variant

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

Parameters

Name	Type	Description	Notes
printStatusId	string	Print ID

Return type

BasicPrintResponse

Authorization

AdminAPIAuthentication

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 (string printerId, BasicPrintRequest basicPrintRequest)

Perform basic print job.

Example

Using the PrintWithHttpInfo variant

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

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

PrintOperationResponse

Authorization

AdminAPIAuthentication

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 (string printStatusId, BasicPrintUpdateRequest basicPrintUpdateRequest)

Updates an executing print job.

Example

Using the UpdatePrintWithHttpInfo variant

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

Parameters

Name	Type	Description	Notes
printStatusId	string	Print ID
basicPrintUpdateRequest	BasicPrintUpdateRequest

Return type

PrintOperationResponse

Authorization

AdminAPIAuthentication

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	-