/
Book Job REST API
Document toolboxDocument toolbox

Book Job REST API

Owned by Andrew Hill (Deactivated)
Last updated: Oct 01, 2024 by Jason Andrew

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 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.

Before the Book Job REST API can be used for a given entity, it will be necessary to use the Entity System Configuration REST API to update the entity's Entity System Configuration Object and configure the RestApi.BookJob property, to define the REST Endpoint URI of an API that implements the Followup WorkOrder Rest API.

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

API Specific Parameters

ParameterDescription

${WorkOrderID}

Identifies the current Work Order number requiring follow-up service.

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.


API Specifics

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

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

URL

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

HTTP Request Body

The HTTP request body must contain a valid Book Job Object.

HTTP Response

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

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

Related content