Domain Model
Site
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 |
| customerId | string | Yes | — | ID of the associated customer |
| siteName | string | Yes | — | Site name |
| address | object | Yes | — | Address |
| siteType | enum(commercial, residential, industrial, government, education, healthcare, retail, mixed_use) | Yes | — | Site type |
| occupancyProfile | enum(24_7, business_hours, extended_hours, seasonal, variable) | No | — | Occupancy profile |
| serviceInstructions | string | No | — | Service instructions |
| accessInstructions | string | No | — | Access instructions |
| hazardsNotes | string | No | — | Hazards notes |
| customerSiteManagerContactId | string | No | — | ID of the associated customer site manager contact |
| activeContractIds | string[] | Yes | — | Active contract ids |
| siteHealthScore | number | No | — | Site health score |
| workspaceId | string | Yes | — | ID of the associated workspace |
| visibilityMode | unknown | Yes | — | Visibility mode |
Create Schema
Fields accepted when creating a new record:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| customerId | string | Yes | — | ID of the associated customer |
| siteName | string | Yes | — | Site name |
| address | object | Yes | — | Address |
| siteType | enum(commercial, residential, industrial, government, education, healthcare, retail, mixed_use) | Yes | — | Site type |
| occupancyProfile | enum(24_7, business_hours, extended_hours, seasonal, variable) | No | — | Occupancy profile |
| serviceInstructions | string | No | — | Service instructions |
| accessInstructions | string | No | — | Access instructions |
| hazardsNotes | string | No | — | Hazards notes |
| customerSiteManagerContactId | string | No | — | ID of the associated customer site manager contact |
| activeContractIds | string[] | Yes | [] | Active contract ids |
| siteHealthScore | number | No | — | Site health score |
| workspaceId | string | No | — | ID of the associated workspace |
| visibilityMode | unknown | No | — | Visibility mode |
Update Schema
All fields are optional when updating:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| customerId | string | No | — | ID of the associated customer |
| siteName | string | No | — | Site name |
| address | object | No | — | Address |
| siteType | enum(commercial, residential, industrial, government, education, healthcare, retail, mixed_use) | No | — | Site type |
| occupancyProfile | enum(24_7, business_hours, extended_hours, seasonal, variable) | No | — | Occupancy profile |
| serviceInstructions | string | No | — | Service instructions |
| accessInstructions | string | No | — | Access instructions |
| hazardsNotes | string | No | — | Hazards notes |
| customerSiteManagerContactId | string | No | — | ID of the associated customer site manager contact |
| activeContractIds | string[] | No | — | Active contract ids |
| siteHealthScore | number | No | — | Site health score |