basePath: /
host: apis.accela.com
info:
  description: The Settings API provides configuration values that have been defined in Civic Platform Administration, typically
    as standard choice values. The Settings APIs are helpful when you need reference or custom-configured values in your API
    calls.
  title: Settings
  version: v4
schemes:
- https
swagger: '2.0'
paths:
  /v4/settings/activities/priorities:
    get:
      description: "Gets a list of available priorities.\n\n\n\n**API Endpoint**: GET /v4/settings/activities/priorities\n\
        \n**Scope**:  settings \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.3\n\n"
      summary: Get All Activity Priorities
      operationId: v4.get.settings.activities.priorities
      tags:
      - Settings/Activities
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/activities/statuses:
    get:
      description: "Gets all status values associated with activities.\n\n\n\n**API Endpoint**:  GET /v4/settings/activities/statuses\
        \ \n\n**Scope**:  settings \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.3\n\n"
      summary: Get All Activity Statuses
      operationId: v4.get.settings.activities.statuses
      tags:
      - Settings/Activities
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/activities/types:
    get:
      description: "Gets all type values associated with activities.\n\n\n\n**API Endpoint**:  GET /v4/settings/activities/types\
        \ \n\n**Scope**:  settings \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.3\n\n"
      summary: Get All Activity Types
      operationId: v4.get.settings.activities.types
      tags:
      - Settings/Activities
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: Filter by entity type.
        in: query
        name: entityType
        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_settingValueModelArray'
        '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/settings/addresses/countries:
    get:
      description: "Gets the countries for use in an address.\n\n\n\n**API Endpoint**:  GET /v4/settings/addresses/countries\
        \ \n\n**Scope**:  addresses \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.2\n\n"
      summary: Get All Address Countries
      operationId: v4.get.settings.addresses.countries
      tags:
      - Settings/Addresses
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/addresses/customForms:
    get:
      summary: Get Metadata for Address Custom Forms
      description: "Returns the field metadata for all address custom forms (address templates) in the system.\n\n\n\n**API\
        \ Endpoint**:  GET /v4/settings/addresses/customForms \n\n**Scope**:  addresses \n\n**App Type**:  All \n\n**Authorization\
        \ Type**:  Access token \n\n**Civic Platform version**: 9.3.0\n\n"
      tags:
      - Settings/Addresses
      operationId: v4.get.settings.addresses.customForms
      parameters:
      - description: Construct oAuth2 authentication token
        in: header
        name: Authorization
        required: true
        type: string
      - description: Language parameter to support I18N. Default language is en_US
        in: query
        name: lang
        required: false
        type: string
      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_apo_customForms_metadata'
        '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/settings/addresses/states:
    get:
      description: "Gets the states for use in an address.\n\n\n\n**API Endpoint**:  /v4/settings/addresses/states GET \n\n\
        **Scope**:  addresses \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.2\n\n"
      summary: Get All Address States
      operationId: v4.get.settings.addresses.states
      tags:
      - Settings/Addresses
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/addresses/streetDirections:
    get:
      description: "Gets the street directions for use in an address.\n\n\n\n**API Endpoint**:  GET /v4/settings/addresses/streetDirections\
        \ \n\n**Scope**:  addresses \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.2\n\n"
      summary: Get All Address Street Directions
      operationId: v4.get.settings.addresses.streetDirections
      tags:
      - Settings/Addresses
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/addresses/streetFractions:
    get:
      description: "Gets the street fractions for use in an address.\n\n\n\n**API Endpoint**:  GET /v4/settings/addresses/streetFractions\
        \ \n\n**Scope**:  addresses \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.2\n\n"
      summary: Get All Address Street Fractions
      operationId: v4.get.settings.addresses.streetFractions
      tags:
      - Settings/Addresses
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/addresses/streetSuffixes:
    get:
      description: "Gets the street types for use in an address.\n\n\n\n**API Endpoint**:  GET /v4/settings/addresses/streetSuffixes\
        \ \n\n**Scope**:  addresses \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.2\n\n"
      summary: Get All Address Street Suffixes
      operationId: v4.get.settings.addresses.streetSuffixes
      tags:
      - Settings/Addresses
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/addresses/unitTypes:
    get:
      description: "Gets the unit types for use in an address.\n\n\n\n**API Endpoint**:  GET /v4/settings/addresses/unitTypes\
        \ \n\n**Scope**:  addresses \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.2\n\n"
      summary: Get All Address Unit Types
      operationId: v4.get.settings.addresses.unitTypes
      tags:
      - Settings/Addresses
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/assessments/types:
    get:
      description: "Returns all active condition assessment types configured in Civic Platform Administration.\n\n\n\n**API\
        \ Endpoint**:  GET /v4/settings/assessments/types \n\n**Scope**:  records \n\n**App Type**:  Agency \n\n**Authorization\
        \ Type**:  Access token \n\n**Civic Platform version**: 9.0.0\n\n"
      summary: Get All Condition Assessment Types
      operationId: v4.get.settings.assessments.types
      tags:
      - Settings/Assessments
      parameters:
      - $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_conditionAssessmentModelArray'
        '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/settings/assets/groups:
    get:
      description: "Get all configured asset groups.\n\n\n\n**API Endpoint**:  GET /v4/settings/assets/groups \n\n**Scope**:\
        \  assets \n\n**App Type**:  Agency \n\n**Authorization Type**:  No authorization required \n\n**Civic Platform version**:\
        \ 9.0.0\n\n"
      summary: Get All Asset Groups
      operationId: v4.get.settings.assets.groups
      tags:
      - Settings/Assets
      parameters:
      - $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_settingValueModelArray'
        '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/settings/assets/sizeUnits:
    get:
      description: "Gets all configured asset size units.\n\n\n\n**API Endpoint**:  GET /v4/settings/assets/sizeUnits \n\n\
        **Scope**:  assets \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 9.0.0\n\n"
      summary: Get All Asset Size Units
      operationId: v4.get.settings.assets.sizeUnits
      tags:
      - Settings/Assets
      parameters:
      - $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_settingValueModelArray'
        '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/settings/assets/statuses:
    get:
      description: "Gets all configured asset statuses.\n\n\n\n**API Endpoint**:  GET /v4/settings/assets/statuses \n\n**Scope**:\
        \  assets \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: 9.0.0\n\
        \n"
      summary: Get All Asset Statuses
      operationId: v4.get.settings.assets.statuses
      tags:
      - Settings/Assets
      parameters:
      - $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_settingValueModelArray'
        '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/settings/assettypes/classTypes:
    get:
      description: "Returns all out-of-the-box asset class types in Civic Platform.\n\n\n\n**API Endpoint**:  GET /v4/settings/assettypes/classTypes\
        \ \n\n**Scope**:  assets \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 9.0.0\n\n"
      summary: Get All Asset Class Types
      operationId: v4.get.settings.assettypes.classTypes
      tags:
      - Settings/Asset Types
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/limit'
      - $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:
            description: Contains the class types.
            type: object
            properties:
              result:
                items:
                  type: string
                  description: An asset class type
                type: array
              status:
                type: integer
                description: The HTTP return status.
        '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/settings/assettypes/ratingTypes:
    get:
      description: "Returns all configured asset rating types. Specify both {assetType} and {assetGroup} parameters to filter\
        \ by asset type and asset group.\n\n\n\n**API Endpoint**:  GET /v4/settings/assettypes/ratingTypes \n\n**Scope**:\
        \  assets \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: 9.0.0\n\
        \n"
      summary: Get All Asset Rating Types
      operationId: v4.get.settings.assettypes.ratingTypes
      tags:
      - Settings/Asset Types
      parameters:
      - description: '**NOTE: If this parameter is provided, then assetType is required. If this parameter is omitted, then
          assetType must also be omitted too.** Filter by asset group. For example: Water or Street. An Asset Group is an
          agency-defined collection of objects the agency owns or maintains.'
        in: query
        name: assetGroup
        type: string
      - description: '**NOTE: If this parameter is provided, then assetGroup is required. If this parameter is omitted, assetGroup
          must also be omitted too.** Filter by type of asset. For example: Hydrant or Manhole. An Asset Type is an agencydefined
          classification of similar objects that share the same standard asset attributes. Related asset types belong to an
          asset group, and multiple asset types can share the same Class Type. See [Get All Asset Types](./api-settings.html#operation/v4.get.settings.assettypes.types).'
        in: query
        name: assetType
        type: string
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/limit'
      - $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_ratingTypeModelArray'
        '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/settings/assettypes/recordtypes:
    get:
      description: "Returns all configured record types for a given asset type or asset group.\n\n\n\n**API Endpoint**:  GET\
        \ /v4/settings/assettypes/recordtypes \n\n**Scope**:  settings \n\n**App Type**:  Agency \n\n**Authorization Type**:\
        \  Access token \n\n**Civic Platform version**: 9.0.0\n\n"
      summary: Get All Record Types for Asset Type
      operationId: v4.get.settings.assettypes.recordtypes
      tags:
      - Settings/Asset Types
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: 'Filter by asset group. For example: Water or Street. An Asset Group is an agency-defined collection
          of objects the agency owns or maintains.'
        in: query
        name: assetGroup
        required: true
        type: string
      - description: 'Filter by type of asset. For example: Hydrant or Manhole. An Asset Type is an agencydefined classification
          of similar objects that share the same standard asset attributes. Related asset types belong to an asset group,
          and multiple asset types can share the same Class Type. See [Get All Asset Types](./api-settings.html#operation/v4.get.settings.assettypes.types).'
        in: query
        name: assetType
        type: string
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/limit'
      - $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_assetRecordTypeModelArray'
        '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/settings/assettypes/types:
    get:
      description: "Returns all asset types, which can be filtered by asset group.\n\n\n\n**API Endpoint**: GET /v4/settings/assettypes/types\
        \ \n\n**Scope** : assets\n\n**App Type** : Agency\n\n**Authorization Type** : Access token\n\n**Civic Platform version**\
        \ : 9.0.0\n\n "
      summary: Get All Asset Types
      operationId: v4.get.settings.assettypes.types
      tags:
      - Settings/Asset Types
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: Filter by asset group.
        in: query
        name: assetGroup
        type: string
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/limit'
      - $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_assetTypeModelArray'
        '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/settings/assettypes/usageTypes:
    get:
      description: "Returns all configured asset usage types.\n\n\n\n**API Endpoint**:  GET /v4/settings/assettypes/usageTypes\
        \ \n\n**Scope**:  assets \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 9.0.0\n\n"
      summary: Get All Asset Usage Types
      operationId: v4.get.settings.assettypes.usageTypes
      tags:
      - Settings/Asset Types
      parameters:
      - description: Asset group filter
        in: query
        name: assetGroup
        type: string
      - description: Asset type filter
        in: query
        name: assetType
        type: string
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/limit'
      - $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_assetUnitTypeModelArray'
        '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/settings/comments:
    get:
      description: "Gets the standard comments available in the system.\n\n\n\n**API Endpoint**:  GET v4/settings/comments\
        \ \n\n**Scope**:  settings \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.2\n\n"
      summary: Get All Standard Comments
      operationId: v4.get.settings.comments
      tags:
      - Settings/Comments
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: Filter by group.
        in: query
        name: groups
        required: false
        type: string
      - description: 'Filter by one or more (comma-delimited) standard comment types. For valid values, use types[] in [Get
          All Standard Comment Groups](./api-settings.html#operation/v4.get.settings.comments.groups).


          **Civic Platform version**: 9.3.0


          '
        in: query
        name: types
        required: false
        type: string
      - $ref: '#/parameters/lang'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/limit'
      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_standardCommentModelArray'
        '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/settings/comments/groups:
    get:
      description: "Gets available standard comment groups.\n\n\n\n**API Endpoint**:  GET /v4/settings/comments/groups \n\n\
        **Scope**:  settings \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.2\n\n"
      summary: Get All Standard Comment Groups
      operationId: v4.get.settings.comments.groups
      tags:
      - Settings/Comments
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/lang'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/limit'
      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_standardCommentGroupModelArray'
        '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/settings/conditionApprovals/statuses:
    get:
      description: "Gets the statuses for use with a conditon of approval.\n\n\n\n**API Endpoint**:  GET /v4/settings/conditionApprovals/statuses\
        \ \n\n**Scope**:  conditions \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.2\n\n"
      summary: Get All Approval Condition Statuses
      operationId: v4.get.settings.conditionApprovals.statuses
      tags:
      - Settings/Conditions
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/conditions/priorities:
    get:
      description: "Gets the priorities for use with a standard condition.\n\n\n\n**API Endpoint**:  GET /v4/settings/conditions/priorities\
        \ \n\n**Scope**:  conditions \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.2\n\n"
      summary: Get All Standard Conditon Priorities
      operationId: v4.get.settings.conditions.priorities
      tags:
      - Settings/Conditions
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/conditions/statuses:
    get:
      description: "Gets the statuses for use with a standard condition.\n\n\n\n**API Endpoint**:  GET /v4/settings/conditions/statuses\
        \ \n\n**Scope**:  conditions \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.2\n\n"
      summary: Get All Standard Condition Statuses
      operationId: v4.get.settings.conditions.statuses
      tags:
      - Settings/Conditions
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_conditionStatusModelArray'
        '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/settings/conditions/types:
    get:
      description: "Gets the standard condition types.\n\n\n\n**API Endpoint**:  GET /v4/settings/conditions/types \n\n**Scope**:\
        \  conditions \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.2\n\n"
      summary: Get All Standard Condition Types
      operationId: v4.get.settings.conditions.types
      tags:
      - Settings/Conditions
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_conditionTypeModelArray'
        '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/settings/contacts/preferredChannels:
    get:
      description: "Gets the preferred channels for use with a contact.\n\n\n\n**API Endpoint**:  GET /v4/settings/contacts/preferredChannels\
        \ \n\n**Scope**:  contacts \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.2\n\n"
      summary: Get All Contact Preferred Channels
      operationId: v4.get.settings.contacts.preferredChannels
      tags:
      - Settings/Contacts
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/contacts/races:
    get:
      description: "Gets the races for use with a contact.\n\n\n\n**API Endpoint**:  GET /v4/settings/contacts/races \n\n\
        **Scope**:  contacts \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.2\n\n"
      summary: Get All Contact Races
      operationId: v4.get.settings.contacts.races
      tags:
      - Settings/Contacts
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/contacts/relations:
    get:
      description: "Gets the relations for use with a contact.\n\n\n\n**API Endpoint**:  GET /v4/settings/contacts/relations\
        \ \n\n**Scope**:  contacts \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.2\n\n"
      summary: Get All Contact Relations
      operationId: v4.get.settings.contacts.relations
      tags:
      - Settings/Contacts
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/contacts/salutations:
    get:
      description: "Gets the salutations for use with a contact.\n\n\n\n**API Endpoint**:  GET /v4/settings/contacts/salutations\
        \ \n\n**Scope**:  contacts \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.2\n\n"
      summary: Get All Contact Salutations
      operationId: v4.get.settings.contacts.salutations
      tags:
      - Settings/Contacts
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/contacts/types:
    get:
      description: "Gets the contact types for use with a contact.\n\n\n\n**API Endpoint**:  GET /v4/settings/contacts/types\
        \ \n\n**Scope**:  contacts \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.2\n\n"
      summary: Get All Contact Types
      operationId: v4.get.settings.contacts.types
      tags:
      - Settings/Contacts
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: Moudle Name
        in: query
        name: module
        required: false
        type: string
      - $ref: '#/parameters/lang'
      - description: Flag to expand the reponse
        in: query
        name: expand
        required: false
        type: string
      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_settingValueModelArray'
        '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/settings/contacts/types/{id}/customForms:
    get:
      description: "Get the metadata of all custom forms for the specified contact type.\n\n\n\n**API Endpoint**:  GET /v4/settings/contacts/types/{id}/customForms\
        \ \n\n**Scope**:  settings \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.2\n\n"
      summary: Get All Custom Forms Metadata for Contact Type
      operationId: v4.get.settings.contacts.types.id.customForms
      tags:
      - Settings/Contacts
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: The ID of the contact type 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_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/settings/contacts/types/{id}/customTables:
    get:
      description: "Gets the metadata for all custom tables for the specified contact type.\n\n\n\n**API Endpoint**:  GET\
        \ /v4/settings/contacts/types/{id}/customTables \n\n**Scope**:  settings \n\n**App Type**:  Agency \n\n**Authorization\
        \ Type**:  Access token \n\n**Civic Platform version**: 8.0.3\n\n"
      summary: Get All Custom Tables Metadata for Contact Type
      operationId: v4.get.settings.contacts.types.id.customTables
      tags:
      - Settings/Contacts
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: The ID of the contact type to fetch.
        in: path
        name: id
        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/settings/costs/accounts:
    get:
      description: "Gets all accounts associated with costs.\n\n\n\n**API Endpoint**:  GET /v4/settings/costs/accounts \n\n\
        **Scope**:  settings \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.3\n\n"
      summary: Get All Cost Accounts
      operationId: v4.get.settings.costs.accounts
      tags:
      - Settings/Costs
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/costs/factors:
    get:
      description: "Gets all factors associated with costs.\n\n\n\n**API Endpoint**:  GET /v4/settings/costs/factors \n\n\
        **Scope**:  settings \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.3\n\n"
      summary: Get All Cost Factors
      operationId: v4.get.settings.costs.factors
      tags:
      - Settings/Costs
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/costs/types:
    get:
      description: "Gets all type values associated with costs.\n\n\n\n**API Endpoint**:  GET /v4/settings/costs/types \n\n\
        **Scope**:  settings \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.3\n\n"
      summary: Get All Cost Types
      operationId: v4.get.settings.costs.types
      tags:
      - Settings/Costs
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/costs/types/{typeName}/items:
    get:
      description: "Gets all items associated to the specified cost type.\n\n\n\n**API Endpoint**:  GET /v4/settings/costs/types/{typeName}/items\
        \ \n\n**Scope**:  settings \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.3\n\n"
      summary: Get All Cost Type Items
      operationId: v4.get.settings.costs.types.typeName.items
      tags:
      - Settings/Costs
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: The ID of cost type to fetch.
        in: path
        name: typeName
        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_settingValueModelArray'
        '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/settings/costs/unitTypes:
    get:
      description: "Get the unit types for use with a cost.\n\n\n\n**API Endpoint**:  GET /v4/settings/costs/unitTypes \n\n\
        **Scope**:  settings \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.3\n\n"
      summary: Get All Cost Unit Types
      operationId: v4.get.settings.costs.unitTypes
      tags:
      - Settings/Costs
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/costs/types/items:
    post:
      description: "Search Cost Type Items.\n\n\n\n**API Endpoint**:  POST /v4/settings/costs/types/items \n\n**Scope**: \
        \ settings \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: 22.2.0\n\
        \n"
      summary: Search Cost Type Items
      operationId: v4.post.settings.costs.types.items
      tags:
      - Settings/Costs
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/lang'
        in: body
        name: body
        required: true
        schema:
          type: object
          properties:
            value:
              description: The setting value.
              type: string
            text:
              description: The setting label.
              type: string
      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_settingCostsTypeItems'
        '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/settings/documents/types:
    get:
      description: "Get all document types (including document groups).\n\n\n\n**API Endpoint**:  GET /v4/settings/documents/types\
        \ \n\n**Scope**:  documents \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 22.1.0\n\n"
      summary: Get Document Types
      operationId: v4.get.documents.types
      tags:
      - Settings/Documents
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/limit'
      - description: The related objects to be returned with the response. The related object(s) will be returned if data
          exists; if data does not exist, the requested object(s) will not be included in the response.
        in: query
        name: expand
        enum:
        - associations
        type: string
      responses:
        '200':
          description: "Successful request. \n\nNote: 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_documentTypesModel'
        '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/settings/departments:
    get:
      description: "Gets a list of agency departments.\n\n\n\n**API Endpoint**:  GET /v4/settings/departments \n\n**Scope**:\
        \  settings \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: 7.3.2\n\
        \n"
      summary: Get All Department Staff
      operationId: v4.get.settings.departments
      tags:
      - Settings/Departments
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_departmentModelArray'
        '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/settings/departments/{id}/staffs:
    get:
      description: "Gets the staff members for a specified department. NOTE: To return the users within a department, this\
        \ API requires an Automation administrator to activate FID 0045 (Admin Organization Hierarchy) and FID 0004 (Admin\
        \ Users) with read-only access.\n\n\n\n**API Endpoint**:  GET /v4/settings/departments/{id}/staffs \n\n**Scope**:\
        \  settings \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: 7.3.2\n\
        \n"
      summary: Get All Department Staff
      operationId: v4.get.settings.departments.id.staffs
      tags:
      - Settings/Departments
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: The ID of the department 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_userModelArray'
        '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/settings/documents/folders:
    post:
      description: "Creates document folders.\n\n\n\n**API Endpoint**:   POST /v4/settings/documents/folders \n\n**Scope**:\
        \  documents \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: 7.3.3\n\
        \n"
      summary: Create Folders
      operationId: v4.post.settings.documents.folders
      tags:
      - Settings/Documents
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: The document folders to create.
        in: body
        name: body
        required: true
        schema:
          items:
            $ref: '#/definitions/documentFolderModel'
          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.
    put:
      description: "Updates document folders.\n\n\n\n**API Endpoint**:  PUT /v4/settings/documents/folders \n\n**Scope**:\
        \  documents \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: 7.3.3\n\
        \n"
      summary: Update Folders
      operationId: v4.put.settings.documents.folders
      tags:
      - Settings/Documents
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: The document folder information to be updated.
        in: body
        name: body
        required: true
        schema:
          items:
            $ref: '#/definitions/documentFolderModel'
          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/settings/documents/folders/{ids}:
    delete:
      description: "Deletes the specified document folders.\n\n\n\n**API Endpoint**:  DELETE /v4/settings/documents/folders/{ids}\
        \  \n\n**Scope**:  documents \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.3\n\n"
      summary: Delete Folders
      operationId: v4.delete.settings.documents.folders.ids
      tags:
      - Settings/Documents
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: Comma-delimited IDs of the document folders 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/settings/documents/categories:
    get:
      description: "Gets the document types.\n\n\n\n**API Endpoint**:  GET /v4/settings/documents/categories \n\n**Scope**:\
        \  documents \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: 7.3.2\n\
        \n"
      summary: Get All Document Categories
      operationId: v4.get.settings.documents.categories
      tags:
      - Settings/Documents
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_documentTypeModelArray'
        '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/settings/documents/folderGroups:
    get:
      description: "Gets all folder groups in the system.\n\n\n\n**API Endpoint**:  GET /v4/settings/documents/folderGroups\
        \ \n\n**Scope**:  documents \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.3\n\n"
      summary: Get All Folder Groups
      operationId: v4.get.settings.documents.folderGroups
      tags:
      - Settings/Documents
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: Filter whether or not the folder gorup is active.
        in: query
        name: isActive
        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_folderGroupModelArray'
        '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 folder groups for documents.\n\n\n\n**API Endpoint**:  PUT /v4/settings/documents/folderGroups\
        \  \n\n**Scope**:  documents \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.3\n\n"
      summary: Update Folder Groups
      operationId: v4.put.settings.documents.folderGroups
      tags:
      - Settings/Documents
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: The document folder group information to be updated.
        in: body
        name: body
        required: true
        schema:
          items:
            $ref: '#/definitions/folderGroupModel'
          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/settings/documents/folders/{groupId}:
    get:
      description: "Gets the folders in the specified folder group.\n\n\n\n**API Endpoint**:  GET /v4/settings/documents/folders/{groupId}\
        \ \n\n**Scope**:  documents \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.3\n\n"
      summary: Get Folder Group
      operationId: v4.get.settings.documents.folders.groupId
      tags:
      - Settings/Documents
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: The ID of the folder group to fetch.
        in: path
        name: groupId
        required: true
        type: string
      - description: Filter by whether or not the folder is active.
        in: query
        name: isActive
        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_documentFolderModelArray'
        '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/settings/drillDown/{drillId}:
    get:
      description: "Gets the values for the specified drilldown.\n\n\n\n**API Endpoint**:  GET /v4/settings/drillDown/{drillId}\
        \ \n\n**Scope**:  settings \n\n**App Type**:  All \n\n**Authorization Type**:  No authorization required \n\n**Civic\
        \ Platform version**: 7.3.2\n\n"
      summary: Get Drilldown Settings
      operationId: v4.get.settings.drillDowns.drillId
      tags:
      - Settings/Drilldowns
      parameters:
      - description: The ID of of the drilldown field to fetch.
        format: int64
        in: path
        name: drillId
        required: true
        type: integer
      - description: The name of the parent table to which the drilldown values apply.
        in: query
        name: parentValue
        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_settingValueModelArray'
        '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/settings/inspections/checklists:
    get:
      description: "Gets all checklists you can use for an inspection.\n\n\n\n**API Endpoint**:  GET /v4/settings/inspections/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: Get All Checklists
      operationId: v4.get.settings.inspections.checklists
      tags:
      - Settings/Inspections
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: Filter by checklist group. See [Get All Checklist Groups](./api-settings.html#operation/v4.get.settings.inspections.checklistsGroups).
        in: query
        name: group
        required: false
        type: string
      - $ref: '#/parameters/fields'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/limit'
      - $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/settings/inspections/checklists/{ids}:
    get:
      description: "Gets specific checklists.\n\n\n\n**API Endpoint**:  GET /v4/settings/inspections/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: Get Checklists
      operationId: v4.get.settings.inspections.checklists.ids
      tags:
      - Settings/Inspections
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: Comma-delimited IDs of the checklists 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_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/settings/inspections/checklists/{checklistId}/checklistItems/{checklistItemid}/customForms:
    get:
      description: "Gets the metadata for all custom forms for the specified checklist item.\n\n\n\n**API Endpoint**:  GET\
        \ /v4/settings/inspections/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 Metadata for Checklist Item
      operationId: v4.get.settings.inspections.checklists.checklistId.checklistItems.checklistItemId.customForms
      tags:
      - Settings/Inspections
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: The ID of the checklist to fetch.
        in: path
        name: checklistId
        required: true
        type: string
      - description: The ID of the checklist item to fetch.
        format: int64
        in: path
        name: checklistItemid
        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_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/settings/inspections/checklists/{checklistId}/checklistItems/{checklistItemid}/customTables:
    get:
      description: "Gets the metadata of all custom tables for the specified checklist item.\n\n\n\n**API Endpoint**:  GET\
        \ /v4/settings/inspections/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 Metadata for Checklist Item
      operationId: v4.get.settings.inspections.checklists.checklistId.checklistItems.checklistItemId.customTables
      tags:
      - Settings/Inspections
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: The id of the checklist to fetch.
        format: int64
        in: path
        name: checklistId
        required: true
        type: integer
      - description: The id of the checklist item to fetch.
        format: int64
        in: path
        name: checklistItemid
        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_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/settings/inspections/checklistsGroups:
    get:
      description: "Gets the checklist groups for use with an inspection.\n\n\n\n**API Endpoint**:  GET /v4/settings/inspections/checklistsGroups\
        \ \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 Checklist Groups
      operationId: v4.get.settings.inspections.checklistsGroups
      tags:
      - Settings/Inspections
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_checklistGroupModelArray'
        '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/settings/inspections/checklists/statuses:
    get:
      description: "Gets the status values for checklists\n\n\n\n**API Endpoint**:  GET /v4/settings/inspections/checklists/statuses\
        \ \n\n**Scope**:  inspections \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.3\n\n"
      summary: Get Inspection Checklist Statuses
      operationId: v4.get.settings.inspections.checklists.statuses
      tags:
      - Settings/Inspections
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: Filter by status group
        in: query
        name: group
        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_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/settings/inspections/types:
    get:
      description: "Gets all available inspection types.\n\n\n\n**API Endpoint**:  GET v4/settings/inspections/types \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 Types
      operationId: v4.get.settings.inspections.types
      tags:
      - Settings/Inspections
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: Filter by inspection type group code.
        in: query
        name: group
        type: string
      - description: The related objects to be returned with the response. The related object(s) will be returned if data
          exists; if data does not exist, the requested object(s) will not be included in the response.
        in: query
        name: expand
        enum:
        - associations
        type: string
      - $ref: '#/parameters/limit'
      - $ref: '#/parameters/offset'
      - $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_inspectionTypeModelArray'
        '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/settings/inspections/types/{ids}:
    get:
      description: "Gets specific inspection types.\n\n\n\n**API Endpoint**:  GET /v4/settings/inspections/types/{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 Inspection Types
      operationId: v4.get.settings.inspections.types.ids
      tags:
      - Settings/Inspections
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: Comma-delimited IDs of inspection types to fetch.
        in: path
        name: ids
        required: true
        type: string
      - description: The related objects to be returned with the response. The related object(s) will be returned if data
          exists; if data does not exist, the requested object(s) will not be included in the response.
        in: query
        name: expand
        enum:
        - associations
        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_inspectionTypeModelArray'
        '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/settings/inspections/types/{id}/comments/groups:
    get:
      description: "Gets the standard comment groups for a given inspection type.\n\n\n\n**API Endpoint**:  GET /v4/settings/inspections/types/{id}/comments/groups\
        \ \n\n**Scope**:  inspections \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 9.3.0 \n\n"
      summary: Get All Standard Comment Groups for Inspection Type
      operationId: v4.get.settings.inspections.type.comments.groups
      tags:
      - Settings/Inspections
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - in: path
        name: id
        description: The system id of the inspection type to fetch. See [Get All Inspection Types](./api-settings.html#operation/v4.get.settings.inspections.types).
        required: true
        format: int64
        type: integer
      - $ref: '#/parameters/lang'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/limit'
      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_standardCommentGroupModelArray'
        '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/settings/inspections/checklistItems/{checklistItemId}/comments/groups:
    get:
      description: "Gets the standard comment groups for a given checklist item.\n\n\n\n**API Endpoint**:  GET /v4/settings/inspections/checklistItems/{checklistItemId}/comments/groups\
        \ \n\n**Scope**:  inspections \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 9.3.0 \n\n"
      summary: Get All Standard Comment Groups for Inspection Checklist
      operationId: v4.get.settings.inspections.checklistItems.checklistItemId.comments.groups
      tags:
      - Settings/Inspections
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - in: path
        name: checklistItemId
        description: The system id of the checklist item to fetch. For valid values, use the id field in items[] returned
          by [Get All Checklists](./api-settings.html#operation/v4.get.settings.inspections.checklists).
        required: true
        format: int64
        type: integer
      - $ref: '#/parameters/lang'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/limit'
      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_standardCommentGroupModelArray'
        '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/settings/inspections/grades:
    get:
      description: "Gets all available grades for use in an inspection.\n\n\n\n**API Endpoint**:  GET /v4/settings/inspections/grades\
        \ \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 Grades
      operationId: v4.get.settings.inspections.grades
      tags:
      - Settings/Inspections
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: Filter by the inspection grade group
        in: query
        name: group
        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_inspectionGradeModelArray'
        '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/settings/inspections/statuses:
    get:
      description: "Gets all available status values for use in an inspection.\n\n\n\n**API Endpoint**:  GET /v4/settings/inspections/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 Statuses
      operationId: v4.get.settings.inspections.statuses
      tags:
      - Settings/Inspections
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: Filter by the inspection status group.
        in: query
        name: group
        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_inspectionResultStatusModelArray'
        '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/settings/modules:
    get:
      description: "Gets the Civic Platform modules.\n\n\n\n**API Endpoint**:  GET /v4/settings/modules \n\n**Scope**:  settings\
        \ \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: 7.3.2\n\n"
      summary: Get All Modules
      operationId: v4.get.settings.modules
      tags:
      - Settings/Modules
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/owners/customForms:
    get:
      summary: Get Metadata for Owner Custom Forms
      description: "Returns the field metadata for all owner custom forms (owner templates) in the system.\n\n\n\n**API Endpoint**:\
        \  GET /v4/settings/owners/customForms  \n\n**Scope**:  owners \n\n**App Type**:  All \n\n**Authorization Type**:\
        \  Access token \n\n**Civic Platform version**: 9.3.0\n\n"
      tags:
      - Settings/Owners
      operationId: v4.get.settings.owners.customForms
      parameters:
      - description: Construct oAuth2 authentication token
        in: header
        name: Authorization
        required: true
        type: string
      - description: Language parameter to support I18N. Default language is en_US
        in: query
        name: lang
        required: false
        type: string
      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_apo_customForms_metadata'
        '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/settings/parcels/customForms:
    get:
      summary: Get Metadata for Parcel Custom Forms
      description: "Returns the field metadata for all parcel custom forms (parcel templates) in the system.\n\n\n\n**API\
        \ Endpoint**:  GET /v4/settings/parcels/customForms \n\n**Scope**:  parcels \n\n**App Type**:  All \n\n**Authorization\
        \ Type**:  Access token \n\n**Civic Platform version**: 9.3.0 \n\n"
      tags:
      - Settings/Parcels
      operationId: v4.get.settings.parcels.customForms
      parameters:
      - description: Construct oAuth2 authentication token
        in: header
        name: Authorization
        required: true
        type: string
      - description: Language parameter to support I18N. Default language is en_US
        in: query
        name: lang
        required: false
        type: string
      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_apo_customForms_metadata'
        '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/settings/parts/locations:
    get:
      description: "Gets all part locations in the system.\n\n\n\n**API Endpoint**:  GET /v4/settings/parts/locations \n\n\
        **Scope**:  settings \n\n**App Type**:  All \n\n**Authorization Type**:  No authorization required \n\n**Civic Platform\
        \ version**: 7.3.3\n\n"
      summary: Get All Part Locations
      operationId: v4.get.settings.parts.locations
      tags:
      - Settings/Parts
      parameters:
      - description: Filter by the transaction type.
        in: query
        name: transactionType
        required: false
        type: string
      - description: Filter by part id.
        in: query
        name: partId
        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_partLocationModelArray'
        '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/settings/parts/types:
    get:
      description: "Gets the part type settings.\n\n\n\n**API Endpoint**:  GET /v4/settings/parts/types \n\n**Scope**:  settings\
        \ \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: 7.3.3\n\n"
      summary: Get Part Types
      operationId: v4.get.settings.parts.types
      tags:
      - Settings/Parts
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/pickLists:
    get:
      description: "Gets all pick lists in the system.\n\n\n\n**API Endpoint**:  GET /v4/settings/pickLists \n\n**Scope**:\
        \  settings \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: 7.3.3\n\
        \n"
      summary: Get All Pick Lists
      operationId: v4.get.settings.pickLists
      tags:
      - Settings/Pick Lists
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_sharedPickListModelArray'
            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/settings/pickLists/{id}:
    get:
      description: "Gets the specified pick list, its values, and the fields that are associated with it.\n\n\n\n**API Endpoint**:\
        \  GET /v4/settings/pickLists/{id} \n\n**Scope**:  settings \n\n**App Type**:  All \n\n**Authorization Type**:  Access\
        \ token \n\n**Civic Platform version**: 7.3.2\n\n"
      summary: Get Pick List
      operationId: v4.get.settings.pickLists.id
      tags:
      - Settings/Pick Lists
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: The ID of the pick list 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_sharedPickListValuesModel'
        '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/settings/priorities:
    get:
      description: "Gets a list of available priorities.\n\n\n\n**API Endpoint**:  GET /v4/settings/priorities \n\n**Scope**:\
        \  settings \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: 7.3.2\n\
        \n"
      summary: Get All Priorities
      operationId: v4.get.settings.priorities
      tags:
      - Settings/Priorities
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/professionals/licenseBoards:
    get:
      description: "Gets the license boards for use with professionals.\n\n\n\n**API Endpoint**:  GET /v4/settings/professionals/licenseBoards\
        \ \n\n**Scope**:  professionals \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.2\n\n"
      summary: Get All Professional License Boards
      operationId: v4.get.settings.professionals.licenseBoards
      tags:
      - Settings/Professsionals
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/professionals/salutations:
    get:
      description: "Gets the salutations for use with professionals.\n\n\n\n**API Endpoint**:  GET /v4/settings/professionals/salutations\
        \ \n\n**Scope**:  professionals \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.2\n\n"
      summary: Get All Professional Salutations
      operationId: v4.get.settings.professionals.salutations
      tags:
      - Settings/Professsionals
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/professionals/types:
    get:
      description: "Gets the license types for use with professionals.\n\n\n\n**API Endpoint**:  GET /v4/settings/professionals/types\
        \ \n\n**Scope**:  professionals \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.2\n\n"
      summary: Get All Professional License Types
      operationId: v4.get.settings.professionals.types
      tags:
      - Settings/Professsionals
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/records/constructionTypes:
    get:
      description: "Gets the construction types for the specified record type.\n\n\n\n**API Endpoint**:  GET /v4/settings/records/constructionTypes\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.2\n\n"
      summary: Get All Record Construction Types
      operationId: v4.get.settings.records.constructionTypes
      tags:
      - Settings/Records
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/records/expirationStatuses:
    get:
      description: "Gets the expiration status values for use with records..\n\n\n\n**API Endpoint**:  GET /v4/settings/records/expirationStatuses\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.2\n\n"
      summary: Get All Record Expiration Statuses
      operationId: v4.get.settings.records.expirationStatuses
      tags:
      - Settings/Records
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_settingValueModelArray'
        '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/settings/records/types:
    get:
      description: "Gets predefined record types.\n\n\n\n**API Endpoint**:  GET /v4/settings/records/types \n\n**Scope**:\
        \  records \n\n**App Type**:  All \n\n**Authorization Type**:  No authorization required \n\n**Civic Platform version**:\
        \ 7.3.2\n\n"
      summary: Get All Record Types
      operationId: v4.get.settings.records.types
      tags:
      - Settings/Records
      parameters:
      - $ref: '#/parameters/offset'
      - description: Search result size limit.
        enum:
        - range[1,1000]
        format: int64
        in: query
        name: limit
        type: integer
      - description: Filter by module. This is required for citizen-facing apps, but not required for agency-facing apps.
        in: query
        name: module
        required: true
        type: string
      - description: Filter by whether or not it is a fee estimate.
        enum:
        - 'true'
        - 'false'
        in: query
        name: isFeeEstimate
        type: boolean
      - description: Filter by action associated with the record type.
        enum:
        - createApplication
        - createHuntingLicense
        - amendApplication
        - amendContact
        in: query
        name: action
        type: string
      - description: The related objects to be returned with the response. The related object(s) will be returned if data
          exists; if data does not exist, the requested object(s) will not be included in the response.
        in: query
        name: expand
        enum:
        - associations
        type: string
      - description: Filter by record type filter name.
        in: query
        name: filterName
        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_recordTypeModelArray'
        '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/settings/records/types/{recordTypeId}/assetTypes:
    get:
      description: "Returns all asset types for a given record type.\n\n\n\n**API Endpoint**:  GET /v4/settings/records/types/{recordTypeId}/assetTypes\
        \ \n\n**Scope**:  records \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 9.0.0\n\n"
      summary: Get All Asset Types for Record Type
      operationId: v4.get.settings.records.types.recordTypeId.assetTypes
      tags:
      - Settings/Records
      parameters:
      - description: The id of the record type to fetch.
        in: path
        name: recordTypeId
        required: true
        type: string
      - description: Filter by asset group.
        in: query
        name: group
        type: string
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/limit'
      - $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_recordTypeAssetTypeModelArray'
        '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/settings/records/types/{id}/customForms:
    get:
      description: "Gets the metadata of custom forms for a specified record type.\n\n\n\n**API Endpoint**:  GET /v4/settings/records/types/{id}/customForms\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  No authorization required \n\n**Civic\
        \ Platform version**: 7.3.2\n\n"
      summary: Get All Custom Forms Metadata for Record Type
      operationId: v4.get.settings.records.types.id.customForms
      tags:
      - Settings/Records
      parameters:
      - description: The id of the record type to fetch.
        in: path
        name: id
        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_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/settings/records/types/{id}/customTables:
    get:
      description: "Gets the metadata of all custom tables for a specified record type.\n\n\n\n**API Endpoint**:  GET /v4/settings/records/types/{id}/customTables\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  No authorization required \n\n**Civic\
        \ Platform version**: 7.3.2\n\n"
      summary: Get All Custom Tables Metadata for Record Type
      operationId: v4.get.settings.records.types.id.customTables
      tags:
      - Settings/Records
      parameters:
      - description: The id of the record type to fetch.
        in: path
        name: id
        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/settings/records/types/{id}/fees/schedules:
    get:
      description: "Gets the types of available fee schedules.\n\n\n\n**API Endpoint**:  GET /v4/settings/records/types/{id}/fees/schedules\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.2\n\n"
      summary: Get All Fee Schedules for Record Type
      operationId: v4.get.settings.records.types.id.fees.schedules
      tags:
      - Settings/Records
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: The ID of the record type to fetch.
        in: path
        name: id
        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_settingValueModelArray'
        '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/settings/records/types/{id}/statuses:
    get:
      description: "Gets the status values for use with a specified record type.\n\n\n\n**API Endpoint**:  GET /v4/settings/records/types/{id}/statuses\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.2\n\n"
      summary: Get All Statuses for Record Type
      operationId: v4.get.settings.records.types.id.statuses
      tags:
      - Settings/Records
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: The ID of the record type 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_recordStatusModelArray'
        '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/settings/timeAccounting/groups:
    get:
      description: "Gets all time accounting groups, optionally for specified userids.\n\n\n\n**API Endpoint**:  GET /v4/settings/timeAccounting/groups\
        \ \n\n**Scope**:  settings \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.2\n\n"
      summary: Get All Time Accounting Groups
      operationId: v4.get.settings.timeAccounting.groups
      tags:
      - Settings/Time Accounting
      parameters:
      - description: Filter by comma-delimited user ids.
        in: query
        name: userIds
        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_settingValueModelArray'
        '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/settings/timeAccounting/types:
    get:
      description: "Gets all time accounting types for specified time accounting groups, optionally for specified userids\
        \ and record type.\n\n\n\n**API Endpoint**:  GET /v4/settings/timeAccounting/types \n\n**Scope**:  settings \n\n**App\
        \ Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: 7.3.2\n\n"
      summary: Get All Time Accounting Types
      operationId: v4.get.settings.timeAccounting.types
      tags:
      - Settings/Time Accounting
      parameters:
      - description: Filter by time accounting group.
        format: int64
        in: query
        name: groupId
        required: true
        type: integer
      - description: Filter by comma-delimited the user ids.
        in: query
        name: userIds
        required: false
        type: string
      - description: Filter by the record type.
        in: query
        name: recordType
        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_settingValueModelArray'
        '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_apo_customForms_metadata:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/apo_customForms_metadata'
        type: array
      status:
        type: integer
        description: The return status code.
  apo_customForms_metadata:
    description: 'Contains metadata description of a custom form, including the custom fields metadata. '
    type: object
    properties:
      name:
        type: string
        description: The name of the custom form
      description:
        type: string
        description: Describes the usage or puporse of the custom form.
      fields:
        items:
          $ref: '#/definitions/apo_customForms_metadata_fields'
        type: array
        description: Contains the field metadata.
      id:
        type: string
        description: The unique string identifier of the custom form.
      customFormType:
        type: string
        description: Indicates whether the custom form is for an address, parcel, or owner.
  apo_customForms_metadata_fields:
    description: "Describes the metadata of a custom field. \n\nAdded in Civic Platform version: 9.2.0"
    type: object
    properties:
      id:
        type: integer
        format: int64
        description: The unique custom field id.
      name:
        type: string
        description: The field name.
      description:
        type: string
        description: Describes the usage or purpose of the custom field.
      label:
        type: object
        description: The field label.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      dataType:
        type: string
        enum:
        - Number
        - Text
        - Date
        - Radio
        - DropdownList
        description: The field data type. If the custom field is a DropdownList, the options[] array contains the list of
          possible values, or the sharedDropdownListName specifies the name of a shared dropdown list containing the possible
          values.
      defaultValue:
        type: string
        description: Any default value for the custom field.
      displayOrder:
        format: int64
        type: integer
        description: The display order of the field on the custom form.
      unit:
        type: string
        description: The unit of measure of a numeric custom field.
      isRequired:
        type: string
        enum:
        - Y
        - N
        description: Indicates whether or not the field is required.
      isPublicVisible:
        type: string
        enum:
        - Y
        - N
        description: Indicates whether or not a citizen user can see this field.
      isRecordSearchable:
        type: string
        enum:
        - Y
        - N
        description: Indicates whether or not the field is searchable.
      maxLength:
        format: int64
        type: integer
        description: The field maximum length.
      options:
        items:
          type: object
          description: A dropdown field value.
          properties:
            text:
              description: The localized display value.
              type: string
            value:
              description: The data value.
              type: string
        type: array
        description: Contains possible field values, if the field is a dropdown field type.
      sharedDropdownListName:
        type: string
        description: The name of the shared dropdown list, if the field is a dropdown field type.
  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 form.
    type: object
    properties:
      displayOrder:
        description: The custom form's display order.
        format: int64
        type: integer
      fields:
        items:
          $ref: '#/definitions/customFormField'
        type: array
      id:
        description: The custom form id.
        type: string
      text:
        description: The custom form name.
        type: string
  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/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_recordStatusModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/recordStatusModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  recordStatusModel:
    type: object
    properties:
      group:
        description: The record status group.
        type: string
      text:
        description: The record status name.
        type: string
      value:
        description: The record status value.
        type: string
  response_assetTypeModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/assetTypeModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  assetTypeModel:
    type: object
    properties:
      display:
        description: "\tDisplays the hierarchical name of the asset type, which includes the asset group and type."
        type: string
      gisIDForAssetID:
        description: "\tThe name of the GIS ID field that is mapped to the asset ID."
        type: string
      gisLayer:
        $ref: '#/definitions/gISLayerIdModel'
      gisService:
        description: "\tThe GIS service to be used with the asset. The GIS service should be a configured map service in Accela\
          \ GIS Administration."
        type: string
      group:
        description: 'The name of the asset group. For example: Water or Street. An Asset Group is an agency-defined collection
          of objects the agency owns or maintains.'
        type: string
      id:
        description: The id of the asset type.
        type: string
      type:
        description: 'The type of asset. For example: Hydrant or Manhole. An Asset Type is an agencydefined classification
          of similar objects that share the same standard asset attributes. Related asset types belong to an asset group,
          and multiple asset types can share the same Class Type.'
        type: string
  response_recordTypeAssetTypeModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/recordTypeAssetTypeModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  recordTypeAssetTypeModel:
    type: object
    properties:
      gisIDForAssetID:
        description: "\tThe name of the GIS ID field that is mapped to the asset ID."
        type: string
      gisLayer:
        $ref: '#/definitions/gISLayerIdModel'
      gisService:
        description: "\tThe GIS service to be used with the asset. The GIS service should be a configured map service in Accela\
          \ GIS Administration."
        type: string
      group:
        description: 'The name of the asset group. For example: Water or Street. An Asset Group is an agency-defined collection
          of objects the agency owns or maintains.'
        type: string
      type:
        description: 'The type of asset. For example: Hydrant or Manhole. An Asset Type is an agencydefined classification
          of similar objects that share the same standard asset attributes. Related asset types belong to an asset group,
          and multiple asset types can share the same Class Type.'
        type: string
  recordTypeAssociationsModel:
    type: object
    properties:
      addressTypeGroup:
        description: The name of the address type group that contains permissible address tyeps for instances of the record
          type.
        type: string
      customFormGroup:
        description: The name of the custom forms group for instances of the record type.
        type: string
      documentCode:
        description: The code that defines the document types for the record type.
        type: string
      expirationCode:
        description: The code that defines the parameters for expiring records that are instances of the record type.
        type: string
      feeSchedule:
        description: The name of the fee schedule associated with instances of the record type.
        type: string
      inspectionGroup:
        description: The name of the inspection group that contains the inspection-related parameters applied to instances
          of the record type.
        type: string
      recordStatusGroup:
        description: The group of record statuses associated with the record type.
        type: string
      standardCommentGroup:
        items:
          type: object
          description: The name of the standard comment group associated with instances of the record type.
          properties:
            text:
              description: The localized display value.
              type: string
            value:
              description: The data value.
              type: string
        type: array
      virtualFolderGroup:
        description: The name of the virtual folder group associated with instances of the record type.
        type: string
      workflow:
        description: The name of the workflow associated with instances of the record type.
        type: string
  response_assetRecordTypeModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/assetRecordTypeModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  assetRecordTypeModel:
    type: object
    properties:
      alias:
        description: The record type alias.
        type: string
      associations:
        $ref: '#/definitions/recordTypeAssociationsModel'
      category:
        description: The 4th level in a 4-level record type structure (Group-Type-Subtype-Category).
        type: string
      createable:
        description: Indicates whether or not the record can be created.
        type: boolean
      deletable:
        description: Indicates whether or not the record can be deleted.
        type: boolean
      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 id.
        type: string
      module:
        description: The module the record type belongs to.
        type: string
      readable:
        description: Indicates whether or not values for sibling fields are readable.
        type: boolean
      searchable:
        description: Indicates whether or not the item is searchable.
        type: boolean
      subType:
        description: The 3rd level in a 4-level record type structure (Group-Type-Subtype-Category).
        type: string
      text:
        description: The localized display text.
        type: string
      type:
        description: The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category).
        type: string
      updatable:
        description: Indicates whether or not the item can be updated.
        type: boolean
      value:
        description: The stored value.
        type: string
  response_recordTypeModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/recordTypeModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  recordTypeModel:
    type: object
    properties:
      alias:
        description: The record type alias.
        type: string
      associations:
        $ref: '#/definitions/recordTypeAssociationsModel'
      category:
        description: The 4th level in a 4-level record type structure (Group-Type-Subtype-Category).
        type: string
      createable:
        description: Indicates whether or not the record can be created.
        type: boolean
      deletable:
        description: Indicates whether or not the record can be deleted.
        type: boolean
      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 id.
        type: string
      asChildOnly:
        description: Indicates whether or not the field is required.
        enum:
        - Y
        - N
        type: string
      module:
        description: The module the record type belongs to.
        type: string
      readable:
        description: Indicates whether or not values for sibling fields are readable.
        type: boolean
      searchable:
        description: Indicates whether or not the item is searchable.
        type: boolean
      subType:
        description: The 3rd level in a 4-level record type structure (Group-Type-Subtype-Category).
        type: string
      text:
        description: The localized display text.
        type: string
      type:
        description: The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category).
        type: string
      updatable:
        description: Indicates whether or not the item can be updated.
        type: boolean
      value:
        description: The stored value.
        type: string
  response_conditionAssessmentModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/conditionAssessmentModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  conditionAssessmentModel:
    type: object
    properties:
      conditionAssessment:
        description: The condition assessment id, as defined on Civic Platform Administration.
        type: string
      description:
        description: The condition assessment description. If the description is null, this field is not returned.
        type: string
  customAttributeModel:
    type: object
    properties:
      aCustomFieldName:
        type: string
      aCustomFieldValue:
        type: string
  response_departmentModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/departmentModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  departmentModel:
    type: object
    properties:
      agency:
        description: The department agency
        type: string
      bureau:
        description: The name of the bureau, which is an organization level within an agency.
        type: string
      division:
        description: The name of the division, which is an organization level within a bureau.
        type: string
      group:
        description: The department group.
        type: string
      id:
        description: The department system id assigned by the Civic Platform server.
        type: string
      office:
        description: An organization level within a group. An office is the final level within an organization structure.
          Agency->Bureau->Division->Section->Group->Office.
        type: string
      section:
        description: A piece of a township measuring 640 acres, one square mile, numbered with reference to the base line
          and meridian line.
        type: string
      serviceProviderCode:
        description: The unique agency identifier
        type: string
      text:
        description: The department display text.
        type: string
      value:
        description: The department value.
        type: string
  gISLayerIdModel:
    description: The GIS layer in the GIS service to be used with the asset. The GIS layer should be a configured map layer
      on the GIS service in Accela GIS Administration.
    type: object
    properties:
      display:
        description: The display name of the GIS layer ID.
        type: string
  response_settingCostsTypeItems:
    type: object
    properties:
      result:
        description: Contains the settings.
        items:
          $ref: '#/definitions/settingCostsTypeItemsArray'
        type: array
      page:
        $ref: '#/definitions/pageModel'
      status:
        type: integer
        description: The HTTP return status.
  settingCostsTypeItemsArray:
    type: object
    properties:
      value:
        description: The setting value.
        type: string
      text:
        description: The setting label.
        type: string
  response_settingValueModelArray:
    type: object
    properties:
      result:
        description: Contains the settings.
        items:
          $ref: '#/definitions/settingValueModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  settingValueModel:
    type: object
    properties:
      text:
        description: The setting label.
        type: string
      value:
        description: The setting value.
        type: string
      addressTypes:
        items:
          $ref: '#/definitions/settingValueModelAddressTypes'
        type: array
  settingValueModelAddressTypes:
    type: object
    properties:
      text:
        description: The setting label.
        type: string
      value:
        description: The setting value.
        type: string
      required:
        description: Indicates whether or not it is required for an address type.
        type: boolean
  gradeModel:
    type: object
    properties:
      grade:
        type: object
        description: The name of the inspection grade.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      gradeImage:
        description: The link to an image file associated to the inspection grade.
        type: string
      group:
        description: The inspection grade group for the inspection grade value.
        type: string
      maximumMajorViolation:
        description: "\tUsed with the maxMajorViolation field to define a range of the acceptable number of major violations\
          \ for an inspection."
        format: int64
        type: integer
      maximumScore:
        description: "\tUsed with the minScore field to define a range of acceptable values for an inspection."
        format: int64
        type: integer
      minimumMajorViolation:
        description: "\tUsed with the maxMajorViolation field to define a range of the acceptable number of major violations\
          \ for an inspection."
        format: int64
        type: integer
      minimumScore:
        description: "\tUsed with the maxScore field to define a range of acceptable values for an inspection."
        format: int64
        type: integer
  response_inspectionGradeModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/inspectionGradeModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  inspectionGradeModel:
    type: object
    properties:
      grades:
        description: Contains the inspection grades.
        items:
          $ref: '#/definitions/gradeModel'
        type: array
      group:
        description: The inspection grade group.
        type: string
  response_inspectionResultStatusModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/inspectionResultStatusModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  inspectionResultStatusModel:
    type: object
    properties:
      group:
        description: The inspection status group.
        type: string
      results:
        description: Contains the inspection grades.
        items:
          $ref: '#/definitions/gradeModel'
        type: array
  response_inspectionTypeModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/inspectionTypeModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  inspectionTypeModel:
    type: object
    properties:
      allowFailChecklistItems:
        description: Indicates whether or not to allow inspection to pass with failed checklist items for the current inspection
          type or from previous inspections.
        enum:
        - Y
        - N
        type: string
      allowMultiInspections:
        description: Indicates whether or not to allow the scheduling of multiple inspections for this inspection type.
        enum:
        - Y
        - N
        type: string
      associations:
        $ref: '#/definitions/inspectionTypeAssociationsModel'
      cancelRestriction:
        $ref: '#/definitions/inspectionRestrictionModel'
      carryoverFlag:
        description: "Indicates how failed guidesheet items for an inspection type are carried over to the next inspection\
          \ guidesheet. \n\nNULL or empty string : Guidesheet items are not carried over. \n\n\"A\" : Automatic carry-over\
          \ of failed guidesheet items to the next inspection guidesheet item."
        enum:
        - null
        - A
        type: string
      defaultDepartment:
        $ref: '#/definitions/departmentModel'
      disciplines:
        description: The inspection disciplines assigned to the inspection type.
        items:
          type: string
        type: array
      flowEnabledFlag:
        description: Indicates whether or not to include the inspection in the inspection flow process.
        enum:
        - Y
        - N
        type: string
      grade:
        description: The name of the inspection grade.
        type: string
      group:
        description: "The name of a group of inspection types.\t"
        type: string
      groupName:
        type: object
        description: The descriptive name associated to an inspection group code.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      guideGroup:
        $ref: '#/definitions/rGuideSheetGroupModel'
      hasCancelPermission:
        description: Indicates whether or not the user can reschedule the inspection.
        enum:
        - Y
        - N
        type: string
      hasFlowFlag:
        description: Indicates whether or not to include the inspection in the inspection flow process.
        enum:
        - Y
        - N
        type: string
      hasNextInspectionAdvance:
        description: Indicates whether or not the next inspection can be scheduled in advance.
        enum:
        - Y
        - N
        type: string
      hasReschdulePermission:
        description: Indicates whether or not the user can reschedule the inspection.
        enum:
        - Y
        - N
        type: string
      hasSchdulePermission:
        description: Indicates whether or not the user can schedule the inspection. Note that hasSchdulePermission returns
          "Y" if result.inspectionTypes.schdulePermission is either "REQUEST_ONLY_PENDING", "REQUEST_SAME_DAY_NEXT_DAY", or
          "SCHEDULE_USING_CALENDAR". If result.inspectionTypes.schdulePermission is "NONE" or null, hasSchdulePermission returns
          "N".
        enum:
        - Y
        - N
        type: string
      id:
        description: The inspection type system id assigned by the Civic Platform server.
        format: int64
        type: integer
      inspectionEditable:
        description: Indicates whether or not inspection result, grade or checklist can be edited.
        enum:
        - Y
        - N
        type: string
      isAutoAssign:
        description: Indicates whether or not you want to automatically reschedule the inspection when the previous inspection
          status attains Approved status.
        enum:
        - Y
        - N
        type: string
      isRequired:
        description: Indicates whether or not the information is required.
        enum:
        - Y
        - N
        type: string
      maxPoints:
        description: The number of points allowed for an inspection, after which the inspection fails.
        format: double
        type: number
      priority:
        description: The priority level assigned to the inspection type.
        type: string
      publicVisible:
        description: Indicates whether or not Accela Citizen Access users can view comment about the inspection results.
        enum:
        - Y
        - N
        type: string
      refereceNumber:
        description: The reference number associated with an inspection.
        type: string
      rescheduleRestriction:
        $ref: '#/definitions/inspectionRestrictionModel'
      resultGroup:
        description: The name of a grouping of Inspection results, usually indicative of a range of inspection scores.
        type: string
      text:
        description: The localized display text.
        type: string
      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
      totalScoreOption:
        description: "Indicates the method for calculating total scores of checklist items. There are four options:  \n\n\
          TOTAL - Gets the total score of all checklists as the inspection score. \n\nMAX - Gets the max score of all checklists\
          \ as the inspection score. \n\nMIN - Gets the min score of all checklists as the inspection score. \n\nAVG - Gets\
          \ the average score of all checklists as the inspection score. \n\nSUBTRACT - Subtracts the total score of all the\
          \ checklist items from the Total Score defined for the inspection type."
        enum:
        - TOTAL
        - MAX
        - MIN
        - AVG
        - SUBTRACT
        type: string
      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
      value:
        description: The value for the specified parameter.
        type: string
  inspectionTypeAssociationsModel:
    type: object
    properties:
      standardCommentGroup:
        type: object
        description: The name of the standard comment group associated with the inspection type.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  inspectionRestrictionModel:
    type: object
    properties:
      beforeScheduledTime:
        $ref: '#/definitions/inspectionBeforeScheduledTime'
  inspectionBeforeScheduledTime:
    description: Specifies the number of days or hours before the scheduled time on the inspection date.
    type: object
    properties:
      days:
        description: Inspections can only be cancelled within this number of days before the scheduled time on the inspection
          date.
        format: int64
        type: integer
      hours:
        description: Inspections can only be cancelled within this number of hours before the scheduled time on the inspection
          date.
        format: int64
        type: integer
      time:
        description: Inspections can only be cancelled within the number of specified days or hours before this time ("hh:mm
          AM|PM") on the inspection date.
        type: string
  rGuideSheetGroupModel:
    type: object
    properties:
      id:
        description: The inspection checklist sytem id assigned by the Civic Platform server.
        type: string
      text:
        description: The localized display text.
        type: string
      value:
        description: The stored value.
        type: string
  response_partLocationModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/partLocationModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  partLocationModel:
    type: object
    properties:
      address1:
        description: The first line of the address of the part location.
        type: string
      address2:
        description: The second line of the address of the part location.
        type: string
      businessName:
        description: A secondary business name for the applicable individual.
        type: string
      city:
        description: The name of the city.
        type: string
      comments:
        description: Comments or notes about the part location.
        type: string
      contactFname:
        description: The first name of the contact
        type: string
      contactLname:
        description: The last name of the contact.
        type: string
      contactTitle:
        description: The title of the contact.
        type: string
      fax:
        description: The fax number for the contact.
        type: string
      faxCountryCode:
        description: Fax Number Country Code
        type: string
      id:
        description: The id of the part location assigned by the Civic Platform server.
        format: int64
        type: integer
      phone:
        description: The number associated with the entity.
        type: string
      phoneCountryCode:
        description: The country code for the assoicated phone number.
        type: string
      resColumns:
        items:
          type: string
        type: array
      state:
        description: The state corresponding to the address on record.
        type: string
      zip:
        description: The zip code for the part location.
        type: string
  response_checklistGroupModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/checklistGroupModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  checklistGroupModel:
    type: object
    properties:
      id:
        description: The checklist group id.
        type: string
      text:
        description: The checklist group name.
        type: string
      value:
        description: The checklist group value.
        type: string
  checklistItemModel:
    description: Contains the checklist items.
    type: object
    properties:
      comment:
        description: Comments about the checklist item.
        type: string
      defaultScore:
        description: "\tThe default score associated with the checklist item."
        format: int64
        type: integer
      displayOrder:
        description: "\tThe order of the item in comparison to the other items."
        format: int64
        type: integer
      id:
        description: The ID of the checklist item assigned by the Civic Platform server.
        format: int64
        type: integer
      isCarryOver:
        description: "\tIndicates whether or not the checklist is a carry-over."
        type: string
      isCommentVisible:
        description: "\tIndicates whether or not the comment is visible in a checklist."
        type: string
      isCritical:
        description: "\tIndicates whether or not the checklist item is critical."
        type: string
      isMaxPointsVisible:
        description: "\tIndicates whether or not to display the maximum points for the inspection checklist."
        type: string
      isScoreVisible:
        description: "\tIndicates whether or not to display the inspection checklist score."
        type: string
      maxPoints:
        description: "\tThe number of points allowed for an inspection, after which the inspection fails."
        format: double
        type: number
      statusGroup:
        description: Defines a set of status values for use with inspection types that conform to similar code requirements.
          For example, status groups for building related inspections, such as mechanical, electrical, uniform plumbing, and
          zoning.
        type: string
      statuses:
        description: Uses several parameters to characterize the status of one or more inspection checklists
        items:
          $ref: '#/definitions/checklistItemStatusModel'
        type: array
      text:
        description: The checklist item name.
        type: string
  response_checklistItemStatusModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/checklistItemStatusModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  checklistItemStatusModel:
    type: object
    properties:
      criticalScore:
        description: "\tThe critical score for the status of a guidesheet item that is a Major Violation/Critical Item."
        format: int64
        type: integer
      displayOrder:
        description: "\tThe order of the item in comparison to the other items."
        format: int64
        type: integer
      lhsType:
        description: "\tIndicates whether or not the checklist is for LHS (Life/Health/Safety). For LHS-type items, the maximum\
          \ point value becomes the default score."
        type: string
      majorViolation:
        description: "\tThe number of major violations."
        type: string
      nonCriticalScore:
        description: "\tThe non-critical score for the status of a guidesheet item that is not a Major Violation/Critical\
          \ Item."
        format: int64
        type: integer
      resultType:
        description: "\tThe 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
      text:
        description: The checklist status name.
        type: string
      value:
        description: The checklist status value.
        type: string
  response_checklistModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/checklistModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  checklistModel:
    type: object
    properties:
      group:
        items:
          description: A checklist group.
          type: string
        type: array
      id:
        description: The checklist id.
        type: string
      items:
        items:
          $ref: '#/definitions/checklistItemModel'
        type: array
      serviceProviderCode:
        description: The agency unique identifier.
        type: string
      text:
        description: The checklist name.
        type: string
  response_ratingTypeModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/ratingTypeModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  ratingTypeModel:
    type: object
    properties:
      manualEntryRatingValue:
        description: If 'Y', a user can create a rating formula. If the user creates a formula, the user can enter manual
          rating values in addition to the calculated rating values. If the user does not create a formula, the user must
          enter rating values manually. If 'N', the user must create a rating formula.
        type: string
      recordStatus:
        description: The status of the rating type.
        type: string
      updatedBy:
        description: The person who last updated the rating type.
        type: string
      updatedDate:
        description: The date the rating type was last updated.
        format: date-time
        type: string
  customFormModel:
    type: object
    properties:
      fields:
        items:
          $ref: '#/definitions/fieldModel'
        type: array
      id:
        type: string
      text:
        type: string
      displayOrder:
        type: integer
  fieldModel:
    type: object
    properties:
      id:
        type: string
      fieldType:
        type: string
      text:
        type: string
      maxLength:
        type: integer
      options:
        type: array
        items:
          $ref: '#/definitions/optionsModel'
      displayOrder:
        type: integer
      isRequired:
        type: string
      isReadonly:
        type: string
  optionsModel:
    type: object
    properties:
      value:
        type: string
      text:
        type: string
  customTableModel:
    type: object
    properties:
      fields:
        items:
          $ref: '#/definitions/fieldModel'
        type: array
      id:
        type: string
      text:
        type: string
      displayOrder:
        type: integer
  response_documentTypesModel:
    type: object
    properties:
      result:
        type: object
        properties:
          customForms:
            items:
              $ref: '#/definitions/customFormModel'
            type: array
          autoDownload:
            type: boolean
          customTables:
            items:
              $ref: '#/definitions/customTableModel'
            type: array
          value:
            type: string
          id:
            type: string
          text:
            type: string
          group:
            type: object
            properties:
              value:
                type: string
              text:
                type: string
      status:
        type: integer
        description: The HTTP return status.
      page:
        $ref: '#/definitions/pageModel'
  response_sharedPickListModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/sharedPickListModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  sharedPickListModel:
    type: object
    properties:
      description:
        description: The pick list description.
        type: string
      status:
        type: object
        description: The pick list status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  response_sharedPickListValuesModel:
    type: object
    properties:
      result:
        $ref: '#/definitions/sharedPickListValuesModel'
      status:
        type: integer
        description: The HTTP return status.
  sharedPickListValuesModel:
    type: object
    properties:
      description:
        description: The pick list description.
        type: string
      status:
        type: object
        description: The pick list status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      values:
        description: Contains the pick list values.
        items:
          $ref: '#/definitions/pickListValueModel'
        type: array
  pickListValueModel:
    type: object
    properties:
      description:
        type: object
        description: The pick list value description.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      displayOrder:
        description: The order of the item in comparison to the other items.
        format: int64
        type: integer
      status:
        type: object
        description: The pick list value status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      text:
        description: The pick list display label.
        type: string
      value:
        description: The pick list value.
        type: string
  response_folderGroupModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/folderGroupModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  folderGroupModel:
    type: object
    properties:
      description:
        description: The folder group description.
        type: string
      id:
        description: The ID of the folder group assigned by the Civic Platform server.
        type: string
      isActive:
        description: Indicates whether or not the folder group is active.
        enum:
        - Y
        - N
        type: string
      name:
        description: The folder group name.
        type: string
      type:
        description: The folder group type.
        type: string
  response_resultModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/resultModel'
        type: array
      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
      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_documentFolderModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/documentFolderModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  documentFolderModel:
    type: object
    properties:
      description:
        type: object
        description: The document folder description.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      groupId:
        description: The ID of the document group.
        type: string
      groupName:
        description: The name of the document group.
        type: string
      id:
        description: The ID of the document folder assigned by the Civic Platform server.
        type: string
      isActive:
        description: Indicates whether or not the document folder is active.
        enum:
        - Y
        - N
        type: string
      order:
        description: The document folder order.
        format: int64
        type: integer
      text:
        description: The document folder display name.
        type: string
      value:
        description: The document folder value.
        type: string
  response_standardCommentGroupModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/standardCommentGroupModel'
        type: array
  standardCommentGroupModel:
    type: object
    properties:
      text:
        description: The standard comment group name.
        type: string
      value:
        description: The standard comment group value.
        type: string
  response_standardCommentModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/standardCommentModel'
        type: array
      page:
        $ref: '#/definitions/pageModel'
      status:
        type: integer
        description: The HTTP return status.
  standardCommentModel:
    type: object
    properties:
      comments:
        description: Additional notes about the comment.
        type: string
      group:
        type: object
        description: The name of the standard comments group.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      text:
        description: The comment text.
        type: string
      type:
        type: object
        description: The standard comment type.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      value:
        description: The comment value.
        type: string
  response_conditionStatusModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/conditionStatusModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  conditionStatusModel:
    type: object
    properties:
      id:
        description: The id of the condition status.
        type: string
      severity:
        items:
          type: object
          description: The condition status severity.
          properties:
            text:
              description: The localized display value.
              type: string
            value:
              description: The data value.
              type: string
        type: array
      text:
        description: The condition status name.
        type: string
      value:
        description: The condition status value.
        type: string
  response_userModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/userModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  userModel:
    type: object
    properties:
      cashierId:
        description: The unique ID associated with the cashier.
        type: string
      department:
        $ref: '#/definitions/departmentModel'
      email:
        description: The individual's email address.
        type: string
      employeeId:
        description: The unique ID associated with the employee.
        type: string
      firstName:
        description: The individual's first name.
        type: string
      fullName:
        description: The individual's full name.
        type: string
      id:
        description: The ID of the individual.
        type: string
      initial:
        description: The individual initials.
        type: string
      lastName:
        description: The individual's last name.
        type: string
      middleName:
        description: The individual's middle name.
        type: string
      namesuffix:
        description: The suffix portion of the name of a department staff member, for example; junior, esquire.
        type: string
      password:
        description: The individual's password
        type: string
      phone:
        description: The individual's phone number.
        type: string
      serviceProviderCode:
        description: The agency's unique identifier.
        type: string
      title:
        description: The individual's business title.
        type: string
      userGroups:
        items:
          $ref: '#/definitions/userGroupModel'
        type: array
      value:
        description: The ID of the individual.
        type: string
  response_tableModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/tableModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  tableModel:
    type: object
    properties:
      id:
        description: The custom table id.
        type: string
      rows:
        items:
          $ref: '#/definitions/rowModel'
        description: A table row containing custom fields.
        type: array
  rowModel:
    type: object
    properties:
      action:
        description: The requested operation on the row.
        enum:
        - add
        - update
        - delete
        type: string
      fields:
        $ref: '#/definitions/customAttributeModel'
      id:
        description: The row id.
        type: string
  response_conditionTypeModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/conditionTypeModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  conditionTypeModel:
    type: object
    properties:
      groups:
        items:
          type: object
          description: The condition type group
          properties:
            text:
              description: The localized display value.
              type: string
            value:
              description: The data value.
              type: string
        type: array
      id:
        description: The condition type id.
        type: string
      text:
        description: The condition type name.
        type: string
      value:
        description: The condition type value.
        type: string
  response_documentTypeModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/documentTypeModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  documentTypeModel:
    type: object
    properties:
      groups:
        items:
          type: object
          description: ''
          properties:
            text:
              description: The localized display value.
              type: string
            value:
              description: The data value.
              type: string
        type: array
      id:
        description: The ID of the document type assigned by the Civic Platform server.
        type: string
      text:
        description: The document type display name.
        type: string
      value:
        description: The document type value.
        type: string
  response_assetUnitTypeModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/assetUnitTypeModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  assetUnitTypeModel:
    type: object
    properties:
      recordStatus:
        description: Indicates whether or not the attribute is active.
        type: string
      updatedBy:
        description: The user who last updated the usage type.
        type: string
      updatedDate:
        description: The date and time the usage type was last updated.
        format: date-time
        type: string
      usageDescription:
        description: The usage type's description.
        type: string
      usageType:
        description: The usage type value.
        type: string
  userGroupModel:
    type: object
    properties:
      id:
        description: The ID of the user group.
        format: int64
        type: integer
      moduleName:
        description: The module the user group belongs to.
        type: string
      name:
        description: The name of the user group.
        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.
  classTypeModel:
    type: object
    properties:
      text:
        type: string
      value:
        type: string
parameters:
  authHeaderParam:
    description: Construct oAuth2 authentication token
    in: header
    name: Authorization
    required: true
    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
x-api-evangelist-provenance:
  generated: '2026-09-06'
  method: searched
  source: https://developer.accela.com/api/v4/v4-settings.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.