Completing procedures

📘

Notice

Procedures are an enhanced version of the earlier CheckList object. CheckList has been deprecated for most clients, and we encourage the use of Procedures described below instead.

When you receive a new work order, it may include procedures to complete while performing the work. Procedures are represented as a group of Procedure.

Review if WorkOrder.WorkDetails.Procedures is available.

Each Procedure may also include Steps, represented as a group of StepDescriptor.

Alternatively, you can call the GET /api/procedure method that returns the actual procedures for a work order, and you can call the GET /api/procedure/step

📘

Notice:

Procedure.Order field is used for item ordering and represents logical sequence of procedures.

StepDescriptor.Order field is used for item ordering and representing logical sequences of steps within a procedure.

Updating procedures

❗️

Important

Procedure and Step update functionality is available only for work orders in Accepted, CheckedIn, Paused and OnHold statuses. Procedures and Steps in other statuses are read-only.

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

• Step.Status - indicates the status of the step, .i.e. 'Unknown', 'Open', 'NA', or 'Done'.
• Step.Value - represents a value of the step.
• Step.Comment - represents text comment provided by the provider for the step item.
• Step.Currency - ISO 4217 alphabetic currency code, required if DataType is Money.

📘

WebHook notification available

Every time a technician via CorrigoPro Desktop updates a procedure, your application will receive a corresponding notification about this event. For details about notification content, see Procedure Updated topic.