basePath: /
schemes:
- http
host: apis.accela.com
info:
  description: "Accela API for searching Civic Platform objects \n\nThe Search API provides apps with a global search feature\
    \ to locate records and objects in the system database. In the global search, you specify search criteria and you view\
    \ the records that meet the criteria in a global scope.You can further organize the search results by applying filters\
    \ to the results set.\n\nAnother important use for searches is to ensure valid reference data are used with transaction\
    \ data. For example, searching for valid address, parcel, and owner objects ensures that data integrity and business rules\
    \ are enforced when creating records. \n\n Construct search API's use the HTTP POST method to allow an extensive set of\
    \ search parameters in the request body. \n\n **Using Wildcards** \n\n A wildcard is a special character (%) you can use\
    \ in your search criteria to represent one or more characters in a string of characters. When used, it can represent an\
    \ undefined value. Where you place the wildcard character determines which part of the name or phrase you are not searching\
    \ for. \n\n Note: The Accela API does not support the use of wildcards for all fields. \n\n **Example Use Case** \n\n\
    \ You are searching for an owner with the last name equal or similar to Johnson. You enter %son as the search criterion.\
    \ The search result includes all names it finds ending in \"son\", including Johnson and Thompson. If you enter john%,\
    \ the search results includes all names beginning with \"John\", including Johnson, Johnston, and Johns. If you enter\
    \ %john% and click search, the results include all names with \"john\" anywhere within the whole name, including Johnson,\
    \ or St. Johns. \n\n **Advanced Search** \n\n If you perform advanced search with multiple fields, the search follows\
    \ the following general rules:<br/> * If you base a search on two or more detail search fields, the system uses AND to\
    \ locate that contain all the search criteria. For example, if you pick two fields within the record detail search fields,\
    \ the search applies this rule. <br/> * If you base a search on fields across different categories, such as between record\
    \ search fields and Address, Parcel, Owner (APO) template search fields, Accela Construct uses the AND rule to perform\
    \ the search. For example, if you pick one record detail search fields and one search field from the APO template, the\
    \ search applies this rule. <br/> * If you base a search on two or more Task Spec Info, App Spec Info, or APO template\
    \ search fields, Accela Construct uses AND to locate records that contain only one of the search criteria. For example,\
    \ if you pick two fields within the APO template, the search applies to this rule. <br/> * If you base a search on two\
    \ fields from the record detail search and the APO template, Accela Construct uses AND and OR to perform the search."
  title: Search
  version: v4
swagger: '2.0'
paths:
  /v4/search/addresses:
    post:
      description: "Finds the addresses that match the search criteria. Specify at least one search criteria.\n\n\n\n**API\
        \ Endpoint**:  POST /v4/search/addresses \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: Search Addresses
      operationId: v4.post.search.addresses
      parameters:
      - description: Reference address search query.
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/addressSearchModel'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/limit'
      - $ref: '#/parameters/fields'
      - $ref: '#/parameters/lang'
      - description: Parameter for getting expanded record information.
        enum:
        - parcels, owners
        in: query
        name: expand
        required: false
        type: string
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria. A
            successful request may also return messages related to Event Manager Scripting Engine back-end processing.'
          schema:
            $ref: '#/definitions/response_addressModelArray'
        '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/search/agencies:
    post:
      description: "Finds the agencies that match the search criteria.\n\n\n\n**API Endpoint**:  POST /v4/search/agencies\
        \ \n\n**Scope**:  agencies \n\n**App Type**:  All \n\n**Authorization Type**:  No authorization required \n\n**Civic\
        \ Platform version**: All\n\n"
      summary: Search Agencies
      operationId: v4.post.search.agencies
      parameters:
      - description: Agency search query.
        in: body
        name: wsRequest
        required: true
        schema:
          $ref: '#/definitions/geoSearchAgencies'
      - $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_agencyModelArray'
        '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/search/assets:
    post:
      summary: Search Assets
      description: "Search assets by geolocation and asset query parameters. \n\n\n\n**API Endpoint**:  POST /v4/search/assets\
        \ \n\n**Scope**:  assets \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 9.2.0\n\n"
      operationId: v4.post.search.assets
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: body
        name: query
        description: Asset query parameters
        required: true
        schema:
          $ref: '#/definitions/request_searchAssets'
      - name: limit
        in: query
        description: The maximum number of items in the result set.
        required: false
        type: integer
        format: int64
      - name: offset
        in: query
        description: The first record of the result set starts at the specified offset position.
        required: false
        type: integer
        format: int64
      - name: fields
        in: query
        type: string
        description: Comma-delimited names of fields to be returned in the response. Field names are case-sensitive and only
          first-level fields are supported. Invalid field names are ignored.
      - name: lang
        in: query
        type: string
        description: Language parameter to support I18N. Default language is en_US.
      responses:
        '200':
          description: 'Successful request. Note: A successful request may return no data matching the filter criteria.'
          schema:
            $ref: '#/definitions/response_searchAssets'
        '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/search/global:
    get:
      description: "Finds records that meet the search criteria across the agency.\n\n\n\n**API Endpoint**:  GET /v4/search/global\
        \ \n\n**Scope**:  global_search \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: \t7.3.2\n\n"
      summary: Search All
      operationId: v4.get.search.global
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: Global search query.
        in: query
        name: query
        required: false
        type: string
      - description: Allowed entity type. The system only currently supports Record, Address, Parcel and License Professional
          for citizen user.
        enum:
        - RECORD
        - ADDRESS
        - LICENSEPROFESSIONAL
        - ASSET
        - CONTACT
        - PARCEL
        - DOCUMENT
        in: query
        name: type
        required: false
        type: string
      - description: Comma-separated modules to query.
        in: query
        name: modules
        required: false
        type: string
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/limit'
      - description: The result set is sorted by the specified field name. Specify the sort order in the "direction" parameter.
          The default sort order is the ascending order.
        in: query
        name: sort
        required: false
        type: string
      - description: Sort direction. Default is ASC.
        enum:
        - ASC
        - ' DESC'
        in: query
        name: direction
        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_globalSearchArray'
        '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/search/assessments:
    post:
      description: "Searches condition assessments.\n\n\n\n**API Endpoint**:  POST /v4/search/assessments \n\n**Scope**: \
        \ assessments \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 9.0.0\n\n"
      summary: Search Assessments
      operationId: v4.post.search.assessments
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: Assessment condition search query.
        in: body
        name: body
        schema:
          $ref: '#/definitions/assetConditionAssessmentModel'
      - $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_assetConditionAssessmentModelArray'
        '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/search/contacts:
    post:
      description: "Finds the contacts that match the search criteria. Similar to Civic Platform, the Soundex search functionality\
        \ is available on the street name and common contact fields, such as the following request fields: firstName, middleName,\
        \ lastName, organizationName, tradeName, businessName, streetName.\n\n\n\n**API Endpoint**:  POST /v4/search/contacts\
        \ \n\n**Scope**:  contacts \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform version**:\
        \ 7.3.2\n\n"
      summary: Search Contacts
      operationId: v4.post.search.contacts
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: Contact search query.
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/peopleSearchModel'
      - $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_peopleModelArray'
        '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/search/costs:
    post:
      description: "Finds the costs that match the search criteria. Specify at least one search criteria.\n\n\n\n**API Endpoint**:\
        \  POST /v4/search/costs \n\n**Scope**:  \tsearch_costs \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access\
        \ token \n\n**Civic Platform version**: 7.3.3.2\n\n"
      summary: Search Costs
      operationId: v4.post.search.costs
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: "Cost search query. Ex. '\r\n{\r\n \"id\": \"70183\"}'"
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/costItemModel'
      - $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_costItemModelArray'
        '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/search/inspections:
    post:
      description: "Finds the inspections that match the search criteria.\n\n\n\n**API Endpoint**:  POST /v4/search/inspections\
        \ \n\n**Scope**:  inspections \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: \t7.3.2\n\n"
      summary: Search Inspections
      operationId: v4.post.search.inspections
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: "Inspection search query. Ex. '\r\n{\r\n \"id\": \"83471\"}'"
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/inspectionSearchModel'
      - description: Parameter for getting expanded record information.
        enum:
        - record
        in: query
        name: expand
        required: false
        type: string
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/limit'
      - description: Has total
        enum:
        - 'true'
        - ' false'
        in: query
        name: hasTotal
        required: false
        type: boolean
      - $ref: '#/parameters/fields'
      - $ref: '#/parameters/lang'
      - description: Inspection Team name. It's not required if use department.
        in: query
        name: teamName
        required: false
        type: string
      - description: Inspection Floor.
        in: query
        name: floor
        required: false
        type: string
      - description: Inspection Floor Unit.
        in: query
        name: floorUnit
        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_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/search/owners:
    post:
      description: "Finds the owners that match the search criteria. Specify at least one search criteria.\n\n\n\n**API Endpoint**:\
        \  POST /v4/search/owners \n\n**Scope**:  owners \n\n**App Type**:  All \n\n**Authorization Type**:  Access token\
        \ \n\n**Civic Platform version**: 7.3.2\n\n"
      summary: Search Owners
      operationId: v4.post.search.owners
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: "Owner search query. Ex. '\r\n{\r\n \"id\": \"83471\"}'"
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/ownerSearchModel'
      - $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_ownerModelArray'
        '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/search/parcels:
    post:
      description: "Finds the parcels that match the search criteria. Specify at least one search criteria.\n\n\n\n**API Endpoint**:\
        \  POST /v4/search/parcels \n\n**Scope**:  parcels \n\n**App Type**:  All \n\n**Authorization Type**:  Access token\
        \ \n\n**Civic Platform version**: 7.3.2\n\n"
      summary: Search Parcels
      operationId: v4.post.search.parcels
      parameters:
      - description: Parcel search query.
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/parcelSearchModel'
      - $ref: '#/parameters/offset'
      - $ref: '#/parameters/limit'
      - description: "Parameter for getting related objects with the record \n\ncustomForms option is introduced in Civic\
          \ Platform version 9.3.0"
        enum:
        - owners
        - addresses
        - customForms
        in: query
        name: expand
        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_parcelModelArray'
        '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/search/parts:
    post:
      description: "Finds the parts that match the search criteria. Specify at least one search criteria.\n\n\n\n**API Endpoint**:\
        \  POST /v4/search/parts \n\n**Scope**:  parts \n\n**App Type**:  Agency \n\n**Authorization Type**:  Access token\
        \ \n\n**Civic Platform version**: 7.3.3.2\n\n"
      summary: Search Parts
      operationId: v4.post.search.parts
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: "Part search query. Ex. '\r\n{\r\n \"id\": \"70183\"}'"
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/partInventoryModel'
      - $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_partInventoryModelArray'
        '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/search/professionals:
    post:
      description: "Finds the professionals that match the search criteria.\n\n\n\n**API Endpoint**:  POST /v4/search/professionals\
        \ \n\n**Scope**:  professionals \n\n**App Type**:  All \n\n**Authorization Type**:  Access token \n\n**Civic Platform\
        \ version**: 7.3.2\n\n"
      summary: Search Professionals
      operationId: v4.post.search.professionals
      parameters:
      - $ref: '#/parameters/authHeaderParam'
      - description: "Professional Information. Ex. '\r\n{\r\n \"serviceProviderCode\": \"ABC\",\r\n \"licenseType\": \"ARCHITECT\"\
          }'"
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/licenseSearchModel'
      - $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_searchProfessional'
        '400':
          description: Invalid request.
          schema:
            type: object
            properties:
              status:
                type: integer
                description: The HTTP return status.
              code:
                type: string
              message:
                type: string
              traceId:
                type: integer
        '401':
          description: Authorization failed.
        '403':
          description: Forbidden request.
        '404':
          description: Requested resource not found.
        '500':
          description: Internal server error or bad connection.
  /v4/search/records:
    post:
      summary: Search Records
      description: "Finds the records that match the search criteria.\n\n\n\n**API Endpoint**:  POST /v4/search/records \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"
      operationId: v4.post.search.records
      parameters:
      - description: Construct oAuth2 authentication token
        in: header
        name: Authorization
        required: true
        type: string
      - description: "Contains the record search criteria. For example: '\r\n{\r\n \"id\": \"12BCM-00000-01540\"}'"
        in: body
        name: body
        schema:
          $ref: '#/definitions/recordSearchModel'
      - 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
        type: integer
      - description: Search result size limit.
        format: int64
        in: query
        name: limit
        type: integer
      - description: Comma-delimited list of related objects to be returned with the record. The related object(s) will be
          returned only if data exists; if data does not exist, the requested object(s) will not be included in the response.
        enum:
        - addresses
        - parcels
        - professionals
        - contacts
        - owners
        - customForms
        - customTables
        in: query
        name: expand
        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
      - description: The API allow consumer to specify return field with resource. The values are case-sensitive fields name
          of JSON object and be split by comma.
        in: query
        name: fields
        type: string
      - description: Language parameter to support I18N. Default language is en_US
        in: query
        name: lang
        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_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.
definitions:
  aGISGeometryModel:
    type: object
    properties:
      coordinate:
        type: string
      type:
        type: string
  aGISGeometrySearchModel:
    type: object
    properties:
      distance:
        format: double
        type: number
      geometries:
        $ref: '#/definitions/aGISGeometryModel'
      scope:
        type: string
      serviceId:
        type: string
      unit:
        type: string
  inspectionSearchAddressModel:
    type: object
    properties:
      city:
        type: string
        description: The name of the city.
      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
      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
      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.
      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
      streetEnd:
        format: int64
        type: integer
        description: The ending number of a street address range.
      streetEndFrom:
        description: The start of the street end range.
        format: int64
        type: integer
      streetEndTo:
        description: The last of the street end range.
        format: int64
        type: integer
      streetName:
        type: string
        description: The name of the street.
      streetStart:
        format: int64
        type: integer
        description: The starting number of a street address range.
      streetStartFrom:
        description: The first of the street start range.
        format: int64
        type: integer
      streetStartTo:
        description: The last of the street start range.
        format: int64
        type: integer
      streetSuffix:
        type: object
        description: The type of street such as "Lane" or "Boulevard".
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      streetSuffixDirection:
        type: object
        description: The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW"
          is the street suffix direction.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      unitStart:
        type: string
        description: The starting value of a range of unit numbers.
      unitEnd:
        type: string
        description: The ending value of a range of unit numbers.
      unitType:
        type: object
        description: The unit type designation of the address.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      xCoordinate:
        type: number
        format: double
        description: The longitudinal coordinate for this address.
      yCoordinate:
        type: number
        format: double
        description: The latitudinal coordinate for this address.
  inspectionAddressModel:
    type: object
    properties:
      addressLine1:
        type: string
        description: The first line of the address.
      addressLine2:
        type: string
        description: The first line of the address.
      addressTypeFlag:
        type: object
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
        description: A code name or an abbreviation of the address type.
      city:
        type: string
        description: The name of the city.
      country:
        type: object
        description: The name of the country. See [Get All Address Countries](./api-settings.html#operation/v4.get.settings.addresses.countries).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      county:
        type: string
        description: The name of the county.
      description:
        type: string
        description: A description of the address.
      direction:
        description: The street direction of the primary address associated with the application.
        type: object
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      distance:
        type: number
        format: double
        description: The distance from another landmark used to locate the address.
      houseAlphaStart:
        type: string
        description: The beginning alphabetic unit in street address.
      houseAlphaEnd:
        type: string
        description: The ending alphabetic unit in street address.
      houseFractionStart:
        type: object
        description: Beginning fraction value used in combination with the Street number fields.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      houseFractionEnd:
        type: object
        description: Ending franction value used in combination with the Street number fields.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      id:
        format: int64
        type: integer
        description: The unique address id assigned by the Civic Platform server.
      inspectionDistrict:
        type: string
        description: The inspection district where the address is located.
      inspectionDistrictPrefix:
        type: string
        description: The prefix for the inspection district where the address is located.
      isPrimary:
        type: string
        description: Indicates whether or not to designate the address as the primary address. Only one address can be primary
          at any given time.
      levelStart:
        type: string
        description: The starting level number (floor number) that makes up the address within a complex.
      levelEnd:
        type: string
        description: The ending level number (floor number) that makes up the address within a complex.
      levelPrefix:
        type: string
        description: The prefix for the level numbers (floor numbers) that make up the address.
      neighborhood:
        type: string
        description: The neighborhood where the address is located.
      neighborhoodPrefix:
        type: string
        description: The prefix for neighborhood where the address is located.
      postalCode:
        type: string
        description: The postal ZIP code for the address.
      recordId:
        $ref: '#/definitions/recordIdModel'
      refAddressId:
        description: The reference address id.
        format: int64
        type: integer
      secondaryStreet:
        type: string
        description: This field (along with the Secondary Road Number field) displays an extra description for the location
          when two roads that cross or a street with two names makes up the address of the location.
      secondaryStreetNumber:
        type: number
        format: long
        description: This field (along with the Secondary Road field) displays an extra description for the location when
          two roads that cross or a street with two names makes up the address of the location.
      serviceProviderCode:
        description: The unique agency identifier.
        type: string
      state:
        type: object
        description: The name of the state.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      status:
        type: object
        description: The address status indicating whether the address is active or inactive.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      streetAddress:
        type: string
        description: The street address.
      streetEnd:
        type: number
        format: long
        description: The ending number of a street address range.
      streetEndFrom:
        description: The beginning number of a street end address range.
        format: int64
        type: integer
      streetEndTo:
        description: The ending number of a street end address range.
        format: int64
        type: integer
      streetName:
        type: string
        description: The name of the street.
      streetPrefix:
        type: string
        description: Any part of an address that appears before a street name or number. For example, if the address is 123
          West Main, "West" is the street prefix.
      streetStart:
        type: number
        format: long
        description: The starting number of a street address range.
      streetStartFrom:
        description: The beginning number of a street start address range.
        format: int64
        type: integer
      streetStartTo:
        description: The ending number of a street start address range.
        format: int64
        type: integer
      streetSuffix:
        type: object
        description: The type of street such as "Lane" or "Boulevard".
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      streetSuffixDirection:
        type: object
        description: The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW"
          is the street suffix direction.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      unitStart:
        type: string
        description: The starting value of a range of unit numbers.
      unitEnd:
        type: string
        description: The ending value of a range of unit numbers.
      unitType:
        type: object
        description: The unit type designation of the address.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      xCoordinate:
        type: number
        format: double
        description: The longitudinal coordinate for this address.
      yCoordinate:
        type: number
        format: double
        description: The latitudinal coordinate for this address.
  response_agencyModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/agencyModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  agencyModel:
    type: object
    properties:
      displayName:
        description: The display name of the agency.
        type: string
      enabled:
        description: Indicates whether or not the agency is enabled.
        type: boolean
      hostedACA:
        description: Indicates whether or not the agency is hosted on Accela Citizen Access which allows the public to view
          documents. If true, Public users can view documents.
        type: boolean
      iconName:
        description: The icon filename.
        type: string
      isForDemo:
        description: Indicates whether or not the agency is used for demo purposes only.
        type: boolean
      name:
        description: The name of the agency.
        type: string
      serviceProviderCode:
        description: The unique agency identifier, the system assigns, on the Accela Civic Platform.
        type: string
      state:
        description: The two-character code for the state that the agency belongs to, as configured on Construct [Construct
          Admin Portal](https://admin.accela.com) > Agencies > {Agency} > Agency Info.
        type: string
      country:
        description: The two-character code for the country that the agency belongs to, as configured on [Construct Admin
          Portal](https://admin.accela.com) > Agencies > {Agency} > Agency Info.
        type: string
  request_searchAssets:
    type: object
    properties:
      gisObjects:
        items:
          $ref: '#/definitions/gisObjectModel'
        type: array
  response_searchAssets:
    type: object
    properties:
      result:
        type: array
        items:
          $ref: '#/definitions/masterAssetModel'
      page:
        $ref: '#/definitions/page'
      status:
        type: integer
        description: The HTTP return status.
  response_assetConditionAssessmentModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/assetConditionAssessmentModel'
        type: array
      page:
        $ref: '#/definitions/pageModel'
      status:
        type: integer
        description: The HTTP return status.
  assetConditionAssessmentModel:
    type: object
    properties:
      asset:
        $ref: '#/definitions/assetModel'
      assetCAID:
        description: The asset condition assessment ID.
        format: int64
        type: integer
      assignedToDepartment:
        description: The department responsible for the assessment.
        type: string
      attributes:
        $ref: '#/definitions/customAttributeModel'
      comments:
        description: The name of the inspector performing the assessment.
        type: string
      inspectorFullName:
        description: "\tThe unique identifier of the inspector."
        type: string
      inspectorId:
        description: The inspector id.
        type: string
      scheduledDate:
        description: The scheduled assessment date, in yyyy-mm-dd format.
        format: date-time
        type: string
      scheduledTime:
        description: The scheduled assessment time, in hh:mm AM/PM format.
        type: string
      status:
        description: The assessment status.
        type: string
      timeSpent:
        description: The number of hours spent on the assessment.
        format: double
        type: number
      type:
        description: The type of assessment.
        type: string
  assetModel:
    type: object
    properties:
      description:
        description: The asset description.
        type: string
      group:
        description: The group the asset belongs to.
        type: string
      id:
        description: The asset system id assigned by the Civic Platform server.
        type: string
      status:
        type: object
        description: "\tThe asset status."
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      type:
        description: The asset type.
        type: string
  masterAssetModel:
    type: object
    properties:
      assetId:
        type: string
        description: The unique alpha-numeric asset ID in an asset group.
      attributes:
        $ref: '#/definitions/customAttributeModel'
      attributeTables:
        items:
          $ref: '#/definitions/tableModel'
        type: array
      classType:
        type: string
        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.
      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:
        format: double
        type: number
        description: The current value of the asset.
      dateOfService:
        format: date-time
        type: string
        description: The date the asset was initially placed into service.
      dependentFlag:
        type: string
        description: Indicates whether or not the parent asset is dependent on this asset.
      depreciationAmount:
        format: double
        type: number
        description: The decline in the asset value by the asset depreciation calculation.
      depreciationEndDate:
        format: date-time
        type: string
        description: The end date for the asset depreciation calculation. This field is used in the asset depreciation calculation.
      depreciationStartDate:
        format: date-time
        type: string
        description: The start date for the asset depreciation calculation. This field is used in the asset depreciation calculation.
      depreciationValue:
        format: double
        type: number
        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.
      description:
        type: object
        description: The asset description.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      endID:
        type: string
        description: The ending point asset ID.
      gisObjects:
        items:
          $ref: '#/definitions/gisObjectModel'
        type: array
        description: Contains GIS information about the location of the asset.
      id:
        format: int64
        type: integer
        description: The unique, sequence id assigned by the Civic Platform server. Use the id to identify the object on the
          URI in subsequent object-specific API requests.
      name:
        type: object
        description: The asset name.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      number:
        type: string
        description: The unique, alpha-numeric asset ID.
      salvageValue:
        format: double
        type: number
        description: The residual value of the asset at the end of its useful life.
      serviceProviderCode:
        type: string
        description: The unique agency identifier.
      size:
        format: double
        type: number
        description: A positive numeric value for the asset size.
      sizeUnit:
        type: string
        description: The unit of measure corresponding to the asset size.
      startID:
        type: string
        description: The starting point asset ID.
      startValue:
        format: double
        type: number
        description: The beginning value or purchase price of the asset.
      status:
        type: object
        description: The asset status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusDate:
        format: date-time
        type: string
        description: The date the asset status changed.
      type:
        type: object
        description: The asset type.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      usefulLife:
        type: string
        description: The number of years the asset is expected to be used. This field is used in the asset depreciation calculation
  tableModel:
    type: object
    properties:
      id:
        type: string
      rows:
        items:
          $ref: '#/definitions/rowModel'
        type: array
  rowModel:
    type: object
    properties:
      fields:
        $ref: '#/definitions/customAttributeModel'
      id:
        type: string
  recordAssetModel:
    type: object
    properties:
      classType:
        type: string
        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.
      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:
        format: double
        type: number
        description: The current value of the asset.
      dateOfService:
        format: date-time
        type: string
        description: The date the asset was initially placed into service.
      dependentFlag:
        type: string
        description: Indicates whether or not the parent asset is dependent on this asset.
      depreciationAmount:
        format: double
        type: number
        description: The decline in the asset value by the asset depreciation calculation.
      depreciationEndDate:
        format: date-time
        type: string
        description: The end date for the asset depreciation calculation. This field is used in the asset depreciation calculation.
      depreciationStartDate:
        format: date-time
        type: string
        description: The start date for the asset depreciation calculation. This field is used in the asset depreciation calculation.
      depreciationValue:
        format: double
        type: number
        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.
      description:
        type: object
        description: The asset description.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      endID:
        type: string
        description: The ending point asset ID.
      gisObjects:
        items:
          $ref: '#/definitions/gisObjectModel'
        type: array
        description: Contains GIS information about the location of the asset.
      id:
        format: int64
        type: integer
        description: The unique, sequence id assigned by the Civic Platform server. Use the id to identify the object on the
          URI in subsequent object-specific API requests.
      name:
        type: object
        description: The asset name.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      number:
        type: string
        description: The unique, alpha-numeric asset ID.
      salvageValue:
        format: double
        type: number
        description: The residual value of the asset at the end of its useful life.
      size:
        format: double
        type: number
        description: A positive numeric value for the asset size.
      sizeUnit:
        type: string
        description: The unit of measure corresponding to the asset size.
      startID:
        type: string
        description: The starting point asset ID.
      startValue:
        format: double
        type: number
        description: The beginning value or purchase price of the asset.
      status:
        type: object
        description: The asset status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusDate:
        format: date-time
        type: string
        description: The date the asset status changed.
      type:
        type: object
        description: The asset type.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  requestRecordIdModel:
    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
      idOrCustomId:
        description: The record system id assigned by the Civic Platform server. Or a custom id, 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
      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
  recordIdModel:
    type: object
    properties:
      customId:
        description: An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx).
          Accela Automation auto-generates and applies an alternate ID value when you submit a new application.
        type: string
      id:
        description: The record system id assigned by the Civic Platform server.
        type: string
      serviceProviderCode:
        description: The unique agency identifier.
        type: string
      trackingId:
        description: The application tracking number (IVR tracking number).
        format: int64
        type: integer
      value:
        description: The alphanumeric record id.
        type: string
  recordTypeModel_2:
    type: object
    properties:
      category:
        description: The 4th level in a 4-level record type structure (Group-Type-Subtype-Category).
        type: string
      filterName:
        description: The name of the record type filter which defines the record types to be displayed for the citizen user.
        type: string
      group:
        description: The 1st level in a 4-level record type structure (Group-Type-Subtype-Category).
        type: string
      id:
        description: The record type system id assigned by the Civic Platform server.
        type: string
      module:
        description: Use to filter by the module. See [Get All Modules](./api-settings.html#operation/v4.get.settings.modules).
        type: string
      subType:
        description: The 3rd level in a 4-level record type structure (Group-Type-Subtype-Category).
        type: string
      text:
        description: The record type display text
        type: string
      type:
        description: The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category).
        type: string
      value:
        description: The record type value.
        type: string
  recordTypeModel:
    type: object
    properties:
      alias:
        type: string
      category:
        type: string
      filterName:
        type: string
      group:
        type: string
      id:
        type: string
      module:
        type: string
      subType:
        type: string
      text:
        type: string
      type:
        type: string
      value:
        type: string
  ownerSearchAddressModel:
    type: object
    properties:
      addressLine1:
        description: The first line of the address.
        type: string
      city:
        description: The name of the city.
        type: string
      country:
        type: object
        description: ''
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      postalCode:
        description: The postal ZIP code for the address.
        type: string
      state:
        type: object
        description: ''
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  ownerAddressModel:
    type: object
    properties:
      addressLine1:
        description: The first line of the address.
        type: string
      addressLine2:
        description: The second line of the address.
        type: string
      addressLine3:
        description: The third line of the address.
        type: string
      city:
        description: The name of the city.
        type: string
      country:
        type: object
        description: ''
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      postalCode:
        description: The postal ZIP code for the address.
        type: string
      state:
        type: object
        description: ''
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  response_costItemModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/costItemModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  costItemModel:
    type: object
    properties:
      defaultAccount:
        type: object
        description: The default account associated with the cost.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      defaultFactor:
        type: object
        description: The default cost factor.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      description:
        description: The description of the cost item.
        type: string
      fixedRate:
        description: The fixed cost amount for the cost item.
        format: double
        type: number
      name:
        type: object
        description: The cost item name.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            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
      subgroup:
        description: The subgroup the cost item belongs to.
        type: string
      type:
        type: object
        description: 'The cost type, such as: contract, employee, materials. See [Get All Cost Types](./api-settings.html#operation/v4.get.settings.costs.types).'
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      unitOfMeasure:
        type: object
        description: The unit of measurement for quantifying the cost item.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      unitRate:
        description: The unit rate for the cost item.
        format: double
        type: number
  customAttributeModel:
    description: Contains one or more "customFieldName":"customFieldValue" pairs.
    type: object
    properties:
      aCustomFieldName:
        description: The name of a custom field.
        type: string
      aCustomFieldValue:
        description: The value of a custom field.
        type: string
  gisObjectModel:
    type: object
    properties:
      gisId:
        type: string
        description: The GIS object id.
      layerId:
        type: string
        description: The GIS map layer id.
      serviceId:
        type: string
        description: The GIS map service id.
  geoSearchAgencies:
    type: object
    properties:
      latitude:
        description: The angular distance of a place north or south of the earth's equator, usually expressed in degrees and
          minutes.
        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.
        type: number
      state:
        description: Filters the agencies by state. For US and Canada, specify the two-character state portion of the ISO-3661-2
          code. For example, "CA" for California and "AB" for Alberta. See [https://en.wikipedia.org/wiki/ISO_3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US)
          or [https://en.wikipedia.org/wiki/ISO_3166-2:CA](https://en.wikipedia.org/wiki/ISO_3166-2:CA) for a list of valid
          codes. For other countries, specify the state name, as configured on [Construct Admin Portal](https://admin.accela.com)
          > Agencies > {Agency} > Agency Info.
        type: string
      country:
        description: Filters the agencies by country, as configured on [Construct Admin Portal](https://admin.accela.com)
          > Agencies > {Agency} > Agency Info. Specify the standard ISO-3661-2 country code. See [https://en.wikipedia.org/wiki/ISO_3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)
          for a list of valid codes.
        type: string
  identifierModel:
    type: object
    properties:
      text:
        type: string
      value:
        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/inspectionAddressModel'
      billable:
        description: This defines whether or not the item is billable.
        enum:
        - Y
        - N
        type: string
      category:
        description: The inspection category, which is used to organize inspection types. An inspection type is assigned to
          one or more inspection categories.
        type: string
      commentDisplay:
        description: Indicates whether or not Accela Citizen Access users can view the inspection results comments.
        type: string
      commentPublicVisible:
        description: "Specifies the type of user who can view the inspection result comments. \"All ACA Users\" - Both registered\
          \ and anonymous Accela Citizen Access users can view the comments for inspection results. \"Record Creator Only\"\
          \ - the user who created the record can see the comments for the inspection results. \"Record Creator and Licensed\
          \ Professional\" - The user who created the record and the licensed professional associated with the record can\
          \ see the comments for the inspection results.\t"
        items:
          type: string
        type: array
      completedAMPM:
        description: Indicates whether completed time is "AM" or "PM".
        type: string
      completedDate:
        description: The date of completion.
        format: date-time
        type: string
      completedTime:
        description: The time of completion.
        type: string
      contact:
        $ref: '#/definitions/inspectionContactModel'
      contactFirstName:
        description: The contact's first name. This field is only active when the Contact Type selected is Individual.
        type: string
      contactLastName:
        description: The last name of the contact.
        type: string
      contactMiddleName:
        description: The middle name of the contact.
        type: string
      desiredAMPM:
        description: Indicates whether the desired inspection time is AM or PM.
        type: string
      desiredDate:
        description: The desired inspection date.
        format: date-time
        type: string
      desiredTime:
        description: The desired inspection time.
        type: string
      endMileage:
        description: The ending mileage for the inspection.
        format: float
        type: number
      endTime:
        description: The time the inspection was completed.
        format: date-time
        type: string
      estimatedEndTime:
        description: inspection estimated end time.
        type: string
      estimatedStartTime:
        description: The scheduled start time for the inspection.
        type: string
      gisAreaName:
        description: The GIS Object ID of the parent application if the application that the inspection is scheduled for has
          a parent application that is a project application.
        type: string
      grade:
        description: The name of the inspection grade.
        type: string
      id:
        description: The inspection system id assigned by the Civic Platform server.
        format: int64
        type: integer
      inspectorFullName:
        description: The name of the inspector performing the assessment.
        type: string
      inspectorId:
        description: The ID number of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
        type: string
      isAutoAssign:
        description: This defines whether or not you want to automatically reschedule the inspection when the previous inspection
          status attains Approved status.
        type: string
      latitude:
        description: The angular distance of a place north or south of the earth's equator, usually expressed in degrees and
          minutes.
        format: float
        type: number
      longitude:
        description: The angular distance of a place east or west of the meridian at Greenwich, England, usually expressed
          in degrees and minutes.
        format: float
        type: number
      majorViolation:
        description: The number of major violations.
        format: int64
        type: integer
      overtime:
        description: A labor cost factor that indicates time worked beyond a worker's regular working hours.
        type: string
      priority:
        description: The priority level assigned to the inspection.
        format: double
        type: number
      publicVisible:
        description: This defines whether or not Accela Citizen Access users can view comment about the inspection results.
        type: string
      record:
        $ref: '#/definitions/recordSimpleModel'
      recordId:
        $ref: '#/definitions/recordIdModel'
      recordType:
        $ref: '#/definitions/recordTypeModel_2'
      requestAMPM:
        description: The time segment, AM or PM, for the time specified in the requestTime field.
        type: string
      requestComment:
        description: Comments about the new inspection. For example, you may identify who requested the inspection.
        type: string
      requestDate:
        description: The date when an inspection request is submitted.
        format: date-time
        type: string
      requestTime:
        description: This time is automatically generated when a new inspection is scheduled and submitted.
        type: string
      requestorFirstName:
        description: The first name of the person requesting an inspection-related operation.
        type: string
      requestorLastName:
        description: The last name of the person requesting an inspection-related operation.
        type: string
      requestorMiddleName:
        description: The middle name of the person requesting an inspection-related operation.
        type: string
      requestorPhone:
        description: The telephone number for the person who processes the inspection request or schedules the inspection.
        type: string
      requestorPhoneIDD:
        description: The telephone number for the person who processes the inspection request or schedules the inspection.
        type: string
      requestorUserId:
        description: The user Id of the person requesting an inspection-related operation.
        type: string
      requiredInspection:
        description: This defines whether the inspection is optional or required.
        type: string
      resultComment:
        description: The inspection result comments.
        type: string
      resultType:
        description: 'The type of result that can be ascibed to an inspection. There are three result types: Approved: Approves
          (passes) the checklist item. Denied: Denies (fails) the checklist item. Informational: Indicates that the checklist
          items do not need a status of app'
        type: string
      scheduleDate:
        description: The date when the inspection gets scheduled.
        format: date-time
        type: string
      scheduleEndAMPM:
        description: Indicates whether the scheduleEndTime is in the AM or PM.
        enum:
        - AM
        - PM
        type: string
      scheduleEndTime:
        description: The scheduled end time for the inspection.
        type: string
      scheduleStartAMPM:
        description: AM indicates the 12 hour period from midnight to noon. PM indicates the 12 hour period from noon to midnight.
        enum:
        - AM
        - PM
        type: string
      scheduleStartTime:
        description: The scheduled start time for the inspection.
        type: string
      serviceProviderCode:
        description: The unique agency identifier.
        type: string
      startMileage:
        description: The starting mileage for the inspection.
        format: float
        type: number
      startTime:
        description: The time when you started the inspection.
        format: date-time
        type: string
      status:
        type: object
        description: The inspection status. See [Get All Inspection Statuses](./api-settings.html#operation/v4.get.settings.inspections.statuses).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      submitAMPM:
        description: The time block for the scheduled inspection.
        type: string
      submitDate:
        description: The date that the inspection was submitted.
        format: date-time
        type: string
      submitTime:
        description: The time that a new inspection is submitted. Civic Platform generates this value.
        type: string
      totalMileage:
        description: The total mileage for the inspection.
        format: float
        type: number
      totalScore:
        description: The overall score of the inspection that includes the inspection result, inspection grade, checklist
          total score and checklist major violation option.
        format: int64
        type: integer
      totalTime:
        description: The total amount of time used to do an inspection.
        format: double
        type: number
      type:
        $ref: '#/definitions/inspectionTypeModel'
      unitNumber:
        description: The number of time units (see timeUnitDuration) comprising an inspection.
        type: string
      units:
        description: The amount of time comprising the smallest time unit for conducting an inspection.
        format: double
        type: number
      vehicleId:
        description: A number, such as the license plate number or VIN, that identifies the vehicle used to complete an inspection.
        type: string
  inspectionSearchModel:
    type: object
    properties:
      teamName:
        description: Inspection Team name. It's not required if use department.
        type: string
      floor:
        description: Inspection Floor.
        type: string
      floorUnit:
        description: Inspection Floor Unit.
        type: string
      address:
        $ref: '#/definitions/inspectionSearchAddressModel'
      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
      completedDateFrom:
        description: The start of the completion date range.
        format: date-time
        type: string
      completedDateTo:
        description: The end of the completion date range.
        format: date-time
        type: string
      contact:
        $ref: '#/definitions/inspectionSearchContactModel'
      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
      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
      inspectorId:
        description: The ID number of the inspector. See [Get All Inspectors](./api-inspections.html#operation/v4.get.inspectors).
        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
      overtime:
        description: A labor cost factor that indicates time worked beyond a worker's regular working hours.
        type: string
      parcel:
        $ref: '#/definitions/inspectionParcelModel'
      publicVisible:
        description: Indicates whether or not Accela Citizen Access users can view comment about the inspection results.
        enum:
        - Y
        - N
        type: string
      recordId:
        $ref: '#/definitions/requestRecordIdModel'
      recordTypes:
        items:
          $ref: '#/definitions/recordTypeModel_2'
        type: array
      requestDateFrom:
        description: The date from which to start search for requested inspections.
        format: date-time
        type: string
      requestDateTo:
        description: The date up to which to start search for requested inspections.
        format: date-time
        type: string
      scheduleDateFrom:
        description: The date from which to start search for scheduled inspections.
        format: date-time
        type: string
      scheduleDateTo:
        description: The date up to which to start search for scheduled inspections.
        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
      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
      submitDateFrom:
        description: The date from which to start search for submitted inspections.
        format: date-time
        type: string
      submitDateTo:
        description: The date up to which to start search for submitted inspections.
        format: date-time
        type: string
      totalMileage:
        description: The total mileage for the inspection.
        format: float
        type: number
      totalTime:
        description: The total amount of time used to do an inspection.
        format: double
        type: number
      types:
        description: Contains inspection types and their type properties. See [Get All Inspection Types](./api-settings.html#operation/v4.get.settings.inspections.types).
        items:
          $ref: '#/definitions/inspectionTypeModel'
        type: array
      unitNumber:
        description: The number of time units (see timeUnitDuration) comprising an inspection.
        type: string
      vehicleId:
        description: A number, such as the license plate number or VIN, that identifies the vehicle used to complete an inspection.
        type: string
  inspectionTypeModel:
    type: object
    properties:
      group:
        description: The name of a group of inspection types.
        type: string
      id:
        description: The inspection type system id assigned by the Civic Platform server.
        format: int64
        type: integer
      text:
        description: The inspection type display text.
        type: string
      value:
        description: The inspection type value.
        type: string
  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
  ownerSearchModel:
    type: object
    properties:
      address:
        $ref: '#/definitions/ownerSearchAddressModel'
      addressObject:
        $ref: '#/definitions/ownerSearchAddressModel'
      email:
        description: The contact's email address.
        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
      lastName:
        description: The contact's last name.
        type: string
      mailAddress:
        $ref: '#/definitions/ownerSearchAddressModel'
      mailAddressObject:
        $ref: '#/definitions/ownerSearchAddressModel'
      parcelId:
        description: The unique Id generated for a parcel.
        type: string
      status:
        type: object
        description: The owner status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  response_ownerModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/ownerModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  ownerModel:
    type: object
    properties:
      address:
        $ref: '#/definitions/ownerAddressModel'
      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'
      status:
        type: object
        description: The owner status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      structureName:
        description: The name of the full or partial structure or establishment.
        type: string
      structureType:
        description: The type of structure or establishment
        type: string
      taxId:
        description: The owner's tax ID number.
        type: string
      title:
        description: The individual's business title.
        type: string
  inspectionParcelModel:
    type: object
    properties:
      block:
        description: The block number associated with the parcel.
        type: string
      lot:
        description: The lot name.
        type: string
      parcelNumber:
        description: The alpha-numeric parcel number.
        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
      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
      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
      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
  response_parcelModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/parcelModelWithCustomForms'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  parcelModel:
    type: object
    properties:
      addresses:
        items:
          $ref: '#/definitions/addressModel'
        type: array
      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/ownerModel'
        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
      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
  parcelModelWithCustomForms:
    type: object
    properties:
      addresses:
        items:
          $ref: '#/definitions/addressModel'
        type: array
      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
      customForms:
        items:
          $ref: '#/definitions/customAttributeModel'
        type: array
      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/ownerModel'
        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
      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
  parcelSearchModel:
    type: object
    properties:
      addresses:
        items:
          $ref: '#/definitions/addressModel'
        type: array
      block:
        description: The block number associated with the parcel.
        type: string
      gisObjects:
        items:
          $ref: '#/definitions/gisObjectModel'
        type: array
      isPrimary:
        description: Indicates whether or not to designate the parcel as the primary parcel.
        type: string
      legalDescription:
        description: The legal description of the parcel.
        type: string
      lot:
        description: The lot name.
        type: string
      owners:
        $ref: '#/definitions/ownerSearchModel'
      parcelNumber:
        description: The alpha-numeric parcel number.
        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
      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
      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
  response_partInventoryModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/partInventoryModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  partInventoryModel:
    type: object
    properties:
      brand:
        type: object
        description: The brand name of the asset.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      budgetAccount:
        type: object
        description: The budget account name associated with the asset.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      budgetNumber:
        description: The budget account number associated with the asset.
        type: string
      calculateType:
        type: object
        description: 'Specifies the type used to calculate the average cost of the part: "Simple" : The average cost is equal
          to the sum of the unit cost of a current shipment and existing average cost, divided by two. This provides the average
          value of the existing average cost and the cost per unit of the current shipment. "Weighted" : This is the same
          as the Simple Average, but weighted by quantity. This means that the existing part quantity is multiplied by the
          existing average cost and then the quantity of the current shipment is multiplied by the unit cost of the shipment.
          Then the sum of these values is divided by the total part quantity.'
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      comments:
        description: Comments or notes about the part.
        type: string
      description:
        type: object
        description: The description of the part.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      hardReserve:
        description: The quantity set aside as hard-reserved.
        format: double
        type: number
      id:
        description: The part system id assigned by the Civic Platform server.
        format: int64
        type: integer
      maximumQuantity:
        description: The maximum quantity of asset parts.
        format: double
        type: number
      minimumQuantity:
        description: The minimum quantity of asset parts.
        format: double
        type: number
      partNumber:
        description: The number of the part.
        type: string
      partStatus:
        type: object
        description: The status of the part.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      reorderDue:
        description: The status of reorder displays “Yes” if the total supply is greater than the minimum quantity. The reorder
          due displays “No” if the total supply is less than the minimum quantity.
        type: string
      reorderQuantity:
        description: The quantity to reorder.
        format: double
        type: number
      reservedQuantity:
        description: The quantity reserved.
        format: double
        type: number
      status:
        type: object
        description: The part inventory 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
      totalSupply:
        description: The total quantity on hand for the part.
        format: double
        type: number
      trackCostByLocation:
        description: Indicates whether or not to track the cost of a part based on its stock location.
        enum:
        - Y
        - N
        type: string
      type:
        type: object
        description: The part type, such Fittings, Fleet, Materials. See [Get Part Types](./api-settings.html#operation/v4.get.settings.parts.types).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      unitCost:
        description: The unit cost per part.
        format: double
        type: number
      unitOfMeasure:
        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
  inspectionSearchContactModel:
    type: object
    properties:
      busName2:
        description: A secondary business name for the applicable individual.
        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
      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
      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
      suffix:
        description: The contact name suffix.
        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
  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
  response_peopleModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/peopleModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  peopleModel:
    type: object
    properties:
      additionalAddresses:
        items:
          $ref: '#/definitions/contactAddressModel'
        type: array
      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
      birthDateFrom:
        description: The start of a birth date range to search.
        format: date-time
        type: string
      birthDateTo:
        description: The end of a birth date range to search.
        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
      contactAddress:
        $ref: '#/definitions/contactAddressModel'
      deceasedDateFrom:
        description: The start of a deceased date range to search.
        format: date-time
        type: string
      deceasedDateTo:
        description: The end of a deceased date range to search.
        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
      openCloseMatch:
        description: Indicates whether or not to use close matches as hits in a search for contacts.
        type: string
      openSoundexSearch:
        description: 'Indicates whether or not Soundex search is enabled for any of the following requested parameters: firstName,
          middleName, lastName, organizationName, tradeName, businessName, streetName'
        type: string
        enum:
        - Y
        - N
      orderBy:
        description: 'The fields by which the search results are ordered. For each field, specify the sort order: asc for
          ascending or desc for descending order. Use commas to separate multiple sort fields. The values are not case-sensitive.
          For example: "orderBy":"lastName desc,email asc"'
        enum:
        - LastName
        - LastName ASC
        - LastName DESC
        - FirstName
        - FirstName ASC
        - FirstName DESC
        - birthDate
        - birthDate ASC
        - birthDate DESC
        - AddressCity
        - AddressCity ASC
        - AddressCity DESC
        - AddressState
        - AddressState ASC
        - AddressState DESC
        - AddressZIP
        - AddressZIP ASC
        - AddressZIP DESC
        - AddressCountry
        - AddressCountry ASC
        - AddressCountry DESC
        - email
        - email ASC
        - email DESC
        - PHONE1
        - PHONE1 ASC
        - PHONE1 DESC
        - PHONE2
        - PHONE2 ASC
        - PHONE2 DESC
        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
  recordSearchModel:
    type: object
    properties:
      actualProductionUnit:
        description: Estimated cost per production unit.
        format: double
        type: number
      address:
        $ref: '#/definitions/addressModel'
      appearanceDate:
        description: The date for a hearing appearance.
        format: date-time
        type: string
      appearanceDayOfWeek:
        description: The day for a hearing appearance.
        type: string
      asInspector:
        description: Indicates whether or not the currently logged in user is an inspector who is associated to the record.
        enum:
        - Y
        - N
        type: string
      asLP:
        description: Indicates whether or not the currently logged in user is a licensed professional who is associated to
          the record.
        enum:
        - Y
        - N
        type: string
      asset:
        $ref: '#/definitions/recordAssetModel'
      assetAttribute:
        $ref: '#/definitions/templateAttributeModel'
      assignedDateFrom:
        description: The start of a date range for the assigned action.
        format: date-time
        type: string
      assignedDateTo:
        description: The end of a date range for the assigned action.
        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
      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
      closedDateFrom:
        description: The start of the closure date range.
        format: date-time
        type: string
      closedDateTo:
        description: The end of the closure date range.
        format: date-time
        type: string
      completeDateFrom:
        description: The start of the completion date range.
        format: date-time
        type: string
      completeDateTo:
        description: The end of the completion date range.
        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
      completedDate:
        description: The date of completion.
        format: date-time
        type: string
      condition:
        $ref: '#/definitions/recordConditionRequestModel'
      conditionOfApproval:
        $ref: '#/definitions/recordConditionRequestModel'
      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
      currentWorkflowStatus:
        description: The status of the current workflow. See [Get All Statuses for Workflow Task](./api-records.html#operation/v4.get.records.recordId.workflowTasks.id.statuses).
        type: string
      currentWorkflowTask:
        description: The name of the current workflow task associated with the record.
        type: string
      customForm:
        $ref: '#/definitions/customAttributeModel'
      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
      customTable:
        $ref: '#/definitions/customAttributeModel'
      description:
        description: The description of the record or item.
        type: string
      direction:
        description: Specifies whether to sort in ascending or descending order. Default is ASC.
        enum:
        - ASC
        - DESC
        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
      expirationDate:
        description: The date when the condition expires.
        format: date-time
        type: string
      expirationDateFrom:
        description: The start of the expiration date range.
        format: date-time
        type: string
      expirationDateTo:
        description: The end of the expiration date range.
        format: date-time
        type: string
      firstIssuedDate:
        description: The first issued date for license
        format: date-time
        type: string
      geometry:
        $ref: '#/definitions/aGISGeometrySearchModel'
      gisObjects:
        items:
          $ref: '#/definitions/gisObjectModel'
        type: array
      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
      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
      module:
        description: Use to filter by the module. See [Get All Modules](./api-settings.html#operation/v4.get.settings.modules).
        type: string
      modules:
        description: Use to filter by the multiple modules. See [Get All Modules](./api-settings.html#operation/v4.get.settings.modules).
        items:
          type: string
        type: array
      name:
        description: The name associated to the record.
        type: string
      numberOfBuildings:
        description: The number of buildings.
        format: int64
        type: integer
      openedDateFrom:
        description: The start of date range when application is opened.
        format: date-time
        type: string
      openedDateTo:
        description: The end of date range when application is 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:
        $ref: '#/definitions/ownerModel'
      parcel:
        $ref: '#/definitions/parcelModel'
      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:
        $ref: '#/definitions/licenseProfessionalModel'
      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
      reportedDateFrom:
        description: The start date of a date range in a search for complaints.
        format: date-time
        type: string
      reportedDateTo:
        description: The end date of a date range in a search for complaints.
        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
      sort:
        description: The result set is sorted by the specified field name. Specify the sort order in the "direction" parameter.
          The default sort order is the ascending order.
        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
      statusDateFrom:
        description: The beginning date of status date range.
        format: date-time
        type: string
      statusDateTo:
        description: The ending date of status date range.
        format: date-time
        type: string
      statusReason:
        type: object
        description: The reason for the status setting on the record.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      statusTypes:
        description: An array of record status types as filter criteria.
        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
      trackingId:
        description: The application tracking number (IVR tracking number).
        format: int64
        type: integer
      type:
        $ref: '#/definitions/recordTypeModel'
      types:
        description: The record type. If this type field is within the record type definition, it specifies the 2nd level
          in a 4-level record type structure (Group-Type-Subtype-Category). See [Get All Record Types](./api-settings.html#operation/v4.get.settings.records.types).
        items:
          $ref: '#/definitions/recordTypeModel'
        type: array
      undistributedCost:
        description: The undistributed costs for this work order.
        format: double
        type: number
      updateDate:
        description: The last update date.
        format: date-time
        type: string
      updateDateFrom:
        description: The start date of an update date range filter.
        format: date-time
        type: string
      updateDateTo:
        description: The end date of an update date range filter.
        format: date-time
        type: string
      value:
        description: The record value.
        type: string
  response_recordModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/recordModel'
        type: array
      status:
        type: integer
        description: The return status
  recordModel:
    type: object
    properties:
      actualProductionUnit:
        description: Estimated cost per production unit.
        format: double
        type: number
      address:
        $ref: '#/definitions/addressCustomFormsModel'
      appearanceDate:
        description: The date for a hearing appearance.
        format: date-time
        type: string
      appearanceDayOfWeek:
        description: The day for a hearing appearance.
        type: string
      asset:
        $ref: '#/definitions/recordAssetModel'
      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
      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
      customTable:
        $ref: '#/definitions/customAttributeModel'
      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:
        $ref: '#/definitions/ownerModel'
      parcel:
        $ref: '#/definitions/parcelModel'
      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:
        $ref: '#/definitions/licenseProfessionalModel'
      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: The 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
  recordConditionRequestModel:
    type: object
    properties:
      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
      group:
        type: object
        description: the condition group. 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
      name:
        description: The full name for the application contact.
        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
      status:
        type: object
        description: The record condition status. See [Get All Standard Condition Statuses](./api-settings.html#operation/v4.get.settings.conditions.statuses),
          [Get All Approval Condition Statuses](./api-settings.html#operation/v4.get.settings.conditionApprovals.statuses).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      type:
        type: object
        description: The condition type. See [Get All Condition Types](./api-settings.html#operation/v4.get.settings.conditions.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
      customForms:
        description: Contains record custom fields.
        items:
          $ref: '#/definitions/apo_customForm'
        type: array
      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
  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
  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. 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
      postalCode:
        description: The postal ZIP code for the address.
        type: string
      state:
        type: object
        description: The state corresponding to the address on record.See [Get All Address States](./api-settings.html#operation/v4.get.settings.addresses.states).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  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: The name of a custom field. 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: The value of a custom field.
  recordSimpleModel:
    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 public owns the item.
        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: The 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
  activityModel:
    type: object
    properties:
      attributeValue:
        description: The value of an activity attribute.
        type: string
      description:
        description: The activity description.
        type: string
      name:
        description: The name of the activity.
        type: string
      type:
        description: The type of activity.
        type: string
  addressSearchModel:
    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.
      auditDate:
        description: The creation or last modified date.
        format: date-time
        type: string
      auditId:
        description: The audit id.
        type: string
      auditStatus:
        type: string
        description: The audit status of the address.
      city:
        type: string
        description: The name of the city.
      country:
        type: object
        description: The name of the country. See [Get All Address Countries](./api-settings.html#operation/v4.get.settings.addresses.countries).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      county:
        type: string
        description: The name of the county.
      description:
        type: string
        description: A description of the address.
      direction:
        description: The street direction of the primary address associated with the application.
        type: object
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      distance:
        type: number
        format: double
        description: The distance from another landmark used to locate the address.
      houseAlphaStart:
        type: string
        description: The beginning alphabetic unit in street address.
      houseAlphaEnd:
        type: string
        description: The ending alphabetic unit in street address.
      houseFractionStart:
        type: object
        description: Beginning fraction value used in combination with the Street number fields.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      houseFractionEnd:
        type: object
        description: Ending franction value used in combination with the Street number fields.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      id:
        format: int64
        type: integer
        description: The unique address id assigned by the Civic Platform server.
      inspectionDistrict:
        type: string
        description: The inspection district where the address is located.
      inspectionDistrictPrefix:
        type: string
        description: The prefix for the inspection district where the address is located.
      isPrimary:
        type: string
        description: Indicates whether or not to designate the address as the primary address. Only one address can be primary
          at any given time.
      levelStart:
        type: string
        description: The starting level number (floor number) that makes up the address within a complex.
      levelEnd:
        type: string
        description: The ending level number (floor number) that makes up the address within a complex.
      levelPrefix:
        type: string
        description: The prefix for the level numbers (floor numbers) that make up the address.
      neighborhood:
        type: string
        description: The neighborhood where the address is located.
      neighborhoodPrefix:
        type: string
        description: The prefix for neighborhood where the address is located.
      postalCode:
        type: string
        description: The postal ZIP code for the address.
      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.
      sourceFlag:
        type: string
        description: The Accela permitting system that stores this address information, such as Civic Platform, Kiva, or Tidemark.
      sourceNumber:
        type: number
        format: long
        description: A number that identifies the Accela permitting system that stores this address information.
      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:
        format: int64
        type: integer
        description: The ending number of a street address range.
      streetEndFrom:
        description: The start of the street end range.
        format: int64
        type: integer
      streetEndTo:
        description: The last of the street end range.
        format: int64
        type: integer
      streetName:
        type: string
        description: The name of the street.
      streetPrefix:
        type: string
        description: Any part of an address that appears before a street name or number. For example, if the address is 123
          West Main, "West" is the street prefix.
      streetStart:
        format: int64
        type: integer
        description: The starting number of a street address range.
      streetStartFrom:
        description: The first of the street start range.
        format: int64
        type: integer
      streetStartTo:
        description: The last of the street start range.
        format: int64
        type: integer
      streetSuffix:
        type: object
        description: The type of street such as "Lane" or "Boulevard".
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      streetSuffixDirection:
        type: object
        description: The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW"
          is the street suffix direction.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      unitStart:
        type: string
        description: The starting value of a range of unit numbers.
      unitEnd:
        type: string
        description: The ending value of a range of unit numbers.
      unitType:
        type: object
        description: The unit type designation of the address.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      xCoordinate:
        type: number
        format: double
        description: The longitudinal coordinate for this address.
      yCoordinate:
        type: number
        format: double
        description: The latitudinal coordinate for this address.
  contactAddressModel:
    type: object
    properties:
      addressLine1:
        type: string
        description: The first line of the address.
      addressLine2:
        type: string
        description: The first line of the address.
      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
      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
      effectiveDate:
        description: ''
        format: date-time
        type: string
      expirationDate:
        description: ''
        format: date-time
        type: string
      fax:
        description: ''
        type: string
      faxCountryCode:
        description: ''
        type: string
      houseAlphaStart:
        type: string
        description: The beginning alphabetic unit in street address.
      houseAlphaEnd:
        type: string
        description: The ending alphabetic unit in street address.
      id:
        format: int64
        type: integer
        description: The unique address id assigned by the Civic Platform server.
      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.
      phone:
        description: ''
        type: string
      phoneCountryCode:
        description: ''
        type: string
      postalCode:
        type: string
        description: The postal ZIP code for the address.
      recipient:
        description: ''
        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.
      streetName:
        type: string
        description: The name of the street.
      streetPrefix:
        type: string
        description: Any part of an address that appears before a street name or number. For example, if the address is 123
          West Main, "West" is the street prefix.
      streetStart:
        type: number
        format: long
        description: The starting number of a street address range.
      streetSuffix:
        type: object
        description: The type of street such as "Lane" or "Boulevard".
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      streetSuffixDirection:
        type: object
        description: The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW"
          is the street suffix direction.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      unitStart:
        type: string
        description: The starting value of a range of unit numbers.
      unitEnd:
        type: string
        description: The ending value of a range of unit numbers.
      unitType:
        type: object
        description: The unit type designation of the address.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
  response_addressModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/addressModel'
        type: array
      page:
        $ref: '#/definitions/pageModel'
      status:
        type: integer
        description: The HTTP return status.
  addressModel:
    type: object
    properties:
      streetStart:
        type: number
        format: long
        description: The starting number of a street address range.
      sourceNumber:
        type: number
        format: long
        description: A number that identifies the Accela permitting system that stores this address information.
      id:
        format: int64
        type: integer
        description: The unique address id assigned by the Civic Platform server.
      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.
      xCoordinate:
        type: number
        format: double
        description: The longitudinal coordinate for this address.
      yCoordinate:
        type: number
        format: double
        description: The latitudinal coordinate for this address.
      streetAddress:
        type: string
        description: The street address.
      auditStatus:
        type: string
        description: The audit status of the address.
      postalCode:
        type: string
        description: The postal ZIP code for the address.
      city:
        type: string
        description: The name of the city.
      parcels:
        type: array
        items:
          $ref: '#/definitions/parcelsModel'
      streetName:
        type: string
        description: The name of the street.
      syncIndex:
        type: boolean
      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
      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
      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.
      inspectionDistrict:
        type: string
        description: The inspection district where the address is located.
      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
  addressCustomFormsModel:
    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.
      auditStatus:
        type: string
        description: The audit status of the address.
      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

          '
      customForms:
        items:
          $ref: '#/definitions/apo_customForm'
        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
      houseNumberEndFrom:
        type: number
        description: The first of the ending house number range.
        format: long
      houseNumberEndTo:
        type: number
        description: The last of the ending house number range.
        format: long
      houseNumberStartFrom:
        type: number
        description: The first of the start house number range.
        format: long
      houseNumberStartTo:
        type: number
        description: The last of the start house number range.
        format: long
      id:
        format: int64
        type: integer
        description: The unique address id assigned by the Civic Platform server.
      inspectionDistrict:
        type: string
        description: The inspection district where the address is located.
      inspectionDistrictPrefix:
        type: string
        description: The prefix for the inspection district where the address is located.
      isPrimary:
        type: string
        description: Indicates whether or not to designate the address as the primary address. Only one address can be primary
          at any given time.
      levelStart:
        type: string
        description: The starting level number (floor number) that makes up the address within a complex.
      levelEnd:
        type: string
        description: The ending level number (floor number) that makes up the address within a complex.
      levelPrefix:
        type: string
        description: The prefix for the level numbers (floor numbers) that make up the address.
      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.
      sourceFlag:
        type: string
        description: The Accela permitting system that stores this address information, such as Civic Platform, Kiva, or Tidemark.
      sourceNumber:
        type: number
        format: long
        description: A number that identifies the Accela permitting system that stores this address information.
      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
      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.
  peopleSearchModel:
    type: object
    properties:
      activity:
        $ref: '#/definitions/activityModel'
      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
      birthDateFrom:
        description: The start of a birth date range to search.
        format: date-time
        type: string
      birthDateTo:
        description: The end of a birth date range to search.
        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
      contactAddress:
        $ref: '#/definitions/contactAddressModel'
      deceasedDateFrom:
        description: The start of a deceased date range to search.
        format: date-time
        type: string
      deceasedDateTo:
        description: The end of a deceased date range to search.
        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
      openCloseMatch:
        description: Indicates whether or not to use close matches as hits in a search for contacts.
        type: string
      openSoundexSearch:
        description: 'Indicates whether or not Soundex search is enabled for any of the following requested parameters: firstName,
          middleName, lastName, organizationName, tradeName, businessName, streetName'
        type: string
        enum:
        - Y
        - N
      orderBy:
        description: 'The fields by which the search results are ordered. For each field, specify the sort order: asc for
          ascending or desc for descending order. Use commas to separate multiple sort fields. The values are not case-sensitive.
          For example: "orderBy":"lastName desc,email asc"'
        enum:
        - LastName
        - LastName ASC
        - LastName DESC
        - FirstName
        - FirstName ASC
        - FirstName DESC
        - birthDate
        - birthDate ASC
        - birthDate DESC
        - AddressCity
        - AddressCity ASC
        - AddressCity DESC
        - AddressState
        - AddressState ASC
        - AddressState DESC
        - AddressZIP
        - AddressZIP ASC
        - AddressZIP DESC
        - AddressCountry
        - AddressCountry ASC
        - AddressCountry DESC
        - email
        - email ASC
        - email DESC
        - PHONE1
        - PHONE1 ASC
        - PHONE1 DESC
        - PHONE2
        - PHONE2 ASC
        - PHONE2 DESC
        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
  response_licenseModelArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/licenseModel'
        type: array
      status:
        type: integer
        description: The HTTP return status.
  licenseModel:
    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.
        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
      citizenPermission:
        description: Access permissions for the selected Citizen Access user groups.
        type: string
      city:
        description: The name of the city.
        type: string
      comment:
        description: A comment about the inspection contact.
        type: string
      contractorBusinessName:
        description: The contractor's business name (65 char limit).
        type: string
      contractorLicenseNumber:
        description: The contractor's license number.(30 char limit).
        format: int64
        type: integer
      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
      email:
        description: The contact's email address.
        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 contact's first 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.
        format: int64
        type: integer
      insuranceAmount:
        description: The insurance cost.
        format: double
        type: number
      insuranceCompany:
        description: The name of the company insuring the professional.
        type: string
      insuranceExpirationDate:
        description: The date when the insurance policy is due to expire.
        format: date-time
        type: string
      insurancePolicyNumber:
        description: The insurance policy number.
        type: string
      lastName:
        description: The last name (surname).
        type: string
      lastRenewalDate:
        description: The last date for a professionals renewal license.
        format: date-time
        type: string
      licenseExpirationDate:
        description: The date when the license expires and is no longer valid.
        format: date-time
        type: string
      licenseIssueDate:
        description: The license date of issuance.
        format: date-time
        type: string
      licenseNumber:
        description: The licensed professional's license number. The license is from the Contractors State License Board.
        type: string
      licenseState:
        description: The state that issued the license.
        type: string
      licenseType:
        type: object
        description: The type of license held by the professional. See [Get All Professional License Types](./api-settings.html#operation/v4.get.settings.professionals.types).
        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. See [Get All Professional License Boards](./api-settings.html#operation/v4.get.settings.professionals.licenseBoards).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      middleName:
        description: "The middle name.\t"
        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
      postalCode:
        description: The postal ZIP code for the address.
        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
      state:
        type: object
        description: ''
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      status:
        type: object
        description: The licensed professional 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
      workerCompensationExemption:
        description: The code associated with the Worker's Compensation Insurance Company.
        type: string
      workerCompensationExpirationDate:
        description: This is the expiration date of the Worker's Compensation Insurance Policy.
        format: date-time
        type: string
      workerCompensationPolicyNumber:
        description: This is the policy number for the Worker's Compensation Insurance. Limit of 30 characters.
        type: string
      workerInsuranceCompanyCode:
        description: The code associated with the Worker's Compensation Insurance Company.
        type: string
  licenseSearchModel:
    type: object
    properties:
      acaPermission:
        description: Access permissions for the selected Citizen Access user groups.
        type: string
      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.
        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: A comment about the inspection contact.
        type: string
      contractorBusinessName:
        description: The contractor's business name (65 char limit).
        type: string
      contractorLicenseNumber:
        description: The contractor's license number.(30 char limit).
        format: int64
        type: integer
      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
      email:
        description: The contact's email address.
        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 contact's first 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.
        format: int64
        type: integer
      insuranceAmount:
        description: The insurance cost.
        format: double
        type: number
      insuranceCompany:
        description: The name of the company insuring the professional.
        type: string
      insuranceExpirationDate:
        description: The date when the insurance policy is due to expire.
        format: date-time
        type: string
      insurancePolicyNumber:
        description: The insurance policy number.
        type: string
      lastName:
        description: The last name (surname).
        type: string
      licenseExpirationDate:
        description: The date when the license expires and is no longer valid.
        format: date-time
        type: string
      licenseIssueDate:
        description: The license date of issuance.
        format: date-time
        type: string
      licenseNumber:
        description: The licensed professional's license number. The license is from the Contractors State License Board.
        type: string
      licenseState:
        description: The state that issued the license.
        type: string
      licenseType:
        type: object
        description: The type of license held by the professional. See [Get All Professional License Types](./api-settings.html#operation/v4.get.settings.professionals.types).
        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. See [Get All Professional License Boards](./api-settings.html#operation/v4.get.settings.professionals.licenseBoards).
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      middleName:
        description: "The middle name.\t"
        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
      postalCode:
        description: The postal ZIP code for the address.
        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
      state:
        type: object
        description: ''
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      status:
        type: object
        description: The licensed professional 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
      workerCompensationExemption:
        description: The code associated with the Worker's Compensation Insurance Company.
        type: string
      workerCompensationExpirationDate:
        description: This is the expiration date of the Worker's Compensation Insurance Policy.
        format: date-time
        type: string
      workerCompensationPolicyNumber:
        description: This is the policy number for the Worker's Compensation Insurance. Limit of 30 characters.
        type: string
      workerInsuranceCompanyCode:
        description: The code associated with the Worker's Compensation Insurance Company.
        type: string
  response_searchProfessional:
    type: object
    properties:
      result:
        $ref: '#/definitions/resultSeachProfessionalArrary'
      status:
        type: integer
        description: The HTTP return status.
      page:
        $ref: '#/definitions/pageModel'
  resultSeachProfessionalArrary:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/resultSeachProfessionalModel'
        type: array
  resultSeachProfessionalModel:
    auditStatus:
      type: string
    licenseState:
      type: string
    licenseNumber:
      type: string
    id:
      type: integer
    lastName:
      type: string
    firstName:
      type: string
    serviceProviderCode:
      type: string
    customTables:
      items:
        $ref: '#/definitions/customAndTemplateTablesModel'
      type: array
    customFields:
      items:
        $ref: '#/definitions/customFieldsModel'
      type: array
    templateFields:
      items:
        $ref: '#/definitions/templateFieldsModel'
      type: array
    templateTables:
      items:
        $ref: '#/definitions/customAndTemplateTablesModel'
      type: array
    licenseType:
      type: object
      description: The type of license held by the professional. See [Get All Professional License Types](./api-settings.html#operation/v4.get.settings.professionals.types).
      properties:
        text:
          description: The localized display value.
          type: string
        value:
          description: The data value.
          type: string
    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
    status:
      type: object
      description: The record status.
      properties:
        text:
          description: The localized display value.
          type: string
        value:
          description: The data value.
          type: string
  templateFieldsModel:
    type: object
    properties:
      LATTRIBUTE1:
        type: string
      LATTRIBUTE2:
        type: string
  customFieldsModel:
    type: object
    properties:
      '''Aggregate Rated ''Energy Capacity'': AREC''':
        type: string
      country:
        type: string
      city:
        type: string
  customAndTemplateTablesModel:
    type: object
    properties:
      id:
        description: The custom table id.
        type: string
      rows:
        items:
          $ref: '#/definitions/customAndTemplateRowModel'
        description: A table row containing custom fields.
        type: array
  customAndTemplateRowModel:
    type: object
    properties:
      fields:
        $ref: '#/definitions/customAttributeModel'
      id:
        description: The row id.
        type: string
  templateAttributeModel:
    type: object
    properties:
      label:
        description: The attribute label.
        type: string
      value:
        description: The attribute value.
        type: string
  response_globalSearchArray:
    type: object
    properties:
      result:
        items:
          $ref: '#/definitions/globalSearchRecordModel'
        type: array
      page:
        $ref: '#/definitions/pageModel'
      status:
        type: integer
        description: The HTTP return status.
  globalSearchRecordModel:
    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
      isBooking:
        description: Indicates whether or not there was a booking in addition to a citation.
        type: boolean
      isInfraction:
        description: Indicates whether or not an infraction occurred.
        type: boolean
      isMisdemeanor:
        description: Indicates whether or not a misdemeanor occurred.
        type: boolean
      isOffenseWitnessed:
        description: Indicates whether or not  there was a witness to the alleged offense.
        type: boolean
      isDefendantSignature:
        description: Indicates whether or not a defendant's signature has been obtained.
        type: boolean
      module:
        description: The module the record belongs to. See [Get All Modules](./api-settings.html#operation/v4.get.settings.modules).
        type: string
      serviceProviderCode:
        description: The unique identifier for the agency.
        type: string
      shortNotes:
        description: A brief note about the record subject.
        type: string
      status:
        description: The record status.
        $ref: '#/definitions/identifierModel'
      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
  page:
    type: object
    properties:
      offset:
        type: integer
        description: The requested offset start.
      total:
        type: integer
        description: The total number of results.
      limit:
        type: integer
        description: The requested result limit.
      hasmore:
        type: boolean
        description: true if there are more results to fetch; false if all results have been fetched.
  pageModel:
    type: object
    properties:
      offset:
        type: integer
        description: The requested offset start.
      limit:
        type: integer
        description: The requested result limit.
      total:
        type: integer
        description: The total number of records found.
      hasmore:
        type: boolean
        description: true if there are more results to fetch; false if all results have been fetched.
  parcelsModel:
    type: object
    properties:
      parcelArea:
        description: The total area of the parcel. Your agency determines the standard unit of measure.
        format: double
        type: number
      id:
        description: The system id of the parcel assigned by the Civic Platform server.
        type: string
      isPrimary:
        description: Indicates whether or not to designate the parcel as the primary parcel.
        type: string
      parcelNumber:
        description: The alpha-numeric parcel number.
        type: string
      status:
        type: object
        description: The parcel status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
      owners:
        items:
          $ref: '#/definitions/ownersModel'
        type: array
  ownersModel:
    type: object
    properties:
      address:
        description: The contact's address.
        type: string
      mailAddress:
        description: The contact's mail address.
        type: string
      fax:
        description: The fax number for the contact.
        type: string
      phone:
        description: The telephone number of the owner.
        type: string
      fullName:
        description: The contact's full name. This field is only active when the Contact Type selected is Individual.
        type: string
      firstName:
        description: The contact's first name. This field is only active when the Contact Type selected is Individual.
        type: string
      lastName:
        description: The last name (surname).
        type: string
      middleName:
        description: The contact's middle name.
        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
      mailAddressObject:
        description: ''
        type: object
        properties:
          postalCode:
            type: string
          city:
            type: string
            description: The name of the city.
          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
      addressObject:
        postalCode:
          type: string
        city:
          type: string
          description: The name of the city.
        state:
          type: object
          description: The name of the state.
          addressLine1:
            description: The first line of the address.
            type: string
          properties:
            text:
              description: The localized display value.
              type: string
            value:
              description: The data value.
              type: string
      status:
        type: object
        description: The owner status.
        properties:
          text:
            description: The localized display value.
            type: string
          value:
            description: The data value.
            type: string
parameters:
  authHeaderParam:
    description: Construct oAuth2 authentication token
    in: header
    name: Authorization
    required: true
    type: string
  offset:
    description: The offset position of the first record in the results response array. For example, if offset is 100, the
      first item in the results array in the response is the 100th record in the search result list.
    format: int64
    in: query
    name: offset
    required: false
    type: integer
  limit:
    description: Search result size limit.
    format: int64
    in: query
    name: limit
    required: false
    type: integer
    enum:
    - range[1,1000]
  fields:
    description: Comma-delimited names of fields to be returned in the response. Note - Field names are case-sensitive and
      only first-level fields are supported. Invalid field names are ignored.
    in: query
    name: fields
    required: false
    type: string
  lang:
    description: Language parameter to support I18N. Default language is en_US.
    in: query
    name: lang
    required: false
    type: string
x-api-evangelist-provenance:
  generated: '2026-09-06'
  method: searched
  source: https://developer.accela.com/api/v4/v4-search.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.