Starting work orders

When the technician assigned to a work order arrives on site and starts working, the Check-In operation should be performed. Checking in may not be required by all your customers but nevertheless is strongly recommended.
To perform a check-in, call the PUT /api/workOrder/checkIn method.

📘

WebHook notification available

For details of this notification, see Technician checked in.

❗️

Important

You can check-in only if a work order is in the Accepted or Paused status.

🚧

Provide geolocation information

The information about geographical location of a technician/ subcontractor at the time of the Check-In operation is used for verification of work order activities by a customer.

A successful API response means that the check-in operation was successful, and the status of the work order has changed to CheckedIn.
You can verify that the work order status has changed by calling GET /api/workOrder/. This method returns up-to-date work order data, including its current status.

If the API returns an error, see Error Codes for troubleshooting the problem.

❗️

Backdating by using ActualActionDate

The field ActualActionDate is an optional parameter that is indicating that this step has already been taken and you are providing the datetime for which it was actually performed.

If this step is being performed in real-time, you should not send this field. You may omit the field, or send a value of null.

In order to use an ActualActionDate, the customer's configuration needs to include the setting to allow backdating. If the customer's configuration does not allow for backdating then must send the request with ActualActionDate omitted or set to null.