Permit Schema
Prerequisites
- Basic API knowledge
User Flows Covered
Understanding API data structures
Permit Schema
Understand the structure of permit data in the API.
Permit Object
{
"id": "uuid",
"permit_number": "HWP-001",
"permit_type_id": "uuid",
"project_id": "uuid",
"status": "approved",
"created_by": "uuid",
"created_at": "2024-01-15T10:00:00Z",
"updated_at": "2024-01-15T12:30:00Z",
"responses": {
"question_id_1": "value",
"question_id_2": ["option1", "option2"]
}
}Field Descriptions
| Field | Type | Description |
|---|---|---|
| id | UUID | Unique identifier |
| permit_number | String | Human-readable permit number |
| permit_type_id | UUID | Reference to permit type |
| project_id | UUID | Reference to project |
| status | String | Current workflow status |
| responses | Object | Question responses keyed by ID |
Response Types
Different question types have different response formats:
- Text: String value
- Number: Numeric value
- Date: ISO 8601 date string
- Dropdown: Selected option ID
- Multi-select: Array of option IDs
- File: Array of file URLs
- Signature: Base64 image or URL