Get Inspection Types

Gets the specified inspection types.

Resource Information

Scope	inspections Deprecated scope name: get_settings_inspection_type
App Type	All
Authorization Type	Access token
URI	/v4/settings/inspections/types/{ids}?expand={expand}&fields={fields}&lang={lang}
HTTP Method	GET
Automation Version(s)	7.3.2

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
expand	string	No	associations	The related objects to be returned with the response. The related object(s) will be returned if data exists; if data does not exist, the requested object(s) will not be included in the response.	7.3.3.5
fields	string	No	�	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
ids	string	No	�	One or multiple identifiers separated by a comma like id1,id2,id3.	7.3.2
lang	String	No	�	Indicates the language applied.	7.3.2

Example

Sample Request Head

GET https://apis.accela.com/v4/settings/inspections/types/100,101,102

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/100,101,102

Response Information

Field	Type	Description	Automation Version
result[]	result{}	�	7.3.2
result.allowFailChecklistItems	string	Indicates 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.allowMultiInspections	string	Indicates whether or not to allow the scheduling of multiple inspections for this inspection type.	7.3.2
result.associations	result.associations{}	Contains parameter settings associated with instances of the inspection type.	7.3.3.5
result.associations.standardCommentGroup	result.associations.standardCommentGroup{}	The name of the standard comment group associated with instances of the inspection type.	7.3.3.5
result.associations.standardCommentGroup.text	string	The localized display text.	7.3.3.5
result.associations.standardCommentGroup.value	string	The value for the specified parameter.	7.3.3.5
result.carryoverFlag	string	Indicates 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.defaultDepartment	result.defaultDepartment{}	The default department responsible for the inspection.	7.3.2
result.defaultDepartment.agency	string	The department agency	7.3.2
result.defaultDepartment.bureau	string	The name of the bureau, which is an organization level within an agency.	7.3.2
result.defaultDepartment.division	string	The name of the division, which is an organization level within a bureau.	7.3.2
result.defaultDepartment.group	string	The department group.	7.3.2
result.defaultDepartment.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.defaultDepartment.office	string	An 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.section	string	A 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.serviceProviderCode	string	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
result.defaultDepartment.text	string	The localized display text.	7.3.2
result.defaultDepartment.value	string	The value for the specified parameter.	7.3.2
result.disciplines[]	string	The inspection disciplines assigned to the inspection type.	7.3.2
result.flowEnabledFlag	string	Indicates whether or not to include the inspection in the inspection flow process.	7.3.2
result.grade	string	The name of the inspection grade.	7.3.2
result.group	string	The name of a group of inspection types.	7.3.2
result.groupName	result.groupName{}	The descriptive name associated to an inspection group code.	7.3.2
result.groupName.text	string	The localized display text.	7.3.2
result.groupName.value	string	The value for the specified parameter.	7.3.2
result.guideGroup	result.guideGroup{}	Contains the inspection guide group information	7.3.2
result.guideGroup.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.guideGroup.text	string	The localized display text.	7.3.2
result.guideGroup.value	string	The value for the specified parameter.	7.3.2
result.hasCancelPermission	string	Indicates whether or not the user can cancel the inspection.	7.3.2
result.hasFlowFlag	string	Indicates whether or not to include the inspection in the inspection flow process.	7.3.2
result.hasNextInspectionAdvance	string	Indicates whether or not the next inspection can be scheduled in advance.	7.3.2
result.hasReschdulePermission	string	Indicates whether or not the user can reschedule the inspection.	7.3.2
result.hasSchdulePermission	string	Indicates whether or not the user can schedule the inspection.	7.3.2
result.id	long	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.inspectionEditable	string	Indicates whether or not inspection result, grade or checklist can be edited.	7.3.2
result.isAutoAssign	string	This defines whether or not you want to automatically reschedule the inspection when the previous inspection status attains Approved status.	7.3.2
result.isRequired	string	Indicates whether or not the information is required.	7.3.2
result.maxPoints	double	The number of points allowed for an inspection, after which the inspection fails.	7.3.2
result.priority	string	The priority level assigned to the inspection type.	7.3.2
result.publicVisible	string	Indicates whether or not Accela Citizen Access users can view comment about the inspection results.	7.3.2
result.refereceNumber	string	The reference number associated with an inspection.	7.3.2
result.resultGroup	string	The name of a grouping of Inspection results, usually indicative of a range of inspection scores.	7.3.2
result.text	string	The localized display text.	7.3.2
result.totalScore	long	The overall score of the inspection that includes the inspection result, inspection grade, checklist total score and checklist major violation option.	7.3.2
result.totalScoreOption	string	Indicates 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 guid	7.3.2
result.unitNumber	string	The number of time units (see timeUnitDuration) comprising an inspection.	7.3.2
result.units	double	The amount of time comprising the smallest time unit for conducting an inspection.	7.3.2
result.value	string	The value for the specified parameter.	7.3.2
status	integer	The record status.	7.3.3

Example

Sample Response Body

{
  "result": [
    {
      "priority": "4",
      "value": "Foundation",
      "id": 100,
      "group": "BLD_COMM",
      "publicVisible": "Y",
      "inspectionEditable": "Y",
      "allowMultiInspections": "Y",
      "resultGroup": "BLD_STANDARD",
      "text": "Foundation",
      "isRequired": "N",
      "isAutoAssign": "N",
      "totalScoreOption": "SUM(list)",
      "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",
      "text": "Rough Frame",
      "isRequired": "N",
      "isAutoAssign": "N",
      "totalScoreOption": "SUM(list)",
      "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",
      "text": "Frame",
      "isRequired": "N",
      "isAutoAssign": "N",
      "totalScoreOption": "SUM(list)",
      "groupName": {
        "value": "BLD Commercial",
        "text": "BLD Commercial"
      },
      "hasNextInspectionAdvance": "N"
    }
  ],
  "status": 200
}