3.18.0

The Book Job REST API is to be used in conjunction with ServiceScheduling (or a third party scheduling solution) to book a follow-up work order.

Note: The mobile process flow is as follows:

The mobile worker identifies that follow-up service is required and changes the work order status to Closed-Incomplete and captures a reason code.
If the work order rule CanScheduleFollowup is set to true, the technician will have the ability to request appointment slots from ServiceMobility, which uses the REST Standard REST APIs Appointment Search REST API. This will return a list of available appointment slots.
The mobile worker may then choose to book a new work order against a pre-designated appointment slot. ServiceMobility will then utilize the Book Job REST API to accomplish this.

On this page:

Related pages:

Resource URL Summary

Request to book a new work order for the specified time slot

POST /seiapi/v3/trans/WorkOrder/${WorkOrderID}/Followup

Parameter	Description
`${WorkOrderID}`	Identifies the current Work Order number requiring follow-up service.

API Specifics

This REST API will request the booking of a new Work Order for an available appointment slot that has been obtained via the REST Standard REST APIs Appointment Search REST API.

POST /seiapi/v3/trans/WorkOrder/${WorkOrderID}/Followup

On success, an HTTP status code of 200 will be returned, and the response body will contain a REST Object Definitions Work Order Activity Related Objects Book Job Response Object. Otherwise, on error, the response body will contain a descriptive reason for the error.

JSON Format

{
	"OrderNum": "",
	"OrderedParts": [{
		"PartOrderNum": "",
		"Parts": ["", ""]
	}]
}