Types of Check-In/Out

less than 1 minute read

Our API supports four types of check-in/out: travel, provider, GPS, and custom.

Important: You won’t be able to use most check-in/out types unless special permissions are enabled.

Type Description Work type Required permissions
Travel check‑in/out Report the time spent on traveling to the location. Travel XML check-in/out permission or
GPS check-in/out permission
Provider check‑in/out Report the time spent on work without providing the GPS coordinates of the technician’s position. Repair XML check-in/out permission
GPS check‑in/out Report the time spent on work and record the GPS coordinates of the technician’s position. Repair GPS check-in/out permission
Custom check‑in/out Report the time spent on anything else, for example, having a lunch break or conducting research. Custom No permission required.
However, custom types don’t exist by default. Subscribers should ask ServiceChannel to create custom types for them.

Though these types are different, use the same two universal methods to report technicians’ activity:

POST /workorders/{workorderId}/universalCheckIn to check in

POST /workorders/{workorderId}/universalCheckOut to check out