Share via

3.1.4.6 CancelRequest

  • Article

This operation is used to cancel an operation that is currently running on the protocol server.

 <wsdl:operation name="CancelRequest">
     <wsdl:input message="CancelRequestSoapIn" />
     <wsdl:output message="CancelRequestSoapOut" />
 </wsdl:operation>

The protocol client sends a CancelRequestSoapIn request message, and the protocol server responds with a CancelRequestSoapOut response message, as follows:

  • The protocol server SHOULD<13> try to cancel all requests currently running on the protocol server against the session (2) specified inside the parameter element as specified in CancelRequestSoapIn (section 3.1.4.6.1.1). The CancelRequest operation MUST NOT fail if no operation is currently running or if an operation that is currently running cannot be cancelled.

In the event of an application error on the protocol server during this operation, the protocol server MUST return an ExcelServerMessage as specified in section 2.2.9.2. The id element of the ExcelServerMessage MUST be one of the values specified in section 2.2.9.4, and SHOULD<14> be one of the values described in the following table.

Id

Description

InvalidOrTimedOutSession

See section 2.2.9.5.

RetryError

See section 2.2.9.5.

InternalError

See section 2.2.9.5.