cancelErrorPrintJobs Function for SOAP Web Services

Given a list of print jobs, this function cancels and removes the print jobs from their respective device queues. Optionally, this function can also set the status of the print jobs to an error status and log a reason for the error. This functionality is comparable to the Cancel and Error job actions for a device queue available in the Queue Details page in Status Status . For more information, see Cancel a Print Job.

Note: This function can cancel a print job only if the device queue containing the print job is locked by the user that is referenced for SOAP authentication and if the queue is stopped or paused.

When you create a SOAP Web Service data service for which the WSDL URL is the Loftware Enterprise SP Services Web Services Description Language (WSDL), an operation envelope template containing this function is one of those available. For more information about using SOAP Web Services in Loftware Enterprise SP, see SOAP API for Web Services Integration.

Important! Content in a SOAP Web Service data service or a Web Service integration is case sensitive. This includes names, attributes, and values.

About the syntax documentation

SOAP Operation Envelope (Request)

When you create a SOAP Web Service data service, the XML of the operation envelope template that you select is displayed as the Envelope parameter. Most operation envelope templates include some elements for which you must replace the value with a value appropriate to your environment. If this operation envelope template has such elements, they are described here.

Name	Type	Description
arg0	list<long>	A list of print jobs to be canceled, each identified by print job ID
arg1	string	Reason for canceling the print jobs in the list. This value is logged only if arg2 is true.
arg2	boolean	Whether to set the status of the print jobs to an error status. true: Set the status of the print jobs to an error status and log the error reason as specified in arg1 false: Do not alter the status of the print jobs or log a reason for their cancellation

Name

Type

Description

arg0

list<long>

A list of print jobs to be canceled, each identified by print job ID

arg1

string

Reason for canceling the print jobs in the list. This value is logged only if arg2 is true.

arg2

boolean

Whether to set the status of the print jobs to an error status.

true: Set the status of the print jobs to an error status and log the error reason as specified in arg1
false: Do not alter the status of the print jobs or log a reason for their cancellation

SOAP Response Function

The following is the structure of the Response Function expected as part of a SOAP Response received in response to the preceding type of SOAP Operation Envelope (Request). Any ellipses indicate expected data. For more information, see SOAP API for Web Services Integration.

<pub:cancelErrorPrintJobsResponse xmlns:pub="http://published.webservices.loftware.com/">

<return success="[true|false]"/>

</pub:cancelErrorPrintJobsResponse>