Resource URL Summary

Pass Through Call to Dispatch's "Get Status Enquiry" API

PUT /up/v5/rest/dispatch/getStatusEnquiry

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.

API Specifics

These elements contains the date and datetime objects. If your language does not understand these object types, then the definition is included.

Parameter	Datatype (length)	Description
`CallNo`	String(20)	The call number that was used when the call was originally created.
`StartDate`	String(20)	Starting date to search for status history (format for this is YYYYDDMM).
`EndDate`	String	Ending date to search for status history (format for this is YYYYDDMM).
`StartTime`	String	Starting time to search for status history (format for this is HH24:MI).
`EndTime`	String	Ending Time to search for status history (format for this is HH24:MI).
`CallStatus`	CallStatusEnquiryReqCallStatus	Limit the search to only a certain status.
`SecStatus`	CallStatusEnquiryReqSecStatus	Limit the search to only a certain secondary status MaxAttempt, Unassigned.

Pass Through Call to Dispatch's "Get Status Enquiry" API

This RESTified API will perform a pass-through call to the Dispatch sub-system's "Get Status Enquiry" API (when configured).

URL

PUT /up/v5/rest/dispatch/getStatusEnquiry

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 Dispatch "Get Status Enquiry" APi.

GetStatusEnquiry Object Format

{
	"Id": "",
	"CallStatus": "",
	"SecStatus": "",
	"StartDate": "",
	"StartTime": "",
	"EndDate": "",
	"EndTime": ""
}

GetStatusEnquiry Object Properties

Property	Type	Required?	Description	Dispatch Field Mapping
`Id`	`string`	No	Pass through parameter to the Dispatch "Get Status Enquiry" API.	`CallNo`
`CallStatus`	`string`	No	Pass through parameter to the Dispatch "Get Status Enquiry" API.	`CallStatus`
`SecStatus`	`string`	No	Pass through parameter to the Dispatch "Get Status Enquiry" API.	`SecStatus`
`StartDate`	`string`	No	Pass through parameter to the Dispatch "Get Status Enquiry" API.	`StartDate`
`StartTime`	`string`	No	Pass through parameter to the Dispatch "Get Status Enquiry" API.	`StartTime`
`EndDate`	`string`	No	Pass through parameter to the Dispatch "Get Status Enquiry" API.	`EndDate`
`EndTime`	`string`	No	Pass through parameter to the Dispatch "Get Status Enquiry" API.	`EndTime`

HTTP Response

Success

On success, a JSON-formatted version of the Dispatch "Get Status Enquiry" API response will be returned.

GetStatusEnquiry Response Object Format

{
    "AckMsg": "",
    "WorkItemCount": "4",
    "WorkItems": [
        {
            "MFGID": "9999",
            "Id": "ka.2019-8-7.100263",
            "WorkStatus": "COMPLETED",
            "WorkSubStatus": "COMPLETED",
            "SPSvcrAcct": "FSSTEST",
            "UpdatedDate": "2019-11-04T11:47:00.000Z",
            "CompletedDate": "2019-11-04T00:00:00.000Z",
            "Payment": [
                {
                    "POAmount": "0"
                }
            ],
            "Booking": {
                "ServiceOrg": "FSSTEST",
                "SchdStart": "2019-08-09T12:00:00.000Z",
                "SchdEnd": "2019-08-09T23:00:00.000Z"
            }
        },
		// ...
    ]
}

GetStatusEnquiry Response Object Properties

Property			Type	Description
`AckMsg`			`string`	Description of the response success.
`WorkItemCount`			`string`	The number of Dispatch Servicer objects in the `WorkItems` array.
`WorkItems`			`array`	An array of objects, each representing the status for a Dispatch Work Item.
	`MFGID`		`string`	The Dispatch Work Item `MfgSvcrAcct` value.
	`Id`		`string`	The Dispatch Work Item `CallNo` value.
	`WorkStatus`		`string`	The Dispatch Work Item work status.
	`WorkSubStatus`		`string`	The Dispatch Work Item work sub-status.
	`SPSvcrAcct`		`string`	The Dispatch Work Item ServicePower account number.
	`UpdatedDate`		`string`	The Dispatch Work Item updated date.
	`CompletedDate`		`string`	The Dispatch Work Item completed date.
	`Payment`		`array`	An array containing details of the Work Item payment information.
		`POAmount`	`string`	The Dispatch PO amount value.
	`Booking`		`object`	An object containing details of the Work Item booking.
		`ServiceOrg`	`string`	The Dispatch Work Item service organization.
		`SchdStart`	`string`	The Dispatch Work Item scheduled start date/time.
		`SchdEnd`	`string`	The Dispatch Work Item scheduled end date/time.

Error

On error, a JSON-formatted version of the Dispatch "Get Status Enquiry" API response will be returned.

{
    "Success": false,
    "Code": 9,
    "Payload": {
        "returnCode": {
            "type": "Error",
            "message": "Dispatch Error Code"
        }
    }
}

Return Codes

In addition to the Standard Return Codes, and the Dispatch Error codes, individual API calls made have unique codes found on their individual pages.

ServiceBroker 5

GetStatusEnquiry RESTified API

Analytics