Resource URL Summary

API Specific Parameters

Retrieve dispatch status for a specific work order

This REST API will return the dispatch status information for the work order. The work order with specified ID must already exist in the system.

URL

HTTP Response Body

The HTTP response body, on success, will contain a Work Order Dispatch Object. Otherwise, on error, the response body will contain a descriptive reason for the error. 

{
	"DispatchStatus": 0,
	"DispatchUTC": "2016-11-17T17:30:56.847Z",
	"PlannedDur": 15,
	"PlannedEndDate": "2016-11-17T11:15:00.000Z",
	"PlannedStartDate": "2016-11-17T11:00:00.000Z",
	"PrimaryUserName": "",
	"UserName": ""
}

Update dispatch status for a specific work order

This REST API will update dispatch status information for a specific work order. The system will modify dispatch status in case work order exists in the system. If dispatch status information was changed, the HTTP response code of 200 will be returned. Otherwise, on error, the appropriate HTTP response code will be returned along with details of the error in the response body.

All properties and objects not included in the request body will be ignored. Therefore, only properties and objects that are included will be updated within the Work Order Object.

URL

HTTP Request Body

The HTTP request body must contain a valid Work Order Dispatch Object. 

HTTP Response

On success the API will return a status code of 200.