Versions Compared

Version Old Version 6 New Version 7
Changes made by

Mickey Bushman

Jason Andrew

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space SBUD and version 5

Status
colourGreen
title5.4.0

A pass-through API to ServiceScheduling (when configured) which allows the ServiceScheduling's "Confirm Dispatched Job" API to be called.  

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. 

Info

In this context, the ServiceScheduling "Confirm Dispatched Job" API is the sp:DispResultRequest API.

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

On this page:

Table of Contents
maxLevel2

Related pages:

Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

Pass Through Call to ServiceScheduling's "Confirm Dispatched Job" API

PUT /up/v5/rest/scheduling/DispResult

Include Page
_Default HTTP Headers
_Default HTTP Headers

API Specifics

Panel
borderColor#D3D3D3

Pass Through Call to ServiceScheduling's "Confirm Dispatched Job" API

This RESTified API will perform a pass-through call to the ServiceScheduling sub-system's "Confirm Dispatched Job" API (when configured).

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

PUT /up/v5/rest/scheduling/DispResult

HTTP Request Body

This request requires a JSON object supplied in the HTTP request body, which defines the parameters that will be passed through to the ServiceScheduling "Confirm Dispatched Job" APi.

ConfirmDispatchedJob Object Format

Code Block
languagejs
titleConfirmDispatchedJob JSON
collapsetrue
{
    "ResultCode": 0
}

ConfirmDispatchedJob Object Properties

PropertyTypeDescriptionReq?
ResultCodeInteger

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.

SS Field:  resultCode

Yes

HTTP Response

Success

On success, a JSON-formatted version of the ServiceScheduling "Confirm Dispatched Job" API response will be returned.

Code Block
languagejs
{
	"Success": true,
	"Code": "0",
	"Message": "",
	"Payload": {
    	"result": {
      		"type": "OK",
      		"code": "0"
    	}
  	}
}

Error

On error, a JSON-formatted version of the ServiceScheduling "Confirm Dispatched Job" API response will be returned.

Code Block
languagejs
{
    "Success": false,
    "Code": 9,
    "Payload": {
        "returnCode": {
            "type": "Error",
            "code": "SCH Error Code"
        }
    }
}

Return Codes

In addition to to the Standard Return Codes, and the possible Return Codes from  ServiceScheduling Error codes, individual API calls from this API are:

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