basePath: /
host: apis.accela.com
info:
description: Use the Inspections API 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 property developments, homes,
or complaints.
title: Inspections
version: v4
schemes:
- https
swagger: '2.0'
tags:
- name: Inspections
- name: Inspections/Checklists
- name: Inspections/Checklists/Checklist Items
- name: Inspections/Checklists/Checklist Items/Custom Forms
- name: Inspections/Checklists/Checklist Items/Custom Tables
- name: Inspections/Checklists/Documents
- name: Inspections/Comments
- name: Inspections/Condition Approvals
- name: Inspections/Conditions
- name: Inspections/Documents
- name: Inspections/Time Accounting
- name: Inspectors
paths:
/v4/inspections:
get:
description: "Gets a list of inspections stored in the system.\n\n\n\n**API Endpoint**: GET /v4/inspections \n\n**Scope**:\
\ inspections \n\n**App Type**: All \n\n**Authorization Type**: Access token \n\n**Civic Platform version**: 7.3.2\n\
\n"
summary: Get All Inspections
operationId: v4.get.inspections
tags:
- Inspections
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: Filter by multiple (comma-delimited) inspection types. See [Get All Inspection Types](./api-settings.html#operation/v4.get.settings.inspections.types).
in: query
name: types
required: false
type: string
- description: The start date of schedule date range filter. Use the date format yyyy-mm-dd.
in: query
name: scheduledDateFrom
required: false
type: string
- description: The end date of schedule date range filter. Use the date format yyyy-mm-dd.
in: query
name: scheduledDateTo
required: false
type: string
- description: 'Filter by inspector IDs. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors). '
in: query
name: inspectorIds
required: false
type: string
- description: Filter by district IDs.
in: query
name: districtIds
required: false
type: string
- $ref: '#/parameters/offset'
- $ref: '#/parameters/limit'
- description: Filter by module.
in: query
name: module
required: false
type: string
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_inspectionModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{ids}:
get:
description: "Gets the information for one or more requested inspections.\n\n\n\n**API Endpoint**: GET /v4/inspections/{ids}\
\ \n\n**Scope**: inspections \n\n**App Type**: All \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Get Inspections
operationId: v4.get.inspections.ids
tags:
- Inspections
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: Comma-delimited IDs of the inspections to fetch.
in: path
name: ids
required: true
type: string
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_inspectionModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
delete:
description: "Deletes one or more specified inspections.\n\n\n\n**API Endpoint**: DELETE /v4/inspections/{ids} \n\n\
**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform version**:\
\ 7.3.2\n\n"
summary: Delete Inspections
operationId: v4.delete.inspections.ids
tags:
- Inspections
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: Comma-delimited IDs of the inspections to be deleted.
in: path
name: ids
required: true
type: string
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_resultModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/availableDates:
get:
description: "Gets available dates for scheduling an inspection, starting on the specified {startDate}. This API allows\
\ a date range of up to 31 days. Note that this API does not filter the available dates based on the Schedule Cut-off\
\ Time and Schedule Number of Days Out fields on the Civic Platform inspection calendar. To filter the available dates\
\ based on the Schedule Cut-off Time and Schedule Number of Days Out inspection calendar fields, set both {validateScheduleNumOfDays}\
\ and {validateScheduleNumOfDays} parameters to true.\n\n\n\n**API Endpoint**: GET /v4/inspections/availableDates\
\ \n\n**Scope**: inspections \n\n**App Type**: All \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Get All Available Dates for Inspection
operationId: v4.get.inspections.availableDates
tags:
- Inspections
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: Filter by inspection type id.
format: int64
in: query
name: typeId
type: integer
- description: Filter by record id.
in: query
name: recordId
required: true
type: string
- description: Filter by start date.
in: query
name: startDate
required: true
type: string
- $ref: '#/parameters/limit'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request returns an array of available inspection dates. Note: A successful request may
return no data matching the filter criteria. A successful request may also return messages related to Event Manager
Scripting Engine back-end processing.'
schema:
items:
description: Array of available inspection dates.
format: date
type: string
type: array
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/checkAvailability:
get:
description: "Checks inspection availability for a given record and inspection type. This API returns an array of inspectors\
\ and their available inspection dates and times, based on the record's inspection workflow, calendar, and permissions.\
\ The results include available dates for the current and following months. \n\n\n\n**API Endpoint**: GET /v4/inspections/checkAvailability\
\ \n\n**Scope**: inspections \n\n**App Type**: All \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.3.4\n\n"
summary: Check Inspection Availability
operationId: v4.get.inspections.checkAvailability
tags:
- Inspections
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: 'The record to check. See [Get Records](./api-records.html#operation/v4.get.records.ids). '
in: query
name: recordId
required: true
type: string
- description: 'The inspection type to check for the specified record. See [Get All Inspection Types for Record](./api-records.html#operation/v4.get.records.recordIds.inspectionTypes). '
in: query
name: inspectionTypeId
required: true
type: string
- description: 'Filter by inspection id. See [Get All Inspections](./api-inspections.html#operation/v4.get.inspections). '
in: query
name: inspectionId
type: string
- description: 'Filter by department. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments). '
in: query
name: department
type: string
- description: Filter by start date, using the date format yyyy-mm-dd.
in: query
name: startDate
type: string
- description: Filter by end date, using the date format yyyy-mm-dd.
in: query
name: endDate
type: string
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_inspectionAvailabilityArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/schedule:
post:
description: "Creates an inspection with the specified inspection and scheduling information. The Schedule Inspection\
\ API automatically sets the inspection status to \"Scheduled\" and category to \"Insp Scheduled\".\n\n\n\n**API Endpoint**:\
\ POST /v4/inspections/schedule \n\n**Scope**: inspections \n\n**App Type**: All \n\n**Authorization Type**: Access\
\ token \n\n**Civic Platform version**: 7.3.2\n\n"
summary: Schedule Inspection
operationId: v4.post.inspections.schedule
tags:
- Inspections
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: The inspection to schedule.
in: body
name: body
required: true
schema:
$ref: '#/definitions/requestSchedule_inspectionModel'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_inspectionModel'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{id}:
put:
description: "Updates an inspection with the specified inspection details such as schedule date, time, and inspector.\
\ The Update Inspection API updates the inspection status and category with the specified status and category request\
\ fields.\n\n\n\n**API Endpoint**: PUT /v4/inspections/{id} \n\n**Scope**: inspections \n\n**App Type**: Agency\
\ \n\n**Authorization Type**: Access token \n\n**Civic Platform version**: 7.3.2\n\n"
summary: Update Inspection
operationId: v4.put.inspections.id
tags:
- Inspections
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: The inspection information to be updated.
in: body
name: body
required: true
schema:
$ref: '#/definitions/requestUpdate_inspectionModel'
- description: The ID of the inspection to update.
format: int64
in: path
name: id
required: true
type: integer
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_inspectionModel'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{id}/reschedule:
put:
description: "Updates an inspection with the specified schedule date, time, inspectorId, and comments. The Reschedule\
\ Inspection API automatically sets the inspection status to \"Scheduled\" and category to \"Insp Scheduled\".\n\n\
\n\n**API Endpoint**: PUT /v4/inspections/{id}/reschedule \n\n**Scope**: inspections \n\n**App Type**: All \n\n\
**Authorization Type**: Access token \n\n**Civic Platform version**: 7.3.2\n\n"
summary: Reschedule Inspection
operationId: v4.put.inspections.id.reschedule
tags:
- Inspections
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: The inspection information to reschedule.
in: body
name: body
required: true
schema:
$ref: '#/definitions/requestReschedule_inspectionModel'
- description: Inspection Id
format: int64
in: path
name: id
required: true
type: integer
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_inspectionModel'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{id}/result:
put:
description: "Provides the results of a specified inspection.\n\n\n\n**API Endpoint**: PUT /v4/inspections/{id}/result\
\ \n\n**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Result Inspection
operationId: v4.put.inspections.id.result
tags:
- Inspections
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: The inspection result to update.
in: body
name: body
required: true
schema:
$ref: '#/definitions/requestUpdate_inspectionModel'
- description: Inspection Id
format: int64
in: path
name: id
required: true
type: integer
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_inspectionModel'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{id}/schedule:
put:
description: "Updates a pending inspection with the specified inspection details such as schedule date, time, and inspector.\
\ The Schedule Pending Inspection API automatically sets the inspection status to \"Scheduled\" and category to \"\
Insp Scheduled\".\n\n\n\n**API Endpoint**: PUT /v4/inspections/{id}/schedule \n\n**Scope**: inspections \n\n**App\
\ Type**: All \n\n**Authorization Type**: Access token \n\n**Civic Platform version**: 7.3.2\n\n"
summary: Schedule Pending Inspection
operationId: v4.put.inspections.id.schedule
tags:
- Inspections
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: The inspection information to update.
in: body
name: body
required: true
schema:
$ref: '#/definitions/requestSchedule_inspectionModel'
- description: Inspection Id
format: int64
in: path
name: id
required: true
type: integer
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_inspectionModel'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{ids}/assign:
put:
description: "Assigns an inspector to the specified inspection.\n\n\n\n**API Endpoint**: PUT /v4/inspections/{ids}/assign\
\ \n\n**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Assign Inspections
operationId: v4.put.inspections.ids.assign
tags:
- Inspections
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: Comma-delimited IDs of the inspections to assign
in: path
name: ids
required: true
type: string
- description: The inspector to assign to.
in: query
name: inspectorId
required: true
type: string
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_resultModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{ids}/cancel:
delete:
description: "Cancels scheduled inspections.\n\n\n\n**API Endpoint**: DELETE /v4/inspections/{ids}/cancel \n\n**Scope**:\
\ inspections \n\n**App Type**: All \n\n**Authorization Type**: Access token \n\n**Civic Platform version**: 7.3.2\n\
\n"
summary: Cancel Inspections
operationId: v4.delete.inspections.ids.cancel
tags:
- Inspections
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: Comma-delimited IDs of the inspections to cancel.
in: path
name: ids
required: true
type: string
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_resultModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{id}/related:
get:
description: "Gets the related (child) inspections for the specified parent inspection.\n\n\n\n**API Endpoint**: GET\
\ /v4/inspections/{id}/related \n\n**Scope**: inspections \n\n**App Type**: All \n\n**Authorization Type**: Access\
\ token \n\n**Civic Platform version**: 7.3.2\n\n"
summary: Get Related Inspections
operationId: v4.get.inspections.id.related
tags:
- Inspections
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/idInspection'
- description: Filter by type of inspection relationship
enum:
- child
- parent
- renewal
in: query
name: relationship
required: false
type: string
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
items:
$ref: '#/definitions/response_inspectionRelatedModelArray'
type: array
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
post:
description: "Adds related (child) inspections to the specified parent inspection.\n\n\n\n**API Endpoint**: POST /v4/inspections/{id}/related\
\ \n\n**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Create Related Inspections
operationId: v4.post.inspections.id.related
tags:
- Inspections
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/idInspection'
- $ref: '#/parameters/lang'
- description: An array of inspection IDs to be linked to the parent inspection. See [Get All Inspections](./api-inspections.html#operation/v4.get.inspections),
[Get Related Inspections](./api-inspections.html#operation/v4.get.inspections.id.related).
in: body
name: body
required: true
schema:
items:
format: int64
type: integer
type: array
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_resultModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{id}/related/{childIds}:
delete:
description: "Deletes one or more related (child) inspections from the specified parent inspection.\n\n\n\n**API Endpoint**:\
\ DELETE /v4/inspections/{id}/related/{childIds} \n\n**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization\
\ Type**: Access token \n\n**Civic Platform version**: 7.3.2\n\n"
summary: Delete Related Inspections
operationId: v4.delete.inspections.id.related.childIds
tags:
- Inspections
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: The ID of the inspection to fetch.
in: path
name: id
required: true
type: string
- description: Comma-delimited IDs of child inspections to be deleted.
in: path
name: childIds
required: true
type: string
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_resultModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{inspectionId}/comments:
get:
description: "Gets the comments for the specified inspection.\n\n\n\n**API Endpoint**: GET /v4/inspections/{inspectionId}/comments\
\ \n\n**Scope**: inspections \n\n**App Type**: All \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Get All Comments for Inspection
operationId: v4.get.inspections.inspectionId.comments
tags:
- Inspections
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/inspectionId'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_inspectionCommentModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{inspectionIds}/histories:
get:
description: "Gets the history for the specified inspections.\n\n\n\n**API Endpoint**: GET /v4/inspections/{inspectionIds}/histories\
\ \n\n**Scope**: inspections \n\n**App Type**: All \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Get Inspection History
operationId: v4.get.inspections.inspectionIds.histories
tags:
- Inspections
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: Comma-delimited IDs of inspections to fetch.
in: path
name: inspectionIds
required: true
type: string
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_inspectionModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{inspectionId}/checklists:
get:
description: "Gets the checklists for the specified inspection.\n\n\n\n**API Endpoint**: GET /v4/inspections/{inspectionId}/checklists\
\ \n\n**Scope**: inspections \n\n**App Type**: All \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Get All Checklists for Inspection
operationId: v4.get.inspections.inspectionId.checklists
tags:
- Inspections/Checklists
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: Inspection sequence number
in: path
name: inspectionId
required: true
type: string
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_inpsectionChecklistModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
post:
description: "Creates checklists for the specified inspections.\n\n\n\n**API Endpoint**: POST /v4/inspections/{inspectionId}/checklists\
\ \n\n**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Create Inspection Checklist
operationId: v4.post.inspections.inspectionId.checklists
tags:
- Inspections/Checklists
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: Inspection checklist to be created
in: body
name: body
required: true
schema:
items:
$ref: '#/definitions/inpsectionChecklistModel'
type: array
- description: The ID of the inspection to fetch
in: path
name: inspectionId
required: true
type: string
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_checklistModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{inspectionId}/checklists/{ids}:
delete:
description: "Deletes checklists for the specified inspection.\n\n\n\n**API Endpoint**: DELETE /v4/inspections/{inspectionId}/checklists/{ids}\
\ \n\n**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Delete Inspection Checklists
operationId: v4.delete.inspections.inspectionId.checklists.ids
tags:
- Inspections/Checklists
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/inspectionIdString'
- description: Comma-delimited IDs of inspection checklists to delete.
in: path
name: ids
required: true
type: string
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_resultModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems:
get:
description: "Gets the checklist items for the specified inspection checklist.\n\n\n\n**API Endpoint**: GET /v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems\
\ \n\n**Scope**: inspections \n\n**App Type**: All \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Get All Inspection Checklist Items
operationId: v4.get.inspections.inspectionId.checklists.checklistId.checklistItems
tags:
- Inspections/Checklists/Checklist Items
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/inspectionId'
- $ref: '#/parameters/checklistId'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_inspectionChecklistItemModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/checklists/{id}/checklistItems:
put:
description: "Updates the checklist items for the specified checklist.\n\n\n\n**API Endpoint**: PUT /v4/inspections/checklists/{id}/checklistItems\
\ \n\n**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Update Checklist Items
operationId: v4.put.inspections.checklists.id.checklistItems
tags:
- Inspections/Checklists/Checklist Items
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: The ID of the checklist to fetch.
in: path
name: id
required: true
type: string
- description: The checklist items to be updated.
in: body
name: body
required: true
schema:
items:
$ref: '#/definitions/inspectionChecklistItemModel'
type: array
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_checklistModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customForms:
get:
description: "Returns an array of custom forms associated with the specified record contact. Each custom form consists\
\ of custom field name-and-value pairs.\n\n\n\n**API Endpoint**: GET /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customForms\
\ \n\n**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Get All Custom Forms for Checklist Item
operationId: v4.get.inspections.id.checklists.checklistId.checklistItems.checklistItemId.customForms
tags:
- Inspections/Checklists/Checklist Items/Custom Forms
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/idInspection'
- $ref: '#/parameters/checklistId'
- $ref: '#/parameters/checklistItemId'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_customAttributeModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
put:
description: "Updates custom forms for the requested checklist item.\n\n\n\n**API Endpoint**: PUT /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customForms\
\ \n\n**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Update Custom Forms for Checklist Item
operationId: v4.put.inspections.id.checklists.checklistId.checklistItems.checklistItemId.customForms
tags:
- Inspections/Checklists/Checklist Items/Custom Forms
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/idInspection'
- $ref: '#/parameters/checklistId'
- $ref: '#/parameters/checklistItemId'
- description: Custom forms to be updated.
in: body
name: body
required: true
schema:
items:
$ref: '#/definitions/customAttributeModel'
type: array
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_customAttributeModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customForms/meta:
get:
description: "Gets the custom forms metadata for the specified inspection checklist item.\n\n\n\n**API Endpoint**: \
\ GET /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customForms/meta \n\n**Scope**:\
\ inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform version**:\
\ 7.3.2\n\n"
summary: Get All Custom Forms Metadata for Checklist Item
operationId: v4.get.inspections.id.checklists.checklistId.checklistItems.checklistItemId.customForms.meta
tags:
- Inspections/Checklists/Checklist Items/Custom Forms
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/idInspection'
- $ref: '#/parameters/checklistId'
- $ref: '#/parameters/checklistItemId'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_customFormMetadataModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customForms/{formId}/meta:
get:
description: "Gets the custom form metadata for the specified inspection checklist item.\n\n\n\n**API Endpoint**: GET\
\ /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customForms/{formId}/meta \n\n**Scope**:\
\ inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform version**:\
\ 7.3.2\n\n"
summary: Get Custom Form Metadata for Checklist Item
operationId: v4.get.inspections.id.checklists.checklistId.checklistItems.checklistItemId.customForms.formId.meta
tags:
- Inspections/Checklists/Checklist Items/Custom Forms
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/idInspection'
- $ref: '#/parameters/checklistId'
- $ref: '#/parameters/checklistItemId'
- description: The ID of the custom form to fetch.
in: path
name: formId
required: true
type: string
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_customFormMetadataModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables/{tableId}:
get:
description: "Gets a custom table for the requested checklist item for a specified inspection.\n\n\n\n**API Endpoint**:\
\ GET /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables/{tableId} \n\n\
**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform version**:\
\ 7.3.2\n\n"
summary: Get Custom Table for Inspection Checklist Item
operationId: v4.get.inspections.id.checklists.checklistId.checklistItems.checklistItemId.customTables.tableId
tags:
- Inspections/Checklists/Checklist Items/Custom Tables
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/idInspection'
- $ref: '#/parameters/checklistId'
- $ref: '#/parameters/checklistItemId'
- description: The ID of the custom table to fetch.
in: path
name: tableId
required: true
type: string
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_customTablesModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables:
get:
description: "Gets the custom tables for the requested checklist item for a specified inspection.\n\n\n\n**API Endpoint**:\
\ GET /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables \n\n**Scope**:\
\ inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform version**:\
\ 7.3.2\n\n"
summary: Get All Custom Tables for Inspection Checklist Item
operationId: v4.get.inspections.id.checklists.checklistId.checklistItems.checklistItemId.customTables
tags:
- Inspections/Checklists/Checklist Items/Custom Tables
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/idInspection'
- $ref: '#/parameters/checklistId'
- $ref: '#/parameters/checklistItemId'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_customTablesModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
put:
description: "Updates custom tables for the requested checklist item for a specified inspection.\n\n\n\n**API Endpoint**:\
\ PUT /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables \n\n**Scope**:\
\ inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform version**:\
\ 7.3.2\n\n"
summary: Update Custom Tables for Inspection Checklist Item
operationId: v4.put.inspections.id.checklists.checklistId.checklistItems.checklistItemId.customTables
tags:
- Inspections/Checklists/Checklist Items/Custom Tables
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/idInspection'
- $ref: '#/parameters/checklistId'
- $ref: '#/parameters/checklistItemId'
- description: Custom tables to be updated.
in: body
name: body
required: true
schema:
items:
$ref: '#/definitions/inpsectionChecklistItem_customTable'
type: array
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_resultModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables/meta:
get:
description: "Gets the metadata for the custom tables of the requested checklist item for the specified inspection.\n\
\n\n\n**API Endpoint**: GET /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables/meta\
\ \n\n**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Get All Custom Tables Metadata for an Inspection Checklist Item
operationId: v4.get.inspections.id.checklists.checklistId.checklistItems.checklistItemId.customTables.meta
tags:
- Inspections/Checklists/Checklist Items/Custom Tables
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/idInspection'
- $ref: '#/parameters/checklistId'
- $ref: '#/parameters/checklistItemId'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_customTableMetadataModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables/{tableId}/meta:
get:
description: "Gets the metadata for the custom tables of the requested checklist item for the specified inspection.\n\
\n\n\n**API Endpoint**: GET /v4/inspections/{id}/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables/{tableId}/meta\
\ \n\n**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Get Custom Table Metadata for an Inspection Checklist Item
operationId: v4.get.inspections.id.checklists.checklistId.checklistItems.checklistItemId.customTables.tableId.meta
tags:
- Inspections/Checklists/Checklist Items/Custom Tables
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/idInspection'
- $ref: '#/parameters/checklistId'
- $ref: '#/parameters/checklistItemId'
- description: The ID of the custom table to fetch.
in: path
name: tableId
required: true
type: string
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_customTableMetadataModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{checklistItemId}/histories:
get:
description: "Gets historical (audit) data related to a checklist item for the specified inspection.\n\n\n\n**API Endpoint**:\
\ GET /v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{checklistItemId}/histories \n\n**Scope**:\
\ inspections \n\n**App Type**: All \n\n**Authorization Type**: Access token \n\n**Civic Platform version**: 7.3.2\n\
\n"
summary: Get Inspection Checklist Item History
operationId: v4.get.inspections.inspectionId.checklists.checklistId.checklistItems.checklistItemId.histories
tags:
- Inspections/Checklists/Checklist Items
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/inspectionIdString'
- $ref: '#/parameters/checklistIdString'
- $ref: '#/parameters/checklistItemIdString'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_chekclistItemHistoryModel'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{checklistItemId}/statuses:
get:
description: "Gets historical (audit) data related to a checklist item for the specified inspection.\n\n\n\n**API Endpoint**:\
\ GET /v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{checklistItemId}/statuses \n\n**Scope**:\
\ inspections \n\n**App Type**: All \n\n**Authorization Type**: Access token \n\n**Civic Platform version**: 7.3.2\n\
\n"
summary: Get All Inspection Checklist Item Statuses
operationId: v4.get.inspections.inspectionId.checklists.checklistId.checklistItems.checklistItemId.statuses
tags:
- Inspections/Checklists/Checklist Items
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/inspectionIdString'
- $ref: '#/parameters/checklistIdString'
- $ref: '#/parameters/checklistItemIdString'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_checklistItemStatusModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/search:
get:
description: "Get all inspection checklist items along with reference guide sheet status group available statuses. \n\
\n\n\n**API Endpoint**: GET /v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/search \n\n**Scope**:\
\ inspections \n\n**App Type**: All \n\n**Authorization Type**: Access token \n\n**Civic Platform version**: 20.2.x\
\ \n\n"
summary: Get All Inspection Checklist Items Search
operationId: v4.get.inspections.inspectionId.checklists.checklistId.checklistItems.search
tags:
- Inspections/Checklists/Checklist Items
parameters:
- $ref: '#/parameters/inspectionId'
- $ref: '#/parameters/checklistId'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
- $ref: '#/parameters/limit'
- $ref: '#/parameters/offset'
- $ref: '#/parameters/expand'
- $ref: '#/parameters/authHeaderParam'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_checklistItemStatusSearchModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{checkListItemId}/documents:
get:
description: "Gets the documents associated with the specified checklist item.\n\n\n\n**API Endpoint**: GET /v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{checkListItemId}/documents\
\ \n\n**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Get All Inspection Checklist Item Documents
operationId: v4.get.inspections.inspectionId.checklists.checklistId.checklistItems.checklistItemId.documents
tags:
- Inspections/Checklists/Checklist Items
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/inspectionId'
- $ref: '#/parameters/checklistId'
- description: The ID of the checklist item to fetch.
in: path
name: checkListItemId
required: true
type: string
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_documentModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
post:
description: "Attaches documents to a checklist item.\n\n\n\n**API Endpoint**: POST /v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{checkListItemId}/documents\
\ \n\n**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Create Checklist Item Documents
operationId: v4.post.inspections.inspectionId.checklists.checklistId.checklistItems.checklistItemId.documents
tags:
- Inspections/Checklists/Checklist Items
consumes:
- multipart/form-data
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/inspectionId'
- $ref: '#/parameters/checklistId'
- description: The ID of the checklist item to fetch.
in: path
name: checkListItemId
required: true
type: string
- description: Specify the filename parameter with the file to be uploaded. See example for details.
in: formData
name: uploadedFile
required: true
type: file
- description: A string array containing the file metadata for each specified filename. See example for details.
in: formData
name: fileInfo
type: string
required: true
- description: The document group.
in: query
name: group
required: false
type: string
- description: The document category. The list of category options varies depending on the document group. See [Get
All Document Categories](./api-settings.html#operation/v4.get.settings.documents.categories).
in: query
name: category
required: false
type: string
- description: The standard EDMS adapter userid. It's required for user level authentication
in: query
name: userId
required: false
type: string
- description: The standard EMDS adapter password. It's required for user level authentication
in: query
name: password
required: false
type: string
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_resultModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{inspectionId}/conditionApprovals:
get:
description: "Gets the conditions of approvals applicable to the specified inspections.\n\n\n\n**API Endpoint**: GET\
\ /v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{checkListItemId}/documents \n\n**Scope**:\
\ inspections \n\n**App Type**: All \n\n**Authorization Type**: Access token \n\n**Civic Platform version**: 7.3.2\n\
\n"
summary: Get All Approval Conditions for Inspection
operationId: v4.get.inspections.inspectionId.conditionApprovals
tags:
- Inspections/Condition Approvals
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/inspectionId'
- description: Filter whether or not notice information is needed.
in: query
name: isNeedNoticeInfo
required: false
type: boolean
- description: Filter by effective date.
format: date-time
in: query
name: effectiveDate
required: false
type: string
- description: Filter by expiration date.
format: date-time
in: query
name: expirationDate
required: false
type: string
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_inspectionConditionModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
post:
description: "Adds one or more conditions of approval to the specified inspection.\n\n\n\n**API Endpoint**: POST /v4/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{checkListItemId}/documents\
\ \n\n**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Create Inspection Approval Conditions
operationId: v4.post.inspections.inspectionId.conditionApprovals
tags:
- Inspections/Condition Approvals
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: The inspection condition approval to add.
in: body
name: body
required: true
schema:
items:
$ref: '#/definitions/inspectionConditionModel'
type: array
- $ref: '#/parameters/inspectionId'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_resultModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{inspectionId}/conditionApprovals/{id}:
get:
description: "Gets the conditions of approval for the specified inspections.\n\n\n\n**API Endpoint**: GET /v4/inspections/{inspectionId}/conditionApprovals/{id}\
\ \n\n**Scope**: inspections \n\n**App Type**: All \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Get Inspection Approval Condition
operationId: v4.get.inspections.inspectionId.conditionApprovals.id
tags:
- Inspections/Condition Approvals
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/inspectionId'
- description: The ID of the inspection condition to fetch.
format: int64
in: path
name: id
required: true
type: integer
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_inspectionConditionModel'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
put:
description: "Updates a condition of approval for the specified inspections.\n\n\n\n**API Endpoint**: PUT /v4/inspections/{inspectionId}/conditionApprovals/{id}\
\ \n\n**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Update Inspection Approval Condition
operationId: v4.put.inspections.inspectionId.conditionApprovals.id
tags:
- Inspections/Condition Approvals
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/inspectionId'
- description: The inspection condition information to be updated.
in: body
name: body
required: true
schema:
$ref: '#/definitions/inspectionConditionModel'
- description: The ID of the inspection condition to update.
in: path
name: id
required: true
type: string
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_inspectionConditionModel'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{inspectionId}/conditionApprovals/{ids}:
delete:
description: "Deletes one or more conditions of approval from the specified inspections.\n\n\n\n**API Endpoint**: DELETE\
\ /v4/inspections/{inspectionId}/conditionApprovals/{ids} \n\n**Scope**: inspections \n\n**App Type**: Agency \n\
\n**Authorization Type**: Access token \n\n**Civic Platform version**: 7.3.2\n\n"
summary: Delete Inspection Approval Conditions
operationId: v4.delete.inspections.inspectionId.conditionApprovals.ids
tags:
- Inspections/Condition Approvals
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/inspectionId'
- description: Comma-delimited IDs of inspection conditions to be deleted.
in: path
name: ids
required: true
type: string
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_resultModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{inspectionId}/conditions:
get:
description: "Gets the conditions that apply to the specified inspections.\n\n\n\n**API Endpoint**: GET /v4/inspections/{inspectionId}/conditions\
\ \n\n**Scope**: inspections \n\n**App Type**: All \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Get All Standard Conditions for Inspection
operationId: v4.get.inspections.inspectionId.conditions
tags:
- Inspections/Conditions
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/inspectionId'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_inspectionConditionModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
post:
description: "Adds a set of conditions to the specified inspections.\n\n\n\n**API Endpoint**: POST /v4/inspections/{inspectionId}/conditions\
\ \n\n**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Create Inspection Standard Conditions
operationId: v4.post.inspections.inspectionId.conditions
tags:
- Inspections/Conditions
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: The inspection condition to add.
in: body
name: body
required: true
schema:
items:
$ref: '#/definitions/inspectionConditionModel'
type: array
- $ref: '#/parameters/inspectionId'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_resultModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{inspectionId}/conditions/{id}:
get:
description: "Gets the condition for the specified inspection.\n\n\n\n**API Endpoint**: GET /v4/inspections/{inspectionId}/conditions/{id}\
\ \n\n**Scope**: inspections \n\n**App Type**: All \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Get Inspection Condition
operationId: v4.get.inspections.inspectionId.conditions.id
tags:
- Inspections/Conditions
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/inspectionId'
- description: The ID of inspection condition to fetch.
format: int64
in: path
name: id
required: true
type: integer
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_inspectionConditionModel'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
put:
description: "Updates conditions for the specified inspection.\n\n\n\n**API Endpoint**: PUT /v4/inspections/{inspectionId}/conditions/{id}\
\ \n\n**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Update Inspection Condition
operationId: v4.put.inspections.inspectionId.conditions.id
tags:
- Inspections/Conditions
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: The condition information to be updated.
in: body
name: body
required: true
schema:
$ref: '#/definitions/inspectionConditionModel'
- $ref: '#/parameters/inspectionId'
- description: The ID of the inspection condition to update.
in: path
name: id
required: true
type: string
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_inspectionConditionModel'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{inspectionId}/conditions/{ids}:
delete:
description: "Deletes conditons from the specified inspections.\n\n\n\n**API Endpoint**: DELETE /v4/inspections/{inspectionId}/conditions/{ids}\
\ \n\n**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Delete Inspection Conditions
operationId: v4.delete.inspections.inspectionId.conditions.ids
tags:
- Inspections/Conditions
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/inspectionId'
- description: Comma-delimited IDs of inspection conditions to be deleted.
in: path
name: ids
required: true
type: string
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_resultModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{inspectionId}/conditions/{id}/histories:
get:
description: "Gets the history for the specified conditions associated with the specified inspections.\n\n\n\n**API\
\ Endpoint**: GET /v4/inspections/{inspectionId}/conditions/{id}/histories \n\n**Scope**: inspections \n\n**App\
\ Type**: All \n\n**Authorization Type**: Access token \n\n**Civic Platform version**: 7.3.2\n\n"
summary: Get Inspection Condition History
operationId: v4.get.inspections.inspectionId.conditions.id.histories
tags:
- Inspections/Conditions
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/inspectionId'
- description: The ID of the inspection condition to fetch.
format: int64
in: path
name: id
required: true
type: integer
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_conditionHistoryModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{inspectionId}/documents:
get:
description: "Gets the documents for the specified inspection.\n\n\n\n**API Endpoint**: GET /v4/inspections/{inspectionId}/documents\
\ \n\n**Scope**: inspections \n\n**App Type**: All \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Get All Documents for Inspection
operationId: v4.get.inspections.inspectionId.documents
tags:
- Inspections/Documents
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/inspectionId'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_documentModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
post:
description: "Creates one or more document attachments for the specified inspection. To specify the documents to be\
\ attached, use the HTTP header \"Content-Type:multipart/form-data\" and form-data for \"uploadedFile\" and \"fileInfo\"\
. Note that the \"fileInfo\" is a string containing an array of file attributes. Use \"fileInfo\" to specify one or\
\ more documents to be attached. For example:\n\n\tContent - Disposition: form - data;name = \"uploadedFile\"; filename=\"\
summaryReport.pdf\"\n\n\tContent - Disposition: form - data;name = \"fileInfo\"\n\n\t[\n\t\t {\n\t\t\t\"serviceProviderCode\"\
: \"BPTDEV\",\n\t\t\t\"fileName\": \"CXA12-pipe.png\",\n\t\t\t\"type\": \"image/png\",\n\t\t\t\"description\": \"\
Inspected pipe\"\n\t\t\r\n\t\t\t\t\t}\n\t]\n\n\n\n**API Endpoint**: POST /v4/inspections/{inspectionId}/documents\
\ \n\n **Scope** : inspections\n\n **App Type** : All\n\n **Authorization Type** : Access token\n\n **Civic Platform\
\ version** : 7.3.2\n\n "
summary: Create Inspection Documents
operationId: v4.post.inspections.inspectionId.documents
tags:
- Inspections/Documents
consumes:
- multipart/form-data
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: Inspection sequence number
in: path
name: inspectionId
required: true
type: string
- description: Specify the filename parameter with the file to be uploaded. See example for details.
in: formData
name: uploadedFile
required: true
type: file
- description: A string array containing the file metadata for each specified filename. See example for details.
in: formData
name: fileInfo
type: string
required: true
- description: The document group.
in: query
name: group
required: false
type: string
- description: The document category.
in: query
name: category
required: false
type: string
- description: The standard EDMS Adapter userid. It's required for user level authentication
in: query
name: userId
required: false
type: string
- description: The standard EMDS Adapter password. It's required for user level authentication
in: query
name: password
required: false
type: string
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_resultModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{inspectionId}/documents/{ids}:
delete:
description: "Deletes documents from the specified inspection.\n\n\n\n**API Endpoint**: DELETE /v4/inspections/{inspectionId}/documents/{ids}\
\ \n\n**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Delete Inspection Documents
operationId: v4.delete.inspections.inspectionId.documents.ids
tags:
- Inspections/Documents
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: Inspection sequence number
in: path
name: inspectionId
required: true
type: string
- description: Comma-delimited IDs of documents to be deleted.
in: path
name: ids
required: true
type: string
- description: The standard EDMS Adapter userid. It's required for user level authentication
in: query
name: userId
required: false
type: string
- description: The standard EMDS Adapter password. It's required for user level authentication
in: query
name: password
required: false
type: string
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_resultModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{inspectionId}/timeAccounting:
get:
description: "\n\n\n\n**API Endpoint**: GET /v4/inspections/{inspectionId}/timeAccounting \n\n**Scope**: inspections\
\ \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform version**: 7.3.2\n\n"
summary: Get All Inspection Time Accounting Entries
operationId: v4.get.inspections.inspectionId.timeAccounting
tags:
- Inspections/Time Accounting
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/inspectionId'
- $ref: '#/parameters/fields'
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_timeLogModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
post:
description: "Creates time accounting items for the specified inspection.\n\n\n\n**API Endpoint**: POST /v4/inspections/{inspectionId}/timeAccounting\
\ \n\n**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Create Inspection Time Accounting Entries
operationId: v4.post.inspections.inspectionId.timeAccounting
tags:
- Inspections/Time Accounting
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/inspectionId'
- description: Inspection time log entries to be added.
in: body
name: body
required: true
schema:
items:
$ref: '#/definitions/request_timeLogModel'
type: array
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_resultModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{inspectionId}/timeAccounting/{id}:
put:
description: "Updates a time accounting item for an inspection.\n\n\n\n**API Endpoint**: PUT /v4/inspections/{inspectionId}/timeAccounting/{id}\
\ \n\n**Scope**: inspections \n\n**App Type**: All \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Update Inspection Time Accounting Entry
operationId: v4.put.inspections.inspectionId.timeAccounting.id
tags:
- Inspections/Time Accounting
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: ID of inspection that needs to be fetched
in: path
name: inspectionId
required: true
format: int64
type: integer
- description: Time accounting information to be updated.
in: body
name: body
required: true
schema:
$ref: '#/definitions/request_timeLogModel'
- description: The ID of the inspection time accountint item to update.
in: path
name: id
required: true
type: string
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_timeLogModel'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspections/{inspectionId}/timeAccounting/{ids}:
delete:
description: "Deletes one or more time accounting items for an inspection.\n\n\n\n**API Endpoint**: DELETE /v4/inspections/{inspectionId}/timeAccounting/{idS}\
\ \n\n**Scope**: inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform\
\ version**: 7.3.2\n\n"
summary: Delete Inspection Time Accounting Entries
operationId: v4.delete.inspections.inspectionId.timeAccounting.ids
tags:
- Inspections/Time Accounting
parameters:
- $ref: '#/parameters/authHeaderParam'
- $ref: '#/parameters/inspectionId'
- description: Comma-delimited IDs of time accounting items to be deleted.
in: path
name: ids
required: true
type: string
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_resultModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspectors:
get:
description: "Gets all the inspectors in the agency.\n\n\n\n**API Endpoint**: GET /v4/inspectors \n\n**Scope**: inspections\
\ \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform version**: 7.3.2\n\n"
summary: Get All Inspectors
operationId: v4.get.inspectors
tags:
- Inspectors
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: Filter by department code. For example, 'HEALTH/DCA/SUPER/NA/NA/NA/INTAKE'
in: query
name: department
type: string
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_inspectorModelArray'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
/v4/inspectors/{id}:
get:
description: "Gets information about an inspector.\n\n\n\n**API Endpoint**: GET /v4/inspectors/{id} \n\n**Scope**:\
\ inspections \n\n**App Type**: Agency \n\n**Authorization Type**: Access token \n\n**Civic Platform version**:\
\ 7.3.2\n\n"
summary: Get Inspector
operationId: v4.get.inspectors.id
tags:
- Inspectors
parameters:
- $ref: '#/parameters/authHeaderParam'
- description: The ID of the inspector to fetch.
in: path
name: id
required: true
type: string
- $ref: '#/parameters/lang'
responses:
'200':
description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
schema:
$ref: '#/definitions/response_inspectorModel'
'400':
description: Invalid request.
'401':
description: Authorization failed.
'403':
description: Forbidden request.
'404':
description: Requested resource not found.
'500':
description: Internal server error or bad connection.
definitions:
response_customFormMetadataModelArray:
type: object
properties:
result:
items:
$ref: '#/definitions/customFormMetadataModel'
type: array
status:
type: integer
description: The HTTP return status.
customFormMetadataModel:
description: Contains the metadata for a custom table.
type: object
properties:
displayOrder:
description: The custom table's display order.
format: int64
type: integer
fields:
items:
$ref: '#/definitions/customFormField'
type: array
id:
description: The custom table id.
type: string
text:
description: The custom table name.
type: string
customFormField:
type: object
properties:
displayOrder:
description: ''
format: int64
type: integer
drillDown:
$ref: '#/definitions/aSITableDrill'
fieldType:
description: The custom field data type.
type: string
id:
description: The custom field system id assigned by the Civic Platform server.
type: string
isReadonly:
description: Indicates whether or not the custom field is read-only.
enum:
- Y
- N
type: string
isRequired:
description: Indicates whether or not the custom field is required.
enum:
- Y
- N
type: string
maxLength:
description: The custom field length
format: int64
type: integer
options:
items:
type: object
description: Contains dropdown option values.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
type: array
text:
description: The custom field localized text.
type: string
value:
description: The custom field stored value.
type: string
aSITableDrill:
description: Contains drilldown field information.
type: object
properties:
children:
items:
$ref: '#/definitions/childDrill'
type: array
isRoot:
type: boolean
childDrill:
type: object
properties:
drillId:
description: The ID of the drilldown child record.
format: int64
type: integer
id:
description: The ID of the current record.
type: string
response_inspectionCommentModelArray:
type: object
properties:
result:
items:
$ref: '#/definitions/inspectionCommentModel'
type: array
status:
type: integer
description: The HTTP return status.
inspectionCommentModel:
type: object
properties:
createdBy:
description: The userid of the individual that created the entry.
type: string
createdDate:
description: The date the comment was created.
type: string
inspectionId:
description: The ID of the inspection the comment is attached to.
format: int64
type: integer
recordId:
$ref: '#/definitions/recordIdModel'
text:
description: The comment.
type: string
type:
description: The comment type.
type: string
response_conditionHistoryModelArray:
type: object
properties:
result:
items:
$ref: '#/definitions/conditionHistoryModel'
type: array
status:
type: integer
description: The HTTP return status.
conditionHistoryModel:
type: object
properties:
actionbyDepartment:
type: object
description: ''
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
actionbyUser:
type: object
description: ''
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
activeStatus:
type: object
description: ''
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
additionalInformation:
type: string
additionalInformationPlainText:
type: string
appliedDate:
format: date-time
type: string
appliedbyDepartment:
type: object
description: ''
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
appliedbyUser:
type: object
description: ''
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
dispAdditionalInformationPlainText:
type: string
displayNoticeInAgency:
type: boolean
displayNoticeInCitizens:
type: boolean
displayNoticeInCitizensFee:
type: boolean
effectiveDate:
format: date-time
type: string
expirationDate:
format: date-time
type: string
group:
type: object
description: ''
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
id:
format: int64
type: integer
inheritable:
type: object
description: ''
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
isIncludeNameInNotice:
type: boolean
isIncludeShortCommentsInNotice:
type: boolean
longComments:
type: string
manipulationDate:
format: date-time
type: string
manipulationType:
type: string
name:
type: string
priority:
type: object
description: ''
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
publicDisplayMessage:
type: string
resAdditionalInformationPlainText:
type: string
resolutionAction:
type: string
serviceProviderCode:
type: string
severity:
type: object
description: ''
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
shortComments:
type: string
status:
type: object
description: ''
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
statusDate:
format: date-time
type: string
statusType:
type: string
type:
type: object
description: ''
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
response_checklistItemStatusModelArray:
type: object
properties:
result:
items:
$ref: '#/definitions/checklistItemStatusModel'
type: array
status:
type: integer
description: The HTTP return status.
response_checklistItemStatusSearchModelArray:
type: object
properties:
serviceProviderCode:
description: The unique agency identifier.
type: string
statusGroup:
description: The statusGroup of the checklist.
type: string
displayOrder:
description: The item's display order.
format: int64
type: integer
checklist:
description: The name of a checklist.
type: string
isRequired:
description: Indicates whether or not the field is required.
enum:
- Y
- N
type: string
id:
description: The checklist item system id assigned by the Civic Platform server.
format: int64
type: integer
score:
description: The inspection score for a checklist or checklist item.
format: int64
type: integer
checklistId:
description: The unique ID associated with the checklist.
format: int64
type: integer
isCritical:
description: Indicates whether or not the checklist item is critical.
enum:
- Y
- N
type: string
checklistItem:
type: object
description: An item in the checklist.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
status:
type: object
description: The checklist item status.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
availableStatuses:
type: object
description: Indicates the available status.
properties:
value:
description: The localized display value.
type: string
resultType:
description: The localized display value.
type: string
displayOrder:
description: The localized display value.
type: integer
criticalScore:
description: The localized display value.
type: integer
majorViolation:
description: The localized display value.
type: string
text:
description: The localized display value.
type: string
nonCriticalScore:
description: The localized display value.
type: integer
commentGroups:
type: object
description: Comments or notes about the checklist item.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
checklistItemStatusModel:
description: A checklist item status
type: object
properties:
text:
description: The status display label.
type: string
value:
description: The status value.
type: string
response_customAttributeModelArray:
type: object
properties:
result:
items:
$ref: '#/definitions/customAttributeModel'
type: array
status:
type: integer
description: The HTTP return status.
customAttributeModel:
description: 'A custom field name and value pair. For example in JSON, "My Custom Field": "My Custom Value". The custom
field name and its data type are defined in Civic Platform custom forms or custom tables:
**For a Text field**,
the maximum length is 256.
**For a Number field**, any numeric form is allowed, including negative numbers.
**For
a Date field**, the format is MM/dd/yyyy.
**For a Time field**, the format is hh:mm.
**For a TextArea field**,
the maximum length is 4000 characters, and allows line return characters.
**For a DropdownList field**, the dropdown
list values are in the options[] array.
**For a CheckBox field**, the (case-sensitive) valid values are "UNCHECKED"
and "CHECKED".
**For a Radio(Y/N) field**, the (case-sensitive) valid values are "Yes" and "No".'
type: object
properties:
:
type: string
:
type: string
response_documentModelArray:
type: object
properties:
result:
items:
$ref: '#/definitions/documentModel'
type: array
status:
type: integer
description: The HTTP return status.
documentModel:
type: object
properties:
category:
type: object
description: The document category. The list of category options varies depending on the document group.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
deletable:
$ref: '#/definitions/userRolePrivilegeModel'
department:
description: The name of the department where the inspector works.
type: string
description:
description: The description of the document.
type: string
downloadable:
$ref: '#/definitions/userRolePrivilegeModel'
entityId:
description: The unique ID of the entity or record.
type: string
entityType:
description: The type of entity.
type: string
fileName:
description: The name of the file as it displays in the source location.
type: string
group:
type: object
description: The document group which allows agencies to organize the different types of documents that users might
need to add to certain applications.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
id:
description: The document system id assigned by the Civic Platform server.
format: int64
type: integer
modifiedBy:
description: The user account that last modified the document.
type: string
modifiedDate:
description: The date the document was last modified.
format: date-time
type: string
serviceProviderCode:
description: The unique agency identifier.
type: string
size:
description: The file size of the document.
format: double
type: number
source:
description: The name for your agency's electronic document management system.
type: string
status:
type: object
description: The documet status.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
statusDate:
description: The date when the current status changed.
format: date-time
type: string
titleViewable:
$ref: '#/definitions/userRolePrivilegeModel'
type:
description: The document type.
type: string
uploadedBy:
description: The user who uploaded the document to the record.
type: string
uploadedDate:
description: The date when the document was uploaded to the record.
format: date-time
type: string
virtualFolders:
description: The virtual folder for storing the attachment. With virtual folders you can organize uploaded attachments
in groups
type: string
response_inspectionChecklistItemModelArray:
type: object
properties:
result:
items:
$ref: '#/definitions/inspectionChecklistItemModel'
type: array
status:
type: integer
description: The HTTP return status.
inspectionChecklistItemModel:
type: object
properties:
checklist:
description: The name of a checklist.
type: string
checklistId:
description: The unique ID associated with the checklist.
format: int64
type: integer
checklistItem:
type: object
description: An item in the checklist.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
comment:
type: object
description: Comments or notes about the checklist item.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
customId:
description: The checklist item's custom ID.
type: string
displayOrder:
description: The item's display order.
format: int64
type: integer
id:
description: The checklist item system id assigned by the Civic Platform server.
format: int64
type: integer
refGuideType:
description: The name of the checklist group the given item is originally from.
type: string
isCritical:
description: Indicates whether or not the checklist item is critical.
enum:
- Y
- N
type: string
isMajorViolation:
description: Indicates whether or not the checklist item is a major violation.
enum:
- Y
- N
type: string
isRequired:
description: Indicates whether or not the field is required.
enum:
- Y
- N
type: string
score:
description: The inspection score for a checklist or checklist item.
format: int64
type: integer
serviceProviderCode:
description: The unique agency identifier.
type: string
status:
type: object
description: The checklist item status.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
response_inpsectionChecklistModelArray:
type: object
properties:
result:
items:
$ref: '#/definitions/inpsectionChecklistModel'
type: array
status:
type: integer
description: The HTTP return status.
inpsectionChecklistModel:
type: object
properties:
teamName:
description: Inspection Team name.
type: string
floor:
description: Inspection Floor.
type: string
floorUnit:
description: Inspection Floor Unit.
type: string
checklistDesc:
description: The checklist description.
type: string
checklistStatus:
description: The status of the checklist.
type: string
customId:
description: An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx).
Accela Automation auto-generates and applies an alternate ID value when you submit a new application.
type: string
defaultOrderBy:
description: The field by which the checklist items are ordered by default.
type: string
entityType:
description: The type of entity, for example "INSPECTION".
type: string
group:
description: The inspection checklist group.
type: string
guideType:
type: object
description: The inspection checklist type.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
id:
description: The checklist system id assigned by the Civic Platform server.
format: int64
type: integer
inspectionId:
description: The ID of the inspection.
type: string
isRequired:
description: Indicates whether or not the checklist is required.
enum:
- Y
- N
type: string
items:
items:
$ref: '#/definitions/inspectionChecklistItemModel'
type: array
recordId:
$ref: '#/definitions/recordIdModel'
serviceProviderCode:
description: The unique agency identifier.
type: string
response_chekclistItemHistoryModel:
type: object
properties:
result:
$ref: '#/definitions/chekclistItemHistoryModel'
status:
type: integer
description: The HTTP return status.
chekclistItemHistoryModel:
type: object
properties:
checklistItemId:
description: The checklist item id.
format: int64
type: integer
comments:
description: Comments or note about the checklist item.
type: string
inspectionType:
description: The inspection type.
type: string
isRequired:
description: Indicates whether or not the field is required.
enum:
- Y
- N
type: string
majorViolation:
type: object
description: The major violation related to the checklist item.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
score:
description: The inspection score related to the checklist item.
format: int64
type: integer
status:
description: The checklist item status.
type: string
updatedBy:
description: The user who last updated the checklist item.
type: string
updatedDate:
description: The date and time the checklist item was last updated.
format: date-time
type: string
response_inspectionConditionModelArray:
type: object
properties:
result:
items:
$ref: '#/definitions/inspectionConditionModel'
type: array
status:
type: integer
description: The HTTP return status.
response_inspectionConditionModel:
type: object
properties:
result:
$ref: '#/definitions/inspectionConditionModel'
status:
type: integer
description: The HTTP return status.
inspectionConditionModel:
type: object
properties:
actionbyDepartment:
type: object
description: The department responsible for the action.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
actionbyUser:
type: object
description: The individual responsible for the action.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
activeStatus:
type: object
description: Indicates whether or not the condition is active.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
additionalInformation:
description: An unlimited text field to use if other fields are filled.
type: string
additionalInformationPlainText:
description: An unlimited text field to use if other fields are filled.
type: string
appliedDate:
description: The date the standard condition was applied.
format: date-time
type: string
appliedbyDepartment:
type: object
description: "The department responsible for applying a condition.\t"
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
appliedbyUser:
type: object
description: "The staff member responsible for applying a condition.\t"
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
dispAdditionalInformationPlainText:
description: An unlimited text field to use if other fields are filled.
type: string
displayNoticeInAgency:
description: Indicates whether or not to display the condition notice in Accela Automation when a condition to a record
or parcel is applied.
type: boolean
displayNoticeInCitizens:
description: Indicates whether or not to display the condition notice in Accela Citizen Access when a condition to
a record or parcel is applied.
type: boolean
displayNoticeInCitizensFee:
description: Indicates whether or not to display the condition notice in Accela Citizen Access Fee Estimate page when
a condition to a record or parcel is applied.
type: boolean
displayOrder:
description: The display order of the condition in a list.
format: int64
type: integer
effectiveDate:
description: The date when you want the condition to become effective.
format: date-time
type: string
expirationDate:
description: The date when the condition expires.
format: date-time
type: string
group:
type: object
description: The condition group is an attribute of a condition that organizes condition types. Your agency defines
these groups.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
id:
description: The condition system id assigned by the Civic Platform server.
format: int64
type: integer
inheritable:
type: object
description: This defines whether or not Accela Automation checks for inheritable conditions when a user associates
a child record with a parent record.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
inspectionId:
description: The ID of the inspection the condition is attached to.
format: int64
type: integer
isIncludeNameInNotice:
description: Indicates whether or not to display the condition name in the notice.
type: boolean
isIncludeShortCommentsInNotice:
description: Indicates whether or not to display the condition comments in the notice.
type: boolean
longComments:
description: Narrative comments to help identify the purpose or uses of the standard condition.
type: string
name:
description: The name of the standard condition.
type: string
priority:
type: object
description: The priority level assigned to the condition.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
publicDisplayMessage:
description: Text entered into this field displays in the condition notice or condition status bar for the Condition
Name for the public user in Accela IVR (AIVR) and Accela Citizen Access (ACA).
type: string
resAdditionalInformationPlainText:
description: An unlimited text field to use if other fields are filled.
type: string
resolutionAction:
description: The action performed in response to a condition.
type: string
serviceProviderCode:
description: The unique agency identifier.
type: string
severity:
type: object
description: The severity of the condition.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
shortComments:
description: A brief description of the condition name. For example, the text may describe the situation that requires
the system to apply the condition. You can set these short comments to display when a user accesses an application
with this condition applied to it
type: string
status:
type: object
description: The condition status.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
statusDate:
description: The date when the current status changed.
format: date-time
type: string
statusType:
description: The status type for a standard condition or an approval condition, applied or not applied for example.
type: string
type:
type: object
description: The condition type.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
response_inspectionModelArray:
type: object
properties:
result:
items:
$ref: '#/definitions/inspectionModel'
type: array
status:
type: integer
description: The HTTP return status.
response_inspectionModel:
type: object
properties:
result:
$ref: '#/definitions/inspectionModel'
status:
type: integer
description: The HTTP return status.
inspectionModel:
type: object
properties:
teamName:
description: Inspection Team name.
type: string
floor:
description: Inspection Floor.
type: string
floorUnit:
description: Inspection Floor Unit.
type: string
address:
$ref: '#/definitions/inspectionAddressModel'
billable:
description: This defines whether or not the item is billable.
enum:
- Y
- N
type: string
category:
description: The inspection category, which is used to organize inspection types. An inspection type is assigned to
one or more inspection categories.
type: string
commentDisplay:
description: Indicates whether or not Accela Citizen Access users can view the inspection results comments.
type: string
commentPublicVisible:
description: "Specifies the type of user who can view the inspection result comments. \"All ACA Users\" - Both registered\
\ and anonymous Accela Citizen Access users can view the comments for inspection results. \"Record Creator Only\"\
\ - the user who created the record can see the comments for the inspection results. \"Record Creator and Licensed\
\ Professional\" - The user who created the record and the licensed professional associated with the record can\
\ see the comments for the inspection results.\t"
items:
type: string
type: array
completedAMPM:
description: Indicates whether completed time is "AM" or "PM".
type: string
completedDate:
description: The date of completion.
format: date-time
type: string
completedTime:
description: The time of completion.
type: string
contact:
$ref: '#/definitions/inspectionContactModel'
contactFirstName:
description: The contact's first name. This field is only active when the Contact Type selected is Individual.
type: string
contactLastName:
description: The last name of the contact.
type: string
contactMiddleName:
description: The middle name of the contact.
type: string
desiredAMPM:
description: Indicates whether the desired inspection time is AM or PM.
type: string
desiredDate:
description: The desired inspection date.
format: date-time
type: string
desiredTime:
description: The desired inspection time.
type: string
endMileage:
description: The ending mileage for the inspection.
format: float
type: number
endTime:
description: The time the inspection was completed.
format: date-time
type: string
estimatedEndTime:
description: inspection estimated end time.
type: string
estimatedStartTime:
description: The scheduled start time for the inspection.
type: string
gisAreaName:
description: The GIS Object ID of the parent application if the application that the inspection is scheduled for has
a parent application that is a project application.
type: string
grade:
description: The name of the inspection grade.
type: string
id:
description: The inspection system id assigned by the Civic Platform server.
format: int64
type: integer
inspectorFullName:
description: The name of the inspector performing the assessment.
type: string
inspectorId:
description: The ID number of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
type: string
isAutoAssign:
description: This defines whether or not you want to automatically reschedule the inspection when the previous inspection
status attains Approved status.
type: string
latitude:
description: The angular distance of a place north or south of the earth's equator, usually expressed in degrees and
minutes.
format: float
type: number
longitude:
description: The angular distance of a place east or west of the meridian at Greenwich, England, usually expressed
in degrees and minutes.
format: float
type: number
majorViolation:
description: The number of major violations.
format: int64
type: integer
overtime:
description: A labor cost factor that indicates time worked beyond a worker's regular working hours.
type: string
priority:
description: The priority level assigned to the inspection.
format: double
type: number
publicVisible:
description: This defines whether or not Accela Citizen Access users can view comment about the inspection results.
type: string
recordId:
$ref: '#/definitions/recordIdModel'
recordType:
$ref: '#/definitions/recordTypeModel_2'
requestAMPM:
description: The time segment, AM or PM, for the time specified in the requestTime field.
type: string
requestComment:
description: Comments about the new inspection. For example, you may identify who requested the inspection.
type: string
requestDate:
description: The date when an inspection request is submitted.
format: date-time
type: string
requestTime:
description: This time is automatically generated when a new inspection is scheduled and submitted.
type: string
requestorFirstName:
description: The first name of the person requesting an inspection-related operation.
type: string
requestorLastName:
description: The last name of the person requesting an inspection-related operation.
type: string
requestorMiddleName:
description: The middle name of the person requesting an inspection-related operation.
type: string
requestorPhone:
description: The telephone number for the person who processes the inspection request or schedules the inspection.
type: string
requestorPhoneIDD:
description: The telephone number for the person who processes the inspection request or schedules the inspection.
type: string
requestorUserId:
description: The user Id of the person requesting an inspection-related operation.
type: string
requiredInspection:
description: This defines whether the inspection is optional or required.
type: string
resultComment:
description: The inspection result comments.
type: string
resultType:
description: 'The type of result that can be ascibed to an inspection. There are three result types: Approved: Approves
(passes) the checklist item. Denied: Denies (fails) the checklist item. Informational: Indicates that the checklist
items do not need a status of app'
type: string
scheduleDate:
description: The date when the inspection gets scheduled.
format: date-time
type: string
scheduleEndAMPM:
description: Indicates whether the scheduleEndTime is in the AM or PM.
enum:
- AM
- PM
type: string
scheduleEndTime:
description: The scheduled end time for the inspection.
type: string
scheduleStartAMPM:
description: AM indicates the 12 hour period from midnight to noon. PM indicates the 12 hour period from noon to midnight.
enum:
- AM
- PM
type: string
scheduleStartTime:
description: The scheduled start time for the inspection.
type: string
serviceProviderCode:
description: The unique agency identifier.
type: string
startMileage:
description: The starting mileage for the inspection.
format: float
type: number
startTime:
description: The time when you started the inspection.
format: date-time
type: string
status:
type: object
description: The inspection status. See [Get All Inspection Statuses](./api-settings.html#operation/v4.get.settings.inspections.statuses).
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
submitAMPM:
description: The time block for the scheduled inspection.
type: string
submitDate:
description: The date that the inspection was submitted.
format: date-time
type: string
submitTime:
description: The time that a new inspection is submitted. Civic Platform generates this value.
type: string
totalMileage:
description: The total mileage for the inspection.
format: float
type: number
totalScore:
description: The overall score of the inspection that includes the inspection result, inspection grade, checklist
total score and checklist major violation option.
format: int64
type: integer
totalTime:
description: The total amount of time used to do an inspection.
format: double
type: number
type:
$ref: '#/definitions/inspectionTypeModel'
unitNumber:
description: The number of time units (see timeUnitDuration) comprising an inspection.
type: string
units:
description: The amount of time comprising the smallest time unit for conducting an inspection.
format: double
type: number
vehicleId:
description: A number, such as the license plate number or VIN, that identifies the vehicle used to complete an inspection.
type: string
response_inspectionRelatedModelArray:
type: object
properties:
result:
items:
$ref: '#/definitions/inspectionRelatedModel'
type: array
status:
type: integer
description: The HTTP return status.
inspectionRelatedModel:
type: object
properties:
teamName:
description: Inspection Team name.
type: string
floor:
description: Inspection Floor.
type: string
floorUnit:
description: Inspection Floor Unit.
type: string
address:
$ref: '#/definitions/inspectionAddressModel'
billable:
description: This defines whether or not the item is billable.
enum:
- Y
- N
type: string
category:
description: The inspection category, which is used to organize inspection types. An inspection type is assigned to
one or more inspection categories.
type: string
commentDisplay:
description: Indicates whether or not Accela Citizen Access users can view the inspection results comments.
type: string
commentPublicVisible:
description: "Specifies the type of user who can view the inspection result comments. \"All ACA Users\" - Both registered\
\ and anonymous Accela Citizen Access users can view the comments for inspection results. \"Record Creator Only\"\
\ - the user who created the record can see the comments for the inspection results. \"Record Creator and Licensed\
\ Professional\" - The user who created the record and the licensed professional associated with the record can\
\ see the comments for the inspection results.\t"
items:
type: string
type: array
completedAMPM:
description: Indicates whether completed time is "AM" or "PM".
type: string
completedDate:
description: The date of completion.
format: date-time
type: string
completedTime:
description: The time of completion.
type: string
contact:
$ref: '#/definitions/inspectionContactModel'
contactFirstName:
description: The contact's first name. This field is only active when the Contact Type selected is Individual.
type: string
contactLastName:
description: The last name of the contact.
type: string
contactMiddleName:
description: The middle name of the contact.
type: string
desiredAMPM:
description: Indicates whether the desired inspection time is AM or PM.
type: string
desiredDate:
description: The desired inspection date.
format: date-time
type: string
desiredTime:
description: The desired inspection time.
type: string
endMileage:
description: The ending mileage for the inspection.
format: float
type: number
endTime:
description: The time the inspection was completed.
format: date-time
type: string
estimatedEndTime:
description: inspection estimated end time.
type: string
estimatedStartTime:
description: The scheduled start time for the inspection.
type: string
gisAreaName:
description: The GIS Object ID of the parent application if the application that the inspection is scheduled for has
a parent application that is a project application.
type: string
grade:
description: The name of the inspection grade.
type: string
id:
description: The inspection system id assigned by the Civic Platform server.
format: int64
type: integer
inspectorFullName:
description: The name of the inspector performing the assessment.
type: string
inspectorId:
description: The ID number of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
type: string
isAutoAssign:
description: This defines whether or not you want to automatically reschedule the inspection when the previous inspection
status attains Approved status.
type: string
latitude:
description: The angular distance of a place north or south of the earth's equator, usually expressed in degrees and
minutes.
format: float
type: number
longitude:
description: The angular distance of a place east or west of the meridian at Greenwich, England, usually expressed
in degrees and minutes.
format: float
type: number
majorViolation:
description: The number of major violations.
format: int64
type: integer
overtime:
description: A labor cost factor that indicates time worked beyond a worker's regular working hours.
type: string
priority:
description: The priority level assigned to the inspection.
format: double
type: number
publicVisible:
description: This defines whether or not Accela Citizen Access users can view comment about the inspection results.
type: string
recordId:
$ref: '#/definitions/recordIdModel'
recordType:
$ref: '#/definitions/recordTypeModel_2'
relationship:
description: The type of inspection record relationship.
enum:
- Child
- Parent
- Renewal
type: string
requestAMPM:
description: The time segment, AM or PM, for the time specified in the requestTime field.
type: string
requestComment:
description: Comments about the new inspection. For example, you may identify who requested the inspection.
type: string
requestDate:
description: The date when an inspection request is submitted.
format: date-time
type: string
requestTime:
description: This time is automatically generated when a new inspection is scheduled and submitted.
type: string
requestorFirstName:
description: The first name of the person requesting an inspection-related operation.
type: string
requestorLastName:
description: The last name of the person requesting an inspection-related operation.
type: string
requestorMiddleName:
description: The middle name of the person requesting an inspection-related operation.
type: string
requestorPhone:
description: The telephone number for the person who processes the inspection request or schedules the inspection.
type: string
requestorPhoneIDD:
description: The telephone number for the person who processes the inspection request or schedules the inspection.
type: string
requestorUserId:
description: The user Id of the person requesting an inspection-related operation.
type: string
requiredInspection:
description: This defines whether the inspection is optional or required.
type: string
resultComment:
description: The inspection result comments.
type: string
resultType:
description: 'The type of result that can be ascibed to an inspection. There are three result types: Approved: Approves
(passes) the checklist item. Denied: Denies (fails) the checklist item. Informational: Indicates that the checklist
items do not need a status of app'
type: string
scheduleDate:
description: The date when the inspection gets scheduled.
format: date-time
type: string
scheduleEndAMPM:
description: Indicates whether the scheduleEndTime is in the AM or PM.
enum:
- AM
- PM
type: string
scheduleEndTime:
description: The scheduled end time for the inspection.
type: string
scheduleStartAMPM:
description: AM indicates the 12 hour period from midnight to noon. PM indicates the 12 hour period from noon to midnight.
enum:
- AM
- PM
type: string
scheduleStartTime:
description: The scheduled start time for the inspection.
type: string
serviceProviderCode:
description: The unique agency identifier.
type: string
startMileage:
description: The starting mileage for the inspection.
format: float
type: number
startTime:
description: The time when you started the inspection.
format: date-time
type: string
status:
type: object
description: The inspection status. See [Get All Inspection Statuses](./api-settings.html#operation/v4.get.settings.inspections.statuses).
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
submitAMPM:
description: The time block for the scheduled inspection.
type: string
submitDate:
description: The date that the inspection was submitted.
format: date-time
type: string
submitTime:
description: The time that a new inspection is submitted. Civic Platform generates this value.
type: string
totalMileage:
description: The total mileage for the inspection.
format: float
type: number
totalScore:
description: The overall score of the inspection that includes the inspection result, inspection grade, checklist
total score and checklist major violation option.
format: int64
type: integer
totalTime:
description: The total amount of time used to do an inspection.
format: double
type: number
type:
$ref: '#/definitions/inspectionTypeModel'
unitNumber:
description: The number of time units (see timeUnitDuration) comprising an inspection.
type: string
units:
description: The amount of time comprising the smallest time unit for conducting an inspection.
format: double
type: number
vehicleId:
description: A number, such as the license plate number or VIN, that identifies the vehicle used to complete an inspection.
type: string
requestSchedule_inspectionModel:
type: object
properties:
teamName:
description: Inspection Team name. It's not required if use department.
type: string
floor:
description: Inspection Floor.
type: string
floorUnit:
description: Inspection Floor Unit.
type: string
billable:
description: This defines whether or not the item is billable.
enum:
- Y
- N
type: string
category:
description: The inspection category, which is used to organize inspection types. An inspection type is assigned to
one or more inspection categories.
type: string
commentDisplay:
description: Indicates whether or not Accela Citizen Access users can view the inspection results comments.
type: string
commentPublicVisible:
description: "Specifies the type of user who can view the inspection result comments. \"All ACA Users\" - Both registered\
\ and anonymous Accela Citizen Access users can view the comments for inspection results. \"Record Creator Only\"\
\ - the user who created the record can see the comments for the inspection results. \"Record Creator and Licensed\
\ Professional\" - The user who created the record and the licensed professional associated with the record can\
\ see the comments for the inspection results.\t"
items:
type: string
type: array
completedAMPM:
description: Indicates whether completed time is "AM" or "PM".
type: string
completedDate:
description: The date of completion.
format: date-time
type: string
completedTime:
description: The time of completion.
type: string
contact:
$ref: '#/definitions/inspectionContactModel'
desiredAMPM:
description: Indicates whether the desired inspection time is AM or PM.
type: string
desiredDate:
description: The desired inspection date.
format: date-time
type: string
desiredTime:
description: The desired inspection time.
type: string
endMileage:
description: The ending mileage for the inspection.
format: float
type: number
endTime:
description: The time the inspection was completed.
format: date-time
type: string
estimatedEndTime:
description: inspection estimated end time.
type: string
estimatedStartTime:
description: The scheduled start time for the inspection.
type: string
gisAreaName:
description: The GIS Object ID of the parent application if the application that the inspection is scheduled for has
a parent application that is a project application.
type: string
grade:
description: The name of the inspection grade.
type: string
inspectorId:
description: The ID number of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
type: string
isAutoAssign:
description: This defines whether or not you want to automatically reschedule the inspection when the previous inspection
status attains Approved status.
type: string
latitude:
description: The angular distance of a place north or south of the earth's equator, usually expressed in degrees and
minutes.
format: float
type: number
longitude:
description: The angular distance of a place east or west of the meridian at Greenwich, England, usually expressed
in degrees and minutes.
format: float
type: number
majorViolation:
description: The number of major violations.
format: int64
type: integer
overtime:
description: A labor cost factor that indicates time worked beyond a worker's regular working hours.
type: string
priority:
description: The priority level assigned to the inspection.
format: double
type: number
publicVisible:
description: This defines whether or not Accela Citizen Access users can view comment about the inspection results.
type: string
recordId:
$ref: '#/definitions/recordIdModel'
requestComment:
description: Comments about the new inspection. For example, you may identify who requested the inspection.
type: string
requestorFirstName:
description: The first name of the person requesting an inspection-related operation.
type: string
requestorLastName:
description: The last name of the person requesting an inspection-related operation.
type: string
requestorMiddleName:
description: The middle name of the person requesting an inspection-related operation.
type: string
requestorPhone:
description: The telephone number for the person who processes the inspection request or schedules the inspection.
type: string
requestorPhoneIDD:
description: The telephone number for the person who processes the inspection request or schedules the inspection.
type: string
requestorUserId:
description: The user Id of the person requesting an inspection-related operation.
type: string
requiredInspection:
description: This defines whether the inspection is optional or required.
type: string
resultComment:
description: The inspection result comments.
type: string
resultType:
description: 'The type of result that can be ascibed to an inspection. There are three result types: Approved: Approves
(passes) the checklist item. Denied: Denies (fails) the checklist item. Informational: Indicates that the checklist
items do not need a status of app'
type: string
scheduleEndAMPM:
description: Indicates whether the scheduleEndTime is in the AM or PM.
enum:
- AM
- PM
type: string
scheduleEndTime:
description: The scheduled end time for the inspection.
type: string
scheduleStartAMPM:
description: AM indicates the 12 hour period from midnight to noon. PM indicates the 12 hour period from noon to midnight.
enum:
- AM
- PM
type: string
scheduleStartTime:
description: The scheduled start time for the inspection.
type: string
serviceProviderCode:
description: The unique agency identifier.
type: string
startMileage:
description: The starting mileage for the inspection.
format: float
type: number
startTime:
description: The time when you started the inspection.
format: date-time
type: string
status:
type: object
description: The inspection status. See [Get All Inspection Statuses](./api-settings.html#operation/v4.get.settings.inspections.statuses).
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
totalMileage:
description: The total mileage for the inspection.
format: float
type: number
totalScore:
description: The overall score of the inspection that includes the inspection result, inspection grade, checklist
total score and checklist major violation option.
format: int64
type: integer
totalTime:
description: The total amount of time used to do an inspection.
format: double
type: number
type:
$ref: '#/definitions/inspectionTypeModel'
unitNumber:
description: The number of time units (see timeUnitDuration) comprising an inspection.
type: string
units:
description: The amount of time comprising the smallest time unit for conducting an inspection.
format: double
type: number
vehicleId:
description: A number, such as the license plate number or VIN, that identifies the vehicle used to complete an inspection.
type: string
requestUpdate_inspectionModel:
type: object
properties:
teamName:
description: Inspection Team name. It's not required if use department.
type: string
floor:
description: Inspection Floor.
type: string
floorUnit:
description: Inspection Floor Unit.
type: string
billable:
description: This defines whether or not the item is billable.
enum:
- Y
- N
type: string
category:
description: The inspection category, which is used to organize inspection types. An inspection type is assigned to
one or more inspection categories.
type: string
commentDisplay:
description: Indicates whether or not Accela Citizen Access users can view the inspection results comments.
type: string
commentPublicVisible:
description: "Specifies the type of user who can view the inspection result comments. \"All ACA Users\" - Both registered\
\ and anonymous Accela Citizen Access users can view the comments for inspection results. \"Record Creator Only\"\
\ - the user who created the record can see the comments for the inspection results. \"Record Creator and Licensed\
\ Professional\" - The user who created the record and the licensed professional associated with the record can\
\ see the comments for the inspection results.\t"
items:
type: string
type: array
completedAMPM:
description: Indicates whether completed time is "AM" or "PM".
type: string
completedDate:
description: The date of completion.
format: date-time
type: string
completedTime:
description: The time of completion.
type: string
contact:
$ref: '#/definitions/inspectionContactModel'
desiredAMPM:
description: Indicates whether the desired inspection time is AM or PM.
type: string
desiredDate:
description: The desired inspection date.
format: date-time
type: string
desiredTime:
description: The desired inspection time.
type: string
endMileage:
description: The ending mileage for the inspection.
format: float
type: number
endTime:
description: The time the inspection was completed.
format: date-time
type: string
estimatedEndTime:
description: inspection estimated end time.
type: string
estimatedStartTime:
description: The scheduled start time for the inspection.
type: string
gisAreaName:
description: The GIS Object ID of the parent application if the application that the inspection is scheduled for has
a parent application that is a project application.
type: string
grade:
description: The name of the inspection grade.
type: string
inspectorId:
description: The ID number of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
type: string
isAutoAssign:
description: This defines whether or not you want to automatically reschedule the inspection when the previous inspection
status attains Approved status.
type: string
latitude:
description: The angular distance of a place north or south of the earth's equator, usually expressed in degrees and
minutes.
format: float
type: number
longitude:
description: The angular distance of a place east or west of the meridian at Greenwich, England, usually expressed
in degrees and minutes.
format: float
type: number
majorViolation:
description: The number of major violations.
format: int64
type: integer
overtime:
description: A labor cost factor that indicates time worked beyond a worker's regular working hours.
type: string
publicVisible:
description: This defines whether or not Accela Citizen Access users can view comment about the inspection results.
type: string
requestAMPM:
description: The time segment, AM or PM, for the time specified in the requestTime field.
type: string
requestComment:
description: Comments about the new inspection. For example, you may identify who requested the inspection.
type: string
requestDate:
description: The date when an inspection request is submitted.
format: date-time
type: string
requestTime:
description: This time is automatically generated when a new inspection is scheduled and submitted.
type: string
requestorFirstName:
description: The first name of the person requesting an inspection-related operation.
type: string
requestorLastName:
description: The last name of the person requesting an inspection-related operation.
type: string
requestorMiddleName:
description: The middle name of the person requesting an inspection-related operation.
type: string
requestorPhone:
description: The telephone number for the person who processes the inspection request or schedules the inspection.
type: string
requestorPhoneIDD:
description: The telephone number for the person who processes the inspection request or schedules the inspection.
type: string
requiredInspection:
description: This defines whether the inspection is optional or required.
type: string
resultComment:
description: The inspection result comments.
type: string
resultType:
description: 'The type of result that can be ascibed to an inspection. There are three result types: Approved: Approves
(passes) the checklist item. Denied: Denies (fails) the checklist item. Informational: Indicates that the checklist
items do not need a status of app'
type: string
scheduleEndAMPM:
description: Indicates whether the scheduleEndTime is in the AM or PM.
enum:
- AM
- PM
type: string
scheduleEndTime:
description: The scheduled end time for the inspection.
type: string
scheduleStartAMPM:
description: AM indicates the 12 hour period from midnight to noon. PM indicates the 12 hour period from noon to midnight.
enum:
- AM
- PM
type: string
scheduleStartTime:
description: The scheduled start time for the inspection.
type: string
serviceProviderCode:
description: The unique agency identifier.
type: string
startMileage:
description: The starting mileage for the inspection.
format: float
type: number
startTime:
description: The time when you started the inspection.
format: date-time
type: string
status:
type: object
description: The inspection status. See [Get All Inspection Statuses](./api-settings.html#operation/v4.get.settings.inspections.statuses).
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
submitAMPM:
description: The time block for the scheduled inspection.
type: string
submitDate:
description: The date that the inspection was submitted.
format: date-time
type: string
submitTime:
description: The time that a new inspection is submitted. Civic Platform generates this value.
type: string
totalMileage:
description: The total mileage for the inspection.
format: float
type: number
totalScore:
description: The overall score of the inspection that includes the inspection result, inspection grade, checklist
total score and checklist major violation option.
format: int64
type: integer
totalTime:
description: The total amount of time used to do an inspection.
format: double
type: number
type:
$ref: '#/definitions/inspectionTypeModel'
unitNumber:
description: The number of time units (see timeUnitDuration) comprising an inspection.
type: string
units:
description: The amount of time comprising the smallest time unit for conducting an inspection.
format: double
type: number
vehicleId:
description: A number, such as the license plate number or VIN, that identifies the vehicle used to complete an inspection.
type: string
requestReschedule_inspectionModel:
type: object
properties:
teamName:
description: Inspection Team name. It's not required if use department.
type: string
floor:
description: Inspection Floor.
type: string
floorUnit:
description: Inspection Floor Unit.
type: string
billable:
description: This defines whether or not the item is billable.
enum:
- Y
- N
type: string
category:
description: The inspection category, which is used to organize inspection types. An inspection type is assigned to
one or more inspection categories.
type: string
commentDisplay:
description: Indicates whether or not Accela Citizen Access users can view the inspection results comments.
type: string
commentPublicVisible:
description: "Specifies the type of user who can view the inspection result comments. \"All ACA Users\" - Both registered\
\ and anonymous Accela Citizen Access users can view the comments for inspection results. \"Record Creator Only\"\
\ - the user who created the record can see the comments for the inspection results. \"Record Creator and Licensed\
\ Professional\" - The user who created the record and the licensed professional associated with the record can\
\ see the comments for the inspection results.\t"
items:
type: string
type: array
completedAMPM:
description: Indicates whether completed time is "AM" or "PM".
type: string
completedDate:
description: The date of completion.
format: date-time
type: string
completedTime:
description: The time of completion.
type: string
contact:
$ref: '#/definitions/inspectionContactModel'
desiredAMPM:
description: Indicates whether the desired inspection time is AM or PM.
type: string
desiredDate:
description: The desired inspection date.
format: date-time
type: string
desiredTime:
description: The desired inspection time.
type: string
endMileage:
description: The ending mileage for the inspection.
format: float
type: number
endTime:
description: The time the inspection was completed.
format: date-time
type: string
estimatedEndTime:
description: inspection estimated end time.
type: string
estimatedStartTime:
description: The scheduled start time for the inspection.
type: string
gisAreaName:
description: The GIS Object ID of the parent application if the application that the inspection is scheduled for has
a parent application that is a project application.
type: string
grade:
description: The name of the inspection grade.
type: string
inspectorId:
description: The ID number of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
type: string
isAutoAssign:
description: This defines whether or not you want to automatically reschedule the inspection when the previous inspection
status attains Approved status.
type: string
latitude:
description: The angular distance of a place north or south of the earth's equator, usually expressed in degrees and
minutes.
format: float
type: number
longitude:
description: The angular distance of a place east or west of the meridian at Greenwich, England, usually expressed
in degrees and minutes.
format: float
type: number
majorViolation:
description: The number of major violations.
format: int64
type: integer
overtime:
description: A labor cost factor that indicates time worked beyond a worker's regular working hours.
type: string
publicVisible:
description: This defines whether or not Accela Citizen Access users can view comment about the inspection results.
type: string
recordId:
$ref: '#/definitions/recordIdModel'
requestComment:
description: Comments about the new inspection. For example, you may identify who requested the inspection.
type: string
requestorFirstName:
description: The first name of the person requesting an inspection-related operation.
type: string
requestorLastName:
description: The last name of the person requesting an inspection-related operation.
type: string
requestorMiddleName:
description: The middle name of the person requesting an inspection-related operation.
type: string
requestorPhone:
description: The telephone number for the person who processes the inspection request or schedules the inspection.
type: string
requestorPhoneIDD:
description: The telephone number for the person who processes the inspection request or schedules the inspection.
type: string
requestorUserId:
description: The user Id of the person requesting an inspection-related operation.
type: string
requiredInspection:
description: This defines whether the inspection is optional or required.
type: string
resultComment:
description: The inspection result comments.
type: string
resultType:
description: 'The type of result that can be ascibed to an inspection. There are three result types: Approved: Approves
(passes) the checklist item. Denied: Denies (fails) the checklist item. Informational: Indicates that the checklist
items do not need a status of app'
type: string
scheduleDate:
description: The date when the inspection is scheduled.
format: date-time
type: string
scheduleEndAMPM:
description: Indicates whether the scheduleEndTime is in the AM or PM.
enum:
- AM
- PM
type: string
scheduleEndTime:
description: The scheduled end time for the inspection.
type: string
scheduleStartAMPM:
description: AM indicates the 12 hour period from midnight to noon. PM indicates the 12 hour period from noon to midnight.
enum:
- AM
- PM
type: string
scheduleStartTime:
description: The scheduled start time for the inspection.
type: string
serviceProviderCode:
description: The unique agency identifier.
type: string
startMileage:
description: The starting mileage for the inspection.
format: float
type: number
startTime:
description: The time when you started the inspection.
format: date-time
type: string
status:
type: object
description: The inspection status. See [Get All Inspection Statuses](./api-settings.html#operation/v4.get.settings.inspections.statuses).
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
totalMileage:
description: The total mileage for the inspection.
format: float
type: number
totalScore:
description: The overall score of the inspection that includes the inspection result, inspection grade, checklist
total score and checklist major violation option.
format: int64
type: integer
totalTime:
description: The total amount of time used to do an inspection.
format: double
type: number
type:
$ref: '#/definitions/inspectionTypeModel'
unitNumber:
description: The number of time units (see timeUnitDuration) comprising an inspection.
type: string
units:
description: The amount of time comprising the smallest time unit for conducting an inspection.
format: double
type: number
vehicleId:
description: A number, such as the license plate number or VIN, that identifies the vehicle used to complete an inspection.
type: string
inspectionAddressModel:
type: object
properties:
addressLine1:
type: string
description: The first line of the address.
addressLine2:
type: string
description: The first line of the address.
addressTypeFlag:
type: object
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
description: A code name or an abbreviation of the address type.
city:
type: string
description: The name of the city.
country:
type: object
description: The name of the country. See [Get All Address Countries](./api-settings.html#operation/v4.get.settings.addresses.countries).
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
county:
type: string
description: The name of the county.
description:
type: string
description: A description of the address.
direction:
description: The street direction of the primary address associated with the application.
type: object
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
distance:
type: number
format: double
description: The distance from another landmark used to locate the address.
houseAlphaStart:
type: string
description: The beginning alphabetic unit in street address.
houseAlphaEnd:
type: string
description: The ending alphabetic unit in street address.
houseFractionStart:
type: object
description: Beginning fraction value used in combination with the Street number fields.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
houseFractionEnd:
type: object
description: Ending franction value used in combination with the Street number fields.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
id:
format: int64
type: integer
description: The unique address id assigned by the Civic Platform server.
inspectionDistrict:
type: string
description: The inspection district where the address is located.
inspectionDistrictPrefix:
type: string
description: The prefix for the inspection district where the address is located.
isPrimary:
type: string
description: Indicates whether or not to designate the address as the primary address. Only one address can be primary
at any given time.
levelStart:
type: string
description: The starting level number (floor number) that makes up the address within a complex.
levelEnd:
type: string
description: The ending level number (floor number) that makes up the address within a complex.
levelPrefix:
type: string
description: The prefix for the level numbers (floor numbers) that make up the address.
neighborhood:
type: string
description: The neighborhood where the address is located.
neighborhoodPrefix:
type: string
description: The prefix for neighborhood where the address is located.
postalCode:
type: string
description: The postal ZIP code for the address.
recordId:
$ref: '#/definitions/recordIdModel'
refAddressId:
description: The reference address id.
format: int64
type: integer
secondaryStreet:
type: string
description: This field (along with the Secondary Road Number field) displays an extra description for the location
when two roads that cross or a street with two names makes up the address of the location.
secondaryStreetNumber:
type: number
format: long
description: This field (along with the Secondary Road field) displays an extra description for the location when
two roads that cross or a street with two names makes up the address of the location.
serviceProviderCode:
description: The unique agency identifier.
type: string
state:
type: object
description: The name of the state.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
status:
type: object
description: The address status indicating whether the address is active or inactive.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
streetAddress:
type: string
description: The street address.
streetEnd:
type: number
format: long
description: The ending number of a street address range.
streetEndFrom:
description: The beginning number of a street end address range.
format: int64
type: integer
streetEndTo:
description: The ending number of a street end address range.
format: int64
type: integer
streetName:
type: string
description: The name of the street.
streetPrefix:
type: string
description: Any part of an address that appears before a street name or number. For example, if the address is 123
West Main, "West" is the street prefix.
streetStart:
type: number
format: long
description: The starting number of a street address range.
streetStartFrom:
description: The beginning number of a street start address range.
format: int64
type: integer
streetStartTo:
description: The ending number of a street start address range.
format: int64
type: integer
streetSuffix:
type: object
description: The type of street such as "Lane" or "Boulevard".
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
streetSuffixDirection:
type: object
description: The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW"
is the street suffix direction.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
unitStart:
type: string
description: The starting value of a range of unit numbers.
unitEnd:
type: string
description: The ending value of a range of unit numbers.
unitType:
type: object
description: The unit type designation of the address.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
xCoordinate:
type: number
format: double
description: The longitudinal coordinate for this address.
yCoordinate:
type: number
format: double
description: The latitudinal coordinate for this address.
inspectionContactModel:
type: object
properties:
address:
$ref: '#/definitions/ownerAddressModel'
birthCity:
type: object
description: The city of birth for an individual.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
birthDate:
description: The birth date.
format: date-time
type: string
birthRegion:
type: object
description: The country of birth or region of birth for an individual.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
birthState:
type: object
description: The state of birth for an individual.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
businessName:
description: A secondary business name for the applicable individual.
type: string
comment:
description: A comment about the inspection contact.
type: string
deceasedDate:
description: The deceased date.
format: date-time
type: string
driverLicenseNumber:
description: The driver's license number of the contact. This field is active only when the Contact Type selected
is Individual.
type: string
driverLicenseState:
type: object
description: The state that issued the driver's license.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
email:
description: The contact's email address.
type: string
fax:
description: The fax number for the contact.
type: string
faxCountryCode:
description: Fax Number Country Code
type: string
federalEmployerId:
description: The Federal Employer Identification Number. It is used to identify a business for tax purposes.
type: string
firstName:
description: The contact's first name.
type: string
fullName:
description: 'The contact''s full name. '
type: string
gender:
type: object
description: The gender (male or female) of the individual.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
id:
description: The contact system id assigned by the Civic Platform server.
type: string
individualOrOrganization:
description: The organization to which the contact belongs. This field is only active when the Contact Type selected
is Organization.
type: string
lastName:
description: The last name (surname).
type: string
middleName:
description: "The middle name.\t"
type: string
organizationName:
description: The organization to which the contact belongs. This field is only active when the Contact Type selected
is Organization.
type: string
passportNumber:
description: The contact's passport number. This field is only active when the Contact Type selected is Individual.
type: string
phone1:
description: The primary telephone number of the contact.
type: string
phone1CountryCode:
description: Phone Number 1 Country Code
type: string
phone2:
description: The secondary telephone number of the contact.
type: string
phone2CountryCode:
description: Phone Number 2 Country Code
type: string
phone3:
description: The tertiary telephone number for the contact.
type: string
phone3CountryCode:
description: Phone Number 3 Country Code
type: string
postOfficeBox:
description: The post office box number.
type: string
preferredChannel:
type: object
description: The method by which the contact prefers to be notified, by phone for example. See [Get All Contact Preferred
Channels](./api-settings.html#operation/v4.get.settings.contacts.preferredChannels).
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
race:
type: object
description: The contact's race or ethnicity. See [Get All Contact Races](./api-settings.html#operation/v4.get.settings.contacts.races).
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
relation:
type: object
description: The contact's relationship to the application or service request.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
salutation:
type: object
description: The salutation to be used when addressing the contact; for example Mr. oar Ms. This field is active only
when Contact Type = Individual. See [Get All Contact Salutations](./api-settings.html#operation/v4.get.settings.contacts.salutations).
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
serviceProviderCode:
description: The unique agency identifier.
type: string
socialSecurityNumber:
description: The individual's social security number. This field is only active when the Contact Type selected is
Individual.
type: string
stateIdNumber:
description: The contact's state ID number. This field is only active when the Contact Type selected is Individual.
type: string
status:
type: object
description: The contact status.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
suffix:
description: The contact name suffix.
type: string
title:
description: The individual's business title.
type: string
tradeName:
description: The contact's preferred business or trade name. This field is active only when the Contact Type selected
is Organization.
type: string
type:
type: object
description: The contact type. See [Get All Contact Types](./api-settings.html#operation/v4.get.settings.contacts.types).
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
ownerAddressModel:
type: object
properties:
addressLine1:
description: The first line of the address.
type: string
addressLine2:
description: The second line of the address.
type: string
addressLine3:
description: The third line of the address.
type: string
city:
description: The name of the city.
type: string
country:
type: object
description: ''
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
postalCode:
description: The postal ZIP code for the address.
type: string
state:
type: object
description: ''
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
recordIdModel:
type: object
properties:
customId:
description: An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx).
Accela Automation auto-generates and applies an alternate ID value when you submit a new application.
type: string
id:
description: The record system id assigned by the Civic Platform server.
type: string
serviceProviderCode:
description: The unique agency identifier.
type: string
trackingId:
description: The application tracking number (IVR tracking number).
format: int64
type: integer
value:
description: The alphanumeric record id.
type: string
recordTypeModel_2:
type: object
properties:
category:
description: The 4th level in a 4-level record type structure (Group-Type-Subtype-Category).
type: string
filterName:
description: The name of the record type filter which defines the record types to be displayed for the citizen user.
type: string
group:
description: The 1st level in a 4-level record type structure (Group-Type-Subtype-Category).
type: string
id:
description: The record type system id assigned by the Civic Platform server.
type: string
module:
description: Use to filter by the module. See [Get All Modules](./api-settings.html#operation/v4.get.settings.modules).
type: string
subType:
description: The 3rd level in a 4-level record type structure (Group-Type-Subtype-Category).
type: string
text:
description: The record type display text
type: string
type:
description: The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category).
type: string
value:
description: The record type value.
type: string
inspectionTypeModel:
type: object
properties:
group:
description: The name of a group of inspection types.
type: string
id:
description: The inspection type system id assigned by the Civic Platform server.
format: int64
type: integer
text:
description: The inspection type display text.
type: string
value:
description: The inspection type value.
type: string
response_inspectionAvailabilityArray:
type: object
properties:
result:
items:
$ref: '#/definitions/inspectionAvailabilityArray'
type: array
status:
type: integer
description: The HTTP return status.
inspectionAvailabilityArray:
type: object
properties:
availableDates:
items:
$ref: '#/definitions/availableDatesArray'
type: array
inspectorId:
type: string
description: The inspector userid whose availability is specified in availableDates[].
availableDatesArray:
type: object
properties:
date:
type: string
format: date
description: A date during which the inspector is available.
times:
items:
$ref: '#/definitions/availableTimesArray'
type: array
availableTimesArray:
type: object
properties:
startTime:
type: string
format: time
description: A start time (hh:mm:ss 24-hour format) the inspector is available.
endTime:
type: string
format: time
description: The corresponding end time (hh:mm:ss 24-hour format) the inspector is available.
startDate:
type: string
format: time
description: Deprecated.
endDate:
type: string
format: time
description: Deprecated.
response_resultModelArray:
type: object
properties:
result:
items:
$ref: '#/definitions/resultModel'
type: array
status:
type: integer
description: The HTTP return status.
response_checklistModelArray:
type: object
properties:
result:
items:
$ref: '#/definitions/checklistModel'
type: array
status:
type: integer
description: The HTTP return status.
response_resultModel:
type: object
properties:
result:
$ref: '#/definitions/resultModel'
status:
type: integer
description: The HTTP return status.
resultModel:
type: object
properties:
code:
description: The error code, if an error is encountered.
type: string
id:
description: The system id of the object in this operation.
format: int64
type: integer
isRequired:
description: Indicates whether or not the field is required.
enum:
- Y
- N
type: string
isSuccess:
description: Indicates whether or not the operation on the object is successful.
type: boolean
message:
description: The error message, if an error is encountered
type: string
checklistModel:
type: object
properties:
code:
description: The error code, if an error is encountered.
type: string
id:
description: The system id of the object in this operation.
format: int64
type: integer
isRequired:
description: Indicates whether or not the field is required.
enum:
- Y
- N
type: string
isSuccess:
description: Indicates whether or not the operation on the object is successful.
type: boolean
message:
description: The error message, if an error is encountered
type: string
response_customTablesModelArray:
type: object
properties:
result:
items:
$ref: '#/definitions/customTablesModel'
type: array
status:
type: integer
description: The HTTP return status.
customTablesModel:
type: object
properties:
code:
type: string
message:
type: string
more:
type: string
page:
$ref: '#/definitions/pageModel'
resultStatus:
$ref: '#/definitions/customTablesStatusModel'
result:
type: string
status:
format: int64
type: integer
traceId:
type: string
pageModel:
type: object
properties:
offset:
type: integer
description: The requested offset start.
limit:
type: integer
description: The requested result limit.
total:
type: integer
description: The total number of records found.
hasmore:
type: boolean
description: true if there are more results to fetch; false if all results have been fetched.
response_customTableMetadataModelArray:
type: object
properties:
result:
items:
$ref: '#/definitions/customTableMetadataModel'
type: array
status:
type: integer
description: The HTTP return status.
customTableMetadataModel:
description: Contains the metadata for a custom table.
type: object
properties:
displayOrder:
description: The custom table's display order.
format: int64
type: integer
fields:
items:
$ref: '#/definitions/customTableMetadataFields'
type: array
id:
description: The custom table id.
type: string
text:
description: The custom table name.
type: string
customTableMetadataFields:
type: object
properties:
displayOrder:
description: The field's display order.
format: int64
type: integer
fieldType:
description: The field's data type.
type: string
id:
description: The field id.
type: string
isReadonly:
description: Indicates whether or not the field is read-only.
enum:
- Y
- N
type: string
isRequired:
description: Indicates whether or not the field is required.
enum:
- Y
- N
type: string
maxLength:
description: The field's maximum field length.
format: int64
type: integer
customTablesStatusDetailModel:
type: object
properties:
code:
format: int64
type: integer
message:
type: string
traceId:
type: string
customTablesStatusModel:
type: object
properties:
detail:
$ref: '#/definitions/customTablesStatusDetailModel'
status:
format: int64
type: integer
inspectionChecklist_rowModel:
type: object
required:
- action
- fields
- id
properties:
action:
description: Specifies whether to add, update, or delete the custom table row.
enum:
- add
- update
- delete
type: string
fields:
$ref: '#/definitions/customAttributeModel'
id:
description: The unique identifier for the custom field. Required only if modifying or deleting a row.
type: string
inpsectionChecklistItem_customTable:
type: object
properties:
id:
description: The custom table id.
type: string
rows:
items:
$ref: '#/definitions/inspectionChecklist_rowModel'
type: array
response_timeLogModelArray:
type: object
properties:
result:
items:
$ref: '#/definitions/timeLogModel'
type: array
status:
type: integer
description: The HTTP return status.
response_timeLogModel:
type: object
properties:
result:
$ref: '#/definitions/timeLogModel'
status:
type: integer
description: The HTTP return status.
timeLogModel:
type: object
properties:
billable:
description: Indicates whether or not the item is billable.
enum:
- Y
- N
type: string
cost:
description: The calculated cost of the entry.
format: double
type: number
createBy:
description: The unique user id of the individual that created this entry.
type: string
createDate:
description: "\tThe date the entry was created."
format: date-time
type: string
detailDuration:
description: Contains details about the time accounting duration.
items:
$ref: '#/definitions/costingQuantityModel'
type: array
duration:
description: The duration of the entry, using the format hh:mm.
type: string
endTime:
description: The end time for the time accounting entry.
type: string
entity:
description: The entity associated with the time accounting item.
type: string
entityId:
description: The unique ID of the entity or record.
type: string
entityType:
description: The type of entity, such as "Record".
type: string
group:
type: object
description: The time accounting group. See [Get All Time Accounting Groups](./api-settings.html#operation/v4.get.settings.timeAccounting.groups).
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
id:
description: The time accounting entry's system id assigned by the Civic Platform server.
format: int64
type: integer
percent:
description: The percentage point for calculating the cost. 50 stands for 50%, 80 stands for 80%, and 150 stands for
150%.
format: double
type: number
rate:
description: The cost rate.
format: double
type: number
recordId:
$ref: '#/definitions/recordIdModel'
serviceProviderCode:
description: The unique agency identifier.
type: string
startTime:
description: The start time of the time accounting entry.
type: string
totalMinutes:
description: The total number of billable minutes.
format: int64
type: integer
type:
type: object
description: The time accounting type. See [Get All Time Accounting Types](./api-settings.html#operation/v4.get.settings.timeAccounting.types).
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
userId:
description: The userid assigned to the time accounting entry.
type: string
request_timeLogModel:
type: object
properties:
billable:
description: Indicates whether or not the item is billable.
enum:
- Y
- N
type: string
cost:
description: The calculated cost of the entry.
format: double
type: number
createBy:
description: The unique user id of the individual that created this entry.
type: string
createDate:
description: "\tThe date the entry was created."
format: date-time
type: string
duration:
description: The duration of the entry, using the format hh:mm.
type: string
endTime:
description: The end time for the time accounting entry.
type: string
entityId:
description: The unique ID of the entity or record.
type: string
entityType:
description: The type of entity, such as "Record".
type: string
group:
type: object
description: The time accounting group. See [Get All Time Accounting Groups](./api-settings.html#operation/v4.get.settings.timeAccounting.groups).
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
id:
description: The time accounting entry's system id assigned by the Civic Platform server.
format: int64
type: integer
percent:
description: The percentage point for calculating the cost. 50 stands for 50%, 80 stands for 80%, and 150 stands for
150%.
format: double
type: number
rate:
description: The cost rate.
format: double
type: number
recordId:
$ref: '#/definitions/recordIdModel'
serviceProviderCode:
description: The unique agency identifier.
type: string
startTime:
description: The start time of the time accounting entry.
type: string
totalMinutes:
description: The total number of billable minutes.
format: int64
type: integer
type:
type: object
description: The time accounting type. See [Get All Time Accounting Types](./api-settings.html#operation/v4.get.settings.timeAccounting.types).
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
userId:
description: The userid assigned to the time accounting entry.
type: string
costingQuantityModel:
type: object
properties:
factor:
description: The cost factor.
format: double
type: number
minutes:
description: The duration in minutes.
format: double
type: number
userRolePrivilegeModel:
type: object
properties:
contactAllowed:
description: Indicates whether or not the permission is given to a contact.
type: boolean
deleteAllowed:
description: "Indicates whether or not the permission to delete a document is allowed.\t"
type: boolean
downloadAllowed:
description: Indicates whether or not the permission to download a document is allowed.
type: boolean
licenseTypeRules:
items:
type: string
description: "A string array containing the types of licensed professionals who are given the permission.\t"
type: array
licensendProfessionalAllowed:
description: Indicates whether or not the permission is given to a licensed professional.
type: boolean
ownerAllowed:
description: Indicates whether or not the permission is given to an owner.
type: boolean
recordCreatorAllowed:
description: Indicates whether or not the permission is given to a record creator.
type: boolean
registeredUserAllowed:
description: Indicates whether or not the permission is given to a registered public user.
type: boolean
titleViewAllowed:
description: Indicates whether or not the permission to view a document name is allowed.
type: boolean
uploadAllowed:
description: Indicates whether or not the permission to upload a document is allowed.
type: boolean
response_inspectorModelArray:
type: object
properties:
result:
items:
$ref: '#/definitions/inspectorModel'
type: array
status:
type: integer
description: The HTTP return status.
response_inspectorModel:
type: object
properties:
result:
$ref: '#/definitions/inspectorModel'
status:
type: integer
description: The HTTP return status.
inspectorModel:
type: object
properties:
department:
type: object
description: The name of the department where the inspector works.
properties:
text:
description: The localized display value.
type: string
value:
description: The data value.
type: string
email:
description: The inspector's email address.
type: string
firstName:
description: The inspector's first name.
type: string
id:
description: The inspector id.
type: string
lastName:
description: The inspector's last name.
type: string
middleName:
description: The inspector's middle name.
type: string
mobilePhone:
description: The inspector's mobile phone number.
type: string
preferredChannel:
description: The method by which the inspector prefers to be notified, by phone for example.
type: string
parameters:
authHeaderParam:
description: Construct oAuth2 authentication token
in: header
name: Authorization
required: true
type: string
expand:
description: 'Parameter to bring comment group. '
in: query
name: expand
required: false
type: string
offset:
description: The offset position of the first record in the results response array. For example, if offset is 100, the
first item in the results array in the response is the 100th record in the search result list.
format: int64
in: query
name: offset
required: false
type: integer
limit:
description: Search result size limit.
format: int64
in: query
name: limit
required: false
type: integer
enum:
- range[1,1000]
fields:
description: Comma-delimited names of fields to be returned in the response. Note - Field names are case-sensitive and
only first-level fields are supported. Invalid field names are ignored.
in: query
name: fields
required: false
type: string
lang:
description: Language parameter to support I18N. Default language is en_US.
in: query
name: lang
required: false
type: string
inspectionId:
description: The ID of the inspection to fetch. See [Get All Inspections](./api-inspections.html#operation/v4.get.inspections),
[Search Inspections](./api-search.html#operation/v4.post.search.inspections).
format: int64
in: path
name: inspectionId
required: true
type: integer
idInspection:
description: The ID of the inspection to fetch. See [Get All Inspections](./api-inspections.html#operation/v4.get.inspections),
[Search Inspections](./api-search.html#operation/v4.post.search.inspections).
format: int64
in: path
name: id
required: true
type: integer
checklistId:
description: The ID of the inspection checklist to fetch. See [Get All Inspection Checklists](./api-settings.html#operation/v4.get.settings.inspections.checklists),
[Get All Checklists for Inspection](./api-inspections.html#operation/v4.get.inspections.inspectionId.checklists).
format: int64
in: path
name: checklistId
required: true
type: integer
checklistItemId:
description: The ID of the inspection checklist item to fetch. See [Get All Checklist Items for Checklist](./api-inspections.html#operation/v4.get.inspections.inspectionId.checklists.checklistId.checklistItems).
format: int64
in: path
name: checklistItemId
required: true
type: integer
inspectionIdString:
description: The ID of the inspection to fetch. See [Get All Inspections](./api-inspections.html#operation/v4.get.inspections),
[Search Inspections](./api-search.html#operation/v4.post.search.inspections).
in: path
name: inspectionId
required: true
type: string
checklistIdString:
description: The ID of the inspection checklist to fetch. See [Get All Inspection Checklists](./api-settings.html#operation/v4.get.settings.inspections.checklists),
[Get All Checklists for Inspection](./api-inspections.html#operation/v4.get.inspections.inspectionId.checklists).
in: path
name: checklistId
required: true
type: string
checklistItemIdString:
description: The ID of the inspection checklist item to fetch. See [Get All Checklist Items for Checklist](./api-inspections.html#operation/v4.get.inspections.inspectionId.checklists.checklistId.checklistItems).
in: path
name: checklistItemId
required: true
type: string
serviceProviderCode:
description: The unique agency identifier.
in: query
name: serviceProviderCode
required: true
type: string
x-api-evangelist-provenance:
generated: '2026-09-06'
method: searched
source: https://developer.accela.com/api/v4/v4-inspections.json
note: Harvested verbatim from the Accela Developer Portal API Reference, which renders these Swagger 2.0 documents via ReDoc
(spec-url on developer.accela.com/docs/api_reference/api-*.html). The byte-identical original is kept at openapi/_original/.
This copy is the same document serialized to YAML.