basePath: /
host: apis.accela.com
info:
  description: Accela API for transactional records and related record resources
  title: Records
  version: v4
schemes:
- https
swagger: '2.0'
tags:
- name: Records
  description: A record is a fundamental Civic Platform object that captures an agency's daily process tranactions, such as
    applications, permits, cases, licenses, service requests, and work orders.
- name: Records/Activities
  description: Activities related to a record can be assigned to a staff member when the activities require further action,
    such as a follow-up inspection or service maintenance.
- name: Records/Addresses
  description: A record can have at least one associated address, such as the address of the application contact or the location
    of a permit application, service request, or work order.
- name: Records/Addresses/Custom Forms
- name: Records/Assets
  description: A work order record is linked to assets that require inspection, repair service, or any kind of task that needs
    to be performed and tracked in the system.
- name: Records/Comments
  description: A staff user can add comments regarding the record, or can choose from standard comments that have been configured
    for the agency.
- name: Records/Conditions
  description: A condition is a requirement that you can apply to an application (or component of an application), that the
    application must fulfill to qualify for approval. Although conditions do not necessarily impose holds, they can prolong
    the permitting process until they met.
- name: Records/Condition Approvals
- name: Records/Contacts
  description: One or more reference contacts can be associated to an application or service request.
- name: Records/Contacts/Custom Forms
- name: Records/Contacts/Custom Tables
- name: Records/Costs
- name: Records/Custom Forms
- name: Records/Custom Tables
- name: Records/Documents
- name: Records/Fees
- name: Records/Inspections
- name: Records/Invoices
- name: Records/Owners
- name: Records/Parcels
- name: Records/Part Transactions
- name: Records/Payments
- name: Records/Professionals
- name: Records/Trust Accounts
- name: Records/Workflows
paths:
  /v4/records:
    get:
      description: "Gets record information, based on the specified query parameters.\n\n\n\n**API Endpoint**:  GET /v4/records\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  \tNo authorization required \n\n**Civic\
        \ Platform version**: 7.3.2\n\n"
      summary: Get All Records
      operationId: v4.get.records
      tags:
      - Records
      parameters:
      - description: Filter by record type. See [Get All Record Types](./api-settings.html#operation/v4.get.settings.records.types).
        in: query
        name: type
        type: string
      - description: Filter by the record's open date range, beginning with this date.
        in: query
        name: openedDateFrom
        type: string
      - description: Filter by the record's open date range, ending with this date.
        in: query
        name: openedDateTo
        type: string
      - description: Filter by the record custom id.
        in: query
        name: customId
        type: string
      - description: Filter by module. See [Get All Modules](./api-settings.html#operation/v4.get.settings.modules).
        in: query
        name: module
        type: string
      - description: Filter by record status.
        in: query
        name: status
        type: string
      - description: Filter by the assigned department.
        in: query
        name: assignedToDepartment
        type: string
      - description: Filter by the assigned user.
        in: query
        name: assignedUser
        type: string
      - description: Filter by the record's assigned date range starting with this date.
        in: query
        name: assignedDateFrom
        type: string
      - description: Filter by the record's assigned date range ending with this date.
        in: query
        name: assignedDateTo
        type: string
      - description: Filter by the record's completed date range starting with this date.
        in: query
        name: completedDateFrom
        type: string
      - description: Filter by the record's completed date range ending with this date.
        in: query
        name: completedDateTo
        type: string
      - description: Filter by the record's status date range starting with this date.
        in: query
        name: statusDateFrom
        type: string
      - description: Filter by the record's status date range ending with this date.
        in: query
        name: statusDateTo
        type: string
      - description: Filter by the deparment which completed the application.
        in: query
        name: completedByDepartment
        type: string
      - description: Filter by the user who completed the application.
        in: query
        name: completedByUser
        type: string
      - description: Filter by the record's closed date range starting with this date.
        in: query
        name: closedDateFrom
        type: string
      - description: Filter by the record's closed date range ending with this date.
        in: query
        name: closedDateTo
        type: string
      - description: Filter by the department which closed the application.
        in: query
        name: closedByDepartment
        type: string
      - description: Filter by the user who closed the application.
        in: query
        name: closedByUser
        type: string
      - description: Filter by record class
        in: query
        name: recordClass
        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_simpleRecordModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    post:
      description: "Creates a new, full record in Civic Platform. The Create Record API triggers the business rules engine\
        \ event ApplicationSubmitAfter. \n\n Note: The Create Record API does not include custom forms and custom tables in\
        \ the request body. To add or update custom forms and custom tables, use the [Update Record Custom Forms](./api-records.html#operation/v4.put.records.recordId.customForms)\
        \ and [Update Record Custom Tables](./api-records.html#operation/v4.put.records.recordId.customForms) after the Create\
        \ Record request.\n\n\n\n**API Endpoint**:  POST /v4/records \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: Create Record
      operationId: v4.post.records
      tags:
      - Records
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: The create record information to be added.
        in: body
        name: body
        schema:
          $ref: '#/definitions/request_createRecordModel'
      - $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_simpleRecordModel'
        '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/records/describe/create:
    get:
      tags:
      - Records
      summary: Describe Required Record Attributes
      description: "Gets the field and element values the system requires in order to create a specific type of record.\n\n\
        \n\n**API Endpoint**:  GET /v4/records/describe/create  \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization\
        \ Type**:  Access token \n\n**Civic Platform version**: \t7.3.2\n\n"
      operationId: v4.get.records.describe.create
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: Filter by record type. See [Get All Record Type](./api-settings.html#operation/v4.get.settings.records.types).
        in: query
        name: type
        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_describeRecordModel'
        '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/records/initialize:
    post:
      tags:
      - Records
      summary: Create Partial Record
      description: "Creates a partial record that allows a user to save an incomplete application that is work in-progress.\
        \ To submit the completed application, use the [Finalize Record](./api-records.html#operation/v4.post.records.recordId.finalize)\
        \ method. See [Creating Records](https://developer.accela.com/docs/construct-api-records.html#construct-api-records__creatingRecords)\
        \ for more information about calling Create Partial Record in tandem with Finalize Record.  \n\nThe Create Partial\
        \ Record API triggers the business rules engine event ApplicationSubmitAfter. \n\nNote: The Create Partial Record\
        \ API does not include custom forms and custom tables in the request body. To add or update custom forms and custom\
        \ tables, use the [Update Record Custom Forms](./api-records.html#operation/v4.put.records.recordId.customForms) and\
        \ [Update Record Custom Tables](./api-records.html#operation/v4.put.records.recordId.customForms) between the Create\
        \ Partial Record and Finalize Record requests.\n\n\n\n**API Endpoint**:  POST /v4/records/initialize \n\n**Scope**:\
        \  records \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: \t7.3.2\n\
        \n"
      operationId: v4.post.records.initialize
      parameters:
      - description: The record information to be initialized.
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/request_recordModel'
      - description: Indicates whether or not it is for a fee estimate.
        enum:
        - 'true'
        - ' false'
        in: query
        name: isFeeEstimate
        required: false
        type: boolean
      - $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_simpleRecordModel'
        '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/records/mine:
    get:
      description: "Gets records for the currently logged-in user.\n\n\n\n**API Endpoint**:  GET /v4/records/mine \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 My Records
      operationId: v4.get.records.mine
      tags:
      - Records
      parameters:
      - description: Filter by record type. See [Get All Record Types](./api-settings.html#operation/v4.get.settings.records.types).
        in: query
        name: type
        type: string
      - description: Filter by the record's open date range, beginning with this date.
        in: query
        name: openedDateFrom
        type: string
      - description: Filter by the record's open date range, ending with this date.
        in: query
        name: openedDateTo
        type: string
      - description: Filter by the record custom id.
        in: query
        name: customId
        type: string
      - description: Filter by module. See [Get All Modules](./api-settings.html#operation/v4.get.settings.modules).
        in: query
        name: module
        type: string
      - description: Filter by record status.
        in: query
        name: status
        type: string
      - description: Filter by the record's assigned date range starting with this date.
        in: query
        name: assignedDateFrom
        type: string
      - description: Filter by the record's assigned date range ending with this date.
        in: query
        name: assignedDateTo
        type: string
      - description: Filter by the record's completed date range starting with this date.
        in: query
        name: completedDateFrom
        type: string
      - description: Filter by the record's completed date range ending with this date.
        in: query
        name: completedDateTo
        type: string
      - description: Filter by the record's status date range starting with this date.
        in: query
        name: statusDateFrom
        type: string
      - description: Filter by the record's status date range ending with this date.
        in: query
        name: statusDateTo
        type: string
      - description: Record update Date From
        in: query
        name: updateDateFrom
        type: string
      - description: Record update Date To
        in: query
        name: updateDateTo
        type: string
      - description: Filter by the deparment which completed the application.
        in: query
        name: completedByDepartment
        type: string
      - description: Filter by the user who completed the application.
        in: query
        name: completedByUser
        type: string
      - description: Filter by the record's closed date range starting with this date.
        in: query
        name: closedDateFrom
        type: string
      - description: Filter by the record's closed date range ending with this date.
        in: query
        name: closedDateTo
        type: string
      - description: Filter by the department which closed the application.
        in: query
        name: closedByDepartment
        type: string
      - description: Filter by the user who closed the application.
        in: query
        name: closedByUser
        type: string
      - description: Filter by record class
        in: query
        name: recordClass
        type: string
      - description: Filter by comma-separated multiple record types.
        in: query
        name: types
        type: string
      - description: Filter by comma-separated multiple modules.
        in: query
        name: modules
        type: string
      - description: Filter by comma-separated multiple record status types.
        in: query
        name: statusTypes
        type: string
      - description: Comma-delimited list of 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:
        - addresses
        - parcels
        - professionals
        - contacts
        - owners
        - customForms
        - customTables
        type: string
      - name: expandCustomForms
        description: "Valid values: \"addresses\"\n          \nIf {expand} includes any of addresses, parcels, owners, or\
          \ contacts, {expandCustomForms} specifies which {expand} objects should include custom forms. By default, custom\
          \ forms for addresses, parcels, owners, and contacts are not included in the response data. Note that requesting\
          \ APO custom forms may have performance implications, depending on the amount of data and connectivity to any external\
          \ data source.\n\nAdded in Civic Platform version: 9.2.0\n"
        in: query
        type: string
        enum:
        - addresses
      - $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_recordExtModel_1Array'
        '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/records/{ids}:
    delete:
      tags:
      - Records
      summary: Delete Records
      description: "Deletes the specified record.\n\n\n\n**API Endpoint**:  DELETE /v4/records/{ids} \n\n**Scope**:  records\
        \ \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: \t7.3.3\n\n"
      operationId: v4.delete.records.ids
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: Comma-delimited IDs of the records to be deleted.
        in: path
        name: ids
        required: true
        type: string
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_resultModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    get:
      tags:
      - Records
      summary: Get Records
      description: "Gets the requested record(s).\n\n\n\n**API Endpoint**:  GET /v4/records/{ids} \n\n**Scope**:  records\
        \ \n\n**App Type**:  All \n\n**Authorization Type**:  No authorization required \n\n**Civic Platform version**: \t\
        7.3.2\n\n"
      operationId: v4.get.records.ids
      parameters:
      - description: Comma-delimited IDs of the records to fetch.
        in: path
        name: ids
        required: true
        type: string
      - description: Comma-delimited list of 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:
        - addresses
        - parcels
        - professionals
        - contacts
        - owners
        - customForms
        - customTables
        - assets
        type: string
      - name: expandCustomForms
        description: 'Valid values: "addresses"


          If {expand} includes any of addresses, parcels, owners, or contacts, {expandCustomForms} specifies which {expand}
          objects should include custom forms. By default, custom forms for addresses, parcels, owners, and contacts are not
          included in the response data. Note that requesting APO custom forms may have performance implications, depending
          on the amount of data and connectivity to any external data source.


          Added in Civic Platform version: 9.2.0

          '
        in: query
        type: string
        enum:
        - addresses
      - $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_recordModelArray'
        '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/records/{id}:
    put:
      tags:
      - Records
      summary: Update Record
      description: "Updates details for the specified record. \n\n\n\n**API Endpoint**:  PUT /v4/records/{id} \n\n**Scope**:\
        \  records \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: \t7.3.2\n\
        \n"
      operationId: v4.put.records.id
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: The ID of the record to update.
        in: path
        name: id
        required: true
        type: string
      - description: Record information to be updated.
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/request_simpleRecordModel'
      - $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/simpleRecordModel'
        '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/records/{recordId}/activities:
    get:
      description: "Gets all activities related to the specified record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/activities\
        \ \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 Activities
      operationId: v4.get.records.recordId.activities
      tags:
      - Records/Activities
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $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_activityModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    post:
      description: "Creates activities associated to the specified record.\n\n\n\n**API Endpoint**:  POST /v4/records/{recordId}/activities\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.3.2\n\n"
      summary: Create Record Activities
      operationId: v4.post.records.recordId.activities
      tags:
      - Records/Activities
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: The activity information to be added.
        in: body
        name: body
        required: true
        schema:
          items:
            $ref: '#/definitions/request_activityAddModel'
          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/records/{recordId}/activities/{id}:
    put:
      description: "Updates the activity for the specified record.\n\n\n\n**API Endpoint**:  PUT /v4/records/{recordId}/activities/{id}\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.3.2\n\n"
      summary: Update Record Activity
      operationId: v4.put.records.recordId.activities.id
      tags:
      - Records/Activities
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: The ID of the record activity to update.
        format: int64
        in: path
        name: id
        required: true
        type: integer
      - description: The activity information to be updated.
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/request_activityUpdateModel'
      - $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_resultModel'
        '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/records/{recordId}/additional:
    get:
      tags:
      - Records
      summary: Get Additional Details for Record
      description: "Gets additional information for the requested record. \n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/additional\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ \t7.3.2\n\n"
      operationId: v4.get.records.recordId.additional
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: The ID of record to fetch.
        in: path
        name: recordId
        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_recordAdditionalModelArray'
        '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:
      tags:
      - Records
      summary: Update Additional Details for Record
      description: "Updates additional information for the specified record. \n\n\n\n**API Endpoint**:  PUT /v4/records/{recordId}/additional\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ \t7.3.2\n\n"
      operationId: v4.put.records.recordId.additional
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: The ID of the record to fetch.
        in: path
        name: recordId
        required: true
        type: string
      - description: Additional record information for update.
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/recordAdditionalModel'
      - $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_recordAdditionalModelArray'
        '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/records/{recordId}/addresses:
    get:
      tags:
      - Records/Addresses
      summary: Get All Record Addresses
      description: "Gets the addresses linked to the specified record. \n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/addresses\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  No auth required \n\n**Civic Platform\
        \ version**: 7.3.3.2\n\n"
      operationId: v4.get.records.recordId.addresses
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: Filter by the primary address flag.
        in: query
        name: isPrimary
        required: false
        type: string
      - $ref: '#/parameters/fields'
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            items:
              $ref: '#/definitions/recordAddressModel'
            type: array
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    post:
      tags:
      - Records/Addresses
      summary: Create Record Addresses
      description: "Creates new address(es) for the specified record.\n\n\n\n**API Endpoint**:  POST /v4/records/{recordId}/addresses\
        \ \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"
      operationId: v4.post.records.recordId.addresses
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Record address request information to be created.
        in: body
        name: body
        required: false
        schema:
          items:
            $ref: '#/definitions/recordAddressModel'
          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/records/{recordId}/addresses/{id}:
    put:
      description: "Updates the address for the specified record.\n\n\n\n**API Endpoint**:  PUT /v4/records/{recordId}/addresses/{id}\
        \ \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: Update Record Address
      operationId: v4.put.records.recordId.addresses.id
      tags:
      - Records/Addresses
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: The ID of the address to update.
        format: int64
        in: path
        name: id
        required: true
        type: integer
      - description: Address information to be updated.
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/request_recordAddressModel'
      - $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/addressModel'
        '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/records/{recordId}/addresses/{ids}:
    delete:
      tags:
      - Records/Addresses
      summary: Delete Record Addresses
      description: "Deletes addresses from the specified record.\n\n\n\n**API Endpoint**:  DELETE /v4/records/{recordId}/addresses/{idS}\
        \ \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"
      operationId: v4.delete.records.recordId.addresses.ids
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Comma-delimited IDs of of the addresses to be deleted.
        in: path
        name: ids
        required: true
        type: string
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_resultModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
  /v4/records/{recordId}/addresses/{addressId}/customForms:
    get:
      summary: Get Record Address Custom Forms
      description: "Returns an array of custom form data associated with a given record address.\n\n\n\n**API Endpoint**:\
        \  GET /v4/records/{recordId}/addresses/{addressId}/customForms \n\n**Scope**:  records \n\n**App Type**:  All \n\n\
        **Authorization Type**:  Access token \n\n**Civic Platform version**: 9.2.0\n\n"
      operationId: v4.get.records.recordId.addresses.addressId.customForms
      tags:
      - Records/Addresses/Custom Forms
      parameters:
      - description: Construct oAuth2 authentication token
        in: header
        name: Authorization
        required: true
        type: string
      - description: The ID of the record to be fetched
        in: path
        name: recordId
        required: true
        type: string
      - description: The ID of the address to be fetched
        format: int64
        in: path
        name: addressId
        required: true
        type: integer
      - description: Comma-delimited names of fields to be returned in the response. Note that field names are case-sensitive
          and only first-level fields are supported. Invalid field names are ignored.
        in: query
        name: fields
        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_customAttributeModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
  /v4/records/{recordId}/addresses/{addressId}/customForms/meta:
    get:
      summary: Get Record Address Custom Forms Metadata
      description: "Returns the field metadata for all custom forms associated with a given record address.\n\n\n\n**API Endpoint**:\
        \  GET /v4/records/{recordId}/addresses/{addressId}/customForms/meta \n\n**Scope**:  records \n\n**App Type**:  All\
        \ \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: 9.2.0\n\n"
      tags:
      - Records/Addresses/Custom Forms
      operationId: v4.get.records.recordId.addresses.addressId.customForms.meta
      parameters:
      - description: Construct oAuth2 authentication token
        in: header
        name: Authorization
        required: true
        type: string
      - description: ID of record to be fetched
        in: path
        name: recordId
        required: true
        type: string
      - description: ID of record address to be fetched
        format: int64
        in: path
        name: addressId
        required: true
        type: integer
      - description: Comma-delimited names of fields to be returned in the response. Note that 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
      - 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/records/{recordId}/assets:
    get:
      description: "Returns all assets for a given record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/assets \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 Assets for Record
      operationId: v4.get.records.recordId.assets
      tags:
      - Records/Assets
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $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_assetMasterModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    post:
      description: "Adds one or more assets to a given record.\n\n\n\n**API Endpoint**:  POST /v4/records/{recordId}/assets\
        \ \n\n**Scope**:  records \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.2\n\n"
      summary: Add Assets to Record
      operationId: v4.post.records.recordId.assets
      tags:
      - Records/Assets
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: An array of asset IDs to be linked to the record.
        in: body
        name: assetIds
        schema:
          items:
            type: string
          type: array
      - $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_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/records/{recordId}/assets/{ids}:
    delete:
      description: "Deletes one or more assets from a given record.\n\n\n\n**API Endpoint**:  DELETE /v4/records/{recordId}/assets/{ids}\
        \ \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: Delete Assets from Record
      operationId: v4.delete.records.recordId.assets.ids
      tags:
      - Records/Assets
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Comma-delimited IDs of the assets to be removed.
        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/records/{recordId}/comments:
    get:
      description: "Gets comments associated to a record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/comments \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 Comments for Record
      operationId: v4.get.records.recordId.comments
      tags:
      - Records/Comments
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_recordCommentModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    post:
      description: "Add comments to a record.\n\n\n\n**API Endpoint**:  POST /v4/records/{recordId}/comments  \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: Add Comments to a Record
      operationId: v4.post.records.recordId.comments
      tags:
      - Records/Comments
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Record comments to be added.
        in: body
        name: body
        schema:
          items:
            $ref: '#/definitions/commentModel'
          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/records/{recordId}/comments/{id}:
    put:
      description: "Update a record comment.\n\n\n\n**API Endpoint**:  PUT /v4/records/{recordId}/comments/{id} \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: Update Record Comment
      operationId: v4.put.records.recordId.comments.id
      tags:
      - Records/Comments
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: The ID of the comment to update.
        format: int64
        in: path
        name: id
        required: true
        type: integer
      - description: Comments to be updated.
        in: body
        name: body
        schema:
          $ref: '#/definitions/commentModel'
      - $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_recordCommentModel'
        '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/records/{recordId}/comments/{ids}:
    delete:
      tags:
      - Records/Comments
      summary: Delete Record Comments
      description: "Deletes the specified comment(s) for the specified record.\n\n\n\n**API Endpoint**:  DELETE /v4/records/{recordId}/comments/{idS}\
        \ \n\n**Scope**:  \n\n\n\n**API Endpoint**:  \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 \n\n**App Type**:  All \n\n**Authorization Type**:\
        \  Access token \n\n**Civic Platform version**: 7.3.2\n\n"
      operationId: v4.delete.records.recordId.comments.ids
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Comma-delimited IDs of the record comments to be deleted.
        in: path
        name: ids
        required: true
        type: string
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_resultModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
  /v4/records/{recordId}/conditionApprovals:
    get:
      description: "Gets the conditions of approval for the specified record(s).\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/conditionApprovals\
        \ \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 Approval Conditions for Record
      operationId: v4.get.records.recordId.conditionApprovals
      tags:
      - Records/Condition Approvals
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $ref: '#/parameters/fields'
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            items:
              $ref: '#/definitions/recordConditionModel'
            type: array
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    post:
      description: "Adds approval conditions to the specified record.\n\n\n\n**API Endpoint**:  POST /v4/records/{recordId}/conditionApprovals\
        \ \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: Create Record Approval Conditions
      operationId: v4.post.records.recordId.conditionApprovals
      tags:
      - Records/Condition Approvals
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Record condition information to be added.
        in: body
        name: body
        required: true
        schema:
          items:
            $ref: '#/definitions/recordConditionModel'
          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/records/{recordId}/conditionApprovals/{id}:
    get:
      description: "Gets the specified condition of approvals for the specified record(s).\n\n\n\n**API Endpoint**: GET /v4/records/{recordId}/conditionApprovals/{id}\
        \  \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 Record Approval Condition
      operationId: v4.get.records.recordId.conditionApprovals.id
      tags:
      - Records/Condition Approvals
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: The ID of record condition approval 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_recordConditionModelArray'
        '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 the condition of approvals for the specified record(s).\n\n\n\n**API Endpoint**:  PUT /v4/records/{recordId}/conditionApprovals/{id}\
        \ \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: Update Record Approval Condition
      operationId: v4.put.records.recordId.conditionApprovals.id
      tags:
      - Records/Condition Approvals
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: The ID of the condition approval to update.
        in: path
        name: id
        required: true
        type: string
      - description: The condition approval information to be updated.
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/request_recordConditionModel'
      - $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_recordConditionModelArray'
        '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/records/{recordId}/conditionApprovals/{ids}:
    delete:
      description: "Deletes approval conditions for the specified record.\n\n\n\n**API Endpoint**:  DELETE /v4/records/{recordId}/conditionApprovals/{ids}\
        \ \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: Delete Record Approval Conditions
      operationId: v4.delete.records.recordId.conditionApprovals.ids
      tags:
      - Records/Condition Approvals
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Comma-delimited IDs of the approval conditions to be deleted.
        in: path
        name: ids
        required: true
        type: string
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_resultModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
  /v4/records/{recordId}/conditions:
    get:
      description: "Gets all conditions for the specified record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/conditions\
        \ \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 Conditions for Record
      operationId: v4.get.records.recordId.conditions
      tags:
      - Records/Conditions
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $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_recordConditionModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    post:
      description: "Adds a condition to the specified record.\n\n\n\n**API Endpoint**:  POST /v4/records/{recordId}/conditions\
        \ \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: Create Record Conditions
      operationId: v4.post.records.recordId.conditions
      tags:
      - Records/Conditions
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Condition information to be added.
        in: body
        name: body
        required: true
        schema:
          items:
            $ref: '#/definitions/recordConditionModel'
          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/records/{recordId}/conditions/{id}:
    get:
      description: "Gets a record condition.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/conditions/{id} \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 Record Condition
      operationId: v4.get.records.recordId.conditions.id
      tags:
      - Records/Conditions
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: The ID of record condition to fetch.
        format: int64
        in: path
        name: id
        required: true
        type: integer
      - $ref: '#/parameters/fields'
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/recordConditionModel'
        '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: "Update a record condition.\n\n\n\n**API Endpoint**:  PUT /v4/records/{recordId}/conditions/{id} \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: Update Record Condition
      operationId: v4.put.records.recordId.conditions.id
      tags:
      - Records/Conditions
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: Record condition information to be updated.
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/recordConditionModel'
      - $ref: '#/parameters/recordId'
      - description: The ID of record condition 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/recordConditionModel'
        '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/records/{recordId}/conditions/{id}/histories:
    get:
      description: "Gets the history for a given record condition.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/conditions/{id}/histories\
        \ \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 History for Record Condition
      operationId: v4.get.records.recordId.conditions.id.histories
      tags:
      - Records/Conditions
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: The ID of record condition to fetch.
        format: int64
        in: path
        name: id
        required: true
        type: integer
      - $ref: '#/parameters/fields'
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/conditionHistoryModel'
        '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/records/{recordId}/conditions/{ids}:
    delete:
      description: "Deletes conditions for the specified record.\n\n\n\n**API Endpoint**:  DELETE /v4/records/{recordId}/conditions/{ids}\
        \ \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: Delete Record Conditions
      operationId: v4.delete.records.recordId.conditions.ids
      tags:
      - Records/Conditions
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Comma-delimited ids of the conditions to be deleted.
        in: path
        name: ids
        required: true
        type: string
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_resultModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
  /v4/records/{recordId}/contacts:
    get:
      description: "Gets contacts associated to a record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/contacts \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 Contacts for Record
      operationId: v4.get.records.recordId.contacts
      tags:
      - Records/Contacts
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $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_recordContactSimpleModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    post:
      description: "Creates new contact(s) for the specified record.\n\n\n\n**API Endpoint**:  POST /v4/records/{recordId}/contacts\
        \ \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: Create Record Contacts
      operationId: v4.post.records.recordId.contacts
      tags:
      - Records/Contacts
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: The contact information to be added.
        in: body
        name: body
        required: true
        schema:
          items:
            $ref: '#/definitions/recordContactSimpleModel'
          type: array
      - $ref: '#/parameters/fields'
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_resultModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
  /v4/records/{recordId}/contacts/{id}:
    put:
      description: "Updates information for a specified contact associated with a specified record.\n\n\n\n**API Endpoint**:\
        \  PUT /v4/records/{recordId}/contacts/{id} \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: Update Record Contact
      operationId: v4.put.records.recordId.contacts.id
      tags:
      - Records/Contacts
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: The contact information to be updated.
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/recordContactSimpleModel'
      - description: The ID of the contact to update.
        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_recordContactSimpleModelArray'
        '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/records/{recordId}/contacts/{ids}:
    delete:
      description: "Removes the association of specified contacts from a specified record.\n\n\n\n**API Endpoint**:  DELETE\
        \ /v4/records/{recordId}/contacts/{ids} \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: Delete Record Contacts
      operationId: v4.delete.records.recordId.contacts.ids
      tags:
      - Records/Contacts
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Comma-delimited IDs of the contacts to remove.
        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_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/records/{recordId}/contacts/{contactId}/addresses:
    get:
      description: "Gets the addresses for the specified contacts and specified records.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/contacts/{contactId}/addresses\
        \ \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 Addresses for Contact
      operationId: v4.get.records.recordId.contacts.contactId.addresses
      tags:
      - Records/Contacts
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $ref: '#/parameters/contactId'
      - $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_contactAddressArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    post:
      description: "Creates addresses for the specified contact for the specified record.\n\n\n\n**API Endpoint**:  POST /v4/records/{recordId}/contacts/{contactId}/addresses\
        \ \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: Create Record Contact Addresses
      operationId: v4.post.records.recordId.contacts.contactId.addresses
      tags:
      - Records/Contacts
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $ref: '#/parameters/contactId'
      - description: The address information to be added.
        in: body
        name: body
        required: false
        schema:
          items:
            $ref: '#/definitions/contactAddress'
          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/records/{recordId}/contacts/{contactId}/addresses/{id}:
    put:
      description: "Updates the specified address for the specified contact and specified record.\n\n\n\n**API Endpoint**:\
        \  PUT /v4/records/{recordId}/contacts/{contactId}/addresses/{id} \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: Update Record Contact Address
      operationId: v4.put.records.recordId.contacts.contactId.addresses.id
      tags:
      - Records/Contacts
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $ref: '#/parameters/contactId'
      - description: The ID of the address to be updated.
        in: path
        name: id
        required: true
        format: int64
        type: integer
      - description: The address information to be updated.
        in: body
        name: body
        required: false
        schema:
          $ref: '#/definitions/contactAddress'
      - $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/contactAddress'
        '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/records/{recordId}/contacts/{contactId}/addresses/{ids}:
    delete:
      description: "Deletes the specified addresses from the specified contacts and specified records.\n\n\n\n**API Endpoint**:\
        \  DELETE /v4/records/{recordId}/contacts/{contactId}/addresses/{ids} \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: Delete Record Contact Addresses
      operationId: v4.delete.records.recordId.contacts.contactId.addresses.ids
      tags:
      - Records/Contacts
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $ref: '#/parameters/contactId'
      - description: Comma-delimited IDs of the addresses to be deleted.
        in: path
        name: ids
        required: true
        type: string
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_resultModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
  /v4/records/{recordId}/contacts/{contactId}/customForms:
    get:
      description: "Returns an array of custom forms associated with the specified record contact. Each custom form consists\
        \ of the custom form id and custom field name-and-value pairs.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/contacts/{contactId}/customForms\
        \ \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 Record Contacts Custom Forms
      operationId: v4.get.records.recordId.contacts.contactId.customForms
      tags:
      - Records/Contacts/Custom Forms
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $ref: '#/parameters/contactId'
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_customAttributeModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    put:
      description: "Updates the custom forms for the specified record contact. The request body is an array of custom forms,\
        \ with each item containing the custom form's id and custom field name/value pairs. \n\n\n\n**API Endpoint**:  PUT\
        \ /v4/records/{recordId}/contacts/{contactId}/customForms  \n\n**Scope**:  records \n\n**App Type**:  Agency \n\n\
        **Authorization Type**:  Access token \n\n**Civic Platform version**: 7.3.2\n\n"
      summary: Update Record Contact Custom Forms
      operationId: v4.put.records.recordId.contacts.contactId.customForms
      tags:
      - Records/Contacts/Custom Forms
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $ref: '#/parameters/contactId'
      - description: 'The custom form information to be updated. Example: [{ "field1": "field1Val", "field2": "field2Val",
          "id": "Group&SubGroup" }]'
        in: body
        name: body
        required: true
        schema:
          items:
            $ref: '#/definitions/customAttributeModel'
          type: array
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_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/records/{recordId}/contacts/{contactId}/customForms/meta:
    get:
      description: "Gets the custom forms metadata associated with the specified record contact.\n\n\n\n**API Endpoint**:\
        \  GET /v4/records/{recordId}/contacts/{contactId}/customForms/meta \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 Record Contacts Custom Forms Meta
      operationId: v4.get.records.recordId.contacts.contactId.customForms.meta
      tags:
      - Records/Contacts/Custom Forms
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $ref: '#/parameters/contactId'
      - $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_customFormSubgroupModelArray'
        '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/records/{recordId}/contacts/{contactId}/customForms/{formId}/meta:
    get:
      description: "Gets the metadata associated with the requested custom form for the record contact.\n\n\n\n**API Endpoint**:\
        \  GET /v4/records/{recordId}/contacts/{contactId}/customForms/{formId}/meta \n\n**Scope**:  records \n\n**App Type**:\
        \  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: 9.2.0\n\n"
      summary: Get Record Contact Custom Form Metadata
      operationId: v4.get.records.recordId.contacts.contactId.customForms.formId.meta
      tags:
      - Records/Contacts/Custom Forms
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $ref: '#/parameters/contactId'
      - description: The ID of the custom form to fetch.
        in: path
        name: formId
        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/records/{recordId}/contacts/{contactId}/customTables:
    get:
      description: "Gets the custom tables associated with the specified record contact.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/contacts/{contactId}/customTables\
        \ \n\n**Scope**:  records \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 for Record Contact
      operationId: v4.get.records.recordId.contacts.contactId.customTables
      tags:
      - Records/Contacts/Custom Tables
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $ref: '#/parameters/contactId'
      - $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_tableModelArray'
        '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 the custom tables for the specified record contact. The request body is an array of custom tables,\
        \ each with the custom table id and an array of rows. Use this API to add, update and delete rows from an existing\
        \ custom table. (Custom tables are defined in Civic Platform.) Note that the modified custom table data only applies\
        \ to the transactional record contact, not the reference contact.\n\n\n\n**API Endpoint**:  PUT /v4/records/{recordId}/contacts/{contactId}/customTables\
        \ \n\n**Scope**:  records \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 8.0.3\n\n"
      summary: Update Record Custom Tables
      operationId: v4.put.records.recordId.contacts.contactId.customTables
      tags:
      - Records/Contacts/Custom Tables
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $ref: '#/parameters/contactId'
      - description: The custom table information to be updated.
        in: body
        name: body
        schema:
          items:
            $ref: '#/definitions/tableModel'
          type: array
      - $ref: '#/parameters/fields'
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_resultModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
  /v4/records/{recordId}/contacts/{contactId}/customTables/meta:
    get:
      description: "Gets the metadata of all custom tables associated with the specified record contact.\n\n\n\n**API Endpoint**:\
        \  GET /v4/records/{recordId}/contacts/{contactId}/customTables/meta \n\n**Scope**:  records \n\n**App Type**:  Agency\
        \ \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: 8.0.3\n\n"
      summary: Get Metadata of All Record Contact Custom Tables
      operationId: v4.get.records.recordId.contacts.contactId.customTables.meta
      tags:
      - Records/Contacts/Custom Tables
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $ref: '#/parameters/contactId'
      - $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_customFormSubgroupModelArray'
        '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/records/{recordId}/contacts/{contactId}/customTables/{tableId}/meta:
    get:
      description: "Gets the metadata of a specified custom table associated with the specified record contact.\n\n\n\n**API\
        \ Endpoint**:  GET /v4/records/{recordId}/contacts/{contactId}/customTables/{tableId}/meta \n\n**Scope**:  records\
        \ \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: 8.0.3\n\n"
      summary: Get Metadata of a Record Contact Custom Table
      operationId: v4.get.records.recordId.contacts.contactId.customTables.tableId.meta
      tags:
      - Records/Contacts/Custom Tables
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $ref: '#/parameters/contactId'
      - description: The custom table ID to fetch.
        in: path
        name: tableId
        required: true
        type: string
      - $ref: '#/parameters/fields'
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_customFormSubgroupModelArray'
        '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/records/{recordId}/costs:
    get:
      description: "Returns the costs associated to a given record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/costs\
        \ \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 Record Costs
      operationId: v4.get.records.recordId.costs
      tags:
      - Records/Costs
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $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_costingModelArray'
        '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/records/{recordId}/costs/{ids}:
    delete:
      description: "Deletes one or more costs from a given record.\n\n\n\n**API Endpoint**:  DELETE /v4/records/{recordId}/costs/{ids}\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 9.0.0\n\n"
      summary: Delete Record Costs
      operationId: v4.delete.records.recordId.costs.ids
      tags:
      - Records/Costs
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Comma-delimited IDs of costs to be removed
        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.
    put:
      description: "Update the details of the costs for given records.\n\n\n\n**API Endpoint**:  PUT /v4/records/{recordId}/costs/{id}\
        \ \n\n**Scope**:  costs \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 20.1.4\n\n"
      summary: Update Record Costs
      operationId: v4.put.records.recordId.costs.id
      tags:
      - Records/Costs
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: The ID of the record to update.
        in: path
        name: recordId
        required: true
        type: string
      - description: The ID of the cost to update.
        in: path
        name: id
        required: true
        type: string
      - $ref: '#/parameters/lang'
      - description: The cost information to be updated.
        in: body
        name: body
        required: true
        schema:
          items:
            $ref: '#/definitions/request_costingModelArray'
          type: array
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_costingModelArray'
        '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/records/{recordId}/customForms:
    get:
      description: "Returns an array of custom forms associated with the specified record. Each custom form consists of custom\
        \ field name-and-value pairs.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/customForms \n\n**Scope**:  records\
        \ \n\n**App Type**:  All \n\n**Authorization Type**:  \tNo authorization required \n\n**Civic Platform version**:\
        \ 7.3.2\n\n"
      summary: Get All Custom Forms for Record
      operationId: v4.get.records.recordId.customForms
      tags:
      - Records/Custom Forms
      parameters:
      - $ref: '#/parameters/recordId'
      - $ref: '#/parameters/fields'
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_customAttributeModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    put:
      description: "Updates the custom form for the specified record.\n\n\n\n**API Endpoint**:  PUT /v4/records/{recordId}/customForms\
        \  \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: Update Record Custom Forms
      operationId: v4.put.records.recordId.customForms
      tags:
      - Records/Custom Forms
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: 'Custom form informatio to be updated. Example: [{ "field1": "field1Val", "field2": "field2Val", "_Id_":
          "Group&SubGroup" }]'
        in: body
        name: body
        required: true
        schema:
          items:
            $ref: '#/definitions/customAttributeModel'
          type: array
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_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/records/{recordId}/customForms/meta:
    get:
      description: "Gets the detailed data associated with the custom forms for the specified record.\n\n\n\n**API Endpoint**:\
        \  GET /v4/records/{recordId}/customForms/meta \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
      operationId: v4.get.records.recordId.customForms.meta
      tags:
      - Records/Custom Forms
      parameters:
      - $ref: '#/parameters/recordId'
      - $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_customFormSubgroupModelArray'
        '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/records/{recordId}/customForms/{formId}/meta:
    get:
      description: "Gets the detailed data associated with the specified custom form for the specified record.\n\n\n\n**API\
        \ Endpoint**:  GET /v4/records/{recordId}/customForms/{formId}/meta \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 Custom Form Metadata for Record
      operationId: v4.get.records.recordId.customForms.formId.meta
      tags:
      - Records/Custom Forms
      parameters:
      - $ref: '#/parameters/recordId'
      - description: The ID of the custom form to fetch.).
        in: path
        name: formId
        required: true
        type: string
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_customFormSubgroupModelArray'
        '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/records/{recordId}/customTables:
    get:
      description: "Gets all the custom tables associated with the specified record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/customTables\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  \tNo authorization required \n\n**Civic\
        \ Platform version**: 7.3.2\n\n"
      summary: Get All Custom Tables for Record
      operationId: v4.get.records.recordId.customTables
      tags:
      - Records/Custom Tables
      parameters:
      - $ref: '#/parameters/recordId'
      - $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_tableModelArray'
        '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 the custom table for the specified record.\n\n\n\n**API Endpoint**:  PUT /v4/records/{recordId}/customTables\
        \  \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: Update Record Custom Tables
      operationId: v4.put.records.recordId.customTables
      tags:
      - Records/Custom Tables
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Custom table data to be updated.
        in: body
        name: body
        required: true
        schema:
          items:
            $ref: '#/definitions/tableModel'
          type: array
      - $ref: '#/parameters/fields'
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_resultModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
  /v4/records/{recordId}/customTables/{tableId}:
    get:
      description: "Gets the requested custom table for the specified record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/customTables/{tableId}\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  \tNo authorization required \n\n**Civic\
        \ Platform version**: 7.3.2\n\n"
      summary: Get Record Custom Table
      operationId: v4.get.records.recordId.customTables.tableId
      tags:
      - Records/Custom Tables
      parameters:
      - $ref: '#/parameters/recordId'
      - description: The ID of the custom table to fetch.
        in: path
        name: tableId
        required: true
        type: string
      - $ref: '#/parameters/fields'
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_tableModelArray'
        '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/records/{recordId}/customTables/meta:
    get:
      description: "Gets detailed data associated with the custom tables for the specified record.\n\n\n\n**API Endpoint**:\
        \  GET /v4/records/{recordId}/customTables/meta \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
      operationId: v4.get.records.recordId.customTables.meta
      tags:
      - Records/Custom Tables
      parameters:
      - $ref: '#/parameters/recordId'
      - $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_customFormSubgroupModelArray'
        '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/records/{recordId}/customTables/{tableId}/meta:
    get:
      description: "Gets the detailed data associated with the specified custom table for the specified record.\n\n\n\n**API\
        \ Endpoint**:  GET /v4/records/{recordId}/customTables/{tableId}/meta \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 Custom Table Metadata for Record
      operationId: v4.get.records.recordId.customTables.tableId.meta
      tags:
      - Records/Custom Tables
      parameters:
      - $ref: '#/parameters/recordId'
      - description: The ID of the custom table to fetch.
        in: path
        name: tableId
        required: true
        type: string
      - $ref: '#/parameters/fields'
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_customFormSubgroupModelArray'
        '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/records/{recordId}/documentCategories:
    get:
      description: "Gets the document types associated with the specified record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/documentCategories\
        \ \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 Document Categories for Record
      operationId: v4.get.records.recordId.documentCategories
      tags:
      - Records/Documents
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $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/records/{recordId}/documents:
    get:
      description: "Gets the documents associated with the specified record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/documents\
        \ \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 Documents for Record
      operationId: v4.get.records.recordId.documents
      tags:
      - Records/Documents
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $ref: '#/parameters/fields'
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_documentModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    post:
      description: "Creates one or more document attachments for the specified record. To specify the documents to be attached,\
        \ use the HTTP header \"Content-Type:multipart/form-data\" and form-data for \"uploadedFile\" and \"fileInfo\". Note\
        \ that the \"fileInfo\" is a string containing an array of file attributes. Use \"fileInfo\" to specify one or more\
        \ documents to be attached. See the example for details.\n\n\n\n**API Endpoint**:  POST /v4/records/{recordId}/documents\
        \  \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: Create Record Documents
      operationId: v4.post.records.recordId.documents
      tags:
      - Records/Documents
      consumes:
      - multipart/form-data
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Specify the filename parameter with the file to be uploaded. See example for details.
        in: formData
        name: uploadedFile
        required: true
        type: file
      - description: A string array containing the file metadata for each specified filename. See example for details.
        in: formData
        name: fileInfo
        type: string
        required: true
      - description: The document group
        in: query
        name: group
        required: false
        type: string
      - description: The document category
        in: query
        name: category
        required: false
        type: string
      - description: The EDMS Adapter User ID. It's required for user level authentication
        in: query
        name: userId
        required: false
        type: string
      - description: The EMDS Adapter password. It's required for user level authentication
        in: query
        name: password
        required: false
        type: string
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_resultModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
  /v4/records/{recordId}/documents/{documentIds}:
    delete:
      description: "Deletes documents attached to a record.\n\n\n\n**API Endpoint**:  DELETE /v4/records/{recordId}/documents/{documentIds}\
        \ \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: Delete Record Documents
      operationId: v4.delete.records.recordId.documents.documentIds
      tags:
      - Records/Documents
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Comma-delimited IDs of the documents to be deleted.
        in: path
        name: documentIds
        required: true
        type: string
      - description: The EDMS Adapter User ID. It's required for user level authentication
        in: query
        name: userId
        required: true
        type: string
      - description: The EMDS Adapter password. It's required for user level authentication
        in: query
        name: password
        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/records/{recordId}/fees:
    get:
      description: "Gets the fee schedules associated with the specified record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/fees\
        \ \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 Fees for Record
      operationId: v4.get.records.recordId.fees
      tags:
      - Records/Fees
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $ref: '#/parameters/fields'
      - description: Filter by the status of the fee items.
        enum:
        - paid
        - unpaid
        in: query
        name: status
        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_feeItemModel_1Array'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    post:
      description: "Creates fees for the specified record.\n\n\n\n**API Endpoint**:  POST /v4/records/{recordId}/fees \n\n\
        **Scope**:  records \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.2\n\n"
      summary: Create Record Fees
      operationId: v4.post.records.recordId.fees
      tags:
      - Records/Fees
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $ref: '#/parameters/fields'
      - description: 'Fee item information to be added. eg: [{ "code" : {"value":"TESTFEE2"}, "feeNotes":"test note1", "paymentPeriod"
          : {"value":"FINAL"}, "quantity" : 9, "schedule" : {"value":"J_FEE"}, "version" : {"value":"1.0"}}, { "code" : {"value":"JFEE"},"feeNotes":"test
          note1","paymentPeriod" :{"value": "FINAL"}, "quantity" : 9, "schedule" : {"value":"AD_LETTER"}, "version" : {"value":"1"}}
          ]'
        in: body
        name: body
        required: true
        schema:
          items:
            $ref: '#/definitions/feeItemBaseModel'
          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/records/{recordId}/fees/estimate:
    put:
      description: "Provides fee estimations for the specified record.\n\n\n\n**API Endpoint**:  PUT /v4/records/{recordId}/fees/estimate\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.3\n\n"
      summary: Estimate Record Fees
      operationId: v4.put.records.recordId.fees.estimate
      tags:
      - Records/Fees
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: The record fee items information to be updated.
        in: body
        name: body
        required: true
        schema:
          items:
            $ref: '#/definitions/feeItemBaseModel_1'
          type: array
      - $ref: '#/parameters/fields'
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_estimateFeeModel'
        '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/records/{recordId}/finalize:
    post:
      description: "Creates the finalized record in the database. Use this method after calling Create Partial Record to submit\
        \ the completed record. See [Creating Records](https://developer.accela.com/docs/construct-api-records.html#construct-api-records__creatingRecords)\
        \ for more information about calling Finalize Record in tandem with Create Partial Record. \n\n The Create Partial\
        \ Record API triggers the business rules engine event ApplicationSubmitAfter. \n\n Note: The Finalize Record API does\
        \ not include custom forms and custom tables in the request body. To add or update custom forms and custom tables,\
        \ use the [Update Record Custom Forms](./api-records.html#operation/v4.put.records.recordId.customForms) and [Update\
        \ Record Custom Tables](./api-records.html#operation/v4.put.records.recordId.customForms) between the Create Partial\
        \ Record and Finalize Record requests.\n\n\n\n**API Endpoint**:  POST /v4/records/{recordId}/finalize \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: Finalize Record
      operationId: v4.post.records.recordId.finalize
      tags:
      - Records
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Create Record request information.
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/request_recordModel'
      - $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_simpleRecordModel'
        '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/records/{recordId}/inspections:
    get:
      description: "Gets the scheduled inspections for the specified record. \n\n Note: For a citizen token, the Display in\
        \ ACA setting of the given {recordId} determines whether or not an inspection is returned. If Display in ACA is enabled\
        \ for the given {recordId}, the inspection is included in the response; otherwise, the inspection will not be included.\
        \ For an agency token, the Display in ACA setting of the given {recordId} is ignored.\n\n\n\n**API Endpoint**:  GET\
        \ /v4/records/{recordId}/inspections  \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 Inspections for Record
      operationId: v4.get.records.recordId.inspections
      tags:
      - Records/Inspections
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $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_inspectionModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
  /v4/records/{recordIds}/inspectionTypes:
    get:
      description: "Gets the inspection types associated with the specified record(s).\n\n\n\n**API Endpoint**:  GET /v4/records/{recordIds}/inspectionTypes\
        \ \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 Inspection Types for Record
      operationId: v4.get.records.recordIds.inspectionTypes
      tags:
      - Records/Inspections
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: Comma-delimited IDs of the records to fetch.
        in: path
        name: recordIds
        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_recordInspectionTypeModelArray'
        '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/records/{recordId}/invoices:
    get:
      description: "Returns all invoices for a given record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/invoices\
        \ \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 Record Invoices
      operationId: v4.get.records.recordId.invoices
      tags:
      - Records/Invoices
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $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_invoiceModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    post:
      description: "Adds or links invoices to a given record.\n\n\n\n**API Endpoint**:  POST /v4/records/{recordId}/invoices\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.3.2\n\n"
      summary: Create Record Invoices
      operationId: v4.post.records.recordId.invoices
      tags:
      - Records/Invoices
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $ref: '#/parameters/fields'
      - description: 'An array of invoice fee IDs to be added to the record. eg: [7295255, 7295256]'
        in: body
        name: invoiceFeeId
        required: true
        schema:
          items:
            format: int64
            type: integer
          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_resultModel'
        '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/records/{recordId}/owners:
    get:
      description: "Gets owners associated with the specified record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/owners\
        \  \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 Owners for Record
      operationId: v4.get.records.recordId.owners
      tags:
      - Records/Owners
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $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_refOwnerModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    post:
      description: "Creates a new owner association for the specified record.\n\n\n\n**API Endpoint**:  POST /v4/records/{recordId}/owners\
        \ \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: Create Record Owners
      operationId: v4.post.records.recordId.owners
      tags:
      - Records/Owners
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Create Inspection Owners request information.
        in: body
        name: body
        required: true
        schema:
          items:
            $ref: '#/definitions/refOwnerModel'
          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/records/{recordId}/owners/{id}:
    put:
      description: "Updates information about the specified owner for the specified record.\n\n\n\n**API Endpoint**:  PUT\
        \ /v4/records/{recordId}/owners/{id} \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: Update Record Owner
      operationId: v4.put.records.recordId.owners.id
      tags:
      - Records/Owners
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: The ID of Owner to fetch.
        in: path
        name: id
        required: true
        type: string
      - description: Update Inspection Owner request information.
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/refOwnerModel'
      - $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_refOwnerModel'
        '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/records/{recordId}/owners/{ids}:
    delete:
      description: "Removes the specified owner(s) from the specified record.\n\n\n\n**API Endpoint**:  DELETE /v4/records/{recordId}/owners/{ids}\
        \  \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: Delete Record Owners
      operationId: v4.delete.records.recordId.owners.ids
      tags:
      - Records/Owners
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Comma-delmited IDs of the owners to be removed from the record.
        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/records/{recordId}/parcels:
    get:
      description: "Gets the parcels associated with the specified parcel.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/parcels\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  \tNo authorization required \n\n**Civic\
        \ Platform version**: 7.3.2\n\n"
      summary: Get All Parcels for Record
      operationId: v4.get.records.recordId.parcels
      tags:
      - Records/Parcels
      parameters:
      - $ref: '#/parameters/recordId'
      - $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_recordParcelModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    post:
      description: "Creates a new parcel for the specified record.\n\n\n\n**API Endpoint**:  POST /v4/records/{recordId}/parcels\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  \tNo authorization required \n\n**Civic\
        \ Platform version**: 7.3.2\n\n"
      summary: Create Record Parcels
      operationId: v4.post.records.recordId.parcels
      tags:
      - Records/Parcels
      parameters:
      - $ref: '#/parameters/recordId'
      - description: Record parcel information to be added.
        in: body
        name: body
        required: true
        schema:
          items:
            $ref: '#/definitions/recordParcelModel'
          type: array
      - $ref: '#/parameters/fields'
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_resultModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
  /v4/records/{recordId}/parcels/{id}:
    put:
      description: "Updates parcel information associated with the specified record.\n\n\n\n**API Endpoint**:  PUT /v4/records/{recordId}/parcels/{id}\
        \ \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: Update Record Parcel
      operationId: v4.put.records.recordId.parcels.id
      tags:
      - Records/Parcels
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Record parcel information to be updated.
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/recordParcelModel'
      - description: The ID of the record parcel to update.
        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_recordParcelModelArray'
        '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/records/{recordId}/parcels/{ids}:
    delete:
      description: "Removes the association of the specified parcel(s) from the specified record.\n\n\n\n**API Endpoint**:\
        \  DELETE /v4/records/{recordId}/parcels/{ids} \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: Delete Record Parcels
      operationId: v4.delete.records.recordId.parcels.ids
      tags:
      - Records/Parcels
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Comma-delimited IDs of the parcels to be removed.
        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_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/records/{recordId}/partTransaction:
    get:
      description: "Gets information about the part transaction associated with the specified record.\n\n\n\n**API Endpoint**:\
        \  GET /v4/records/{recordId}/partTransaction \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:\
        \  Access token \n\n**Civic Platform version**: 7.3.3\n\n"
      summary: Get Record Part Transaction
      operationId: v4.get.records.recordId.partTransaction
      tags:
      - Records/Part Transactions
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $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_partTransactionModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    post:
      description: "Creates a part transaction for the specified record.\n\n\n\n**API Endpoint**:  POST /v4/records/{recordId}/partTransaction\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.3\n\n"
      summary: Create Record Part Transaction
      operationId: v4.post.records.recordId.partTransaction
      tags:
      - Records/Part Transactions
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Part transaction information to be added.
        in: body
        name: body
        required: true
        schema:
          items:
            $ref: '#/definitions/partTransactionModel'
          type: array
      - $ref: '#/parameters/fields'
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_resultModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
  /v4/records/{recordId}/partTransaction/{ids}:
    delete:
      description: "Voids one or more part transactions for the specified record. The part transaction is voided, not deleted.\n\
        \n\n\n**API Endpoint**:  DELETE /v4/records/{recordId}/partTransaction/{ids} \n\n**Scope**:  records \n\n**App Type**:\
        \  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: 7.3.3\n\n"
      summary: Void Record Part Transactions
      operationId: v4.delete.records.recordId.partTransaction.ids
      tags:
      - Records/Part Transactions
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Comma-delimited IDs of the part transactions to be removed.
        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/records/{recordId}/payments:
    get:
      description: "Gets information about the payments for the specified record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/payments\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 9.0.0\n\n"
      summary: Get All Payments for Record
      operationId: v4.get.records.recordId.payments
      tags:
      - Records/Payments
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Filter by whether or not a payment has been made in full.
        enum:
        - Y
        - N
        in: query
        name: paymentStatus
        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_paymentModelArray'
        '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/records/{recordId}/payments/{paymentId}:
    get:
      description: "Gets information about the specified payment for the specified record.\n\n\n\n**API Endpoint**: GET /v4/records/{recordId}/payments/{paymentId}\
        \  \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 Record Payment
      operationId: v4.get.records.recordId.payments.paymentId
      tags:
      - Records/Payments
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: The ID of the payment to fetch.
        format: int64
        in: path
        name: paymentId
        required: true
        type: integer
      - $ref: '#/parameters/fields'
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_paymentModelArray'
        '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/records/{recordId}/professionals:
    get:
      description: "Gets the professionals for the specified record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/professionals\
        \ \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 Professionals for Record
      operationId: v4.get.records.recordId.professionals
      tags:
      - Records/Professionals
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $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_licenseProfessionalModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    post:
      description: "Creates a new professional and associates the professional with the specified record.\n\n\n\n**API Endpoint**:\
        \  POST /v4/records/{recordId}/professionals \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: Create Record Professionals
      operationId: v4.post.records.recordId.professionals
      tags:
      - Records/Professionals
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: The licensed professional information to be added.
        in: body
        name: body
        required: true
        schema:
          items:
            $ref: '#/definitions/licenseProfessionalModel'
          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/records/{recordId}/professionals/{id}:
    put:
      description: "Updates information for the specified professional associated with the specified record.\n\n\n\n**API\
        \ Endpoint**:  PUT /v4/records/{recordId}/professionals/{id} \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: Update Record Professional
      operationId: v4.put.records.recordId.professionals.id
      tags:
      - Records/Professionals
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: The ID of professional to update.
        in: path
        name: id
        required: true
        type: string
      - description: The licensed professional information to be updated.
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/licenseProfessionalModel'
      - $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_licenseProfessionalModel'
        '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/records/{recordId}/professionals/{ids}:
    delete:
      description: "Removes the association between the specified professional(s) and the specified record.\n\n\n\n**API Endpoint**:\
        \  DELETE /v4/records/{recordId}/professionals/{ids} \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: Delete Record Professionals
      operationId: v4.delete.records.recordId.professionals.ids
      tags:
      - Records/Professionals
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Comma-delimited IDs of the licensed professionals to be removed.
        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/records/{recordId}/related:
    get:
      description: "Gets the records related, by a parent or child relation, to the specified record.\n\n\n\n**API Endpoint**:\
        \  GET /v4/records/{recordId}/related \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 Related Details for Record
      operationId: v4.get.records.recordId.related
      tags:
      - Records
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Filter by record relationship.
        in: query
        name: relationship
        enum:
        - parent
        - child
        - renewal
        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_recordRelatedModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    post:
      description: "Creates a child relationship to the specified (parent) record.\n\n\n\n**API Endpoint**:  POST /v4/records/{recordId}/related\
        \  \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: Create Related Details for Record
      operationId: v4.post.records.recordId.related
      tags:
      - Records
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $ref: '#/parameters/lang'
      - description: Related record information to be added.
        in: body
        name: body
        required: true
        schema:
          items:
            type: string
          type: array
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_resultModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
  /v4/records/{recordId}/related/{childRecordIds}:
    delete:
      description: "Removes the relationship between the specifed child record(s) and their specified parent record.\n\n\n\
        \n**API Endpoint**:  DELETE /v4/records/{recordId}/related/{childRecordIds} \n\n**Scope**:  records \n\n**App Type**:\
        \  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: 7.3.2\n\n"
      summary: Delete Related Details from Record
      operationId: v4.delete.records.recordId.related.childRecordIds
      tags:
      - Records
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: Comma-delimited IDs of the related records to be removed.
        in: path
        name: childRecordIds
        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/records/{recordId}/trustAccounts:
    get:
      description: "Gets all trust accounts for the specified record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/trustAccounts\
        \ \n\n**Scope**:  records \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.3.4\n\n"
      summary: Get All Trust Accounts for Record
      operationId: v4.get.records.recordId.trustAccounts
      tags:
      - Records/Trust Accounts
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $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_trustAccountModelArray'
        '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/records/{recordId}/votes:
    get:
      description: "Gets the votes for the specified record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/votes \n\
        \n**Scope**:  records \n\n**App Type**:  Citizen \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.2\n\n"
      summary: Get All Votes for Record
      operationId: v4.get.records.recordId.votes
      tags:
      - Records/Votes
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $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_voteResult'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    post:
      description: "Creates a vote for the specified record.\n\n\n\n**API Endpoint**:  POST /v4/records/{recordId}/votes \n\
        \n**Scope**:  records \n\n**App Type**:  Citizen \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.2\n\n"
      summary: Create Record Votes
      operationId: v4.post.records.recordId.votes
      tags:
      - Records/Votes
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $ref: '#/parameters/lang'
      - description: The vote request to add.
        in: body
        name: voteRequest
        required: true
        schema:
          $ref: '#/definitions/voteRequest'
      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_voteResult'
        '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/records/{recordId}/votes/summary:
    get:
      description: "Gets the voting summary for the specified record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/votes/summary\
        \ \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 Record Votes Summary
      operationId: v4.get.records.recordId.votes.summary
      tags:
      - Records/Votes
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $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_voteSummary'
        '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/records/{recordId}/workflowTasks:
    get:
      description: "Gets all the workflow tasks associated with the specified record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/workflowTasks\
        \ \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 Workflow Tasks for Record
      operationId: v4.get.records.recordId.workflowTasks
      tags:
      - Records/Workflows
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $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_taskItemModelArray'
        '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/records/{recordId}/workflowTasks/{id}:
    get:
      description: "Gets the requested workflow task for the specified record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/workflowTasks/{id}\
        \ \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 Record Workflow Task
      operationId: v4.get.records.recordId.workflowTasks.id
      tags:
      - Records/Workflows
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: The ID of task 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_taskItemModelArray'
        '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 the requested workflow task for the specified record.\n\n\n\n**API Endpoint**:  PUT /v4/records/{recordId}/workflowTasks/{id}\
        \ \n\n**Scope**:  records \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.2\n\n"
      summary: Update Record Workflow Task
      operationId: v4.put.records.recordId.workflowTasks.id
      tags:
      - Records/Workflows
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: The ID of task to fetch.
        in: path
        name: id
        required: true
        type: string
      - description: The task information to be updated
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/request_taskItemModel'
      - $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_taskItemModel'
        '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/records/{recordId}/workflowTasks/{id}/statuses:
    get:
      description: "Gets the status of the specified workflow task for the specified record.\n\n\n\n**API Endpoint**:  GET\
        \ /v4/records/{recordId}/workflowTasks/{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 Workflow Task
      operationId: v4.get.records.recordId.workflowTasks.id.statuses
      tags:
      - Records/Workflows
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: The ID of task 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_identifierModelArray'
        '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/records/{recordId}/workflowTasks/comments/histories:
    get:
      description: "Gets the workflow task comment history for the specified record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/workflowTasks/comments/histories\
        \  \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 Workflow Task Comment Histories
      operationId: v4.get.records.recordId.workflowTasks.comments.histories
      tags:
      - Records/Workflows
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $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_workflowTaskCommentModelArray'
        '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/records/{recordId}/workflowTasks/histories:
    get:
      description: "Gets all the workflow task history associated with the specified record.\n\n\n\n**API Endpoint**:  GET\
        \ /v4/records/{recordId}/workflowTasks/histories \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 Workflow Task History for Record
      operationId: v4.get.records.recordId.workflowTasks.histories
      tags:
      - Records/Workflows
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - $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_taskItemActionModelArray'
        '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/records/{recordId}/workflowTasks/{taskId}/customForms:
    get:
      description: "Returns the custom forms containing task-specific information for a given workflow task for a specific\
        \ record.\n\n\n\n**API Endpoint**:  GET /v4/records/{recordId}/workflowTasks/{taskId}/customForms  \n\n**Scope**:\
        \  records \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: 8.0.3\n\
        \n"
      summary: Get All Custom Forms for Record Workflow Task
      operationId: v4.get.records.recordId.workflowTasks.taskId.customForms
      tags:
      - Records/Workflows
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: The ID of the workflow task to fetch.
        in: path
        name: taskId
        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_customAttributeModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
    put:
      description: "Updates custom forms containing task-specific information for a given workflow task for a specific record.\n\
        \n\n\n**API Endpoint**:  PUT /v4/records/{recordId}/workflowTasks/{taskId}/customForms  \n\n**Scope**:  records \n\
        \n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**: 8.0.3\n\n"
      summary: Update Custom Form for Record Workflow Task
      operationId: v4.put.records.recordId.workflowTasks.taskId.customForms
      tags:
      - Records/Workflows
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: The ID of the workflow task to fetch.
        in: path
        name: taskId
        required: true
        type: string
      - description: 'The custom form information to be updated. Ex. [{"apiField1": "val1", "id": "group-subGroup"   }]'
        in: body
        name: body
        required: true
        schema:
          items:
            $ref: '#/definitions/customAttributeModel'
          type: array
      - $ref: '#/parameters/lang'
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_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/records/{recordId}/workflowTasks/{taskId}/customForms/meta:
    get:
      description: "Returns the metadata associated with all custom forms for a given workflow task for a specific record.\n\
        \n\n\n**API Endpoint**:  GET /v4/records/{recordId}/workflowTasks/{taskId}/customForms/meta  \n\n**Scope**:  records\
        \ \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 Record Workflow Task
      operationId: v4.get.records.recordId.workflowTasks.taskId.customForms.meta
      tags:
      - Records/Workflows
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - $ref: '#/parameters/recordId'
      - description: The ID of the workflow task to fetch.
        in: path
        name: taskId
        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_customFormSubgroupModelArray'
        '400':
          description: Invalid request.
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
definitions:
  response_customFormMetadataModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/customFormMetadataModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  customFormMetadataModel:
    description: Contains the metadata for a custom table.
    type: object
    properties:
      displayOrder:
        description: The custom table's display order.
        format: int64
        type: integer
      fields:
        items:
          $ref: '#/definitions/customFormField'
        type: array
      id:
        description: The custom table id.
        type: string
      text:
        description: The custom table name.
        type: string
  customFormField:
    type: object
    properties:
      displayOrder:
        description: ''
        format: int64
        type: integer
      drillDown:
        $ref: '#/definitions/aSITableDrill'
      fieldType:
        description: The custom field data type.
        type: string
      id:
        description: The custom field system id assigned by the Civic Platform server.
        type: string
      isReadonly:
        description: Indicates whether or not the custom field is read-only.
        enum:
        - Y
        - N
        type: string
      isRequired:
        description: Indicates whether or not the custom field is required.
        enum:
        - Y
        - N
        type: string
      maxLength:
        description: The custom field length
        format: int64
        type: integer
      options:
        items:
          type: object
          description: A dropdown option value.
          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
  response_customFormSubgroupModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/customFormSubgroupModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  customFormSubgroupModel:
    type: object
    properties:
      displayOrder:
        description: The custom form subgroup display order.
        format: int64
        type: integer
      fields:
        items:
          $ref: '#/definitions/customFormField'
        type: array
      id:
        description: The custom form subgroup system id assigned by the Civic Platform server.
        type: string
      text:
        description: The custom form subgroup name.
        type: string
  aSITableDrill:
    type: object
    properties:
      children:
        items:
          $ref: '#/definitions/childDrill'
        type: array
      isRoot:
        type: boolean
  response_apo_customForms:
    description: "APO custom forms response. \n\nAdded in Civic Platform version: 9.2.0"
    type: object
    properties:
      apo_customForms:
        items:
          $ref: '#/definitions/apo_customForm'
        type: array
      status:
        type: integer
        description: The return status code.
  apo_customForm:
    description: "A set of custom field name-value pairs on a custom form. \n\nAdded in Civic Platform version: 9.2.0"
    type: object
    properties:
      id:
        type: string
        description: The unique string id of the custom form template for the custom data.
      aCustomFieldName:
        type: string
        description: A custom field name. Note that this is the custom attribute name (not the attribute label). To get the
          attribute display label, use [Get Record Address Custom Forms Metadata](#operation/v4.get.records.recordId.addresses.addressId.customForms.meta).
      aCustomFieldValue:
        type: string
        description: A custom field value
  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. \n\nAdded in Civic\
      \ Platform version: 9.2.0"
    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
        enum:
        - address
        - parcel
        - owner
        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_activityModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/activityModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  activityModel:
    type: object
    properties:
      activityStatus:
        type: object
        description: The status of the record activity.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      assignedDepartment:
        type: object
        description: The department responsible for the activity.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      assignedUser:
        type: object
        description: The staff member responsible for the activity.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      description:
        description: The activity description
        type: string
      dueDate:
        description: The desired completion date of the task.
        format: date-time
        type: string
      id:
        description: The activity system id assigned by the Civic Platform server.
        format: int64
        type: integer
      name:
        description: The activity name.
        type: string
      priority:
        type: object
        description: The priority level assigned to the activity.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      startDate:
        description: The activity start date.
        format: date-time
        type: string
      status:
        type: object
        description: The activity status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      type:
        type: object
        description: The activity type.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  request_activityAddModel:
    type: object
    properties:
      activityStatus:
        type: object
        description: The status of the record activity.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      assignedDepartment:
        type: object
        description: The department responsible for the activity.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      assignedUser:
        type: object
        description: The staff member responsible for the activity.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      description:
        description: The activity description
        type: string
      dueDate:
        description: The desired completion date of the task.
        format: date-time
        type: string
      name:
        description: The activity name.
        type: string
      priority:
        type: object
        description: The priority level assigned to the activity.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      startDate:
        description: The activity start date.
        format: date-time
        type: string
      type:
        type: object
        description: The activity type.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  request_activityUpdateModel:
    type: object
    properties:
      activityStatus:
        type: object
        description: The status of the record activity.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      assignedDepartment:
        type: object
        description: The department responsible for the activity.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      assignedUser:
        type: object
        description: The staff member responsible for the activity.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      description:
        description: The activity description
        type: string
      dueDate:
        description: The desired completion date of the task.
        format: date-time
        type: string
      name:
        description: The activity name.
        type: string
      priority:
        type: object
        description: The priority level assigned to the activity.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      startDate:
        description: The activity start date.
        format: date-time
        type: string
      status:
        type: object
        description: The activity status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      type:
        type: object
        description: The activity type.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  addressModel:
    type: object
    properties:
      addressLine1:
        type: string
      addressLine2:
        type: string
      addressTypeFlag:
        $ref: '#/definitions/identifierModel'
      city:
        type: string
      country:
        $ref: '#/definitions/identifierModel'
      county:
        type: string
      description:
        type: string
      direction:
        $ref: '#/definitions/identifierModel'
      distance:
        format: double
        type: number
      houseAlphaEnd:
        type: string
      houseAlphaStart:
        type: string
      houseFractionEnd:
        $ref: '#/definitions/identifierModel'
      houseFractionStart:
        $ref: '#/definitions/identifierModel'
      id:
        format: int64
        type: integer
      inspectionDistrict:
        type: string
      inspectionDistrictPrefix:
        type: string
      isPrimary:
        type: string
      levelEnd:
        type: string
      levelPrefix:
        type: string
      levelStart:
        type: string
      neighborhood:
        type: string
      neighborhoodPrefix:
        type: string
      postalCode:
        type: string
      recordId:
        $ref: '#/definitions/capIDModel'
      refAddressId:
        format: int64
        type: integer
      secondaryStreet:
        type: string
      secondaryStreetNumber:
        type: integer
      serviceProviderCode:
        type: string
      state:
        $ref: '#/definitions/identifierModel'
      status:
        $ref: '#/definitions/identifierModel'
      streetAddress:
        type: string
      streetEnd:
        type: integer
      streetEndFrom:
        type: integer
      streetEndTo:
        type: integer
      streetName:
        type: string
      streetPrefix:
        type: string
      streetStart:
        type: integer
      streetStartFrom:
        type: integer
      streetStartTo:
        type: integer
      streetSuffix:
        $ref: '#/definitions/identifierModel'
      streetSuffixDirection:
        $ref: '#/definitions/identifierModel'
      type:
        $ref: '#/definitions/identifierModel'
      unitEnd:
        type: string
      unitStart:
        type: string
      unitType:
        $ref: '#/definitions/identifierModel'
      xCoordinate:
        format: double
        type: number
      yCoordinate:
        format: double
        type: number
  response_recordAddressModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/recordAddressModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  recordAddressModel:
    type: object
    properties:
      addressLine1:
        type: string
        description: The first line of the address.
      addressLine2:
        type: string
        description: The second line of the address.
      addressTypeFlag:
        type: object
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
        description: A code name or an abbreviation of the address type.
      city:
        type: string
        description: The name of the city.
      country:
        type: object
        description: The name of the country. See [Get All Address Countries](./api-settings.html#operation/v4.get.settings.addresses.countries).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      crossStreetNameStart:
        type: string
        description: 'The beginning intersecting street name for searching.


          Added in Civic Platform version: 9.2.0

          '
      crossStreetNameEnd:
        type: string
        description: 'The ending intersecting street name for searching.


          Added in Civic Platform version: 9.2.0

          '
      county:
        type: string
        description: The name of the county.
      description:
        type: string
        description: A description of the address.
      direction:
        description: The street direction of the primary address associated with the application.
        type: object
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      distance:
        type: number
        format: double
        description: The distance from another landmark used to locate the address.
      houseAlphaStart:
        type: string
        description: The beginning alphabetic unit in street address.
      houseAlphaEnd:
        type: string
        description: The ending alphabetic unit in street address.
      houseFractionStart:
        type: object
        description: Beginning fraction value used in combination with the Street number fields.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      houseFractionEnd:
        type: object
        description: Ending franction value used in combination with the Street number fields.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      id:
        format: int64
        type: integer
        description: The unique address id assigned by the Civic Platform server.
      inspectionDistrict:
        type: string
        description: The inspection district where the address is located.
      inspectionDistrictPrefix:
        type: string
        description: The prefix for the inspection district where the address is located.
      isPrimary:
        type: string
        description: Indicates whether or not to designate the address as the primary address. Only one address can be primary
          at any given time.
      levelEnd:
        type: string
        description: The ending level number (floor number) that makes up the address within a complex.
      levelPrefix:
        type: string
        description: The prefix for the level numbers (floor numbers) that make up the address.
      levelStart:
        type: string
        description: The starting level number (floor number) that makes up the address within a complex.
      locationType:
        type: string
        description: 'The type of location used for Right of Way Management. The valid values are configured with the LOCATION_TYPE
          standard choice in Civic Platform Administration.


          Added in Civic Platform version: 9.2.0

          '
      neighborhood:
        type: string
        description: The neighborhood where the address is located.
      neighborhoodPrefix:
        type: string
        description: The prefix for neighborhood where the address is located.
      postalCode:
        type: string
        description: The postal ZIP code for the address.
      recordId:
        $ref: '#/definitions/recordIdModel'
      refAddressId:
        description: The reference address id.
        format: int64
        type: integer
      secondaryStreet:
        type: string
        description: This field (along with the Secondary Road Number field) displays an extra description for the location
          when two roads that cross or a street with two names makes up the address of the location.
      secondaryStreetNumber:
        type: number
        format: long
        description: This field (along with the Secondary Road field) displays an extra description for the location when
          two roads that cross or a street with two names makes up the address of the location.
      serviceProviderCode:
        description: The unique agency identifier.
        type: string
      state:
        type: object
        description: The name of the state.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      status:
        type: object
        description: The address status indicating whether the address is active or inactive.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      streetAddress:
        type: string
        description: The street address.
      streetEnd:
        type: number
        format: long
        description: The ending number of a street address range.
      streetEndFrom:
        description: The beginning number of a street end address range.
        format: int64
        type: integer
      streetEndTo:
        description: The ending number of a street end address range.
        format: int64
        type: integer
      streetName:
        type: string
        description: The name of the street.
      streetNameStart:
        type: string
        description: 'The beginning street name for searching.


          Added in Civic Platform version: 9.2.0

          '
      streetNameEnd:
        type: string
        description: 'The ending street name for searching.


          Added in Civic Platform version: 9.2.0

          '
      streetPrefix:
        type: string
        description: Any part of an address that appears before a street name or number. For example, if the address is 123
          West Main, "West" is the street prefix.
      streetStart:
        type: number
        format: long
        description: The starting number of a street address range.
      streetStartFrom:
        description: The beginning number of a street start address range.
        format: int64
        type: integer
      streetStartTo:
        description: The ending number of a street start address range.
        format: int64
        type: integer
      streetSuffix:
        type: object
        description: The type of street such as "Lane" or "Boulevard".
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      streetSuffixDirection:
        type: object
        description: The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW"
          is the street suffix direction.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      type:
        type: object
        description: The address type.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      unitStart:
        type: string
        description: The starting value of a range of unit numbers.
      unitEnd:
        type: string
        description: The ending value of a range of unit numbers.
      unitType:
        type: object
        description: The unit type designation of the address.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      xCoordinate:
        type: number
        format: double
        description: The longitudinal coordinate for this address.
      yCoordinate:
        type: number
        format: double
        description: The latitudinal coordinate for this address.
  recordAddressCustomFormsModel:
    type: object
    properties:
      addressLine1:
        type: string
        description: The first line of the address.
      addressLine2:
        type: string
        description: The second line of the address.
      addressTypeFlag:
        type: object
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
        description: A code name or an abbreviation of the address type.
      city:
        type: string
        description: The name of the city.
      country:
        type: object
        description: The name of the country. See [Get All Address Countries](./api-settings.html#operation/v4.get.settings.addresses.countries).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      crossStreetNameStart:
        type: string
        description: 'The beginning intersecting street name for searching.


          Added in Civic Platform version: 9.2.0

          '
      crossStreetNameEnd:
        type: string
        description: 'The ending intersecting street name for searching.


          Added in Civic Platform version: 9.2.0

          '
      county:
        type: string
        description: The name of the county.
      customForms:
        items:
          $ref: '#/definitions/customAttributeModel'
        type: array
      description:
        type: string
        description: A description of the address.
      direction:
        description: The street direction of the primary address associated with the application.
        type: object
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      distance:
        type: number
        format: double
        description: The distance from another landmark used to locate the address.
      houseAlphaStart:
        type: string
        description: The beginning alphabetic unit in street address.
      houseAlphaEnd:
        type: string
        description: The ending alphabetic unit in street address.
      houseFractionStart:
        type: object
        description: Beginning fraction value used in combination with the Street number fields.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      houseFractionEnd:
        type: object
        description: Ending franction value used in combination with the Street number fields.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      id:
        format: int64
        type: integer
        description: The unique address id assigned by the Civic Platform server.
      inspectionDistrict:
        type: string
        description: The inspection district where the address is located.
      inspectionDistrictPrefix:
        type: string
        description: The prefix for the inspection district where the address is located.
      isPrimary:
        type: string
        description: Indicates whether or not to designate the address as the primary address. Only one address can be primary
          at any given time.
      levelEnd:
        type: string
        description: The ending level number (floor number) that makes up the address within a complex.
      levelPrefix:
        type: string
        description: The prefix for the level numbers (floor numbers) that make up the address.
      levelStart:
        type: string
        description: The starting level number (floor number) that makes up the address within a complex.
      locationType:
        type: string
        description: 'The type of location used for Right of Way Management. The valid values are configured with the LOCATION_TYPE
          standard choice in Civic Platform Administration.


          Added in Civic Platform version: 9.2.0

          '
      neighborhood:
        type: string
        description: The neighborhood where the address is located.
      neighborhoodPrefix:
        type: string
        description: The prefix for neighborhood where the address is located.
      postalCode:
        type: string
        description: The postal ZIP code for the address.
      recordId:
        $ref: '#/definitions/recordIdModel'
      refAddressId:
        description: The reference address id.
        format: int64
        type: integer
      secondaryStreet:
        type: string
        description: This field (along with the Secondary Road Number field) displays an extra description for the location
          when two roads that cross or a street with two names makes up the address of the location.
      secondaryStreetNumber:
        type: number
        format: long
        description: This field (along with the Secondary Road field) displays an extra description for the location when
          two roads that cross or a street with two names makes up the address of the location.
      serviceProviderCode:
        description: The unique agency identifier.
        type: string
      state:
        type: object
        description: The name of the state.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      status:
        type: object
        description: The address status indicating whether the address is active or inactive.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      streetAddress:
        type: string
        description: The street address.
      streetEnd:
        type: number
        format: long
        description: The ending number of a street address range.
      streetEndFrom:
        description: The beginning number of a street end address range.
        format: int64
        type: integer
      streetEndTo:
        description: The ending number of a street end address range.
        format: int64
        type: integer
      streetName:
        type: string
        description: The name of the street.
      streetNameStart:
        type: string
        description: 'The beginning street name for searching.


          Added in Civic Platform version: 9.2.0

          '
      streetNameEnd:
        type: string
        description: 'The ending street name for searching.


          Added in Civic Platform version: 9.2.0

          '
      streetPrefix:
        type: string
        description: Any part of an address that appears before a street name or number. For example, if the address is 123
          West Main, "West" is the street prefix.
      streetStart:
        type: number
        format: long
        description: The starting number of a street address range.
      streetStartFrom:
        description: The beginning number of a street start address range.
        format: int64
        type: integer
      streetStartTo:
        description: The ending number of a street start address range.
        format: int64
        type: integer
      streetSuffix:
        type: object
        description: The type of street such as "Lane" or "Boulevard".
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      streetSuffixDirection:
        type: object
        description: The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW"
          is the street suffix direction.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      type:
        type: object
        description: The address type.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      unitStart:
        type: string
        description: The starting value of a range of unit numbers.
      unitEnd:
        type: string
        description: The ending value of a range of unit numbers.
      unitType:
        type: object
        description: The unit type designation of the address.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      xCoordinate:
        type: number
        format: double
        description: The longitudinal coordinate for this address.
      yCoordinate:
        type: number
        format: double
        description: The latitudinal coordinate for this address.
  request_recordAddressModel:
    type: object
    properties:
      addressLine1:
        type: string
        description: The first line of the address.
      addressLine2:
        type: string
        description: The first line of the address.
      addressTypeFlag:
        type: object
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
        description: A code name or an abbreviation of the address type.
      city:
        type: string
        description: The name of the city.
      country:
        type: object
        description: The name of the country. See [Get All Address Countries](./api-settings.html#operation/v4.get.settings.addresses.countries).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      county:
        type: string
        description: The name of the county.
      crossStreetNameStart:
        type: string
        description: 'The beginning intersecting street name for searching.


          Added in Civic Platform version: 9.2.0

          '
      crossStreetNameEnd:
        type: string
        description: 'The ending intersecting street name for searching.


          Added in Civic Platform version: 9.2.0

          '
      description:
        type: string
        description: A description of the address.
      direction:
        description: The street direction of the primary address associated with the application.
        type: object
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      distance:
        type: number
        format: double
        description: The distance from another landmark used to locate the address.
      houseAlphaStart:
        type: string
        description: The beginning alphabetic unit in street address.
      houseAlphaEnd:
        type: string
        description: The ending alphabetic unit in street address.
      houseFractionStart:
        type: object
        description: Beginning fraction value used in combination with the Street number fields.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      houseFractionEnd:
        type: object
        description: Ending franction value used in combination with the Street number fields.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      inspectionDistrict:
        type: string
        description: The inspection district where the address is located.
      inspectionDistrictPrefix:
        type: string
        description: The prefix for the inspection district where the address is located.
      isPrimary:
        type: string
        description: Indicates whether or not to designate the address as the primary address. Only one address can be primary
          at any given time.
      levelStart:
        type: string
        description: The starting level number (floor number) that makes up the address within a complex.
      levelEnd:
        type: string
        description: The ending level number (floor number) that makes up the address within a complex.
      levelPrefix:
        type: string
        description: The prefix for the level numbers (floor numbers) that make up the address.
      locationType:
        type: string
        description: 'The type of location used for Right of Way Management. The valid values are configured with the LOCATION_TYPE
          standard choice in Civic Platform Administration.


          Added in Civic Platform version: 9.2.0

          '
      neighborhood:
        type: string
        description: The neighborhood where the address is located.
      neighborhoodPrefix:
        type: string
        description: The prefix for neighborhood where the address is located.
      postalCode:
        type: string
        description: The postal ZIP code for the address.
      secondaryStreet:
        type: string
        description: This field (along with the Secondary Road Number field) displays an extra description for the location
          when two roads that cross or a street with two names makes up the address of the location.
      secondaryStreetNumber:
        type: number
        format: long
        description: This field (along with the Secondary Road field) displays an extra description for the location when
          two roads that cross or a street with two names makes up the address of the location.
      state:
        type: object
        description: The name of the state.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      status:
        type: object
        description: The address status indicating whether the address is active or inactive.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      streetAddress:
        type: string
        description: The street address.
      streetEnd:
        type: number
        format: long
        description: The ending number of a street address range.
      streetName:
        type: string
        description: The name of the street.
      streetNameStart:
        type: string
        description: 'The beginning street name for searching.


          Added in Civic Platform version: 9.2.0

          '
      streetNameEnd:
        type: string
        description: 'The ending street name for searching.


          Added in Civic Platform version: 9.2.0

          '
      streetPrefix:
        type: string
        description: Any part of an address that appears before a street name or number. For example, if the address is 123
          West Main, "West" is the street prefix.
      streetStart:
        type: number
        format: long
        description: The starting number of a street address range.
      streetSuffix:
        type: object
        description: The type of street such as "Lane" or "Boulevard".
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      streetSuffixDirection:
        type: object
        description: The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW"
          is the street suffix direction.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      type:
        type: object
        description: The address type.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      unitStart:
        type: string
        description: The starting value of a range of unit numbers.
      unitEnd:
        type: string
        description: The ending value of a range of unit numbers.
      unitType:
        type: object
        description: The unit type designation of the address.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      xCoordinate:
        type: number
        format: double
        description: The longitudinal coordinate for this address.
      yCoordinate:
        type: number
        format: double
        description: The latitudinal coordinate for this address.
  response_assetMasterModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/assetMasterModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  assetMasterModel:
    type: object
    properties:
      assetId:
        description: "The unique alpha-numeric asset ID in an asset group. \n\n**Added in Civic Platform version**: 9.2.0\n\
          \n"
        type: string
      classType:
        description: "A Class Type is how Civic Platform groups objects that an agency owns or maintains. The five class types\
          \ are component, linear, node-link linear, point, and polygon. Asset class types provide the ability to assign or\
          \ group multiple asset types together.\t"
        type: string
      comments:
        type: object
        description: General comments about the asset.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      currentValue:
        description: The current value of the asset.
        format: double
        type: number
      dateOfService:
        description: The date the asset was initially placed into service.
        format: date-time
        type: string
      dependentFlag:
        description: Indicates whether or not the parent asset is dependent on this asset.
        enum:
        - Y
        - N
        type: string
      depreciationAmount:
        description: The decline in the asset value by the asset depreciation calculation.
        format: double
        type: number
      depreciationEndDate:
        description: The end date for the asset depreciation calculation. This field is used in the asset depreciation calculation.
        format: date-time
        type: string
      depreciationStartDate:
        description: The start date for the asset depreciation calculation. This field is used in the asset depreciation calculation.
        format: date-time
        type: string
      depreciationValue:
        description: The asset value after the asset depreciation calculation, which is based on the start value, depreciation
          start and end dates, useful life, and salvage value.
        format: double
        type: number
      description:
        type: object
        description: The description of the asset.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      endID:
        description: The ending point asset ID.
        type: string
      gisObjects:
        items:
          $ref: '#/definitions/gISObjectModel'
        type: array
      id:
        description: The asset system id assigned by the Civic Platform server.
        format: int64
        type: integer
      name:
        type: object
        description: The descriptive name of the asset.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      number:
        description: The unique, alpha-numeric asset ID.
        type: string
      salvageValue:
        description: The residual value of the asset at the end of it’s useful life.
        format: double
        type: number
      serviceProviderCode:
        description: The unique agency identifier.
        type: string
      size:
        description: A positive numeric value for the asset size.
        format: double
        type: number
      sizeUnit:
        description: The unit of measure corresponding to the asset size.
        type: string
      startID:
        description: The starting point asset ID.
        type: string
      startValue:
        description: The beginning value or purchase price of the asset.
        format: double
        type: number
      status:
        type: object
        description: The status of the asset.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusDate:
        description: The date the asset status changed.
        format: date-time
        type: string
      type:
        type: object
        description: The type of asset.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  recordExpirationModel:
    type: object
    properties:
      expirationDate:
        description: The date when the condition expires.
        format: date-time
        type: string
      expirationStatus:
        type: object
        description: Indicates whether the expiration is enabled or disabled. See [Get All Record Expiration Statuses](./api-settings.html#operation/v4.get.settings.records.expirationStatuses).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  commentModel:
    type: object
    properties:
      displayOnInspection:
        description: Indicates whether or not the comment is displayed on inspection.
        enum:
        - Y
        - N
        type: string
      text:
        description: The comment text.
        type: string
  response_recordCommentModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/recordCommentModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  response_recordCommentModel:
    type: object
    properties:
      result:
        $ref: '#/definitions/recordCommentModel'
      status:
        type: integer
        description: The HTTP return status.
  recordCommentModel:
    type: object
    properties:
      createdBy:
        description: The user who added the record comment.
        type: string
      createdDate:
        description: The date when the record comment was added.
        format: date-time
        type: string
      displayOnInspection:
        description: Indicates whether or not the comment is displayed on inspection.
        enum:
        - Y
        - N
        type: string
      id:
        description: The comment system id assigned by the Civic Platform server.
        format: int64
        type: integer
      recordId:
        $ref: '#/definitions/recordIdModel'
      text:
        description: The comment text.
        type: string
  response_recordConditionModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/recordConditionModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  recordConditionModel:
    type: object
    properties:
      actionbyDepartment:
        type: object
        description: The department responsible for the action.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      actionbyUser:
        type: object
        description: The individual responsible for the action.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      activeStatus:
        type: object
        description: Indicates whether or not the condition is active.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      additionalInformation:
        description: An unlimited text field to use if other fields are filled.
        type: string
      additionalInformationPlainText:
        description: An unlimited text field to use if other fields are filled.
        type: string
      appliedDate:
        description: The date the standard condition was applied.
        format: date-time
        type: string
      appliedbyDepartment:
        type: object
        description: "The department responsible for applying a condition.\t"
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      appliedbyUser:
        type: object
        description: "The staff member responsible for applying a condition.\t"
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      dispAdditionalInformationPlainText:
        description: An unlimited text field to use if other fields are filled.
        type: string
      displayNoticeInAgency:
        description: Indicates whether or not to display the condition notice in Accela Automation when a condition to a record
          or parcel is applied.
        type: boolean
      displayNoticeInCitizens:
        description: Indicates whether or not to display the condition notice in Accela Citizen Access when a condition to
          a record or parcel is applied.
        type: boolean
      displayNoticeInCitizensFee:
        description: Indicates whether or not to display the condition notice in Accela Citizen Access Fee Estimate page when
          a condition to a record or parcel is applied.
        type: boolean
      displayOrder:
        description: The display order of the condition in a list.
        format: int64
        type: integer
      effectiveDate:
        description: The date when you want the condition to become effective.
        format: date-time
        type: string
      expirationDate:
        description: The date when the condition expires.
        format: date-time
        type: string
      group:
        type: object
        description: The condition group is an attribute of a condition that organizes condition types. Your agency defines
          these groups.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      id:
        description: The condition system id assigned by the Civic Platform server.
        format: int64
        type: integer
      inheritable:
        type: object
        description: This defines whether or not Accela Automation checks for inheritable conditions when a user associates
          a child record with a parent record.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      isIncludeNameInNotice:
        description: Indicates whether or not to display the condition name in the notice.
        type: boolean
      isIncludeShortCommentsInNotice:
        description: Indicates whether or not to display the condition comments in the notice.
        type: boolean
      longComments:
        description: Narrative comments to help identify the purpose or uses of the standard condition.
        type: string
      name:
        description: The name of the standard condition.
        type: string
      priority:
        type: object
        description: The priority level assigned to the condition.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      publicDisplayMessage:
        description: Text entered into this field displays in the condition notice or condition status bar for the Condition
          Name for the public user in Accela IVR (AIVR) and Accela Citizen Access (ACA).
        type: string
      resAdditionalInformationPlainText:
        description: An unlimited text field to use if other fields are filled.
        type: string
      resolutionAction:
        description: he action performed in response to a condition.
        type: string
      serviceProviderCode:
        description: The unique agency identifier.
        type: string
      severity:
        type: object
        description: The severity of the condition.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      shortComments:
        description: A brief description of the condition name. For example, the text may describe the situation that requires
          the system to apply the condition. You can set these short comments to display when a user accesses an application
          with this condition applied to it
        type: string
      status:
        type: object
        description: The condition status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusDate:
        description: The date when the current status changed.
        format: date-time
        type: string
      statusType:
        description: The status type for a standard condition or an approval condition, applied or not applied for example.
        type: string
      type:
        type: object
        description: The condition type.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  request_recordConditionModel:
    type: object
    properties:
      actionbyDepartment:
        type: object
        description: The department responsible for the action.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      actionbyUser:
        type: object
        description: The individual responsible for the action.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      activeStatus:
        type: object
        description: Indicates whether or not the condition is active.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      additionalInformation:
        description: An unlimited text field to use if other fields are filled.
        type: string
      additionalInformationPlainText:
        description: An unlimited text field to use if other fields are filled.
        type: string
      appliedDate:
        description: The date the standard condition was applied.
        format: date-time
        type: string
      appliedbyDepartment:
        type: object
        description: "The department responsible for applying a condition.\t"
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      appliedbyUser:
        type: object
        description: "The staff member responsible for applying a condition.\t"
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      conditionNumber:
        description: The condition sequence number.
        format: int64
        type: integer
      dispAdditionalInformationPlainText:
        description: An unlimited text field to use if other fields are filled.
        type: string
      displayNoticeInAgency:
        description: Indicates whether or not to display the condition notice in Accela Automation when a condition to a record
          or parcel is applied.
        type: boolean
      displayNoticeInCitizens:
        description: Indicates whether or not to display the condition notice in Accela Citizen Access when a condition to
          a record or parcel is applied.
        type: boolean
      displayNoticeInCitizensFee:
        description: Indicates whether or not to display the condition notice in Accela Citizen Access Fee Estimate page when
          a condition to a record or parcel is applied.
        type: boolean
      displayOrder:
        description: The display order of the condition in a list.
        format: int64
        type: integer
      effectiveDate:
        description: The date when you want the condition to become effective.
        format: date-time
        type: string
      expirationDate:
        description: The date when the condition expires.
        format: date-time
        type: string
      group:
        type: object
        description: The condition group is an attribute of a condition that organizes condition types. Your agency defines
          these groups.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      inheritable:
        type: object
        description: This defines whether or not Accela Automation checks for inheritable conditions when a user associates
          a child record with a parent record.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      isIncludeNameInNotice:
        description: Indicates whether or not to display the condition name in the notice.
        type: boolean
      isIncludeShortCommentsInNotice:
        description: Indicates whether or not to display the condition comments in the notice.
        type: boolean
      longComments:
        description: Narrative comments to help identify the purpose or uses of the standard condition.
        type: string
      name:
        description: The name of the standard condition.
        type: string
      priority:
        type: object
        description: The priority level assigned to the condition.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      publicDisplayMessage:
        description: Text entered into this field displays in the condition notice or condition status bar for the Condition
          Name for the public user in Accela IVR (AIVR) and Accela Citizen Access (ACA).
        type: string
      resAdditionalInformationPlainText:
        description: An unlimited text field to use if other fields are filled.
        type: string
      resolutionAction:
        description: he action performed in response to a condition.
        type: string
      serviceProviderCode:
        description: The unique agency identifier.
        type: string
      severity:
        type: object
        description: The severity of the condition.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      shortComments:
        description: A brief description of the condition name. For example, the text may describe the situation that requires
          the system to apply the condition. You can set these short comments to display when a user accesses an application
          with this condition applied to it
        type: string
      status:
        type: object
        description: The condition status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusDate:
        description: The date when the current status changed.
        format: date-time
        type: string
      statusType:
        description: The status type for a standard condition or an approval condition, applied or not applied for example.
        type: string
      type:
        type: object
        description: The condition type.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  capConditionModel_2:
    type: object
    properties:
      actionbyDepartment:
        $ref: '#/definitions/identifierModel'
      actionbyUser:
        $ref: '#/definitions/identifierModel'
      activeStatus:
        $ref: '#/definitions/identifierModel'
      additionalInformation:
        type: string
      additionalInformationPlainText:
        type: string
      agencyListSQL:
        type: string
      appliedDate:
        format: date-time
        type: string
      appliedbyDepartment:
        $ref: '#/definitions/identifierModel'
      appliedbyUser:
        $ref: '#/definitions/identifierModel'
      dispAdditionalInformationPlainText:
        type: string
      displayNoticeInAgency:
        type: boolean
      displayNoticeInCitizens:
        type: boolean
      displayNoticeInCitizensFee:
        type: boolean
      displayOrder:
        format: int64
        type: integer
      effectiveDate:
        format: date-time
        type: string
      expirationDate:
        format: date-time
        type: string
      group:
        $ref: '#/definitions/identifierModel'
      id:
        format: int64
        type: integer
      inheritable:
        $ref: '#/definitions/identifierModel'
      isIncludeNameInNotice:
        type: boolean
      isIncludeShortCommentsInNotice:
        type: boolean
      longComments:
        type: string
      name:
        type: string
      priority:
        $ref: '#/definitions/identifierModel'
      publicDisplayMessage:
        type: string
      recordId:
        $ref: '#/definitions/capIDModel'
      resAdditionalInformationPlainText:
        type: string
      resolutionAction:
        type: string
      serviceProviderCode:
        type: string
      serviceProviderCodes:
        items: {}
        type: string
      severity:
        $ref: '#/definitions/identifierModel'
      shortComments:
        type: string
      status:
        $ref: '#/definitions/identifierModel'
      statusDate:
        format: date-time
        type: string
      statusType:
        type: string
      type:
        $ref: '#/definitions/identifierModel'
  response_recordContactSimpleModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/recordContactSimpleModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  recordContactSimpleModel:
    type: object
    properties:
      address:
        $ref: '#/definitions/compactAddressModel'
      birthCity:
        type: object
        description: The city of birth for an individual.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      birthDate:
        description: The birth date.
        format: date-time
        type: string
      birthRegion:
        type: object
        description: The country of birth or region of birth for an individual.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      birthState:
        type: object
        description: The state of birth for an individual.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      businessName:
        description: A secondary business name for the applicable individual.
        type: string
      comment:
        description: A comment about the inspection contact.
        type: string
      deceasedDate:
        description: The deceased date.
        format: date-time
        type: string
      driverLicenseNumber:
        description: The driver's license number of the contact. This field is active only when the Contact Type selected
          is Individual.
        type: string
      driverLicenseState:
        type: object
        description: The state that issued the driver's license.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      email:
        description: The contact's email address.
        type: string
      endDate:
        description: The date when the contact address ceases to be active.
        format: date-time
        type: string
      fax:
        description: The fax number for the contact.
        type: string
      faxCountryCode:
        description: Fax Number Country Code
        type: string
      federalEmployerId:
        description: The Federal Employer Identification Number. It is used to identify a business for tax purposes.
        type: string
      firstName:
        description: The contact's first name.
        type: string
      fullName:
        description: 'The contact''s full name. '
        type: string
      gender:
        type: object
        description: The gender (male or female) of the individual.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      id:
        description: The contact system id assigned by the Civic Platform server.
        type: string
      individualOrOrganization:
        description: The organization to which the contact belongs. This field is only active when the Contact Type selected
          is Organization.
        type: string
      isPrimary:
        description: Indicates whether or not to designate the contact as the primary contact Only one address can be primary
          at any given time.
        enum:
        - Y
        - N
        type: string
      lastName:
        description: The last name (surname).
        type: string
      middleName:
        description: "The middle name.\t"
        type: string
      organizationName:
        description: The organization to which the contact belongs. This field is only active when the Contact Type selected
          is Organization.
        type: string
      passportNumber:
        description: The contact's passport number. This field is only active when the Contact Type selected is Individual.
        type: string
      phone1:
        description: The primary telephone number of the contact.
        type: string
      phone1CountryCode:
        description: Phone Number 1 Country Code
        type: string
      phone2:
        description: The secondary telephone number of the contact.
        type: string
      phone2CountryCode:
        description: Phone Number 2 Country Code
        type: string
      phone3:
        description: The tertiary telephone number for the contact.
        type: string
      phone3CountryCode:
        description: Phone Number 3 Country Code
        type: string
      postOfficeBox:
        description: The post office box number.
        type: string
      preferredChannel:
        type: object
        description: The method by which the contact prefers to be notified, by phone for example. See [Get All Contact Preferred
          Channels](./api-settings.html#operation/v4.get.settings.contacts.preferredChannels).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      race:
        type: object
        description: The contact's race or ethnicity. See [Get All Contact Races](./api-settings.html#operation/v4.get.settings.contacts.races).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      recordId:
        $ref: '#/definitions/recordIdModel'
      referenceContactId:
        description: The unique Id generated for a contact stored in the sytem.
        type: string
      relation:
        type: object
        description: The contact's relationship to the application or service request.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      salutation:
        type: object
        description: The salutation to be used when addressing the contact; for example Mr. oar Ms. This field is active only
          when Contact Type = Individual. See [Get All Contact Salutations](./api-settings.html#operation/v4.get.settings.contacts.salutations).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      socialSecurityNumber:
        description: The individual's social security number. This field is only active when the Contact Type selected is
          Individual.
        type: string
      startDate:
        description: The date the contact became active.
        format: date-time
        type: string
      stateIdNumber:
        description: The contact's state ID number. This field is only active when the Contact Type selected is Individual.
        type: string
      status:
        type: object
        description: The contact status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      suffix:
        description: The contact name suffix.
        type: string
      title:
        description: The individual's business title.
        type: string
      tradeName:
        description: The contact's preferred business or trade name. This field is active only when the Contact Type selected
          is Organization.
        type: string
      type:
        type: object
        description: The contact type. See [Get All Contact Types](./api-settings.html#operation/v4.get.settings.contacts.types).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  recordContactModel:
    type: object
    properties:
      address:
        $ref: '#/definitions/compactAddressModel'
      birthCity:
        type: object
        description: The city of birth for an individual.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      birthDate:
        description: The birth date.
        format: date-time
        type: string
      birthRegion:
        type: object
        description: The country of birth or region of birth for an individual.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      birthState:
        type: object
        description: The state of birth for an individual.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      businessName:
        description: A secondary business name for the applicable individual.
        type: string
      comment:
        description: A comment about the inspection contact.
        type: string
      deceasedDate:
        description: The deceased date.
        format: date-time
        type: string
      driverLicenseNumber:
        description: The driver's license number of the contact. This field is active only when the Contact Type selected
          is Individual.
        type: string
      driverLicenseState:
        type: object
        description: The state that issued the driver's license.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      email:
        description: The contact's email address.
        type: string
      endDate:
        description: The date when the contact address ceases to be active.
        format: date-time
        type: string
      fax:
        description: The fax number for the contact.
        type: string
      faxCountryCode:
        description: Fax Number Country Code
        type: string
      federalEmployerId:
        description: The Federal Employer Identification Number. It is used to identify a business for tax purposes.
        type: string
      firstName:
        description: The contact's first name.
        type: string
      fullName:
        description: 'The contact''s full name. '
        type: string
      gender:
        type: object
        description: The gender (male or female) of the individual.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      id:
        description: The contact system id assigned by the Civic Platform server.
        type: string
      individualOrOrganization:
        description: The organization to which the contact belongs. This field is only active when the Contact Type selected
          is Organization.
        type: string
      isPrimary:
        description: Indicates whether or not to designate the contact as the primary contact Only one address can be primary
          at any given time.
        enum:
        - Y
        - N
        type: string
      lastName:
        description: The last name (surname).
        type: string
      middleName:
        description: "The middle name.\t"
        type: string
      organizationName:
        description: The organization to which the contact belongs. This field is only active when the Contact Type selected
          is Organization.
        type: string
      passportNumber:
        description: The contact's passport number. This field is only active when the Contact Type selected is Individual.
        type: string
      phone1:
        description: The primary telephone number of the contact.
        type: string
      phone1CountryCode:
        description: Phone Number 1 Country Code
        type: string
      phone2:
        description: The secondary telephone number of the contact.
        type: string
      phone2CountryCode:
        description: Phone Number 2 Country Code
        type: string
      phone3:
        description: The tertiary telephone number for the contact.
        type: string
      phone3CountryCode:
        description: Phone Number 3 Country Code
        type: string
      postOfficeBox:
        description: The post office box number.
        type: string
      preferredChannel:
        type: object
        description: The method by which the contact prefers to be notified, by phone for example. See [Get All Contact Preferred
          Channels](./api-settings.html#operation/v4.get.settings.contacts.preferredChannels).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      race:
        type: object
        description: The contact's race or ethnicity. See [Get All Contact Races](./api-settings.html#operation/v4.get.settings.contacts.races).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      recordId:
        $ref: '#/definitions/recordIdModel'
      referenceContactId:
        description: The unique Id generated for a contact stored in the sytem.
        type: string
      relation:
        type: object
        description: The contact's relationship to the application or service request.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      salutation:
        type: object
        description: The salutation to be used when addressing the contact; for example Mr. oar Ms. This field is active only
          when Contact Type = Individual. See [Get All Contact Salutations](./api-settings.html#operation/v4.get.settings.contacts.salutations).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      socialSecurityNumber:
        description: The individual's social security number. This field is only active when the Contact Type selected is
          Individual.
        type: string
      startDate:
        description: The date the contact became active.
        format: date-time
        type: string
      stateIdNumber:
        description: The contact's state ID number. This field is only active when the Contact Type selected is Individual.
        type: string
      status:
        type: object
        description: The contact status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      suffix:
        description: The contact name suffix.
        type: string
      title:
        description: The individual's business title.
        type: string
      tradeName:
        description: The contact's preferred business or trade name. This field is active only when the Contact Type selected
          is Organization.
        type: string
      type:
        type: object
        description: The contact type. See [Get All Contact Types](./api-settings.html#operation/v4.get.settings.contacts.types).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  recordIdModel:
    type: object
    properties:
      customId:
        description: An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx).
          Accela Automation auto-generates and applies an alternate ID value when you submit a new application.
        type: string
      id:
        description: The record system id assigned by the Civic Platform server.
        type: string
      serviceProviderCode:
        description: The unique agency identifier.
        type: string
      trackingId:
        description: The application tracking number (IVR tracking number).
        format: int64
        type: integer
      value:
        description: The alphanumeric record id.
        type: string
  capIDModel:
    type: object
    properties:
      customId:
        type: string
      id:
        type: string
      serviceProviderCode:
        type: string
      trackingId:
        format: int64
        type: integer
      value:
        type: string
  recordIdSimpleModel:
    type: object
    properties:
      customId:
        description: An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx).
          Accela Automation auto-generates and applies an alternate ID value when you submit a new application.
        type: string
      id:
        description: The record system id assigned by the Civic Platform server.
        type: string
      serviceProviderCode:
        description: The unique agency identifier.
        type: string
      trackingId:
        description: The application tracking number (IVR tracking number).
        format: int64
        type: integer
  response_recordParcelModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/recordParcelModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  recordParcelModel:
    type: object
    properties:
      block:
        description: The block number associated with the parcel.
        type: string
      book:
        description: A reference to the physical location of parcel information in the County Assessor's office.
        type: string
      censusTract:
        description: The unique number assigned by the Census Bureau that identifies the tract to which this parcel belongs.
        type: string
      councilDistrict:
        description: The council district to which the parcel belongs.
        type: string
      exemptionValue:
        description: The total value of any tax exemptions that apply to the land within the parcel.
        format: double
        type: number
      gisSequenceNumber:
        description: The GIS object ID of the parcel.
        format: int64
        type: integer
      id:
        description: The system id of the parcel assigned by the Civic Platform server.
        type: string
      improvedValue:
        description: The total value of any improvements to the land within the parcel.
        format: double
        type: number
      isPrimary:
        description: Indicates whether or not to designate the parcel as the primary parcel.
        type: string
      landValue:
        description: The total value of the land within the parcel.
        format: double
        type: number
      legalDescription:
        description: The legal description of the parcel.
        type: string
      lot:
        description: The lot name.
        type: string
      mapNumber:
        description: The unique map number that identifies the map for this parcel.
        type: string
      mapReferenceInfo:
        description: The map reference for this parcel.
        type: string
      owners:
        items:
          $ref: '#/definitions/refOwnerModel'
        type: array
      page:
        description: A reference to the physical location of the parcel information in the records of the County Assessor
          (or other responsible department).
        type: string
      parcel:
        description: The official parcel name or number, as determined by the county assessor or other responsible department.
        type: string
      parcelArea:
        description: The total area of the parcel. Your agency determines the standard unit of measure.
        format: double
        type: number
      parcelNumber:
        description: The alpha-numeric parcel number.
        type: string
      planArea:
        description: The total area of the parcel. Your agency determines the standard unit of measure.
        type: string
      range:
        description: When land is surveyed using the rectangular-survey system, range represents the measure of units east
          and west of the base line.
        type: string
      recordId:
        $ref: '#/definitions/recordIdModel'
      section:
        description: A piece of a township measuring 640 acres, one square mile, numbered with reference to the base line
          and meridian line.
        format: int64
        type: integer
      status:
        type: object
        description: The parcel status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      subdivision:
        type: object
        description: The name of the subdivision.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      supervisorDistrict:
        description: The supervisor district to which the parcel belongs.
        type: string
      township:
        description: When land is surveyed using the rectangular-survey system, township represents the measure of units North
          or South of the base line. Townships typically measure 6 miles to a side, or 36 square miles.
        type: string
      tract:
        description: The name of the tract associated with this application. A tract may contain one or more related parcels.
        type: string
  recordTypeNoAliasModel:
    type: object
    properties:
      category:
        description: The 4th level in a 4-level record type structure (Group-Type-Subtype-Category).
        type: string
      filterName:
        description: The name of the record type filter which defines the record types to be displayed for the citizen user.
        type: string
      group:
        description: The 1st level in a 4-level record type structure (Group-Type-Subtype-Category).
        type: string
      id:
        description: The record type system id assigned by the Civic Platform server.
        type: string
      module:
        description: Use to filter by the module. See [Get All Modules](./api-settings.html#operation/v4.get.settings.modules).
        type: string
      subType:
        description: The 3rd level in a 4-level record type structure (Group-Type-Subtype-Category).
        type: string
      text:
        description: The record type display text
        type: string
      type:
        description: The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category).
        type: string
      value:
        description: The record type value.
        type: string
  recordTypeModel:
    type: object
    properties:
      alias:
        description: The record type alias.
        type: string
      category:
        description: The 4th level in a 4-level record type structure (Group-Type-Subtype-Category).
        type: string
      filterName:
        description: The name of the record type filter which defines the record types to be displayed for the citizen user.
        type: string
      group:
        description: The 1st level in a 4-level record type structure (Group-Type-Subtype-Category).
        type: string
      id:
        description: The record type id.
        type: string
      module:
        description: The module the record type belongs to.
        type: string
      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
      value:
        description: The stored value.
        type: string
  childDrill:
    type: object
    properties:
      drillId:
        format: int64
        type: integer
      id:
        type: string
  compactAddressModel:
    type: object
    properties:
      addressLine1:
        description: The first line of the address.
        type: string
      addressLine2:
        description: The second line of the address.
        type: string
      addressLine3:
        description: The third line of the address.
        type: string
      city:
        description: The name of the city.
        type: string
      country:
        type: object
        description: The name of the country.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      postalCode:
        description: The postal ZIP code for the address.
        type: string
      state:
        type: object
        description: The address state.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  conditionHistoryModel:
    type: object
    properties:
      actionbyDepartment:
        type: object
        description: The department responsible for the action.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      actionbyUser:
        type: object
        description: The individual responsible for the action.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      activeStatus:
        type: object
        description: Indicates whether or not the condition is active.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      additionalInformation:
        description: An unlimited text field to use if other fields are filled.
        type: string
      additionalInformationPlainText:
        description: An unlimited text field to use if other fields are filled.
        type: string
      appliedDate:
        description: The date the standard condition was applied.
        format: date-time
        type: string
      appliedbyDepartment:
        type: object
        description: "The department responsible for applying a condition.\t"
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      appliedbyUser:
        type: object
        description: "The staff member responsible for applying a condition.\t"
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      dispAdditionalInformationPlainText:
        description: An unlimited text field to use if other fields are filled.
        type: string
      displayNoticeInAgency:
        description: Indicates whether or not to display the condition notice in Accela Automation when a condition to a record
          or parcel is applied.
        type: boolean
      displayNoticeInCitizens:
        description: Indicates whether or not to display the condition notice in Accela Citizen Access when a condition to
          a record or parcel is applied.
        type: boolean
      displayNoticeInCitizensFee:
        description: Indicates whether or not to display the condition notice in Accela Citizen Access Fee Estimate page when
          a condition to a record or parcel is applied.
        type: boolean
      effectiveDate:
        description: The date when you want the condition to become effective.
        format: date-time
        type: string
      expirationDate:
        description: The date when the condition expires.
        format: date-time
        type: string
      group:
        type: object
        description: The condition group is an attribute of a condition that organizes condition types. Your agency defines
          these groups.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      id:
        description: The condition system id assigned by the Civic Platform server.
        format: int64
        type: integer
      inheritable:
        type: object
        description: This defines whether or not Accela Automation checks for inheritable conditions when a user associates
          a child record with a parent record.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      isIncludeNameInNotice:
        description: Indicates whether or not to display the condition name in the notice.
        type: boolean
      isIncludeShortCommentsInNotice:
        description: Indicates whether or not to display the condition comments in the notice.
        type: boolean
      longComments:
        description: Narrative comments to help identify the purpose or uses of the standard condition.
        type: string
      name:
        description: The name of the standard condition.
        type: string
      priority:
        type: object
        description: The priority level assigned to the condition.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      publicDisplayMessage:
        description: Text entered into this field displays in the condition notice or condition status bar for the Condition
          Name for the public user in Accela IVR (AIVR) and Accela Citizen Access (ACA).
        type: string
      resAdditionalInformationPlainText:
        description: An unlimited text field to use if other fields are filled.
        type: string
      resolutionAction:
        description: he action performed in response to a condition.
        type: string
      serviceProviderCode:
        description: The unique agency identifier.
        type: string
      severity:
        type: object
        description: The severity of the condition.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      shortComments:
        description: A brief description of the condition name. For example, the text may describe the situation that requires
          the system to apply the condition. You can set these short comments to display when a user accesses an application
          with this condition applied to it
        type: string
      status:
        type: object
        description: The condition status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusDate:
        description: The date when the current status changed.
        format: date-time
        type: string
      statusType:
        description: The status type for a standard condition or an approval condition, applied or not applied for example.
        type: string
      type:
        type: object
        description: The condition type.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  response_contactAddressArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/contactAddress'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  contactAddress:
    type: object
    properties:
      addressLine1:
        type: string
      addressLine2:
        type: string
      addressLine3:
        type: string
      city:
        type: string
      country:
        $ref: '#/definitions/identifierModel'
      direction:
        $ref: '#/definitions/identifierModel'
      effectiveDate:
        format: date-time
        type: string
      expirationDate:
        format: date-time
        type: string
      fax:
        type: string
      faxCountryCode:
        type: string
      houseAlphaEnd:
        type: string
      houseAlphaStart:
        type: string
      id:
        format: int64
        type: integer
      isPrimary:
        type: string
      levelEnd:
        type: string
      levelPrefix:
        type: string
      levelStart:
        type: string
      phone:
        type: string
      phoneCountryCode:
        type: string
      postalCode:
        type: string
      recipient:
        type: string
      state:
        $ref: '#/definitions/identifierModel'
      status:
        $ref: '#/definitions/identifierModel'
      streetAddress:
        type: string
      streetEnd:
        format: int64
        type: integer
      streetName:
        type: string
      streetPrefix:
        type: string
      streetStart:
        format: int64
        type: integer
      streetSuffix:
        $ref: '#/definitions/identifierModel'
      streetSuffixDirection:
        $ref: '#/definitions/identifierModel'
      type:
        $ref: '#/definitions/identifierModel'
      unitEnd:
        type: string
      unitStart:
        type: string
      unitType:
        $ref: '#/definitions/identifierModel'
  contactTypeModel:
    type: object
    properties:
      maxOccurance:
        description: The maximum number of times a contact type is used.
        format: int64
        type: integer
      minOccurance:
        description: The minimum number of times a contact type is used.
        format: int64
        type: integer
      value:
        description: The contact type value.
        type: string
  response_costingModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/costingModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  request_costingModelArray:
    type: object
    properties:
      comments:
        description: Comments about the cost.
        type: string
      costAccount:
        description: The cost account name.
        type: string
      costDate:
        description: The date when the cost applied.
        format: date-time
        type: string
      costFactor:
        type: object
        description: The cost factor.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      costItem:
        description: The cost item name.
        type: string
      dispCostingCostItem:
        description: The cost item display name.
        type: string
      distributeFlag:
        description: Indicates whether or not costing is distributed.
        enum:
        - Y
        - N
        type: string
      endTime:
        description: The end time associated to the cost item.
        type: string
      fixedRate:
        description: The fixed rate associated to the cost item.
        format: double
        type: number
      id:
        description: The cost item system id assigned by the Civic Platform server.
        format: int64
        type: integer
      quantity:
        description: The cost item quantity.
        format: double
        type: number
      quantityDetail:
        description: Details about the cost item quantity.
        type: string
      quantityDetailList:
        $ref: '#/definitions/costingQuantityModel'
      relatedAsgnNbr:
        description: Related cost item.
        format: int64
        type: integer
      startTime:
        description: The start time associated to the cost item.
        type: string
      status:
        type: object
        description: The cost item status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      totalCost:
        description: The total cost.
        format: double
        type: number
      type:
        type: object
        description: The cost item type.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      unitOfMeasure:
        type: object
        description: The cost item's unit of measure.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      unitRate:
        description: The cost unit rate.
        format: double
        type: number
      workOrderTaskCode:
        description: The work order task code associated to the cost item.
        type: string
      workOrderTaskCodeIndex:
        description: The order of the work order task.
        format: int64
        type: integer
  costingModel:
    type: object
    properties:
      comments:
        description: Comments about the cost.
        type: string
      costAccount:
        description: The cost account name.
        type: string
      costDate:
        description: The date when the cost applied.
        format: date-time
        type: string
      costFactor:
        type: object
        description: The cost factor.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      costItem:
        description: The cost item name.
        type: string
      dispCostingCostItem:
        description: The cost item display name.
        type: string
      distributeFlag:
        description: Indicates whether or not costing is distributed.
        enum:
        - Y
        - N
        type: string
      endTime:
        description: The end time associated to the cost item.
        type: string
      fixedRate:
        description: The fixed rate associated to the cost item.
        format: double
        type: number
      id:
        description: The cost item system id assigned by the Civic Platform server.
        format: int64
        type: integer
      quantity:
        description: The cost item quantity.
        format: double
        type: number
      quantityDetail:
        description: Details about the cost item quantity.
        type: string
      quantityDetailList:
        $ref: '#/definitions/costingQuantityModel'
      recordId:
        $ref: '#/definitions/recordIdModel'
      relatedAsgnNbr:
        description: Related cost item.
        format: int64
        type: integer
      startTime:
        description: The start time associated to the cost item.
        type: string
      status:
        type: object
        description: The cost item status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      totalCost:
        description: The total cost.
        format: double
        type: number
      type:
        type: object
        description: The cost item type.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      unitOfMeasure:
        type: object
        description: The cost item's unit of measure.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      unitRate:
        description: The cost unit rate.
        format: double
        type: number
      workOrderTaskCode:
        description: The work order task code associated to the cost item.
        type: string
      workOrderTaskCodeIndex:
        description: The order of the work order task.
        format: int64
        type: integer
  costingQuantityModel:
    type: object
    properties:
      factor:
        description: The cost factor.
        format: double
        type: number
      minutes:
        description: The number of minutes associated to the cost.
        format: double
        type: number
  response_customAttributeModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/customAttributeModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  customAttributeModel:
    description: 'Contains a custom form consisting of the custom form id and custom field name and value pairs. For example
      in JSON, "My Custom Field": "My Custom Value". The custom field name and its data type are defined in Civic Platform
      custom forms or custom tables: <br/>**For a Text field**, the maximum length is 256.  <br/>**For a Number field**, any
      numeric form is allowed, including negative numbers.  <br/>**For a Date field**, the format is MM/dd/yyyy.  <br/>**For
      a Time field**, the format is hh:mm.  <br/>**For a TextArea field**, the maximum length is 4000 characters, and allows
      line return characters.  <br/>**For a DropdownList field**, the dropdown list values are in the options[] array.  <br/>**For
      a CheckBox field**, the (case-sensitive) valid values are "UNCHECKED" and "CHECKED".  <br/>**For a Radio(Y/N) field**,
      the (case-sensitive) valid values are "Yes" and "No".'
    type: object
    properties:
      id:
        description: The custom form id.
        type: string
      <aCustomFieldName>:
        description: The name of a custom field.
        type: string
      <aCustomFieldValue>:
        description: The value of a custom field.
        type: string
  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 localized display text.
        type: string
      value:
        description: The value for the specified parameter.
        type: string
  response_describeRecordModel:
    type: object
    properties:
      result:
        $ref: '#/definitions/describeRecordModel'
      status:
        type: integer
        description: The HTTP return status.
  describeRecordModel:
    type: object
    properties:
      elements:
        items:
          $ref: '#/definitions/elementModel'
        type: array
      fields:
        items:
          $ref: '#/definitions/fieldModel'
        type: array
  response_documentModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/documentModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  documentModel:
    type: object
    properties:
      category:
        type: object
        description: The document category. The list of category options varies depending on the document group.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      deletable:
        description: Contains permission assignments for deleting documents.
        $ref: '#/definitions/userRolePrivilegeModel'
      department:
        description: The name of the department the document belongs to.
        type: string
      description:
        description: The document description.
        type: string
      downloadable:
        description: Contains permission assignments for downloading documents.
        $ref: '#/definitions/userRolePrivilegeModel'
      entityId:
        description: The unique ID of the entity or record.
        type: string
      entityType:
        description: The type of entity.
        type: string
      fileName:
        description: The name of the file as it displays in the source location.
        type: string
      group:
        type: object
        description: The document group.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      id:
        description: The document id.
        format: int64
        type: integer
      modifiedBy:
        description: The user account that last modified the document.
        type: string
      modifiedDate:
        description: The date the document was last modified.
        format: date-time
        type: string
      serviceProviderCode:
        description: The unique agency identifier.
        type: string
      size:
        description: The file size of the document.
        format: double
        type: number
      source:
        description: The name for your agency's electronic document management system.
        type: string
      status:
        type: object
        description: The documet status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusDate:
        description: The date when the current status changed.
        format: date-time
        type: string
      titleViewable:
        description: Contains permission assignments for viewing document names.
        $ref: '#/definitions/userRolePrivilegeModel'
      type:
        description: The document type.
        type: string
      uploadedBy:
        description: The user who uploaded the document to the record.
        type: string
      uploadedDate:
        description: The date when the document was uploaded.
        format: date-time
        type: string
      virtualFolders:
        description: This is the virtual folder for storing the attachment. With virtual folders you can organize uploaded
          attachments in groups
        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:
      deletable:
        description: Indicates whether or not the record can be deleted.
        type: boolean
      downloadable:
        description: Indicates whether or not the document type can be downloaded.
        type: boolean
      group:
        type: object
        description: "The document group for the document category.\t"
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      id:
        description: The document category system id assigned by the Civic Platform server.
        type: string
      text:
        description: The localized display text.
        type: string
      uploadable:
        description: Indicates whether or not you can upload documents of the specified category.
        type: boolean
      value:
        description: The document category value.
        type: string
      viewable:
        description: Indicates whether or not you can view the document category associated with the record.
        type: boolean
  elementModel:
    type: object
    properties:
      isReference:
        description: Indicates whether or not the entity is a reference.
        type: boolean
      isRequired:
        description: Indicates whether or not the entity is required.
        type: boolean
      name:
        description: The entity name.
        type: string
      types:
        items:
          $ref: '#/definitions/contactTypeModel'
        type: array
  response_estimateFeeModel:
    type: object
    properties:
      result:
        $ref: '#/definitions/estimateFeeModel'
      status:
        type: integer
        description: The HTTP return status.
  estimateFeeModel:
    type: object
    properties:
      currencyCode:
        description: The standard ISO 4217 currency code. For example, "USD" for US Dollars
        type: string
      feeTotal:
        description: The total fee.
        format: double
        type: number
  feeItemBaseModel:
    type: object
    properties:
      code:
        type: object
        description: The fee item code.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      feeNotes:
        description: Notes about the fee.
        type: string
      id:
        description: The fee item system id assigned by the Civic Platform server.
        format: int64
        type: integer
      paymentPeriod:
        type: object
        description: The time interval for processing invoices.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      quantity:
        description: The number of units for which the same fee applies.
        format: double
        type: number
      schedule:
        type: object
        description: Contains parameters that define the fee schedule.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      version:
        type: object
        description: The fee schedule version.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  feeItemBaseModel_1:
    type: object
    properties:
      code:
        type: object
        description: The fee item code.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      id:
        description: The fee item system id assigned by the Civic Platform server.
        format: int64
        type: integer
      notes:
        description: "A note entered against a fee item.\t"
        type: string
      paymentPeriod:
        type: object
        description: The time interval for processing invoices.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      quantity:
        description: The number of units for which the fee applies.
        format: double
        type: number
      schedule:
        type: object
        description: Contains parameters that define the fee schedule. See [Get All Fee Schedules for Record Type](./api-settings.html#operation/v4.get.settings.records.types.id.fees.schedules).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      version:
        type: object
        description: The fee item version.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  feeItemModel:
    type: object
    properties:
      acaRequiredFlag:
        description: Indicates whether or not the fee schedule is required in order to make it accessible to citizens.
        type: string
      accountCode1:
        description: The code associated with the first fee
        type: string
      accountCode1Allocation:
        description: Allocation proportion or amount of account code 1.
        format: double
        type: number
      accountCode2:
        description: The code associated with the second fee
        type: string
      accountCode2Allocation:
        description: Allocation proportion or amount of account code 2.
        format: double
        type: number
      accountCode3:
        description: The code associated with the third fee
        type: string
      accountCode3Allocation:
        description: Allocation proportion or amount of account code 3.
        format: double
        type: number
      allocatedFee1:
        description: The allocated fee for account code 1.
        format: double
        type: number
      allocatedFee2:
        description: The allocated fee for account code 2.
        format: double
        type: number
      allocatedFee3:
        description: The allocated fee for account code 3.
        format: double
        type: number
      amount:
        description: The amount of a payment transaction or account balance.
        format: double
        type: number
      applyDate:
        description: The date the fee is applied.
        format: date-time
        type: string
      autoAssessFlag:
        description: Indicates whether or not the fee item is automatically assessed.
        type: string
      autoInvoiceFlag:
        description: Indicates whether or not the fee item is automatically invoiced.
        type: string
      balanceDue:
        description: The amount due.
        format: double
        type: number
      calcFlag:
        description: Indicates whether or not the fee amount is based on fee calculation.
        type: string
      calculatedFlag:
        description: Indicates whether or not the fee amount is based on fee calculation.
        type: string
      code:
        type: object
        description: A code identifying an associated item
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      description:
        type: object
        description: The fee description.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      displayOrder:
        description: The display order of the fee item.
        format: int64
        type: integer
      effectDate:
        description: Fee item effective date.
        format: date-time
        type: string
      expireDate:
        description: The date when the item expires
        format: date-time
        type: string
      feeAllocationType:
        description: The fee allocation type to each account code.
        type: string
      feeNotes:
        description: Notes about the fee.
        type: string
      id:
        description: The fee system id.
        format: int64
        type: integer
      invoiceId:
        description: The invoice ID for the fee item.
        format: int64
        type: integer
      maxFee:
        description: The maximum fee item.
        format: double
        type: number
      minFee:
        description: The minimum fee item.
        format: double
        type: number
      paymentPeriod:
        type: object
        description: The time interval for processing invoices.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      priority:
        description: The priority level assigned to the fee item.
        format: int64
        type: integer
      quantity:
        description: The number of units for which the same fee applies.
        format: double
        type: number
      recordId:
        $ref: '#/definitions/recordIdModel'
      schedule:
        type: object
        description: The payment schedule name.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      status:
        description: The fee item status.
        type: string
      subGroup:
        type: object
        description: The subgroup the fee is associated with.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      udf1:
        description: User defined field 1
        type: string
      udf2:
        description: User defined field 2
        type: string
      udf3:
        description: User defined field 3
        type: string
      unit:
        type: object
        description: The unit of measure used for the object.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      variable:
        description: The variable associated with the fee item.
        type: string
      version:
        type: object
        description: The payment schedule version
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  response_feeItemModel_1Array:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/feeItemModel_1'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  feeItemModel_1:
    type: object
    properties:
      accountCode1:
        description: The code associated with the first fee
        type: string
      accountCode1Allocation:
        description: Allocation proportion or amount of account code 1.
        format: double
        type: number
      accountCode2:
        description: The code associated with the second fee
        type: string
      accountCode2Allocation:
        description: Allocation proportion or amount of account code 2.
        format: double
        type: number
      accountCode3:
        description: The code associated with the third fee
        type: string
      accountCode3Allocation:
        description: Allocation proportion or amount of account code 3.
        format: double
        type: number
      amount:
        description: The amount of a payment transaction or account balance.
        format: double
        type: number
      auditDate:
        description: The date when the fee item was added or updated.
        format: date-time
        type: string
      applyDate:
        description: The date the fee is applied.
        format: date-time
        type: string
      balanceDue:
        description: The amount due.
        format: double
        type: number
      code:
        type: object
        description: A code identifying an associated item
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      displayOrder:
        description: The display order of the fee item.
        format: int64
        type: integer
      id:
        description: The fee system id.
        format: int64
        type: integer
      invoiceId:
        description: The invoice ID for the fee item.
        format: int64
        type: integer
      maxFee:
        description: The maximum fee item.
        format: double
        type: number
      minFee:
        description: The minimum fee item.
        format: double
        type: number
      notes:
        description: Notes about the fee item.
        type: string
      paymentPeriod:
        type: object
        description: The time interval for processing invoices.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      priority:
        description: The priority level assigned to the fee item.
        format: int64
        type: integer
      quantity:
        description: The number of units for which the same fee applies.
        format: double
        type: number
      recordId:
        $ref: '#/definitions/recordIdModel'
      schedule:
        type: object
        description: The payment schedule name.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      status:
        description: The fee item status.
        type: string
      subGroup:
        type: object
        description: The subgroup the fee is associated with.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      udf1:
        description: User defined field 1
        type: string
      udf2:
        description: User defined field 2
        type: string
      udf3:
        description: User defined field 3
        type: string
      unit:
        type: object
        description: The unit of measure used for the object.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      variable:
        description: The variable associated with the fee item.
        type: string
      version:
        type: object
        description: The payment schedule version
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  fieldModel:
    type: object
    properties:
      isRequired:
        description: Indicates whether or not the information is required.
        type: boolean
      name:
        description: The field name.
        type: string
  gISObjectModel:
    type: object
    properties:
      gisId:
        description: The GIS object id.
        type: string
      layerId:
        description: The map layer id.
        type: string
      serviceId:
        description: The map service id.
        type: string
  response_identifierModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/identifierModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  identifierModel:
    type: object
    properties:
      text:
        type: string
      value:
        type: string
  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
  response_inspectionModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/inspectionModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  inspectionModel:
    type: object
    properties:
      teamName:
        description: Inspection Team name.
        type: string
      floor:
        description: Inspection Floor.
        type: string
      floorUnit:
        description: Inspection Floor Unit.
        type: string
      address:
        $ref: '#/definitions/recordAddressModel'
      billable:
        description: This defines whether or not the item is billable.
        enum:
        - Y
        - N
        type: string
      category:
        description: The inspection category, which is used to organize inspection types. An inspection type is assigned to
          one or more inspection categories.
        type: string
      commentDisplay:
        description: Indicates whether or not Accela Citizen Access users can view the inspection results comments.
        type: string
      commentPublicVisible:
        description: "Specifies the type of user who can view the inspection result comments. \"All ACA Users\" - Both registered\
          \ and anonymous Accela Citizen Access users can view the comments for inspection results. \"Record Creator Only\"\
          \ - the user who created the record can see the comments for the inspection results. \"Record Creator and Licensed\
          \ Professional\" - The user who created the record and the licensed professional associated with the record can\
          \ see the comments for the inspection results.\t"
        items:
          type: string
        type: array
      completedAMPM:
        description: Indicates whether completed time is "AM" or "PM".
        type: string
      completedDate:
        description: The date of completion.
        format: date-time
        type: string
      completedTime:
        description: The time of completion.
        type: string
      contact:
        $ref: '#/definitions/inspectionContactModel'
      contactFirstName:
        description: The contact's first name. This field is only active when the Contact Type selected is Individual.
        type: string
      contactLastName:
        description: The last name of the contact.
        type: string
      contactMiddleName:
        description: The middle name of the contact.
        type: string
      desiredAMPM:
        description: Indicates whether the desired inspection time is AM or PM.
        type: string
      desiredDate:
        description: The desired inspection date.
        format: date-time
        type: string
      desiredTime:
        description: The desired inspection time.
        type: string
      endMileage:
        description: The ending mileage for the inspection.
        format: float
        type: number
      endTime:
        description: The time the inspection was completed.
        format: date-time
        type: string
      estimatedEndTime:
        description: inspection estimated end time.
        type: string
      estimatedStartTime:
        description: The scheduled start time for the inspection.
        type: string
      gisAreaName:
        description: The GIS Object ID of the parent application if the application that the inspection is scheduled for has
          a parent application that is a project application.
        type: string
      grade:
        description: The name of the inspection grade.
        type: string
      id:
        description: The inspection system id assigned by the Civic Platform server.
        format: int64
        type: integer
      inspectorFullName:
        description: The name of the inspector performing the assessment.
        type: string
      inspectorId:
        description: The ID number of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
        type: string
      isAutoAssign:
        description: This defines whether or not you want to automatically reschedule the inspection when the previous inspection
          status attains Approved status.
        type: string
      latitude:
        description: The angular distance of a place north or south of the earth's equator, usually expressed in degrees and
          minutes.
        format: float
        type: number
      longitude:
        description: The angular distance of a place east or west of the meridian at Greenwich, England, usually expressed
          in degrees and minutes.
        format: float
        type: number
      majorViolation:
        description: The number of major violations.
        format: int64
        type: integer
      overtime:
        description: A labor cost factor that indicates time worked beyond a worker's regular working hours.
        type: string
      priority:
        description: The priority level assigned to the inspection.
        format: double
        type: number
      publicVisible:
        description: This defines whether or not Accela Citizen Access users can view comment about the inspection results.
        type: string
      record:
        $ref: '#/definitions/simpleRecordModel'
      recordId:
        $ref: '#/definitions/recordIdModel'
      recordType:
        $ref: '#/definitions/recordTypeNoAliasModel'
      requestAMPM:
        description: The time segment, AM or PM, for the time specified in the requestTime field.
        type: string
      requestComment:
        description: Comments about the new inspection. For example, you may identify who requested the inspection.
        type: string
      requestDate:
        description: The date when an inspection request is submitted.
        format: date-time
        type: string
      requestTime:
        description: This time is automatically generated when a new inspection is scheduled and submitted.
        type: string
      requestorFirstName:
        description: The first name of the person requesting an inspection-related operation.
        type: string
      requestorLastName:
        description: The last name of the person requesting an inspection-related operation.
        type: string
      requestorMiddleName:
        description: The middle name of the person requesting an inspection-related operation.
        type: string
      requestorPhone:
        description: The telephone number for the person who processes the inspection request or schedules the inspection.
        type: string
      requestorPhoneIDD:
        description: The telephone number for the person who processes the inspection request or schedules the inspection.
        type: string
      requestorUserId:
        description: The user Id of the person requesting an inspection-related operation.
        type: string
      requiredInspection:
        description: This defines whether the inspection is optional or required.
        type: string
      resultComment:
        description: The inspection result comments.
        type: string
      resultType:
        description: 'The type of result that can be ascibed to an inspection. There are three result types: Approved: Approves
          (passes) the checklist item. Denied: Denies (fails) the checklist item. Informational: Indicates that the checklist
          items do not need a status of app'
        type: string
      scheduleDate:
        description: The date when the inspection gets scheduled.
        format: date-time
        type: string
      scheduleEndAMPM:
        description: Indicates whether the scheduleEndTime is in the AM or PM.
        enum:
        - AM
        - PM
        type: string
      scheduleEndTime:
        description: The scheduled end time for the inspection.
        type: string
      scheduleStartAMPM:
        description: AM indicates the 12 hour period from midnight to noon. PM indicates the 12 hour period from noon to midnight.
        enum:
        - AM
        - PM
        type: string
      scheduleStartTime:
        description: The scheduled start time for the inspection.
        type: string
      serviceProviderCode:
        description: The unique agency identifier.
        type: string
      startMileage:
        description: The starting mileage for the inspection.
        format: float
        type: number
      startTime:
        description: The time when you started the inspection.
        format: date-time
        type: string
      status:
        type: object
        description: The inspection status. See [Get All Inspection Statuses](./api-settings.html#operation/v4.get.settings.inspections.statuses).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      submitAMPM:
        description: The time block for the scheduled inspection.
        type: string
      submitDate:
        description: The date that the inspection was submitted.
        format: date-time
        type: string
      submitTime:
        description: The time that a new inspection is submitted. Civic Platform generates this value.
        type: string
      totalMileage:
        description: The total mileage for the inspection.
        format: float
        type: number
      totalScore:
        description: The overall score of the inspection that includes the inspection result, inspection grade, checklist
          total score and checklist major violation option.
        format: int64
        type: integer
      totalTime:
        description: The total amount of time used to do an inspection.
        format: double
        type: number
      type:
        $ref: '#/definitions/inspectionTypeSimpleModel'
      unitNumber:
        description: The number of time units (see timeUnitDuration) comprising an inspection.
        type: string
      units:
        description: The amount of time comprising the smallest time unit for conducting an inspection.
        format: double
        type: number
      vehicleId:
        description: A number, such as the license plate number or VIN, that identifies the vehicle used to complete an inspection.
        type: string
  inspectionContactModel:
    type: object
    properties:
      address:
        $ref: '#/definitions/ownerAddressModel'
      birthCity:
        type: object
        description: The city of birth for an individual.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      birthDate:
        description: The birth date.
        format: date-time
        type: string
      birthRegion:
        type: object
        description: The country of birth or region of birth for an individual.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      birthState:
        type: object
        description: The state of birth for an individual.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      businessName:
        description: A secondary business name for the applicable individual.
        type: string
      comment:
        description: A comment about the inspection contact.
        type: string
      deceasedDate:
        description: The deceased date.
        format: date-time
        type: string
      driverLicenseNumber:
        description: The driver's license number of the contact. This field is active only when the Contact Type selected
          is Individual.
        type: string
      driverLicenseState:
        type: object
        description: The state that issued the driver's license.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      email:
        description: The contact's email address.
        type: string
      fax:
        description: The fax number for the contact.
        type: string
      faxCountryCode:
        description: Fax Number Country Code
        type: string
      federalEmployerId:
        description: The Federal Employer Identification Number. It is used to identify a business for tax purposes.
        type: string
      firstName:
        description: The contact's first name.
        type: string
      fullName:
        description: 'The contact''s full name. '
        type: string
      gender:
        type: object
        description: The gender (male or female) of the individual.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      id:
        description: The contact system id assigned by the Civic Platform server.
        type: string
      individualOrOrganization:
        description: The organization to which the contact belongs. This field is only active when the Contact Type selected
          is Organization.
        type: string
      lastName:
        description: The last name (surname).
        type: string
      middleName:
        description: "The middle name.\t"
        type: string
      organizationName:
        description: The organization to which the contact belongs. This field is only active when the Contact Type selected
          is Organization.
        type: string
      passportNumber:
        description: The contact's passport number. This field is only active when the Contact Type selected is Individual.
        type: string
      phone1:
        description: The primary telephone number of the contact.
        type: string
      phone1CountryCode:
        description: Phone Number 1 Country Code
        type: string
      phone2:
        description: The secondary telephone number of the contact.
        type: string
      phone2CountryCode:
        description: Phone Number 2 Country Code
        type: string
      phone3:
        description: The tertiary telephone number for the contact.
        type: string
      phone3CountryCode:
        description: Phone Number 3 Country Code
        type: string
      postOfficeBox:
        description: The post office box number.
        type: string
      preferredChannel:
        type: object
        description: The method by which the contact prefers to be notified, by phone for example. See [Get All Contact Preferred
          Channels](./api-settings.html#operation/v4.get.settings.contacts.preferredChannels).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      race:
        type: object
        description: The contact's race or ethnicity. See [Get All Contact Races](./api-settings.html#operation/v4.get.settings.contacts.races).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      relation:
        type: object
        description: The contact's relationship to the application or service request.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      salutation:
        type: object
        description: The salutation to be used when addressing the contact; for example Mr. oar Ms. This field is active only
          when Contact Type = Individual. See [Get All Contact Salutations](./api-settings.html#operation/v4.get.settings.contacts.salutations).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      serviceProviderCode:
        description: The unique agency identifier
        type: string
      socialSecurityNumber:
        description: The individual's social security number. This field is only active when the Contact Type selected is
          Individual.
        type: string
      stateIdNumber:
        description: The contact's state ID number. This field is only active when the Contact Type selected is Individual.
        type: string
      status:
        type: object
        description: The contact status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      suffix:
        description: The contact name suffix.
        type: string
      title:
        description: The individual's business title.
        type: string
      tradeName:
        description: The contact's preferred business or trade name. This field is active only when the Contact Type selected
          is Organization.
        type: string
      type:
        type: object
        description: The contact type. See [Get All Contact Types](./api-settings.html#operation/v4.get.settings.contacts.types).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  inspectionRestrictionModel:
    type: object
    properties:
      beforeScheduledTime:
        $ref: '#/definitions/inspectionBeforeScheduledTime'
  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
  inspectionTypeSimpleModel:
    type: object
    properties:
      group:
        type: string
      id:
        format: int64
        type: integer
      ivrNumber:
        format: int64
        type: integer
        description: "The IVR (Interactive Voice Response) number assigned to the inspection type. \n\nAdded in Civic Platform\
          \ 9.3.0"
      text:
        type: string
      value:
        type: string
  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
      ivrNumber:
        format: int64
        type: integer
        description: "The IVR (Interactive Voice Response) number assigned to the inspection type. \n\nAdded in Civic Platform\
          \ 9.3.0"
      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
      schdulePermission:
        description: "Returns one of the scheduling permissions in Citizen Access: \n\nNONE - Does not allow public users\
          \ to schedule this inspection type online. \n\nREQUEST_ONLY_PENDING - Only allows public users to request for an\
          \ inspection online. The agency coordinates the appointment for the inspection date and time. \n\nREQUEST_SAME_DAY_NEXT_DAY\
          \ - Allows public users to request an inspection for the same day, next day, or next available day, based on the\
          \ inspection type calendar parameters defined on the inspection type. \n\nSCHEDULE_USING_CALENDAR - Allows public\
          \ users to schedule inspections based on the availability on the inspection type calendar."
        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
  response_invoiceModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/invoiceModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  invoiceModel:
    type: object
    properties:
      amount:
        description: The invoice fee amount.
        format: double
        type: number
      auditStatus:
        description: The audit status of the invoice fee item.
        type: string
      balance:
        description: The amount due.
        format: double
        type: number
      dueDate:
        description: The invoice due date.
        format: date-time
        type: string
      fees:
        items:
          $ref: '#/definitions/feeItemModel'
        type: array
      id:
        description: The unique id of the invoice.
        format: int64
        type: integer
      invBatchDate:
        description: The invoice batch date.
        format: date-time
        type: string
      invComment:
        description: A comment related to the invoice.
        type: string
      invStatus:
        description: The invoice status.
        type: string
      invoiceDate:
        description: The invoice date.
        format: date-time
        type: string
      invoiceNumber:
        description: The invoice number string.
        type: string
      printed:
        description: Indicates whether or not the invoice is printed.
        enum:
        - Y
        - N
        type: string
      recordId:
        $ref: '#/definitions/recordIdModel'
      serviceProviderCode:
        description: The unique agency identifier.
        type: string
      udf1:
        description: Invoice user defined field 1.
        type: string
      udf2:
        description: Invoice user defined field 2.
        type: string
      udf3:
        description: Invoice user defined field 3.
        type: string
      udf4:
        description: Invoice user defined field 4.
        type: string
  response_licenseProfessionalModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/licenseProfessionalModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  response_licenseProfessionalModel:
    type: object
    properties:
      result:
        $ref: '#/definitions/licenseProfessionalModel'
      status:
        type: integer
        description: The HTTP return status.
  licenseProfessionalModel:
    type: object
    properties:
      addressLine1:
        description: The first line of the address.
        type: string
      addressLine2:
        description: The second line of the address.
        type: string
      addressLine3:
        description: The third line of the address.
        type: string
      birthDate:
        description: The birth date of an individual.
        format: date-time
        type: string
      businessLicense:
        description: The official business license number issued by an agency. A licensed professional can have the same license
          number assigned to multiple license types.
        type: string
      businessName:
        description: A business name for the applicable individual.
        type: string
      businessName2:
        description: A secondary business name for the applicable individual.
        type: string
      city:
        description: The name of the city.
        type: string
      comment:
        description: Comments or notes about the current context.
        type: string
      country:
        type: object
        description: The name of the country.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      email:
        description: The contact's email address.
        type: string
      expirationDate:
        description: The license expiration date.
        format: date-time
        type: string
      fax:
        description: The fax number for the contact.
        type: string
      federalEmployerId:
        description: The Federal Employer Identification Number. It is used to identify a business for tax purposes.
        type: string
      firstName:
        description: 'The licensed professional''s first name. '
        type: string
      fullName:
        description: 'The licensed professional''s full name. '
        type: string
      gender:
        type: object
        description: The gender (male or female) of the individual.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      id:
        description: The licensed professional system id assigned by the Civic Platform server.
        type: string
      isPrimary:
        description: Indicates whether or not to designate the professional as the primary professional.
        type: string
      lastName:
        description: 'The licensed professional''s last name. '
        type: string
      lastRenewalDate:
        description: The last date for a professionals renewal license.
        format: date-time
        type: string
      licenseNumber:
        description: The licensed professional's license number.
        type: string
      licenseType:
        type: object
        description: The type of license held by the professional.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      licensingBoard:
        type: object
        description: The name of the licensing board that issued the license.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      middleName:
        description: 'The licensed professional''s middle name. '
        type: string
      originalIssueDate:
        description: The original issuance date of license.
        format: date-time
        type: string
      phone1:
        description: The primary phone number of the contact.
        type: string
      phone2:
        description: The secondary phone number of the contact.
        type: string
      phone3:
        description: "The tertiary phone number for the contact.\t"
        type: string
      postOfficeBox:
        description: The post office box number.
        type: string
      postalCode:
        description: The postal ZIP code for the address.
        type: string
      recordId:
        $ref: '#/definitions/recordIdModel'
      referenceLicenseId:
        description: The unique Id generated for a professional stored in the system.
        type: string
      salutation:
        type: object
        description: The salutation to be used when addressing the contact; for example Mr. or Ms. This field is active only
          when Contact Type = Individual.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      serviceProviderCode:
        description: The unique agency identifier.
        type: string
      state:
        type: object
        description: The state corresponding to the address on record.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      suffix:
        description: The licensed professional's name suffix.
        type: string
      title:
        description: The individual's professional title.
        type: string
  noticeConditionModel:
    type: object
    properties:
      actionbyDepartment:
        $ref: '#/definitions/identifierModel'
      actionbyUser:
        $ref: '#/definitions/identifierModel'
      activeStatus:
        $ref: '#/definitions/identifierModel'
      additionalInformation:
        type: string
      additionalInformationPlainText:
        type: string
      agencyListSQL:
        type: string
      appliedDate:
        format: date-time
        type: string
      appliedbyDepartment:
        $ref: '#/definitions/identifierModel'
      appliedbyUser:
        $ref: '#/definitions/identifierModel'
      dispAdditionalInformationPlainText:
        type: string
      displayNoticeInAgency:
        type: boolean
      displayNoticeInCitizens:
        type: boolean
      displayNoticeInCitizensFee:
        type: boolean
      displayOrder:
        format: int64
        type: integer
      effectiveDate:
        format: date-time
        type: string
      expirationDate:
        format: date-time
        type: string
      group:
        $ref: '#/definitions/identifierModel'
      id:
        format: int64
        type: integer
      inheritable:
        $ref: '#/definitions/identifierModel'
      isIncludeNameInNotice:
        type: boolean
      isIncludeShortCommentsInNotice:
        type: boolean
      longComments:
        type: string
      name:
        type: string
      priority:
        $ref: '#/definitions/identifierModel'
      publicDisplayMessage:
        type: string
      recordId:
        $ref: '#/definitions/capIDModel'
      resAdditionalInformationPlainText:
        type: string
      resolutionAction:
        type: string
      serviceProviderCode:
        type: string
      serviceProviderCodes:
        items: {}
        type: string
      severity:
        $ref: '#/definitions/identifierModel'
      shortComments:
        type: string
      status:
        $ref: '#/definitions/identifierModel'
      statusDate:
        format: date-time
        type: string
      statusType:
        type: string
      type:
        $ref: '#/definitions/identifierModel'
  ownerAddressModel:
    type: object
    properties:
      addressLine1:
        type: string
      addressLine2:
        type: string
      addressLine3:
        type: string
      city:
        type: string
      country:
        $ref: '#/definitions/identifierModel'
      postalCode:
        type: string
      state:
        $ref: '#/definitions/identifierModel'
  parcelModel_1:
    type: object
    properties:
      block:
        type: string
      book:
        type: string
      censusTract:
        type: string
      councilDistrict:
        type: string
      exemptionValue:
        format: double
        type: number
      gisSequenceNumber:
        format: int64
        type: integer
      id:
        type: string
      improvedValue:
        format: double
        type: number
      isPrimary:
        type: string
      landValue:
        format: double
        type: number
      legalDescription:
        type: string
      lot:
        type: string
      mapNumber:
        type: string
      mapReferenceInfo:
        type: string
      page:
        type: string
      parcel:
        type: string
      parcelArea:
        format: double
        type: number
      parcelNumber:
        type: string
      planArea:
        type: string
      range:
        type: string
      section:
        format: int64
        type: integer
      status:
        $ref: '#/definitions/identifierModel'
      subdivision:
        $ref: '#/definitions/identifierModel'
      supervisorDistrict:
        type: string
      township:
        type: string
      tract:
        type: string
  response_partTransactionModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/partTransactionModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  partTransactionModel:
    type: object
    properties:
      accountName:
        description: The budget account name associated with the part transaction.
        type: string
      accountNumber:
        description: The budget account number associated with the part transaction.
        type: string
      comments:
        description: Comments or notes about the current context.
        type: string
      costTotal:
        description: The total cost of the part transaction.
        format: double
        type: number
      hardReservation:
        description: 'Indicates whether or not the part transaction is a hard reservation. "Y": A hard reservation which guarantees
          the reservation, and subtract the order from the quantity on hand. "N" : A soft reservation which alerts the warehouse
          that houses the part that someone may request the part. The quantity on hand of the part does not change.'
        enum:
        - Y
        - N
        type: string
      id:
        description: The part transaction system id assigned by the Civic Platform server.
        format: int64
        type: integer
      locationId:
        description: The location ID associated with the part transaction.
        format: int64
        type: integer
      partBin:
        description: The name of the part bin.
        type: string
      partBrand:
        description: The name of the part brand.
        type: string
      partDescription:
        description: The description of the part.
        type: string
      partId:
        description: The part ID.
        format: int64
        type: integer
      partLocation:
        description: The location of the part.
        type: string
      partNumber:
        description: The number of the part.
        type: string
      quantity:
        description: The number of units for which the same fee applies.
        format: double
        type: number
      recordId:
        $ref: '#/definitions/recordIdModel'
      resToPartLocation:
        description: ''
        type: string
      reservationNumber:
        description: The part reservation number.
        format: int64
        type: integer
      reservationStatus:
        description: The status of the part reservation.
        type: string
      serviceProviderCode:
        description: The unique agency identifier.
        type: string
      status:
        type: object
        description: The part transaction status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      taxable:
        description: Indicates whether or not the part is taxable.
        enum:
        - Y
        - N
        type: string
      transactionCost:
        description: The part transaction cost.
        format: double
        type: number
      transactionDate:
        description: The part transaction date.
        format: date-time
        type: string
      transactionType:
        description: "The part transaction type. Possible values: \n\n\"Issue\" : occurs either when someone requests and\
          \ receives a part on the spot, or when someone receives a reserved part. \n\n\"Receive\" : occurs when someone purchases\
          \ a part or returns a part to a location. \n\n\"Transfer\" : occurs when someone moves a part from one location\
          \ to another. \n\n\"Adjust\" : occurs when someone makes quantity adjustments for cycle counts. \n\n\"Reserve\"\
          \ : occurs when someone sets aside parts so they can issue them at a later date."
        type: string
        enum:
        - Issue
        - Receive
        - Transfer
        - Adjust
        - Reserve
      type:
        type: object
        description: ''
        properties:
          text:
            description: The part transaction type.
            type: string
          value:
            description: The data value.
            type: string
      unitCost:
        description: The unit cost per part.
        format: double
        type: number
      unitMeasurement:
        type: object
        description: The unit of measurement for quantifying the part.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      updatedBy:
        description: The user who last updated the checklist or checklist item.
        type: string
      workOrderTaskCode:
        description: The work order task code associated with the part transactionmodel.
        type: string
      workOrderTaskCodeIndex:
        description: The work order task code index associated with the part transactionmodel.
        format: int64
        type: integer
  response_paymentModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/paymentModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  paymentModel:
    type: object
    properties:
      amount:
        description: The amount of a payment transaction or account balance.
        format: double
        type: number
      amountNotAllocated:
        description: The payment amount which has not been allocated.
        format: double
        type: number
      cashierId:
        description: The unique ID associated with the cashier.
        type: string
      id:
        description: The payment system id assigned by the Civic Platform server.
        format: int64
        type: integer
      paymentDate:
        description: The date a payment was entered into the system.
        format: date-time
        type: string
      paymentMethod:
        description: Describes the method of payment, for example; credit card, cash, debit card, and so forth.
        type: string
      paymentStatus:
        description: Indicates whether or not a payment has been made in full.
        type: string
      receiptId:
        description: The unique ID generated for the recipient.
        format: int64
        type: integer
      recordId:
        $ref: '#/definitions/recordIdModel'
      transactionCode:
        description: An industry standard code that identifies the type of transaction.
        type: string
      transactionId:
        description: A unique number, assigned by the system, that indentifies the transaction.
        format: int64
        type: integer
  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_recordAdditionalModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/recordAdditionalModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  recordAdditionalModel:
    type: object
    properties:
      buildingCount:
        description: The number of buildings associated with the record.
        format: int64
        type: integer
      constructionType:
        type: object
        description: The US Census Bureau construction type code.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      estimatedValue:
        description: The application's estimated value.
        format: double
        type: number
      houseUnit:
        description: The house unit associated with the application.
        format: int64
        type: integer
      publicOwned:
        description: A flag that indicates whether or not the public owns the item.
        type: string
      recordId:
        $ref: '#/definitions/recordIdSimpleModel'
  response_recordModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/recordAPOCustomFormsModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  recordAPOCustomFormsModel:
    type: object
    properties:
      actualProductionUnit:
        description: Estimated cost per production unit.
        format: double
        type: number
      addresses:
        items:
          $ref: '#/definitions/recordAddressCustomFormsModel'
        type: array
      appearanceDate:
        description: The date for a hearing appearance.
        format: date-time
        type: string
      appearanceDayOfWeek:
        description: The day for a hearing appearance.
        type: string
      assets:
        items:
          $ref: '#/definitions/assetMasterModel'
        type: array
      assignedDate:
        description: The date the application was assigned.
        format: date-time
        type: string
      assignedToDepartment:
        description: The department responsible for the action. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      assignedUser:
        description: The staff member responsible for the action.
        type: string
      balance:
        description: The amount due.
        format: double
        type: number
      booking:
        description: Indicates whether or not there was a booking in addition to a citation.
        type: boolean
      closedByDepartment:
        description: The department responsible for closing the record. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      closedByUser:
        description: The staff member responsible for closure.
        type: string
      closedDate:
        description: The date the application was closed.
        format: date-time
        type: string
      completeDate:
        description: The date the application was completed.
        format: date-time
        type: string
      completedByDepartment:
        description: The department responsible for completion. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      completedByUser:
        description: The staff member responsible for completion.
        type: string
      conditionOfApprovals:
        items:
          $ref: '#/definitions/capConditionModel_2'
        type: array
      conditions:
        items:
          $ref: '#/definitions/noticeConditionModel'
        type: array
      constructionType:
        type: object
        description: The US Census Bureau construction type code. See [Get All Record Construction Types](./api-settings.html#operation/v4.get.settings.records.constructionTypes).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      contact:
        items:
          $ref: '#/definitions/recordContactSimpleModel'
        type: array
      costPerUnit:
        description: The cost for one unit associated to the record.
        format: double
        type: number
      createdBy:
        description: The unique user id of the individual that created the entry.
        type: string
      createdByCloning:
        description: Indictes whether or not the record was cloned.
        enum:
        - Y
        - N
        type: string
      customForms:
        items:
          $ref: '#/definitions/customAttributeModel'
        type: array
      customId:
        description: An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx).
          Civic Platform auto-generates and applies an alternate ID value when you submit a new application.
        type: string
      customTables:
        items:
          $ref: '#/definitions/tableModel'
        type: array
      defendantSignature:
        description: Indicates whether or not a defendant's signature has been obtained.
        type: boolean
      description:
        description: The description of the record or item.
        type: string
      enforceDepartment:
        description: The name of the department responsible for enforcement. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      enforceUser:
        description: Name of the enforcement officer.
        type: string
      enforceUserId:
        description: ID number of the enforcement officer.
        type: string
      estimatedCostPerUnit:
        description: The estimated cost per unit.
        format: double
        type: number
      estimatedDueDate:
        description: The estimated date of completion.
        format: date-time
        type: string
      estimatedProductionUnit:
        description: The estimated number of production units.
        format: double
        type: number
      estimatedTotalJobCost:
        description: The estimated cost of the job.
        format: double
        type: number
      firstIssuedDate:
        description: The first issued date for license
        format: date-time
        type: string
      housingUnits:
        description: The number of housing units.
        format: int64
        type: integer
      id:
        description: The record system id assigned by the Civic Platform server.
        type: string
      inPossessionTime:
        description: The application level in possession time of the time tracking feature.
        format: double
        type: number
      infraction:
        description: Indicates whether or not an infraction occurred.
        type: boolean
      initiatedProduct:
        description: 'The Civic Platform product  where the application is submitted: "AA" : Classic Accela Automation. "ACA"
          : Accela Citizen Access. "AIVR" : Accela Integrated Voice Response. "AMO" : Accela Mobile Office. "AV360" : Accela
          Asset Management, Accela Land Management.'
        type: string
      inspectorDepartment:
        description: The name of the department where the inspector works. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      inspectorId:
        description: The ID number of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
        type: string
      inspectorName:
        description: The name of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
        type: string
      jobValue:
        description: The value of the job.
        format: double
        type: number
      misdemeanor:
        description: Indicates whether or not a misdemeanor occurred.
        type: boolean
      module:
        description: The module the record belongs to. See [Get All Modules](./api-settings.html#operation/v4.get.settings.modules).
        type: string
      name:
        description: The name associated to the record.
        type: string
      numberOfBuildings:
        description: The number of buildings.
        format: int64
        type: integer
      offenseWitnessed:
        description: Indicates whether or not  there was a witness to the alleged offense.
        type: boolean
      openedDate:
        description: The date the application was opened.
        format: date-time
        type: string
      overallApplicationTime:
        description: The amount of elapsed time from the time tracking start date to the completion of the application.
        format: double
        type: number
      owner:
        items:
          $ref: '#/definitions/refOwnerModel'
        type: array
      parcel:
        items:
          $ref: '#/definitions/parcelModel_1'
        type: array
      priority:
        type: object
        description: The priority level assigned to the record. See [Get All Priorities](./api-settings.html#operation/v4.get.settings.priorities).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      professional:
        items:
          $ref: '#/definitions/licenseProfessionalModel'
        type: array
      publicOwned:
        description: Indicates whether or not the record is for the public.
        type: boolean
      recordClass:
        description: General information about the record.
        type: string
      renewalInfo:
        $ref: '#/definitions/recordExpirationModel'
      reportedChannel:
        type: object
        description: The incoming channel through which the applicant submitted the application.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      reportedDate:
        description: The date the complaint was reported.
        format: date-time
        type: string
      reportedType:
        type: object
        description: The type of complaint or incident being reported.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      scheduledDate:
        description: The date when the inspection gets scheduled.
        format: date-time
        type: string
      severity:
        type: object
        description: Indicates the severity of the condition.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      shortNotes:
        description: A brief note about the record subject.
        type: string
      status:
        type: object
        description: The record status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusDate:
        description: "The date when the current status changed.\t"
        format: date-time
        type: string
      statusReason:
        type: object
        description: "\tThe reason for the status setting on the record."
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusType:
        description: The record status type.
        enum:
        - APPROVED
        - CLOSED
        - COMPLETE
        - DENIED
        - INCOMPLETE
        - OPEN
        - PENDING
        - UNASSIGNED
        - VOID
        items:
          type: string
        type: array
      totalFee:
        description: The total amount of the fees invoiced to the record.
        format: double
        type: number
      totalJobCost:
        description: The combination of work order assignments (labor) and costs.
        format: double
        type: number
      totalPay:
        description: The total amount of pay.
        format: double
        type: number
      trackingId:
        description: The application tracking number (IVR tracking number).
        format: int64
        type: integer
      type:
        $ref: '#/definitions/recordTypeModel'
      undistributedCost:
        description: The undistributed costs for this work order.
        format: double
        type: number
      updateDate:
        description: The last update date.
        format: date-time
        type: string
      value:
        description: The record value.
        type: string
  recordModel:
    type: object
    properties:
      actualProductionUnit:
        description: Estimated cost per production unit.
        format: double
        type: number
      addresses:
        items:
          $ref: '#/definitions/recordAddressModel'
        type: array
      appearanceDate:
        description: The date for a hearing appearance.
        format: date-time
        type: string
      appearanceDayOfWeek:
        description: The day for a hearing appearance.
        type: string
      assets:
        items:
          $ref: '#/definitions/assetMasterModel'
        type: array
      assignedDate:
        description: The date the application was assigned.
        format: date-time
        type: string
      assignedToDepartment:
        description: The department responsible for the action. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      assignedUser:
        description: The staff member responsible for the action.
        type: string
      balance:
        description: The amount due.
        format: double
        type: number
      booking:
        description: Indicates whether or not there was a booking in addition to a citation.
        type: boolean
      closedByDepartment:
        description: The department responsible for closing the record. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      closedByUser:
        description: The staff member responsible for closure.
        type: string
      closedDate:
        description: The date the application was closed.
        format: date-time
        type: string
      completeDate:
        description: The date the application was completed.
        format: date-time
        type: string
      completedByDepartment:
        description: The department responsible for completion. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      completedByUser:
        description: The staff member responsible for completion.
        type: string
      conditionOfApprovals:
        items:
          $ref: '#/definitions/capConditionModel_2'
        type: array
      conditions:
        items:
          $ref: '#/definitions/noticeConditionModel'
        type: array
      constructionType:
        type: object
        description: The US Census Bureau construction type code. See [Get All Record Construction Types](./api-settings.html#operation/v4.get.settings.records.constructionTypes).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      contact:
        items:
          $ref: '#/definitions/recordContactSimpleModel'
        type: array
      costPerUnit:
        description: The cost for one unit associated to the record.
        format: double
        type: number
      createdBy:
        description: The unique user id of the individual that created the entry.
        type: string
      createdByCloning:
        description: Indictes whether or not the record was cloned.
        enum:
        - Y
        - N
        type: string
      customForms:
        items:
          $ref: '#/definitions/customAttributeModel'
        type: array
      customId:
        description: An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx).
          Civic Platform auto-generates and applies an alternate ID value when you submit a new application.
        type: string
      customTables:
        items:
          $ref: '#/definitions/tableModel'
        type: array
      defendantSignature:
        description: Indicates whether or not a defendant's signature has been obtained.
        type: boolean
      description:
        description: The description of the record or item.
        type: string
      enforceDepartment:
        description: The name of the department responsible for enforcement. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      enforceUser:
        description: Name of the enforcement officer.
        type: string
      enforceUserId:
        description: ID number of the enforcement officer.
        type: string
      estimatedCostPerUnit:
        description: The estimated cost per unit.
        format: double
        type: number
      estimatedDueDate:
        description: The estimated date of completion.
        format: date-time
        type: string
      estimatedProductionUnit:
        description: The estimated number of production units.
        format: double
        type: number
      estimatedTotalJobCost:
        description: The estimated cost of the job.
        format: double
        type: number
      firstIssuedDate:
        description: The first issued date for license
        format: date-time
        type: string
      housingUnits:
        description: The number of housing units.
        format: int64
        type: integer
      id:
        description: The record system id assigned by the Civic Platform server.
        type: string
      inPossessionTime:
        description: The application level in possession time of the time tracking feature.
        format: double
        type: number
      infraction:
        description: Indicates whether or not an infraction occurred.
        type: boolean
      initiatedProduct:
        description: 'The Civic Platform product  where the application is submitted: "AA" : Classic Accela Automation. "ACA"
          : Accela Citizen Access. "AIVR" : Accela Integrated Voice Response. "AMO" : Accela Mobile Office. "AV360" : Accela
          Asset Management, Accela Land Management.'
        type: string
      inspectorDepartment:
        description: The name of the department where the inspector works. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      inspectorId:
        description: The ID number of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
        type: string
      inspectorName:
        description: The name of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
        type: string
      jobValue:
        description: The value of the job.
        format: double
        type: number
      misdemeanor:
        description: Indicates whether or not a misdemeanor occurred.
        type: boolean
      module:
        description: The module the record belongs to. See [Get All Modules](./api-settings.html#operation/v4.get.settings.modules).
        type: string
      name:
        description: The name associated to the record.
        type: string
      numberOfBuildings:
        description: The number of buildings.
        format: int64
        type: integer
      offenseWitnessed:
        description: Indicates whether or not  there was a witness to the alleged offense.
        type: boolean
      openedDate:
        description: The date the application was opened.
        format: date-time
        type: string
      overallApplicationTime:
        description: The amount of elapsed time from the time tracking start date to the completion of the application.
        format: double
        type: number
      owner:
        items:
          $ref: '#/definitions/refOwnerModel'
        type: array
      parcel:
        items:
          $ref: '#/definitions/parcelModel_1'
        type: array
      priority:
        type: object
        description: The priority level assigned to the record. See [Get All Priorities](./api-settings.html#operation/v4.get.settings.priorities).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      professional:
        items:
          $ref: '#/definitions/licenseProfessionalModel'
        type: array
      publicOwned:
        description: Indicates whether or not the record is for the public.
        type: boolean
      recordClass:
        description: General information about the record.
        type: string
      renewalInfo:
        $ref: '#/definitions/recordExpirationModel'
      reportedChannel:
        type: object
        description: The incoming channel through which the applicant submitted the application.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      reportedDate:
        description: The date the complaint was reported.
        format: date-time
        type: string
      reportedType:
        type: object
        description: The type of complaint or incident being reported.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      scheduledDate:
        description: The date when the inspection gets scheduled.
        format: date-time
        type: string
      severity:
        type: object
        description: Indicates the severity of the condition.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      shortNotes:
        description: A brief note about the record subject.
        type: string
      status:
        type: object
        description: The record status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusDate:
        description: "The date when the current status changed.\t"
        format: date-time
        type: string
      statusReason:
        type: object
        description: "\tThe reason for the status setting on the record."
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusType:
        description: The record status type.
        enum:
        - APPROVED
        - CLOSED
        - COMPLETE
        - DENIED
        - INCOMPLETE
        - OPEN
        - PENDING
        - UNASSIGNED
        - VOID
        items:
          type: string
        type: array
      totalFee:
        description: The total amount of the fees invoiced to the record.
        format: double
        type: number
      totalJobCost:
        description: The combination of work order assignments (labor) and costs.
        format: double
        type: number
      totalPay:
        description: The total amount of pay.
        format: double
        type: number
      trackingId:
        description: The application tracking number (IVR tracking number).
        format: int64
        type: integer
      type:
        $ref: '#/definitions/recordTypeModel'
      undistributedCost:
        description: The undistributed costs for this work order.
        format: double
        type: number
      updateDate:
        description: The last update date.
        format: date-time
        type: string
      value:
        description: The record value.
        type: string
  request_createRecordModel:
    type: object
    properties:
      actualProductionUnit:
        description: Estimated cost per production unit.
        format: double
        type: number
      addresses:
        items:
          $ref: '#/definitions/recordAddressModel'
        type: array
      appearanceDate:
        description: The date for a hearing appearance.
        format: date-time
        type: string
      appearanceDayOfWeek:
        description: The day for a hearing appearance.
        type: string
      assignedDate:
        description: The date the application was assigned.
        format: date-time
        type: string
      assignedToDepartment:
        description: The department responsible for the action. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      assignedUser:
        description: The staff member responsible for the action.
        type: string
      balance:
        description: The amount due.
        format: double
        type: number
      booking:
        description: Indicates whether or not there was a booking in addition to a citation.
        type: boolean
      closedByDepartment:
        description: The department responsible for closing the record. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      closedByUser:
        description: The staff member responsible for closure.
        type: string
      closedDate:
        description: The date the application was closed.
        format: date-time
        type: string
      completeDate:
        description: The date the application was completed.
        format: date-time
        type: string
      completedByDepartment:
        description: The department responsible for completion. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      completedByUser:
        description: The staff member responsible for completion.
        type: string
      conditionOfApprovals:
        items:
          $ref: '#/definitions/capConditionModel_2'
        type: array
      conditions:
        items:
          $ref: '#/definitions/noticeConditionModel'
        type: array
      constructionType:
        type: object
        description: The US Census Bureau construction type code. See [Get All Record Construction Types](./api-settings.html#operation/v4.get.settings.records.constructionTypes).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      contacts:
        items:
          $ref: '#/definitions/recordContactSimpleModel'
        type: array
      costPerUnit:
        description: The cost for one unit associated to the record.
        format: double
        type: number
      createdBy:
        description: The unique user id of the individual that created the entry.
        type: string
      createdByCloning:
        description: Indictes whether or not the record was cloned.
        enum:
        - Y
        - N
        type: string
      customForms:
        items:
          $ref: '#/definitions/customAttributeModel'
        type: array
      customId:
        description: An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx).
          Civic Platform auto-generates and applies an alternate ID value when you submit a new application.
        type: string
      customTables:
        items:
          $ref: '#/definitions/tableModel'
        type: array
      defendantSignature:
        description: Indicates whether or not a defendant's signature has been obtained.
        type: boolean
      description:
        description: The description of the record or item.
        type: string
      enforceDepartment:
        description: The name of the department responsible for enforcement. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      enforceUser:
        description: Name of the enforcement officer.
        type: string
      enforceUserId:
        description: ID number of the enforcement officer.
        type: string
      estimatedCostPerUnit:
        description: The estimated cost per unit.
        format: double
        type: number
      estimatedDueDate:
        description: The estimated date of completion.
        format: date-time
        type: string
      estimatedProductionUnit:
        description: The estimated number of production units.
        format: double
        type: number
      estimatedTotalJobCost:
        description: The estimated cost of the job.
        format: double
        type: number
      firstIssuedDate:
        description: The first issued date for license
        format: date-time
        type: string
      housingUnits:
        description: The number of housing units.
        format: int64
        type: integer
      id:
        description: The record system id assigned by the Civic Platform server.
        type: string
      inPossessionTime:
        description: The application level in possession time of the time tracking feature.
        format: double
        type: number
      infraction:
        description: Indicates whether or not an infraction occurred.
        type: boolean
      initiatedProduct:
        description: 'The product or app that created the record. If initiatedProduct is null or not specified in the request,
          the default is "AV360" (Civic Platform application).


          Added in Civic Platform version: 9.2.0'
        type: string
      inspectorDepartment:
        description: The name of the department where the inspector works. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      inspectorId:
        description: The ID number of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
        type: string
      inspectorName:
        description: The name of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
        type: string
      jobValue:
        description: The value of the job.
        format: double
        type: number
      misdemeanor:
        description: Indicates whether or not a misdemeanor occurred.
        type: boolean
      module:
        description: The module the record belongs to. See [Get All Modules](./api-settings.html#operation/v4.get.settings.modules).
        type: string
      name:
        description: The name associated to the record.
        type: string
      numberOfBuildings:
        description: The number of buildings.
        format: int64
        type: integer
      offenseWitnessed:
        description: Indicates whether or not  there was a witness to the alleged offense.
        type: boolean
      openedDate:
        description: The date the application was opened.
        format: date-time
        type: string
      overallApplicationTime:
        description: The amount of elapsed time from the time tracking start date to the completion of the application.
        format: double
        type: number
      owners:
        items:
          $ref: '#/definitions/refOwnerModel'
        type: array
      parcels:
        items:
          $ref: '#/definitions/parcelModel_1'
        type: array
      priority:
        type: object
        description: The priority level assigned to the record. See [Get All Priorities](./api-settings.html#operation/v4.get.settings.priorities).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      professionals:
        items:
          $ref: '#/definitions/licenseProfessionalModel'
        type: array
      publicOwned:
        description: Indicates whether or not the record is for the public.
        type: boolean
      recordClass:
        description: General information about the record.
        type: string
      renewalInfo:
        $ref: '#/definitions/recordExpirationModel'
      reportedChannel:
        type: object
        description: The incoming channel through which the applicant submitted the application.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      reportedType:
        type: object
        description: The type of complaint or incident being reported.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      scheduledDate:
        description: The date when the inspection gets scheduled.
        format: date-time
        type: string
      severity:
        type: object
        description: Indicates the severity of the condition.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      shortNotes:
        description: A brief note about the record subject.
        type: string
      status:
        type: object
        description: The record status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusReason:
        type: object
        description: "\tThe reason for the status setting on the record."
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusType:
        description: The record status type.
        enum:
        - APPROVED
        - CLOSED
        - COMPLETE
        - DENIED
        - INCOMPLETE
        - OPEN
        - PENDING
        - UNASSIGNED
        - VOID
        items:
          type: string
        type: array
      totalJobCost:
        description: The combination of work order assignments (labor) and costs.
        format: double
        type: number
      totalPay:
        description: The combination of work order assignments (labor) and costs.
        format: double
        type: number
      trackingId:
        description: The total amount of pay.
        format: int64
        type: integer
      type:
        $ref: '#/definitions/recordTypeModel'
      undistributedCost:
        description: The undistributed costs for this work order.
        format: double
        type: number
      updateDate:
        description: The last update date.
        format: date-time
        type: string
  response_recordExtModel_1Array:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/recordExtModel_1'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  recordExtModel_1:
    type: object
    properties:
      actualProductionUnit:
        description: Estimated cost per production unit.
        format: double
        type: number
      addresses:
        items:
          $ref: '#/definitions/recordAddressCustomFormsModel'
        type: array
      appearanceDate:
        description: The date for a hearing appearance.
        format: date-time
        type: string
      appearanceDayOfWeek:
        description: The day for a hearing appearance.
        type: string
      assignedDate:
        description: The date the application was assigned.
        format: date-time
        type: string
      assignedToDepartment:
        description: The department responsible for the action. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      assignedUser:
        description: The staff member responsible for the action.
        type: string
      balance:
        description: The amount due.
        format: double
        type: number
      booking:
        description: Indicates whether or not there was a booking in addition to a citation.
        type: boolean
      closedByDepartment:
        description: The department responsible for closing the record. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      closedByUser:
        description: The staff member responsible for closure.
        type: string
      closedDate:
        description: The date the application was closed.
        format: date-time
        type: string
      completeDate:
        description: The date the application was completed.
        format: date-time
        type: string
      completedByDepartment:
        description: The department responsible for completion. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      completedByUser:
        description: The staff member responsible for completion.
        type: string
      conditionOfApprovals:
        items:
          $ref: '#/definitions/capConditionModel_2'
        type: array
      conditions:
        items:
          $ref: '#/definitions/noticeConditionModel'
        type: array
      constructionType:
        type: object
        description: The US Census Bureau construction type code. See [Get All Record Construction Types](./api-settings.html#operation/v4.get.settings.records.constructionTypes).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      contacts:
        items:
          $ref: '#/definitions/recordContactSimpleModel'
        type: array
      costPerUnit:
        description: The cost for one unit associated to the record.
        format: double
        type: number
      createdBy:
        description: The unique user id of the individual that created the entry.
        type: string
      customForms:
        items:
          $ref: '#/definitions/customAttributeModel'
        type: array
      customId:
        description: An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx).
          Civic Platform auto-generates and applies an alternate ID value when you submit a new application.
        type: string
      customTables:
        items:
          $ref: '#/definitions/tableModel'
        type: array
      defendantSignature:
        description: Indicates whether or not a defendant's signature has been obtained.
        type: boolean
      description:
        description: The description of the record or item.
        type: string
      enforceDepartment:
        description: The name of the department responsible for enforcement. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      enforceUser:
        description: Name of the enforcement officer.
        type: string
      enforceUserId:
        description: ID number of the enforcement officer.
        type: string
      estimatedCostPerUnit:
        description: The estimated cost per unit.
        format: double
        type: number
      estimatedDueDate:
        description: The estimated date of completion.
        format: date-time
        type: string
      estimatedProductionUnit:
        description: The estimated number of production units.
        format: double
        type: number
      estimatedTotalJobCost:
        description: The estimated cost of the job.
        format: double
        type: number
      firstIssuedDate:
        description: The first issued date for license
        format: date-time
        type: string
      housingUnits:
        description: The number of housing units.
        format: int64
        type: integer
      id:
        description: The record system id assigned by the Civic Platform server.
        type: string
      inPossessionTime:
        description: The application level in possession time of the time tracking feature.
        format: double
        type: number
      infraction:
        description: Indicates whether or not an infraction occurred.
        type: boolean
      initiatedProduct:
        description: 'The Civic Platform product  where the application is submitted: "AA" : Classic Accela Automation. "ACA"
          : Accela Citizen Access. "AIVR" : Accela Integrated Voice Response. "AMO" : Accela Mobile Office. "AV360" : Accela
          Asset Management, Accela Land Management.'
        type: string
      inspectorDepartment:
        description: The name of the department where the inspector works. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      inspectorId:
        description: The ID number of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
        type: string
      inspectorName:
        description: The name of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
        type: string
      jobValue:
        description: The value of the job.
        format: double
        type: number
      misdemeanor:
        description: Indicates whether or not a misdemeanor occurred.
        type: boolean
      module:
        description: The module the record belongs to. See [Get All Modules](./api-settings.html#operation/v4.get.settings.modules).
        type: string
      name:
        description: The name associated to the record.
        type: string
      numberOfBuildings:
        description: The number of buildings.
        format: int64
        type: integer
      offenseWitnessed:
        description: Indicates whether or not  there was a witness to the alleged offense.
        type: boolean
      openedDate:
        description: The date the application was opened.
        format: date-time
        type: string
      overallApplicationTime:
        description: The amount of elapsed time from the time tracking start date to the completion of the application.
        format: double
        type: number
      owners:
        items:
          $ref: '#/definitions/refOwnerModel'
        type: array
      parcels:
        items:
          $ref: '#/definitions/parcelModel_1'
        type: array
      priority:
        type: object
        description: The priority level assigned to the record. See [Get All Priorities](./api-settings.html#operation/v4.get.settings.priorities).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      professionals:
        items:
          $ref: '#/definitions/licenseProfessionalModel'
        type: array
      publicOwned:
        description: Indicates whether or not the record is for the public.
        type: boolean
      recordClass:
        description: General information about the record.
        type: string
      renewalInfo:
        $ref: '#/definitions/recordExpirationModel'
      reportedChannel:
        type: object
        description: The incoming channel through which the applicant submitted the application.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      reportedType:
        type: object
        description: The type of complaint or incident being reported.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      scheduledDate:
        description: The date when the inspection gets scheduled.
        format: date-time
        type: string
      severity:
        type: object
        description: Indicates the severity of the condition.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      shortNotes:
        description: A brief note about the record subject.
        type: string
      status:
        type: object
        description: The record status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusReason:
        type: object
        description: "\tThe reason for the status setting on the record."
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusType:
        description: The record status type.
        enum:
        - APPROVED
        - CLOSED
        - COMPLETE
        - DENIED
        - INCOMPLETE
        - OPEN
        - PENDING
        - UNASSIGNED
        - VOID
        items:
          type: string
        type: array
      totalJobCost:
        description: The combination of work order assignments (labor) and costs.
        format: double
        type: number
      totalPay:
        description: The combination of work order assignments (labor) and costs.
        format: double
        type: number
      trackingId:
        description: The total amount of pay.
        format: int64
        type: integer
      type:
        $ref: '#/definitions/recordTypeModel'
      undistributedCost:
        description: The undistributed costs for this work order.
        format: double
        type: number
      updateDate:
        description: The last update date.
        format: date-time
        type: string
      value:
        type: string
  request_recordModel:
    type: object
    properties:
      actualProductionUnit:
        description: Estimated cost per production unit.
        format: double
        type: number
      addresses:
        items:
          $ref: '#/definitions/recordAddressModel'
        type: array
      appearanceDate:
        description: The date for a hearing appearance.
        format: date-time
        type: string
      appearanceDayOfWeek:
        description: The day for a hearing appearance.
        type: string
      assignedDate:
        description: The date the application was assigned.
        format: date-time
        type: string
      assignedToDepartment:
        description: The department responsible for the action. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      assignedUser:
        description: The staff member responsible for the action.
        type: string
      booking:
        description: Indicates whether or not there was a booking in addition to a citation.
        type: boolean
      closedByDepartment:
        description: The department responsible for closing the record. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      closedByUser:
        description: The staff member responsible for closure.
        type: string
      closedDate:
        description: The date the application was closed.
        format: date-time
        type: string
      completeDate:
        description: The date the application was completed.
        format: date-time
        type: string
      completedByDepartment:
        description: The department responsible for completion. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      completedByUser:
        description: The staff member responsible for completion.
        type: string
      constructionType:
        type: object
        description: The US Census Bureau construction type code. See [Get All Record Construction Types](./api-settings.html#operation/v4.get.settings.records.constructionTypes).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      contact:
        $ref: '#/definitions/recordContactModel'
      costPerUnit:
        description: The cost for one unit associated to the record.
        format: double
        type: number
      createdBy:
        description: The unique user id of the individual that created the entry.
        type: string
      createdByCloning:
        description: Indictes whether or not the record was cloned.
        enum:
        - Y
        - N
        type: string
      customForms:
        items:
          $ref: '#/definitions/customAttributeModel'
        type: array
      customId:
        description: An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx).
          Civic Platform auto-generates and applies an alternate ID value when you submit a new application.
        type: string
      customTables:
        items:
          $ref: '#/definitions/tableModel'
        type: array
      defendantSignature:
        description: Indicates whether or not a defendant's signature has been obtained.
        type: boolean
      description:
        description: The description of the record or item.
        type: string
      enforceDepartment:
        description: The name of the department responsible for enforcement. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      enforceUser:
        description: Name of the enforcement officer.
        type: string
      enforceUserId:
        description: ID number of the enforcement officer.
        type: string
      estimatedCostPerUnit:
        description: The estimated cost per unit.
        format: double
        type: number
      estimatedDueDate:
        description: The estimated date of completion.
        format: date-time
        type: string
      estimatedProductionUnit:
        description: The estimated number of production units.
        format: double
        type: number
      estimatedTotalJobCost:
        description: The estimated cost of the job.
        format: double
        type: number
      firstIssuedDate:
        description: The first issued date for license
        format: date-time
        type: string
      housingUnits:
        description: The number of housing units.
        format: int64
        type: integer
      id:
        description: The record system id assigned by the Civic Platform server.
        type: string
      initiatedProduct:
        description: 'The product or app that created the record. If initiatedProduct is null or not specified in the request,
          the default is "AV360" (Civic Platform application).


          Added in Civic Platform version: 9.2.0'
        type: string
      inPossessionTime:
        description: The application level in possession time of the time tracking feature.
        format: double
        type: number
      infraction:
        description: Indicates whether or not an infraction occurred.
        type: boolean
      inspectorDepartment:
        description: The name of the department where the inspector works. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      inspectorId:
        description: The ID number of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
        type: string
      inspectorName:
        description: The name of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
        type: string
      jobValue:
        description: The value of the job.
        format: double
        type: number
      misdemeanor:
        description: Indicates whether or not a misdemeanor occurred.
        type: boolean
      module:
        description: The module the record belongs to. See [Get All Modules](./api-settings.html#operation/v4.get.settings.modules).
        type: string
      name:
        description: The name associated to the record.
        type: string
      numberOfBuildings:
        description: The number of buildings.
        format: int64
        type: integer
      offenseWitnessed:
        description: Indicates whether or not  there was a witness to the alleged offense.
        type: boolean
      owner:
        items:
          $ref: '#/definitions/refOwnerModel'
        type: array
      parcel:
        items:
          $ref: '#/definitions/parcelModel_1'
        type: array
      priority:
        type: object
        description: The priority level assigned to the record. See [Get All Priorities](./api-settings.html#operation/v4.get.settings.priorities).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      professional:
        items:
          $ref: '#/definitions/licenseProfessionalModel'
        type: array
      publicOwned:
        description: Indicates whether or not the record is for the public.
        type: boolean
      recordClass:
        description: General information about the record.
        type: string
      renewalInfo:
        $ref: '#/definitions/recordExpirationModel'
      reportedChannel:
        type: object
        description: The incoming channel through which the applicant submitted the application.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      reportedDate:
        description: The date the complaint was reported.
        format: date-time
        type: string
      reportedType:
        type: object
        description: The type of complaint or incident being reported.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      scheduledDate:
        description: The date when the inspection gets scheduled.
        format: date-time
        type: string
      severity:
        type: object
        description: Indicates the severity of the condition.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      shortNotes:
        description: A brief note about the record subject.
        type: string
      status:
        type: object
        description: The record status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusReason:
        type: object
        description: "\tThe reason for the status setting on the record."
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      totalJobCost:
        description: The combination of work order assignments (labor) and costs.
        format: double
        type: number
      type:
        $ref: '#/definitions/recordTypeModel'
      undistributedCost:
        description: The undistributed costs for this work order.
        format: double
        type: number
  response_simpleRecordModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/simpleRecordModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  response_simpleRecordModel:
    type: object
    properties:
      result:
        $ref: '#/definitions/simpleRecordModel'
      status:
        type: integer
        description: The HTTP return status.
  simpleRecordModel:
    type: object
    properties:
      actualProductionUnit:
        description: Estimated cost per production unit.
        format: double
        type: number
      appearanceDate:
        description: The date for a hearing appearance.
        format: date-time
        type: string
      appearanceDayOfWeek:
        description: The day for a hearing appearance.
        type: string
      assignedDate:
        description: The date the application was assigned.
        format: date-time
        type: string
      assignedToDepartment:
        description: The department responsible for the action. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      assignedUser:
        description: The staff member responsible for the action.
        type: string
      balance:
        description: The amount due.
        format: double
        type: number
      booking:
        description: Indicates whether or not there was a booking in addition to a citation.
        type: boolean
      closedByDepartment:
        description: The department responsible for closing the record. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      closedByUser:
        description: The staff member responsible for closure.
        type: string
      closedDate:
        description: The date the application was closed.
        format: date-time
        type: string
      completeDate:
        description: The date the application was completed.
        format: date-time
        type: string
      completedByDepartment:
        description: The department responsible for completion. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      completedByUser:
        description: The staff member responsible for completion.
        type: string
      constructionType:
        type: object
        description: The US Census Bureau construction type code. See [Get All Record Construction Types](./api-settings.html#operation/v4.get.settings.records.constructionTypes).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      costPerUnit:
        description: The cost for one unit associated to the record.
        format: double
        type: number
      createdBy:
        description: The unique user id of the individual that created the entry.
        type: string
      createdByCloning:
        description: Indictes whether or not the record was cloned.
        enum:
        - Y
        - N
        type: string
      customId:
        description: An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx).
          Civic Platform auto-generates and applies an alternate ID value when you submit a new application.
        type: string
      defendantSignature:
        description: Indicates whether or not a defendant's signature has been obtained.
        type: boolean
      description:
        description: The description of the record or item.
        type: string
      enforceDepartment:
        description: The name of the department responsible for enforcement. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      enforceUser:
        description: Name of the enforcement officer.
        type: string
      enforceUserId:
        description: ID number of the enforcement officer.
        type: string
      estimatedCostPerUnit:
        description: The estimated cost per unit.
        format: double
        type: number
      estimatedDueDate:
        description: The estimated date of completion.
        format: date-time
        type: string
      estimatedProductionUnit:
        description: The estimated number of production units.
        format: double
        type: number
      estimatedTotalJobCost:
        description: The estimated cost of the job.
        format: double
        type: number
      firstIssuedDate:
        description: The first issued date for license
        format: date-time
        type: string
      housingUnits:
        description: The number of housing units.
        format: int64
        type: integer
      id:
        description: The record system id assigned by the Civic Platform server.
        type: string
      inPossessionTime:
        description: The application level in possession time of the time tracking feature.
        format: double
        type: number
      infraction:
        description: Indicates whether or not an infraction occurred.
        type: boolean
      initiatedProduct:
        description: 'The Civic Platform product  where the application is submitted: "AA" : Classic Accela Automation. "ACA"
          : Accela Citizen Access. "AIVR" : Accela Integrated Voice Response. "AMO" : Accela Mobile Office. "AV360" : Accela
          Asset Management, Accela Land Management.'
        type: string
      inspectorDepartment:
        description: The name of the department where the inspector works. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      inspectorId:
        description: The ID number of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
        type: string
      inspectorName:
        description: The name of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
        type: string
      jobValue:
        description: The value of the job.
        format: double
        type: number
      misdemeanor:
        description: Indicates whether or not a misdemeanor occurred.
        type: boolean
      module:
        description: The module the record belongs to. See [Get All Modules](./api-settings.html#operation/v4.get.settings.modules).
        type: string
      name:
        description: The name associated to the record.
        type: string
      numberOfBuildings:
        description: The number of buildings.
        format: int64
        type: integer
      offenseWitnessed:
        description: Indicates whether or not  there was a witness to the alleged offense.
        type: boolean
      openedDate:
        description: The date the application was opened.
        format: date-time
        type: string
      overallApplicationTime:
        description: The amount of elapsed time from the time tracking start date to the completion of the application.
        format: double
        type: number
      priority:
        type: object
        description: The priority level assigned to the record. See [Get All Priorities](./api-settings.html#operation/v4.get.settings.priorities).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      publicOwned:
        description: Indicates whether or not the record is for the public.
        type: boolean
      recordClass:
        description: General information about the record.
        type: string
      renewalInfo:
        $ref: '#/definitions/recordExpirationModel'
      reportedChannel:
        type: object
        description: The incoming channel through which the applicant submitted the application.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      reportedDate:
        description: The date the complaint was reported.
        format: date-time
        type: string
      reportedType:
        type: object
        description: The type of complaint or incident being reported.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      scheduledDate:
        description: The date when the inspection gets scheduled.
        format: date-time
        type: string
      serviceProviderCode:
        description: The unique agency identifier,
        type: string
      severity:
        type: object
        description: Indicates the severity of the condition.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      shortNotes:
        description: A brief note about the record subject.
        type: string
      status:
        type: object
        description: The record status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusDate:
        description: "The date when the current status changed.\t"
        format: date-time
        type: string
      statusReason:
        type: object
        description: "\tThe reason for the status setting on the record."
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      totalFee:
        description: The total amount of the fees invoiced to the record.
        format: double
        type: number
      totalJobCost:
        description: The combination of work order assignments (labor) and costs.
        format: double
        type: number
      totalPay:
        description: The total amount of pay.
        format: double
        type: number
      trackingId:
        description: The application tracking number (IVR tracking number).
        format: int64
        type: integer
      type:
        $ref: '#/definitions/recordTypeModel'
      undistributedCost:
        description: The undistributed costs for this work order.
        format: double
        type: number
      value:
        description: The record value.
        type: string
  request_simpleRecordModel:
    type: object
    properties:
      actualProductionUnit:
        description: Estimated cost per production unit.
        format: double
        type: number
      appearanceDate:
        description: The date for a hearing appearance.
        format: date-time
        type: string
      appearanceDayOfWeek:
        description: The day for a hearing appearance.
        type: string
      assignedDate:
        description: The date the application was assigned.
        format: date-time
        type: string
      assignedToDepartment:
        description: The department responsible for the action. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      balance:
        description: The amount due.
        format: double
        type: number
      booking:
        description: Indicates whether or not there was a booking in addition to a citation.
        type: boolean
      closedByDepartment:
        description: The department responsible for closing the record. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      closedDate:
        description: The date the application was closed.
        format: date-time
        type: string
      completeDate:
        description: The date the application was completed.
        format: date-time
        type: string
      completedByDepartment:
        description: The department responsible for completion. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      defendantSignature:
        description: Indicates whether or not a defendant's signature has been obtained.
        type: boolean
      description:
        description: The description of the record or item.
        type: string
      enforceDepartment:
        description: The name of the department responsible for enforcement. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      estimatedProductionUnit:
        description: The estimated number of production units.
        format: double
        type: number
      estimatedTotalJobCost:
        description: The estimated cost of the job.
        format: double
        type: number
      firstIssuedDate:
        description: The first issued date for license
        format: date-time
        type: string
      infraction:
        description: Indicates whether or not an infraction occurred.
        type: boolean
      inspectorDepartment:
        description: The name of the department where the inspector works. See [Get All Departments](./api-settings.html#operation/v4.get.settings.departments).
        type: string
      inspectorId:
        description: The ID number of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
        type: string
      inspectorName:
        description: The name of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
        type: string
      jobValue:
        description: The value of the job.
        format: double
        type: number
      misdemeanor:
        description: Indicates whether or not a misdemeanor occurred.
        type: boolean
      name:
        description: The name associated to the record.
        type: string
      offenseWitnessed:
        description: Indicates whether or not  there was a witness to the alleged offense.
        type: boolean
      priority:
        type: object
        description: The priority level assigned to the record. See [Get All Priorities](./api-settings.html#operation/v4.get.settings.priorities).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      publicOwned:
        description: Indicates whether or not the record is for the public.
        type: boolean
      renewalInfo:
        $ref: '#/definitions/recordExpirationModel'
      reportedChannel:
        type: object
        description: The incoming channel through which the applicant submitted the application.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      reportedDate:
        description: The date the complaint was reported.
        format: date-time
        type: string
      reportedType:
        type: object
        description: The type of complaint or incident being reported.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      scheduledDate:
        description: The date when the inspection gets scheduled.
        format: date-time
        type: string
      severity:
        type: object
        description: Indicates the severity of the condition.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      shortNotes:
        description: A brief note about the record subject.
        type: string
      status:
        type: object
        description: The record status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusReason:
        type: object
        description: "\tThe reason for the status setting on the record."
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      totalFee:
        description: The total amount of the fees invoiced to the record.
        format: double
        type: number
      totalPay:
        description: The total amount of pay.
        format: double
        type: number
  response_resultModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/resultModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  response_resultModel:
    type: object
    properties:
      result:
        $ref: '#/definitions/resultModel'
      status:
        type: integer
        description: The HTTP return status.
  resultModel:
    type: object
    properties:
      code:
        description: The error code, if an error is encountered.
        type: string
      id:
        description: The system id of the object in this operation.
        format: int64
        type: integer
      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_recordInspectionTypeModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/recordInspectionTypeModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  recordInspectionTypeModel:
    type: object
    properties:
      inspectionTypes:
        items:
          $ref: '#/definitions/inspectionTypeModel'
        type: array
      recordId:
        description: The unique ID associated with a record.
        type: string
  response_recordRelatedModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/recordRelatedModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  recordRelatedModel:
    type: object
    properties:
      customId:
        description: An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx).
          Accela Automation auto-generates and applies an alternate ID value when you submit a new application.
        type: string
      id:
        description: The record system id assigned by the Civic Platform server.
        type: string
      relationship:
        description: The type of relationship of a related record.
        enum:
        - parent
        - child
        - renewal
        type: string
      serviceProveCode:
        description: The unique agency id.
        type: string
      trackingId:
        description: The application tracking number (IVR tracking number).
        format: int64
        type: integer
      type:
        $ref: '#/definitions/recordTypeNoAliasModel'
  response_refOwnerModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/refOwnerModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  response_refOwnerModel:
    type: object
    properties:
      result:
        $ref: '#/definitions/refOwnerModel'
      status:
        type: integer
        description: The HTTP return status.
  refOwnerModel:
    type: object
    properties:
      email:
        description: The contact's email address.
        type: string
      fax:
        description: The fax number for the contact.
        type: string
      firstName:
        description: The contact's first name. This field is only active when the Contact Type selected is Individual.
        type: string
      fullName:
        description: The contact's full name. This field is only active when the Contact Type selected is Individual.
        type: string
      id:
        description: The owner system id assigned by the Civic Platform server.
        format: int64
        type: integer
      isPrimary:
        description: Indicates whether or not to designate the owner as the primary owner.
        type: string
      lastName:
        description: The last name (surname).
        type: string
      mailAddress:
        $ref: '#/definitions/ownerAddressModel'
      middleName:
        description: The contact's middle name.
        type: string
      parcelId:
        description: The unique Id generated for a parcel.
        type: string
      phone:
        description: The telephone number of the owner.
        type: string
      phoneCountryCode:
        description: The country code for the assoicated phone number.
        type: string
      recordId:
        $ref: '#/definitions/recordIdModel'
      refOwnerId:
        description: The reference owner id.
        format: double
        type: number
      status:
        type: object
        description: The owner status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      taxId:
        description: The owner's tax ID number.
        type: string
      title:
        description: The individual's business title.
        type: string
      type:
        description: The owner type.
        type: string
  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_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
  response_taskItemModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/taskItemModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  response_taskItemModel:
    type: object
    properties:
      result:
        $ref: '#/definitions/taskItemModel'
      status:
        type: integer
        description: The HTTP return status.
  taskItemModel:
    type: object
    properties:
      actionbyDepartment:
        type: object
        description: The department responsible for the action.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      actionbyUser:
        type: object
        description: The individual responsible for the action.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      approval:
        description: Used to indicate supervisory approval of an adhoc task.
        type: string
      assignEmailDisplay:
        description: 'Indicates whether or not to display the agency employee’s email address in ACA. Public users can then
          click the e-mail hyperlink and send an e-mail to the agency employee. “Y†: display the email address. “Nâ€
          : hide the email address.'
        type: string
      assignedDate:
        description: The date of the assigned action.
        format: date-time
        type: string
      assignedToDepartment:
        type: object
        description: The department responsible for the action.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      assignedUser:
        type: object
        description: The staff member responsible for the action.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      billable:
        description: Indicates whether or not the item is billable.
        enum:
        - Y
        - N
        type: string
      comment:
        description: Comments or notes about the current context.
        type: string
      commentDisplay:
        description: "Indicates whether or not Accela Citizen Access users can view the inspection results comments.\t"
        type: string
      commentPublicVisible:
        description: Specifies the type of user who can view the inspection result comments. <br/>"All ACA Users" - Both registered
          and anonymous Accela Citizen Access users can view the comments for inspection results. <br/>"Record Creator Only"
          - the user who created the record can see the comments for the inspection results. <br/>"Record Creator and Licensed
          Professional" - The user who created the record and the licensed professional associated with the record can see
          the comments for the inspection results.
        items:
          type: string
        type: array
      currentTaskId:
        description: The ID of the current workflow task.
        type: string
      daysDue:
        description: The amount of time to complete a task (measured in days).
        format: int64
        type: integer
      description:
        description: The description of the record or item.
        type: string
      dispositionNote:
        description: A note describing the disposition of the current task.
        type: string
      dueDate:
        description: The desired completion date of the task.
        format: date-time
        type: string
      endTime:
        description: The time the workflow task was completed.
        format: date-time
        type: string
      estimatedDueDate:
        description: The estimated date of completion.
        format: date-time
        type: string
      estimatedHours:
        description: The estimated hours necessary to complete this task.
        format: double
        type: number
      hoursSpent:
        description: Number of hours used for a workflow or workflow task.
        format: double
        type: number
      id:
        description: The workflow task system id assigned by the Civic Platform server.
        type: string
      inPossessionTime:
        description: The application level in possession time of the time tracking feature.
        format: double
        type: number
      isActive:
        description: Indicates whether or not the workflow task is active.
        enum:
        - Y
        - N
        type: string
      isCompleted:
        description: Indicates whether or not the workflow task is completed.
        enum:
        - Y
        - N
        type: string
      lastModifiedDate:
        description: The date when the task item was last changed.
        format: date-time
        type: string
      lastModifiedDateString:
        description: A string represents the date when the task item was last changed.
        type: string
      nextTaskId:
        description: The id of the next task in a workflow.
        type: string
      overTime:
        description: A labor cost factor that indicates time worked beyond a worker's regular working hours.
        type: string
      processCode:
        description: The process code for the next task in a workflow.
        type: string
      recordId:
        $ref: '#/definitions/recordIdModel'
      serviceProviderCode:
        description: The unique agency identifier.
        type: string
      startTime:
        description: The time the workflow task started.
        format: date-time
        type: string
      status:
        type: object
        description: The workflow task status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusDate:
        description: The date when the current status changed.
        format: date-time
        type: string
      trackStartDate:
        description: The date that time tracking is set to begin.
        format: date-time
        type: string
  response_taskItemActionModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/taskItemActionModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  taskItemActionModel:
    type: object
    properties:
      action:
        description: Audit trail action type like "payment allocation"
        type: string
      actionbyDepartment:
        type: object
        description: The department responsible for the action.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      actionbyUser:
        type: object
        description: The individual responsible for the action.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      approval:
        description: Used to indicate supervisory approval of an adhoc task.
        type: string
      assignEmailDisplay:
        description: 'Indicates whether or not to display the agency employee’s email address in ACA. Public users can then
          click the e-mail hyperlink and send an e-mail to the agency employee. “Y†: display the email address. “Nâ€
          : hide the email address.'
        type: string
      assignedDate:
        description: The date of the assigned action.
        format: date-time
        type: string
      assignedToDepartment:
        type: object
        description: The department responsible for the action.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      assignedUser:
        type: object
        description: The staff member responsible for the action.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      billable:
        description: Indicates whether or not the item is billable.
        enum:
        - Y
        - N
        type: string
      comment:
        description: Comments or notes about the current context.
        type: string
      commentDisplay:
        description: "Indicates whether or not Accela Citizen Access users can view the inspection results comments.\t"
        type: string
      commentPublicVisible:
        description: Specifies the type of user who can view the inspection result comments. <br/>"All ACA Users" - Both registered
          and anonymous Accela Citizen Access users can view the comments for inspection results. <br/>"Record Creator Only"
          - the user who created the record can see the comments for the inspection results. <br/>"Record Creator and Licensed
          Professional" - The user who created the record and the licensed professional associated with the record can see
          the comments for the inspection results.
        items:
          type: string
        type: array
      currentTaskId:
        description: The ID of the current workflow task.
        type: string
      daysDue:
        description: The amount of time to complete a task (measured in days).
        format: int64
        type: integer
      description:
        description: The description of the record or item.
        type: string
      dispositionNote:
        description: A note describing the disposition of the current task.
        type: string
      dueDate:
        description: The desired completion date of the task.
        format: date-time
        type: string
      endTime:
        description: The time the workflow task was completed.
        format: date-time
        type: string
      estimatedDueDate:
        description: The estimated date of completion.
        format: date-time
        type: string
      estimatedHours:
        description: The estimated hours necessary to complete this task.
        format: double
        type: number
      hoursSpent:
        description: Number of hours used for a workflow or workflow task.
        format: double
        type: number
      id:
        description: The workflow task system id assigned by the Civic Platform server.
        type: string
      inPossessionTime:
        description: The application level in possession time of the time tracking feature.
        format: double
        type: number
      isActive:
        description: Indicates whether or not the workflow task is active.
        enum:
        - Y
        - N
        type: string
      isCompleted:
        description: Indicates whether or not the workflow task is completed.
        enum:
        - Y
        - N
        type: string
      lastModifiedDate:
        description: The date when the task item was last changed.
        format: date-time
        type: string
      lastModifiedDateString:
        description: A string represents the date when the task item was last changed.
        type: string
      nextTaskId:
        description: The id of the next task in a workflow.
        type: string
      overTime:
        description: A labor cost factor that indicates time worked beyond a worker's regular working hours.
        type: string
      processCode:
        description: The process code for the next task in a workflow.
        type: string
      recordId:
        $ref: '#/definitions/recordIdModel'
      serviceProviderCode:
        description: The unique agency identifier.
        type: string
      startTime:
        description: The time the workflow task started.
        format: date-time
        type: string
      status:
        type: object
        description: The workflow task status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusDate:
        description: The date when the current status changed.
        format: date-time
        type: string
      trackStartDate:
        description: The date that time tracking is set to begin.
        format: date-time
        type: string
  request_taskItemModel:
    type: object
    properties:
      actionbyDepartment:
        type: object
        description: The department responsible for the action.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      actionbyUser:
        type: object
        description: The individual responsible for the action.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      approval:
        description: Used to indicate supervisory approval of an adhoc task.
        type: string
      assignEmailDisplay:
        description: 'Indicates whether or not to display the agency employee’s email address in ACA. Public users can then
          click the e-mail hyperlink and send an e-mail to the agency employee. “Y†: display the email address. “Nâ€
          : hide the email address.'
        type: string
      billable:
        description: Indicates whether or not the item is billable.
        enum:
        - Y
        - N
        type: string
      comment:
        description: Comments or notes about the current context.
        type: string
      commentDisplay:
        description: "Indicates whether or not Accela Citizen Access users can view the inspection results comments.\t"
        type: string
      commentPublicVisible:
        description: Specifies the type of user who can view the inspection result comments. <br/>"All ACA Users" - Both registered
          and anonymous Accela Citizen Access users can view the comments for inspection results. <br/>"Record Creator Only"
          - the user who created the record can see the comments for the inspection results. <br/>"Record Creator and Licensed
          Professional" - The user who created the record and the licensed professional associated with the record can see
          the comments for the inspection results.
        items:
          type: string
        type: array
      dueDate:
        description: The desired completion date of the task.
        format: date-time
        type: string
      endTime:
        description: The time the workflow task was completed.
        format: date-time
        type: string
      hoursSpent:
        description: Number of hours used for a workflow or workflow task.
        format: double
        type: number
      overTime:
        description: A labor cost factor that indicates time worked beyond a worker's regular working hours.
        type: string
      startTime:
        description: The time the workflow task started.
        format: date-time
        type: string
      status:
        type: object
        description: The workflow task status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusDate:
        description: The date when the current status changed.
        format: date-time
        type: string
  response_trustAccountModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/trustAccountModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  trustAccountModel:
    type: object
    properties:
      account:
        description: The account ID number for the trust account.
        type: string
      associations:
        type: object
        description: The trust account associations.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      balance:
        description: The balance of the trust account in dollars.
        format: double
        type: number
      description:
        description: The description of the trust account.
        type: string
      id:
        description: The trust account system id assigned by the Civic Platform server.
        format: int64
        type: integer
      isPrimary:
        description: Indicates whether or not to designate the trust account as the primary source.
        type: string
        enum:
        - Y
        - N
      ledgerAccount:
        description: The ledger account of the trust account.
        type: string
      overdraft:
        type: object
        description: Indicates whether or not the trust account can use the overdraft option.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      overdraftLimit:
        description: The overdraft limit amount, in dollars, for the trust account.
        format: double
        type: number
      recordId:
        $ref: '#/definitions/recordIdModel'
      serviceProviderCode:
        description: The unique agency identifier.
        type: string
      status:
        type: object
        description: The status of the trust account.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
        enum:
        - Active
        - Closed
      thresholdAmount:
        description: The minimum amount required in a trust account.
        format: double
        type: number
  userRolePrivilegeModel:
    type: object
    properties:
      contactAllowed:
        description: Indicates whether or not the permission is given to a contact.
        type: boolean
      deleteAllowed:
        description: "Indicates whether or not the permission to delete a document is allowed.\t"
        type: boolean
      downloadAllowed:
        description: Indicates whether or not the permission to download a document is allowed.
        type: boolean
      licenseTypeRules:
        items:
          type: string
          description: "A string array containing the types of licensed professionals who are given the permission.\t"
        type: array
      licensendProfessionalAllowed:
        description: Indicates whether or not the permission is given to a licensed professional.
        type: boolean
      ownerAllowed:
        description: Indicates whether or not the permission is given to an owner.
        type: boolean
      recordCreatorAllowed:
        description: Indicates whether or not the permission is given to a record creator.
        type: boolean
      registeredUserAllowed:
        description: Indicates whether or not the permission is given to a registered public user.
        type: boolean
      titleViewAllowed:
        description: Indicates whether or not the permission to view a document name is allowed.
        type: boolean
      uploadAllowed:
        description: Indicates whether or not the permission to upload a document is allowed.
        type: boolean
  voteRequest:
    type: object
    properties:
      vote:
        description: The vote on a record (agenda item in a hearing, for example). A value of true is a "yea" vote and a value
          of false indicates a "nay" vote.
        type: boolean
    required:
    - vote
  response_voteResult:
    type: object
    properties:
      result:
        $ref: '#/definitions/voteResult'
      status:
        type: integer
        description: The HTTP return status.
  voteResult:
    type: object
    properties:
      vote:
        description: The result of a vote on a record (agenda item in a hearing, for example). A value of true is a "yea"
          vote and a value of false indicates a "nay" vote.
        type: boolean
  response_voteSummary:
    type: object
    properties:
      result:
        $ref: '#/definitions/voteSummary'
      status:
        type: integer
        description: The HTTP return status.
  voteSummary:
    type: object
    properties:
      downCount:
        description: The number of votes that disapprove the specified record.
        type: integer
      upCount:
        description: The number of votes that approve the specified record.
        type: integer
  response_workflowTaskCommentModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/workflowTaskCommentModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  workflowTaskCommentModel:
    type: object
    properties:
      action:
        description: Audit trail action type like 'payment allocation'
        type: string
      createdBy:
        description: The unique user id of the individual that created the entry.
        type: string
      createdDate:
        description: The date the entry was created.
        format: date-time
        type: string
      recordId:
        $ref: '#/definitions/recordIdModel'
      text:
        description: The comment text.
        type: string
      workflowTaskId:
        description: The id of the workflow task.
        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
  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
  recordId:
    description: The ID of the record to fetch. See [Get All Records](./api-records.html#operation/v4.get.records), [Search
      Records](./api-search.html#operation/v4.post.search.records), or [Get My Records](./api-records.html#operation/v4.get.records.mine).
    in: path
    name: recordId
    required: true
    type: string
  contactId:
    description: The ID of the contact to fetch. See [Get All Contacts](./api-contacts-professionals.html#operation/v4.get.contacts).
    format: int64
    in: path
    name: contactId
    required: true
    type: integer
x-api-evangelist-provenance:
  generated: '2026-09-06'
  method: searched
  source: https://developer.accela.com/api/v4/v4-records.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.