Get a permit requirement
Módulo Safety
GET/permit-requirements/{id}permitRequirements.get
A permit requirement generated by the jurisdiction permit engine. An unpopulated jurisdiction returns no answer. Returns one permit requirement with its `ETag`. A permit requirement the caller may not see returns 404.
- Requiere la capacidad safety.permit.read.
- Alcances de OAuth: safety.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the permit requirement. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Respuesta 200: PermitRequirement
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the permit requirement. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| project_id | string (uuid) | Sí | Identifier of the project. |
| rule | string | Sí | Canon permit rule that triggered it.Restricciones: length 1 to 300 |
| jurisdiction_id | JurisdictionId | Sí | Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Restricciones: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$ |
| permit | string | Sí | Permit required.Restricciones: length 1 to 300 |
| ahj | string | Sí | Authority having jurisdiction.Restricciones: length 1 to 300 |
| permit_state | string | null | Sí | Permit state. A Title Case value from the lifecycle's database enum.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]*( [A-Za-z0-9&'/.()-]+)*$ |
| lead_time | string | Sí | Lead time as canon states it.Restricciones: length 1 to 300 |
| trigger_type | string | Sí | What triggers the canon rule: threshold, project, element or condition.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| record_id | string (uuid) | null | Sí | Identifier of the Permit record tracking the requirement. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"rule": "Assembly occupancy",
"jurisdiction_id": "US-FL",
"permit": "Certificate of occupancy",
"ahj": "City Building and Fire",
"permit_state": "Proposed",
"lead_time": "4-6 wks",
"trigger_type": "project",
"record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/permit-requirements/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.permitRequirements.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.permit_requirements.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos permit-requirements get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f