Domain Model
Schedule Visit
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string.uuid | Yes | — | Id |
| createdAt | string.date-time | Yes | — | Created at |
| updatedAt | string.date-time | Yes | — | Updated at |
| workspaceId | string.uuid | Yes | — | ID of the associated workspace |
| visibilityMode | unknown | Yes | — | Visibility mode |
| workOrderId | string.uuid | Yes | — | ID of the associated work order |
| ticketId | unknown | No | — | ID of the associated ticket |
| projectId | unknown | No | — | ID of the associated project |
| siteId | string.uuid | Yes | — | ID of the associated site |
| assignedTechnicianId | string.uuid | Yes | — | ID of the associated assigned technician |
| additionalTechnicianIds | unknown | No | — | Additional technician ids |
| status | enum(scheduled, en_route, in_progress, completed, canceled, no_show) | Yes | — | Status |
| visitType | enum(service_call, installation, inspection, pm_visit, follow_up, survey) | Yes | — | Visit type |
| scheduledStart | string.date-time | Yes | — | Scheduled start |
| scheduledEnd | string.date-time | Yes | — | Scheduled end |
| estimatedDurationMinutes | number,null | No | — | Estimated duration minutes |
| actualDurationMinutes | number,null | No | — | Actual duration minutes |
| travelTimeMinutes | number,null | No | — | Travel time minutes |
| sequence | number | Yes | — | Sequence |
| notes | string,null | No | — | Notes |
| dispatcherNotes | string,null | No | — | Dispatcher notes |
| departedAt | unknown | No | — | Departed at |
| arrivedAt | unknown | No | — | Arrived at |
| completedAt | unknown | No | — | Completed at |
| checkInLatitude | number,null | No | — | Check in latitude |
| checkInLongitude | number,null | No | — | Check in longitude |
| signatureData | string,null | No | — | Signature data |
| signedByName | string,null | No | — | Signed by name |
| signedByTitle | string,null | No | — | Signed by title |
| signedAt | unknown | No | — | Signed at |
| signatureS3Key | string,null | No | — | Signature s3key |
| googleCalendarEventId | string,null | No | — | ID of the associated google calendar event |
| cancelReason | string,null | No | — | Cancel reason |
| createdById | unknown | No | — | ID of the associated created by |
Create Schema
Fields accepted when creating a new record:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| workspaceId | string.uuid | No | — | ID of the associated workspace |
| workOrderId | string.uuid | Yes | — | ID of the associated work order |
| ticketId | unknown | No | — | ID of the associated ticket |
| siteId | string.uuid | Yes | — | ID of the associated site |
| assignedTechnicianId | string.uuid | Yes | — | ID of the associated assigned technician |
| additionalTechnicianIds | string[] | No | — | Additional technician ids |
| visitType | enum(service_call, installation, inspection, pm_visit, follow_up, survey) | Yes | — | Visit type |
| scheduledStart | string.date-time | Yes | — | Scheduled start |
| scheduledEnd | string.date-time | Yes | — | Scheduled end |
| estimatedDurationMinutes | integer | No | — | Estimated duration minutes |
| sequence | integer | Yes | 1 | Sequence |
| notes | string | No | — | Notes |
| dispatcherNotes | string | No | — | Dispatcher notes |
Update Schema
All fields are optional when updating:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| assignedTechnicianId | string.uuid | No | — | ID of the associated assigned technician |
| additionalTechnicianIds | string[] | No | — | Additional technician ids |
| visitType | enum(service_call, installation, inspection, pm_visit, follow_up, survey) | No | — | Visit type |
| scheduledStart | string.date-time | No | — | Scheduled start |
| scheduledEnd | string.date-time | No | — | Scheduled end |
| estimatedDurationMinutes | unknown | No | — | Estimated duration minutes |
| notes | string,null | No | — | Notes |
| dispatcherNotes | string,null | No | — | Dispatcher notes |