Previous page

Next page

Locate page in Contents

Print this page

cancel

Summary:

Cancels the processing of a client request.

Request specification:

Name

Min/Max

Type

Description

cancel

 

 

 

{

 

 

 

message_id

1..1

string

Request ID. You must assign this ID manually to every message for which you plan on providing this functionality in your client applications. The ID is assigned using the id attribute of the packet element when you compose the request.

target

0..1

string

The target operator that was specified in the original request. The message ID that exists within a particular Agent session may not be unique within the entire Agent server context. Use this parameter together with message_id (above) to make sure you are canceling the correct request.

global

0..1

none

Normally, Agent will verify that the request that you are trying to cancel and this request both originate on the same client. Include this element to bypass this verification. For this to succeed, the message ID specified in the message_id parameter must be unique.

}

 

 

 

Returns:

OK/Error

Description:

Use the cancel call to cancel a client request which is currently being processed by Agent. Whether the request can be canceled or not depends on how long it takes to process the request and the number of stages the entire request processing is divided into. To cancel a request, you have to know its ID in advance. The ID is assigned to a request manually at the time it is composed.

Please send us your feedback on this help page