Resource URL Summary

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

PUT /up/v5/rest/dispatch/getStatusEnquiry

HTTP Headers

This API uses the standard ServiceBroker HTTP Headers.

API Specifics

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

This RESTified API will perform a pass-through call to the ServiceDispatch 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 ServiceDispatch "Get Status Enquiry" APi.

GetStatusEnquiry Object Format

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

GetStatusEnquiry Object Properties

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

HTTP Response

Success

On success, a JSON-formatted version of the ServiceDispatch "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 ServiceDispatch Servicer objects in the `WorkItems` array.
`WorkItems`			`array`	An array of objects, each representing the status for a ServiceDispatch Work Item.
	`MFGID`		`string`	The ServiceDispatch Work Item `MfgSvcrAcct` value.
	`Id`		`string`	The ServiceDIspatch Work Item `CallNo` value.
	`WorkStatus`		`string`	The ServiceDIspatch Work Item work status.
	`WorkSubStatus`		`string`	The ServiceDIspatch Work Item work sub-status.
	`SPSvcrAcct`		`string`	The ServiceDispatch Work Item ServicePower account number.
	`UpdatedDate`		`string`	The ServiceDIspatch Work Item updated date.
	`CompletedDate`		`string`	The ServiceDIspatch Work Item completed date.
	`Payment`		`array`	An array containing details of the Work Item payment information.
		`POAmount`	`string`	The ServiceDispatch PO amount value.
	`Booking`		`object`	An object containing details of the Work Item booking.
		`ServiceOrg`	`string`	The ServiceDIspatch Work Item service organization.
		`SchdStart`	`string`	The ServiceDIspatch Work Item scheduled start date/time.
		`SchdEnd`	`string`	The ServiceDIspatch Work Item scheduled end date/time.

Error

On error, a JSON-formatted version of the ServiceDispatch "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 ServiceDispatch Error codes, individual API calls made have unique codes found on their individual pages.

GetStatusEnquiry RESTified API