Visits

The Visits API provides comprehensive endpoints for managing work orders visits and activities within the Corrigo platform. This guide covers all available API endpoints for retrieving, updating, and managing visits and their associated data.

Getting Service Details

You can retrieve the list of services associated with a specific visit for a given work order. It returns service details including rate, currency, and name for each service tied to the visit. To get details call the GET/api/visits/services


Starting Visit

When the technician assigned to a work order arrives on site and starts working, the visit Check-In operation should be performed.

To perform a check-in, call the PUT/api/visits/checkIn method.

This method should be called when a technician/subcontractor arrives on site, and starts the work described in the work order. This method can be called only if the work order is in Accepted or Paused status.

📘

Note

The information about geographical location of a technician/subcontractor at the time of the CheckIn operation is required for verification of the work order in the Corrigo Enterprise.
The optional parameter VisitServices, please via GET api/workorder or api/visits/services request to get Visit Services.


Completing Visit

To complete visit, use the, call the PUT/api/visits/checkOut method.

This method should be called when a technician/subcontractor arrives on site, and starts the work described in the work order. This method can be called only if the work order is in Accepted or Paused status.

📘

Note

The information about geographical location of a technician/subcontractor at the time of the CheckOut operation is required for verification of the work order in the Corrigo Enterprise.
The optional parameter VisitServices, please via GET api/workorder request to get Visit Services.


Getting Visit Details

To get visit details, call the GET/api/visits method.

Handles the HTTP GET request to retrieve visits associated with a specific work order. Information for Visits here will be present when the User performs an Accept and Check In.