Completing checklists

❗️

Important

Checklists are becoming Procedures for most Enterprise clients on March 22, 2018, and we discourage their usage.

When you receive a new work order, check whether it is needed to fill in checklist while performing the work. A checklist is represented as a collection of CheckListItemDescriptor.
Review if WorkOrder.WorkDetails.CheckList is available. Alternatively, you can call the GET /api/checklist method that returns an actual checklist of a work order.

📘

Notice:

SortingIndex field is used for item ordering and represents logical sequence of checks.

Updating checklist

❗️

Important

Checklist editing functionality is available only for work orders in Accepted, CheckedIn, Paused and OnHold statuses. Checklists in other statuses are read-only.

After accepting a work order, you can update a checklist by calling the PUT /api/checklist method.
You can update only the following fields:

• CheckListItem.IsDone - indicates whether an item is completed or not
• CheckListItem.Comment - represents comment provided by a provider about the checklist item
• CheckListItem.Exception - represents text of an exception. Additional information provided by the provider for the checklist item.

📘

WebHook notification available

Every time a technician via CorrigoPro Desktop edits a checklist, your application will receive a corresponding notification about this event. For details about notification content, see Checklist updated topic.

For details how to fill in the checklist data while completing a work order, see Completing work orders.