Inspections
Inspections
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Assign Inspections | Agency | inspections | Access token | PUT /v4/inspections/{ids}/assign | 7.3.2 |
| Cancel Inspections | All | inspections | Access token | DELETE /v4/inspections/{ids}/cancel | 7.3.2 |
| Create Related Inspections | Agency | inspections | Access token | POST /v4/inspections/{id}/related | 7.3.2 |
| Delete Inspections | Agency | inspections | Access token | DELETE /v4/inspections/{ids} | 7.3.2 |
| Delete Related Inspections | Agency | inspections | Access token | DELETE /v4/inspections/{id}/related/{childIds} | 7.3.2 |
| Get All Available Dates for Inspection | All | inspections | Access token | GET /v4/inspections/availableDates | 7.3.2 |
| Get All Inspections | All | inspections | Access token | GET /v4/inspections | 7.3.2 |
| Get Inspection History | All | inspections | Access token | GET /v4/inspections/{inspectionIds}/histories | 7.3.2 |
| Get Inspections | All | inspections | Access token | GET /v4/inspections/{ids} | 7.3.2 |
| Get Related Inspections | All | inspections | Access token | GET /v4/inspections/{id}/related | 7.3.2 |
| Reschedule Inspection | All | inspections | Access token | PUT /v4/inspections/{id}/reschedule | 7.3.2 |
| Result Inspection | Agency | inspections | Access token | PUT /v4/inspections/{id}/result | 7.3.2 |
| Schedule Inspection | All | inspections | Access token | POST /v4/inspections/schedule | 7.3.2 |
| Schedule Pending Inspection | All | inspections | Access token | PUT /v4/inspections/{id}/schedule | 7.3.2 |
| Update Inspection | Agency | inspections | Access token | PUT /v4/inspections/{id} | 7.3.2 |
Inspections/Checklists
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Inspection Checklist | Agency | inspections | Access token | POST /v4/inspections/{inspectionId}/checklists | 7.3.2 |
| Delete Inspection Checklists | Agency | inspections | Access token | DELETE /v4/inspections/{inspectionId}/checklists/{ids} | 7.3.2 |
| Get All Checklists for Inspection | All | inspections | Access token | GET /v4/inspections/{inspectionId}/checklists | 7.3.2 |
Inspections/Checklists/ChecklistItems
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Checklist Items for Checklist | Agency | inspections | Access token | GET /v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems | 7.3.2 |
| Get All Statuses for Checklist Item | All | inspections | Access token | GET /v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{checklistItemId}/statuses | 7.3.2 |
| Get Checklist Item History | All | inspections | Access token | GET /v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{checklistItemId}/histories | 7.3.2 |
| Update Inspection Checklist Items | Citizen | inspections | Access token | PUT /v4/inspections/checklists/{id}/checklistItems | 7.3.2 |
Inspections/Checklists/ChecklistItems/CustomForms
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Custom Forms for Checklist Item | Agency | inspections | Access token | GET /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customForms | 7.3.2 |
| Get Metadata of All Checklist Item Custom Forms | Agency | inspections | Access token | GET /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customForms/meta | 7.3.2 |
| Get Metadata of a Checklist Item Custom Form | Agency | inspections | Access token | GET /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customForms/{formId}/meta | 7.3.2 |
| Update Custom Forms for Checklist Item | Agency | inspections | Access token | PUT /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customForms | 7.3.2 |
Inspections/Checklists/ChecklistItems/CustomTables
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Custom Tables for Checklist Item | Agency | inspections | Access token | GET /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables | 7.3.2 |
| Get Metadata of All Checklist Item Custom Tables | Agency | inspections | Access token | GET /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables/meta | 7.3.2 |
| Get Metadata of a Checklist Item Custom Table | Agency | inspections | Access token | GET /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables/{tableId}/meta | 7.3.2 |
| Get Custom Table for Checklist Item | Agency | inspections | Access token | GET /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables/{tableId} | 7.3.2 |
| Update Custom Tables for Checklist Item | Agency | inspections | Access token | PUT /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables | 7.3.2 |
Inspections/Checklists/ChecklistItems/Documents
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Checklist Item Documents | Agency | inspections | Access token | POST /v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{checklistItemId}/documents | 7.3.2 |
| Get All Documents for Checklist Item | Agency | inspections | Access token | GET /v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{checklistItemId}/documents | 7.3.2 |
Inspections/Comments
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Comments for Inspection | All | inspections | Access token | GET /v4/inspections/{inspectionId}/comments | 7.3.2 |
Inspections/ConditionApprovals
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Inspection Approval Conditions | Agency | inspections | Access token | POST /v4/inspections/{inspectionId}/conditionApprovals | 7.3.2 |
| Delete Inspection Approval Conditions | Agency | inspections | Access token | DELETE /v4/inspections/{inspectionId}/conditionApprovals/{ids} | 7.3.2 |
| Get All Approval Conditions for Inspection | All | inspections | Access token | GET /v4/inspections/{inspectionId}/conditionApprovals | 7.3.2 |
| Get Inspection Approval Condition | All | inspections | Access token | GET /v4/inspections/{inspectionId}/conditionApprovals/{id} | 7.3.2 |
| Update Inspection Approval Condition | Agency | inspections | Access token | PUT /v4/inspections/{inspectionId}/conditionApprovals/{id} | 7.3.2 |
Inspections/Conditions
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Inspection Standard Conditions | Agency | inspections | Access token | POST /v4/inspections/{inspectionId}/conditions | 7.3.2 |
| Delete Inspection Conditions | Agency | inspections | Access token | DELETE /v4/inspections/{inspectionId}/conditions/{ids} | 7.3.2 |
| Get All Standard Conditions for Inspection | All | inspections | Access token | GET /v4/inspections/{inspectionId}/conditions | 7.3.2 |
| Get Inspection Condition | All | inspections | Access token | GET /v4/inspections/{inspectionId}/conditions/{id} | 7.3.2 |
| Get Inspection Condition History | All | inspections | Access token | GET /v4/inspections/{inspectionId}/conditions/{id}/histories | 7.3.2 |
| Update Inspection Condition | Agency | inspections | Access token | PUT /v4/inspections/{inspectionId}/conditions/{id} | 7.3.2 |
Inspections/Documents
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Inspection Documents | All | inspections | Access token | POST /v4/inspections/{inspectionId}/documents | 7.3.2 |
| Delete Inspection Documents | Agency | inspections | Access token | DELETE /v4/inspections/{inspectionId}/documents/{ids} | 7.3.2 |
| Get All Documents for Inspection | All | inspections | Access token | GET /v4/inspections/{inspectionId}/documents | 7.3.2 |
Inspections/TimeAccounting
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Inspection Time Accounting Entry | Agency | inspections | Access token | POST /v4/inspections/{inspectionId}/timeAccounting | 7.3.2 |
| Delete Inspection Time Accounting Entries | Agency | inspections | Access token | DELETE /v4/inspections/{inspectionId}/timeAccounting/{ids} | 7.3.2 |
| Get All Time Accounting Entries for Inspection | Agency | inspections | Access token | GET /v4/inspections/{inspectionId}/timeAccounting | 7.3.2 |
| Update Inspection Time Accounting Entry | Agency | inspections | Access token | PUT /v4/inspections/{inspectionId}/timeAccounting/{id} | 7.3.2 |
Settings/Inspections
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Custom Form Settings for Checklist Item | Agency | inspections | Access token | GET /v4/settings/inspections/checklists/{checklistId}/checklistItems/{checklistItemId}/customForms | 7.3.2 |
| Get All Custom Table Settings for Checklist Item | Agency | inspections | Access token | GET /v4/settings/inspections/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables | 7.3.2 |
| Get All Inspection Checklist Groups | Agency | inspections | Access token | GET /v4/settings/inspections/checklistsGroups | 7.3.2 |
| Get All Inspection Checklists | Agency | inspections | Access token | GET /v4/settings/inspections/checklists | 7.3.2 |
| Get All Inspection Grades | All | inspections | Access token | GET /v4/settings/inspections/grades | 7.3.2 |
| Get All Inspection Statuses | All | inspections | Access token | GET /v4/settings/inspections/statuses | 7.3.2 |
| Get All Inspection Types | All | inspections | Access token | GET /v4/settings/inspections/types | 7.3.2 |
| Get Inspection Checklist Statuses | All | inspections | Access token | GET /v4/settings/inspections/checklists/statuses | 7.3.3 |
| Get Inspection Checklists | Agency | inspections | Access token | GET /v4/settings/inspections/checklists/{ids} | 7.3.2 |
| Get Inspection Types | All | inspections | Access token | GET /v4/settings/inspections/types/{ids} | 7.3.2 |
Overview:
Inspections
The system uses the inspections object to manage inspection records during their complete lifecycle from application submittal to permit issuance or license issuance.Your agency may need to complete inspections on new developments, homes, or complaints.
The system supports inspection flow processes, to link different kinds of inspections into a timed sequences of events. The system can automatically schedule inspections to inspectors based on an inspector’s district, their discipline, their availability, and their workload.
The system can automatically schedule inspections upon application submittal. When you automatically schedule inspections, the system verifies inspector profiles against inspection types and assigns the appropriate inspector. Inspector assignments vary depending on geographic district, inspector discipline, calendar permissions, and workload availability. The system automatically assigns the inspector whose profile best matches the inspection type you are scheduling.
