Pausing work orders

If work is temporarily stopped due to a reason, such as end of a work day or lunch time, the status of the work order should be changed to Paused.

Unlike accepting or rejecting work orders Pausing work orders is an optional, but recommended action.

To pause a work order, call the PUT /api/workOrder/pause method.

❗️

Important

You can pause a work order only when it is in the Checked-In status.

📘

WebHook notification available

For details of this notification, see Technician paused.

🚧

Provide Geo-location information

The information about geographical location of a technician/subcontractor at the time of the Pause operation is used for verification of activities related to the work order in the Corrigo Enterprise.

A successful API response means that the work order has been paused, and its status is changed to Paused.
You can verify that the work order status has been 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.