Callout Jobs ​
Callout jobs are service visits to diagnose and repair issues with existing installations. They follow a similar workflow to repair jobs, with an initial inspection visit followed by optional follow-up and remedial visits.
Definition ​
| Property | Description |
|---|---|
jobType | 'Callout' |
Callout Types ​
| Type | Description |
|---|---|
SubscriptionVisit | Callout for customers with service plans |
InstallationVisit | Callout related to a previous installation |
Visit Types ​
| Visit Type | Description | Documentation |
|---|---|---|
inspection | Initial diagnostic visit to identify the problem | Inspection |
follow_up | Return visit to complete repairs after parts ordered | Follow Up |
remedial | Additional work scheduled after inspection or follow-up | Remedial |
Job Properties ​
| Property | Type | Description |
|---|---|---|
calloutType | CalloutType | 'SubscriptionVisit' | 'InstallationVisit' |
visitType | CalloutVisitType | 'inspection' | 'follow_up' | 'remedial' |
partsStatus | CalloutPartsStatus | 'engineer_supplied' | 'ordered' | 'ordered_manually' | 'order_required' | 'not_required' |
visits | CalloutVisit[] | Array of previous visit reports with photos and outcomes |
webApiId | string | API identifier for the current visit |
API Endpoints ​
| Action | Endpoint | Method |
|---|---|---|
| Submit visit outcome | /engineers/callouts/visits/{visitId}/report | POST |
| Update visit notes | /engineers/callouts/visits/{webApiId} | PUT |
| Fetch repair categories | /engineers/callouts/products | GET |
| Get gas safety records | /engineers/callouts/visits/{id}/gas_safety_records | GET |