On This Page:

Related Pages:

The sp:DispResultRequest API method can be used to confirm that a given job has been dispatched.

Description

When a client application has found the details of the next Work Item to be dispatched by a call to the Get Dispatchable Jobs and Activities SOAP API it will normally then attempt to send those details to the operative concerned.

Whether or not that attempt was successful needs to be indicated back to ServiceOptimizer. Once the success of job dispatch has been confirmed, the job won’t be dispatched again.

Definition

The definition of this API is:

Web Service		Type	Description	Req?	Val?
`<sp:DispResultRequest>`
	`<resultCode>?</resultCode>`		If the job was successfully dispatched, this should be set to 0. If any other result is returned, ServiceOptimizer will re-dispatch the job until 0 is returned for it, or disp_expiry_time is reached. ServiceOptimizer does not do any special processing for non-zero responses, but it will be logged in the log file.
`</sp:DispResultRequest>`

Return Structure

The API returns the standard return structure.

Return Codes

In addition to the Standard Return Codes, the possible Return Codes from this API are:

SP_OK (0)
SP_DISP_INIT_EXPECTED (262)
SP_DISP_REQ_EXPECTED (263)

Browser not supported