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

PUT /up/v5/rest/dispatch/getStatusEnquiry   

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

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

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

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"
        }
    }
}