Get All Inspection Types

Gets all available inspection types.

Resource Information

Scopeinspections

Deprecated scope name:   get_settings_inspection_types

App TypeAll
Authorization TypeAccess token
URI /v4/settings/inspections/types?lang={lang}&expand={expand}&offset={offset}&limit={limit}&fields={fields}&group={group}
HTTP MethodGET
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
expandstringNoassociationsThe related objects to be returned with the response. The related object(s) will be returned if data exists; if data does not exist, the requested object(s) will not be included in the response. 7.3.3.5
fieldsstringNo 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.7.3.2
groupstringNo The group query parameter.7.3.2
langStringNo Indicates the language applied.7.3.2
limitlongNo Indicates the number of items that are returned in each page.7.3.2
offsetlongNo Indicates the offset start of each page by the number specified.7.3.2

Example

Sample Request Head

GET https://apis.accela.com/v4/settings/inspections/types?group=BLD_COMM

Notes

The following sample request uses the ISLANDTON agency in the TEST environment on the Accela Developer Sandbox. Click the "Send to Hurl.It" link below to submit the sample request. Replace YOUR-ACCESS-TOKEN before submitting the request.

curl
   -H 'Content-type: application/json'
   -H 'Accept: application/json'
   -H 'Authorization: YOUR-ACCESS-TOKEN'
   -X GET  https://apis.accela.com/v4/settings/inspections/types?group=BLD_COMM

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.allowFailChecklistItemsstringIndicates whether or not to allow inspection to pass with failed checklist items for the current inspection type or from previous inspections.7.3.2
result.allowMultiInspectionsstringIndicates whether or not to allow the scheduling of multiple inspections for this inspection type.7.3.2
result.associationsresult.associations{}Contains parameter settings associated with instances of the inspection type.7.3.3.5
result.associations.standardCommentGroupresult.associations.standardCommentGroup{}The name of the standard comment group associated with instances of the inspection type.7.3.3.5
result.associations.standardCommentGroup.textstringThe localized display text.7.3.3.5
result.associations.standardCommentGroup.valuestringThe value for the specified parameter.7.3.3.5
result.carryoverFlagstringIndicates how failed guidesheet items for an inspection type are carried over to the next inspection guidesheet. NULL or empty string : Guidesheet items are not carried over. "A" : Automatic carry-over of failed guidesheet items to the next inspection guidesheet item. 7.3.2
result.defaultDepartmentresult.defaultDepartment{}The default department responsible for the inspection.7.3.2
result.defaultDepartment.agencystringThe department agency7.3.2
result.defaultDepartment.bureaustringThe name of the bureau, which is an organization level within an agency.7.3.2
result.defaultDepartment.divisionstringThe name of the division, which is an organization level within a bureau.7.3.2
result.defaultDepartment.groupstringThe department group.7.3.2
result.defaultDepartment.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.defaultDepartment.officestringAn organization level within a group. An office is the final level within an organization structure. Agency->Bureau->Division->Section->Group->Office.7.3.2
result.defaultDepartment.sectionstringA piece of a township measuring 640 acres, one square mile, numbered with reference to the base line and meridian line.7.3.2
result.defaultDepartment.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.defaultDepartment.textstringThe localized display text.7.3.2
result.defaultDepartment.valuestringThe value for the specified parameter.7.3.2
result.disciplines[]stringThe inspection disciplines assigned to the inspection type.7.3.2
result.flowEnabledFlagstringIndicates whether or not to include the inspection in the inspection flow process.7.3.2
result.gradestringThe name of the inspection grade. 7.3.2
result.groupstringThe name of a group of inspection types.7.3.2
result.groupNameresult.groupName{}The descriptive name associated to an inspection group code.7.3.2
result.groupName.textstringThe localized display text.7.3.2
result.groupName.valuestringThe value for the specified parameter.7.3.2
result.guideGroupresult.guideGroup{}Contains the inspection guide group information7.3.2
result.guideGroup.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.guideGroup.textstringThe localized display text.7.3.2
result.guideGroup.valuestringThe value for the specified parameter.7.3.2
result.hasCancelPermissionstringIndicates whether or not the user can cancel the inspection.7.3.2
result.hasFlowFlagstringIndicates whether or not to include the inspection in the inspection flow process.7.3.2
result.hasNextInspectionAdvancestringIndicates whether or not the next inspection can be scheduled in advance.7.3.2
result.hasReschdulePermissionstringIndicates whether or not the user can reschedule the inspection.7.3.2
result.hasSchdulePermissionstringIndicates whether or not the user can schedule the inspection.7.3.2
result.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.inspectionEditablestringIndicates whether or not inspection result, grade or checklist can be edited.7.3.2
result.isAutoAssignstringThis defines whether or not you want to automatically reschedule the inspection when the previous inspection status attains Approved status.7.3.2
result.isRequiredstringIndicates whether or not the information is required. 7.3.2
result.maxPointsdoubleThe number of points allowed for an inspection, after which the inspection fails. 7.3.2
result.prioritystringThe priority level assigned to the inspection type.7.3.2
result.publicVisiblestringIndicates whether or not Accela Citizen Access users can view comment about the inspection results.7.3.2
result.refereceNumberstringThe reference number associated with an inspection.7.3.2
result.resultGroupstringThe name of a grouping of Inspection results, usually indicative of a range of inspection scores.7.3.2
result.textstringThe localized display text.7.3.2
result.totalScorelongThe overall score of the inspection that includes the inspection result, inspection grade, checklist total score and checklist major violation option.7.3.2
result.totalScoreOptionstringIndicates the method for calculating total scores of checklist items. There are four options: Total sub scores (the default method). Displays the sum of all the guidesheet item scores. Average of subtotal scores. Displays the average score of all the guid7.3.2
result.unitNumberstringThe number of time units (see timeUnitDuration) comprising an inspection.7.3.2
result.unitsdoubleThe amount of time comprising the smallest time unit for conducting an inspection.7.3.2
result.valuestringThe value for the specified parameter.7.3.2
statusintegerThe record status.7.3.3

Example

Sample Response Body

{
  "result": [
    {
      "priority": "1",
      "value": "Set Backs",
      "id": 97,
      "group": "BLD_COMM",
      "publicVisible": "Y",
      "inspectionEditable": "Y",
      "allowMultiInspections": "Y",
      "resultGroup": "BLD_STANDARD",
      "flowEnabledFlag": "N",
      "hasFlowFlag": "N",
      "text": "Set Backs",
      "isRequired": "N",
      "isAutoAssign": "N",
      "totalScoreOption": "SUM(list)",
      "allowFailChecklistItems": "Y",
      "groupName": {
        "value": "BLD Commercial",
        "text": "BLD Commercial"
      },
      "hasNextInspectionAdvance": "N"
    },
    {
      "priority": "2",
      "value": "Temp Power",
      "id": 98,
      "group": "BLD_COMM",
      "publicVisible": "Y",
      "inspectionEditable": "Y",
      "allowMultiInspections": "Y",
      "resultGroup": "BLD_STANDARD",
      "flowEnabledFlag": "N",
      "hasFlowFlag": "N",
      "text": "Temp Power",
      "isRequired": "N",
      "isAutoAssign": "N",
      "totalScoreOption": "SUM(list)",
      "allowFailChecklistItems": "Y",
      "groupName": {
        "value": "BLD Commercial",
        "text": "BLD Commercial"
      },
      "hasNextInspectionAdvance": "N"
    },
    {
      "priority": "3",
      "value": "Footings & Forms",
      "id": 99,
      "group": "BLD_COMM",
      "publicVisible": "Y",
      "inspectionEditable": "Y",
      "allowMultiInspections": "Y",
      "resultGroup": "BLD_STANDARD",
      "flowEnabledFlag": "N",
      "hasFlowFlag": "N",
      "text": "Footings & Forms",
      "isRequired": "N",
      "isAutoAssign": "N",
      "totalScoreOption": "SUM(list)",
      "allowFailChecklistItems": "Y",
      "groupName": {
        "value": "BLD Commercial",
        "text": "BLD Commercial"
      },
      "hasNextInspectionAdvance": "N"
    },
    {
      "priority": "4",
      "value": "Foundation",
      "id": 100,
      "group": "BLD_COMM",
      "publicVisible": "Y",
      "inspectionEditable": "Y",
      "allowMultiInspections": "Y",
      "resultGroup": "BLD_STANDARD",
      "flowEnabledFlag": "N",
      "hasFlowFlag": "N",
      "text": "Foundation",
      "isRequired": "N",
      "isAutoAssign": "N",
      "totalScoreOption": "SUM(list)",
      "allowFailChecklistItems": "Y",
      "groupName": {
        "value": "BLD Commercial",
        "text": "BLD Commercial"
      },
      "hasNextInspectionAdvance": "N"
    },
    {
      "priority": "5",
      "value": "Rough Frame",
      "id": 101,
      "group": "BLD_COMM",
      "publicVisible": "Y",
      "inspectionEditable": "Y",
      "allowMultiInspections": "Y",
      "resultGroup": "BLD_STANDARD",
      "flowEnabledFlag": "N",
      "hasFlowFlag": "N",
      "text": "Rough Frame",
      "isRequired": "N",
      "isAutoAssign": "N",
      "totalScoreOption": "SUM(list)",
      "allowFailChecklistItems": "Y",
      "groupName": {
        "value": "BLD Commercial",
        "text": "BLD Commercial"
      },
      "hasNextInspectionAdvance": "N"
    },
    {
      "priority": "6",
      "value": "Frame",
      "id": 102,
      "group": "BLD_COMM",
      "publicVisible": "Y",
      "inspectionEditable": "Y",
      "allowMultiInspections": "Y",
      "resultGroup": "BLD_STANDARD",
      "flowEnabledFlag": "N",
      "hasFlowFlag": "N",
      "text": "Frame",
      "isRequired": "N",
      "isAutoAssign": "N",
      "totalScoreOption": "SUM(list)",
      "allowFailChecklistItems": "Y",
      "groupName": {
        "value": "BLD Commercial",
        "text": "BLD Commercial"
      },
      "hasNextInspectionAdvance": "N"
    },
    {
      "priority": "7",
      "value": "Floor Deck",
      "id": 103,
      "group": "BLD_COMM",
      "publicVisible": "Y",
      "inspectionEditable": "Y",
      "allowMultiInspections": "Y",
      "resultGroup": "BLD_STANDARD",
      "flowEnabledFlag": "N",
      "hasFlowFlag": "N",
      "text": "Floor Deck",
      "isRequired": "N",
      "isAutoAssign": "N",
      "totalScoreOption": "SUM(list)",
      "allowFailChecklistItems": "Y",
      "groupName": {
        "value": "BLD Commercial",
        "text": "BLD Commercial"
      },
      "hasNextInspectionAdvance": "N"
    },
    {
      "priority": "8",
      "value": "Roof Deck",
      "id": 104,
      "group": "BLD_COMM",
      "publicVisible": "Y",
      "inspectionEditable": "Y",
      "allowMultiInspections": "Y",
      "resultGroup": "BLD_STANDARD",
      "flowEnabledFlag": "N",
      "hasFlowFlag": "N",
      "text": "Roof Deck",
      "isRequired": "N",
      "isAutoAssign": "N",
      "totalScoreOption": "SUM(list)",
      "allowFailChecklistItems": "Y",
      "groupName": {
        "value": "BLD Commercial",
        "text": "BLD Commercial"
      },
      "hasNextInspectionAdvance": "N"
    },
    {
      "priority": "9",
      "value": "Partial/Temp Building Final",
      "id": 105,
      "group": "BLD_COMM",
      "publicVisible": "Y",
      "inspectionEditable": "Y",
      "allowMultiInspections": "Y",
      "resultGroup": "BLD_STANDARD",
      "flowEnabledFlag": "N",
      "hasFlowFlag": "N",
      "text": "Partial/Temp Building Final",
      "isRequired": "N",
      "isAutoAssign": "N",
      "totalScoreOption": "SUM(list)",
      "allowFailChecklistItems": "Y",
      "groupName": {
        "value": "BLD Commercial",
        "text": "BLD Commercial"
      },
      "hasNextInspectionAdvance": "N"
    },
    {
      "priority": "10",
      "value": "Building Final",
      "id": 106,
      "group": "BLD_COMM",
      "publicVisible": "Y",
      "inspectionEditable": "Y",
      "allowMultiInspections": "Y",
      "resultGroup": "BLD_STANDARD",
      "flowEnabledFlag": "N",
      "hasFlowFlag": "N",
      "text": "Building Final",
      "isRequired": "N",
      "isAutoAssign": "N",
      "totalScoreOption": "SUM(list)",
      "allowFailChecklistItems": "Y",
      "groupName": {
        "value": "BLD Commercial",
        "text": "BLD Commercial"
      },
      "hasNextInspectionAdvance": "N"
    },
    {
      "priority": "11",
      "value": "Fire Final",
      "id": 108,
      "group": "BLD_COMM",
      "publicVisible": "Y",
      "inspectionEditable": "Y",
      "allowMultiInspections": "Y",
      "resultGroup": "BLD_STANDARD",
      "flowEnabledFlag": "N",
      "hasFlowFlag": "N",
      "text": "Fire Final",
      "isRequired": "N",
      "isAutoAssign": "N",
      "totalScoreOption": "SUM(list)",
      "allowFailChecklistItems": "Y",
      "groupName": {
        "value": "BLD Commercial",
        "text": "BLD Commercial"
      },
      "hasNextInspectionAdvance": "N"
    },
    {
      "priority": "12",
      "value": "Health Final",
      "id": 111,
      "group": "BLD_COMM",
      "publicVisible": "Y",
      "inspectionEditable": "Y",
      "allowMultiInspections": "Y",
      "resultGroup": "BLD_STANDARD",
      "flowEnabledFlag": "N",
      "hasFlowFlag": "N",
      "text": "Health Final",
      "isRequired": "N",
      "isAutoAssign": "N",
      "totalScoreOption": "SUM(list)",
      "allowFailChecklistItems": "Y",
      "groupName": {
        "value": "BLD Commercial",
        "text": "BLD Commercial"
      },
      "hasNextInspectionAdvance": "N"
    },
    {
      "priority": "13",
      "value": "Sanitary Sewer Final",
      "id": 110,
      "group": "BLD_COMM",
      "publicVisible": "Y",
      "inspectionEditable": "Y",
      "allowMultiInspections": "Y",
      "resultGroup": "BLD_STANDARD",
      "flowEnabledFlag": "N",
      "hasFlowFlag": "N",
      "text": "Sanitary Sewer Final",
      "isRequired": "N",
      "isAutoAssign": "N",
      "totalScoreOption": "SUM(list)",
      "allowFailChecklistItems": "Y",
      "groupName": {
        "value": "BLD Commercial",
        "text": "BLD Commercial"
      },
      "hasNextInspectionAdvance": "N"
    },
    {
      "priority": "14",
      "value": "Storm Sewer Final",
      "id": 109,
      "group": "BLD_COMM",
      "publicVisible": "Y",
      "inspectionEditable": "Y",
      "allowMultiInspections": "Y",
      "resultGroup": "BLD_STANDARD",
      "flowEnabledFlag": "N",
      "hasFlowFlag": "N",
      "text": "Storm Sewer Final",
      "isRequired": "N",
      "isAutoAssign": "N",
      "totalScoreOption": "SUM(list)",
      "allowFailChecklistItems": "Y",
      "groupName": {
        "value": "BLD Commercial",
        "text": "BLD Commercial"
      },
      "hasNextInspectionAdvance": "N"
    },
    {
      "priority": "15",
      "value": "Storm Water Quality Final",
      "id": 112,
      "group": "BLD_COMM",
      "publicVisible": "Y",
      "inspectionEditable": "Y",
      "allowMultiInspections": "Y",
      "resultGroup": "BLD_STANDARD",
      "flowEnabledFlag": "N",
      "hasFlowFlag": "N",
      "text": "Storm Water Quality Final",
      "isRequired": "N",
      "isAutoAssign": "N",
      "totalScoreOption": "SUM(list)",
      "allowFailChecklistItems": "Y",
      "groupName": {
        "value": "BLD Commercial",
        "text": "BLD Commercial"
      },
      "hasNextInspectionAdvance": "N"
    },
    {
      "priority": "16",
      "value": "Zoning Final",
      "id": 107,
      "group": "BLD_COMM",
      "publicVisible": "Y",
      "inspectionEditable": "Y",
      "allowMultiInspections": "Y",
      "resultGroup": "BLD_STANDARD",
      "flowEnabledFlag": "N",
      "hasFlowFlag": "N",
      "text": "Zoning Final",
      "isRequired": "N",
      "isAutoAssign": "N",
      "totalScoreOption": "SUM(list)",
      "allowFailChecklistItems": "Y",
      "groupName": {
        "value": "BLD Commercial",
        "text": "BLD Commercial"
      },
      "hasNextInspectionAdvance": "N"
    },
    {
      "priority": "17",
      "value": "Progress Check",
      "id": 113,
      "group": "BLD_COMM",
      "publicVisible": "Y",
      "inspectionEditable": "Y",
      "allowMultiInspections": "Y",
      "resultGroup": "BLD_STANDARD",
      "flowEnabledFlag": "N",
      "hasFlowFlag": "N",
      "text": "Progress Check",
      "isRequired": "N",
      "isAutoAssign": "N",
      "totalScoreOption": "SUM(list)",
      "allowFailChecklistItems": "Y",
      "groupName": {
        "value": "BLD Commercial",
        "text": "BLD Commercial"
      },
      "hasNextInspectionAdvance": "N"
    },
    {
      "value": "Testing ASI",
      "id": 84009127,
      "grade": "BLD_GG1",
      "group": "BLD_COMM",
      "publicVisible": "Y",
      "inspectionEditable": "Y",
      "allowMultiInspections": "N",
      "resultGroup": "BLD_STANDARD",
      "guideGroup": {
        "id": "BLD_ELEC",
        "text": "BLD_ELEC",
        "value": "BLD_ELEC"
      },
      "flowEnabledFlag": "N",
      "hasFlowFlag": "N",
      "text": "Testing ASI",
      "isRequired": "N",
      "isAutoAssign": "N",
      "totalScoreOption": "SUM(list)",
      "allowFailChecklistItems": "Y",
      "groupName": {
        "value": "BLD Commercial",
        "text": "BLD Commercial"
      },
      "hasNextInspectionAdvance": "N"
    }
  ],
  "status": 200,
  "page": {
    "offset": 0,
    "limit": 25,
    "hasmore": false
  }
}