Gets the inspection types associated with the specified record(s).
Scope |
records Deprecated scope name: get_record_inspection_types |
App Type | All |
Authorization Type | Access token |
URI | /v4/records/{recordIds}/inspectionTypes?lang={lang} |
HTTP Method | GET |
Automation Version(s) | 7.3.2 |
Field or Parameter | Type | Required | Values | Description | Automation Version |
---|---|---|---|---|---|
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 | |
lang | String | No | Indicates the language applied. | 7.3.2 | |
recordIds | string | Yes | Get All Records Search Records Get My Records | Comma-delimited record ID's. | 7.3.2 |
GET https://apis.accela.com/v4/records/ISLANDTON-14CAP-00000-000FK/inspectionTypes
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/records/ISLANDTON-14CAP-00000-000FK/inspectionTypes
Field | Type | Description | Automation Version |
---|---|---|---|
result[] | result{} | 7.3.2 | |
result.inspectionTypes[] | result.inspectionTypes{} | Contains inspection types and their type properties. | 7.3.2 |
result.inspectionTypes.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.inspectionTypes.allowMultiInspections | string | Indicates whether or not to allow the scheduling of multiple inspections for this inspection type. | 7.3.2 |
result.inspectionTypes.associations | result.inspectionTypes.associations{} | Contains settings associated with instances of the inspection type. | 7.3.3.5 |
result.inspectionTypes.associations.standardCommentGroup | result.inspectionTypes.associations.standardCommentGroup{} | The name of the standard comment group associated with the inspection type. | 7.3.3.5 |
result.inspectionTypes.associations.standardCommentGroup.text | string | The localized display text. | 7.3.3.5 |
result.inspectionTypes.associations.standardCommentGroup.value | string | The value for the specified parameter. | 7.3.3.5 |
result.inspectionTypes.cancelRestrictions | result.inspectionTypes.cancelRestrictions{} | Contains time restrictions against cancelling inspections before the scheduled time on the inspection date. | 7.3.3.5 |
result.inspectionTypes.cancelRestrictions.beforeScheduledTime | result.inspectionTypes.cancelRestrictions.beforeScheduledTime{} | Specifies the number of days or hours before the scheduled time on the inspection date. | 7.3.3.5 |
result.inspectionTypes.cancelRestrictions.beforeScheduledTime.days | long | Inspections can only be cancelled within this number of days before the scheduled time on the inspection date. | 7.3.3.5 |
result.inspectionTypes.cancelRestrictions.beforeScheduledTime.hours | long | Inspections can only be cancelled within this number of hours before the scheduled time on the inspection date. | 7.3.3.5 |
result.inspectionTypes.cancelRestrictions.beforeScheduledTime.time | string | Inspections can only be cancelled within the number of specified days or hours before this time ("hh:mm AM|PM") on the inspection date. | 7.3.3.5 |
result.inspectionTypes.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.inspectionTypes.defaultDepartment | result.inspectionTypes.defaultDepartment{} | The default department responsible for the inspection. | 7.3.2 |
result.inspectionTypes.defaultDepartment.agency | string | The department agency | 7.3.2 |
result.inspectionTypes.defaultDepartment.bureau | string | The name of the bureau, which is an organization level within an agency. | 7.3.2 |
result.inspectionTypes.defaultDepartment.division | string | The name of the division, which is an organization level within a bureau. | 7.3.2 |
result.inspectionTypes.defaultDepartment.group | string | The department group. | 7.3.2 |
result.inspectionTypes.defaultDepartment.id | string | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.2 |
result.inspectionTypes.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.inspectionTypes.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.inspectionTypes.defaultDepartment.serviceProviderCode | string | The unique agency identifier, the system assigns, on the Accela Civic Platform. | 7.3.2 |
result.inspectionTypes.defaultDepartment.text | string | The localized display text. | 7.3.2 |
result.inspectionTypes.defaultDepartment.value | string | The value for the specified parameter. | 7.3.2 |
result.inspectionTypes.disciplines[] | string | The inspection disciplines assigned to the inspection type. | 7.3.2 |
result.inspectionTypes.flowEnabledFlag | string | Indicates whether or not to include the inspection in the inspection flow process. | 7.3.2 |
result.inspectionTypes.grade | string | The name of the inspection grade. | 7.3.2 |
result.inspectionTypes.group | string | The name of a group of inspection types. | 7.3.2 |
result.inspectionTypes.groupName | result.inspectionTypes.groupName{} | The descriptive name associated to an inspection group code. | 7.3.2 |
result.inspectionTypes.groupName.text | string | The localized display text. | 7.3.2 |
result.inspectionTypes.groupName.value | string | The value for the specified parameter. | 7.3.2 |
result.inspectionTypes.guideGroup | result.inspectionTypes.guideGroup{} | Contains the inspection guide group information | 7.3.2 |
result.inspectionTypes.guideGroup.id | string | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.2 |
result.inspectionTypes.guideGroup.text | string | The localized display text. | 7.3.2 |
result.inspectionTypes.guideGroup.value | string | The value for the specified parameter. | 7.3.2 |
result.inspectionTypes.hasCancelPermission | string | Indicates whether or not the user can cancel the inspection. | 7.3.2 |
result.inspectionTypes.hasFlowFlag | string | Indicates whether or not to include the inspection in the inspection flow process. | 7.3.2 |
result.inspectionTypes.hasNextInspectionAdvance | string | Indicates whether or not the next inspection can be scheduled in advance. | 7.3.2 |
result.inspectionTypes.hasReschdulePermission | string | Indicates whether or not the user can reschedule the inspection. | 7.3.2 |
result.inspectionTypes.hasSchdulePermission | string | Indicates whether or not the user can schedule the inspection.
Note that hasSchdulePermission returns 'Y' if result.inspectionTypes.schdulePermission is either "REQUEST_ONLY_PENDING", "REQUEST_SAME_DAY_NEXT_DAY", or "SCHEDULE_USING_CALENDAR". If result.inspectionTypes.schdulePermission is "NONE" or null, hasSchdulePermission returns "N". |
7.3.2 |
result.inspectionTypes.id | long | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.2 |
result.inspectionTypes.inspectionEditable | string | Indicates whether or not inspection result, grade or checklist can be edited. | 7.3.2 |
result.inspectionTypes.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.inspectionTypes.isRequired | string | Indicates whether or not the information is required. | 7.3.2 |
result.inspectionTypes.maxPoints | double | The number of points allowed for an inspection, after which the inspection fails. | 7.3.2 |
result.inspectionTypes.priority | string | The priority level assigned to the inspection type. | 7.3.2 |
result.inspectionTypes.publicVisible | string | Indicates whether or not Accela Citizen Access users can view comment about the inspection results. | 7.3.2 |
result.inspectionTypes.refereceNumber | string | The reference number associated with an inspection. | 7.3.2 |
result.inspectionTypes.rescheduleRestriction | result.inspectionTypes.rescheduleRestriction{} | Contains time restrictions against rescheduling inspections before the scheduled time on the inspection date. | 7.3.3.5 |
result.inspectionTypes.rescheduleRestriction.beforeScheduledTime | result.inspectionTypes.rescheduleRestriction.beforeScheduledTime{} | Specifies the number of days or hours before the scheduled time on the inspection date. | 7.3.3.5 |
result.inspectionTypes.rescheduleRestriction.beforeScheduledTime.days | long | Inspections can only be rescheduled within this number of days before the scheduled time on the inspection date. | 7.3.3.5 |
result.inspectionTypes.rescheduleRestriction.beforeScheduledTime.hours | long | Inspections can only be rescheduled within this number of hours before the scheduled time on the inspection date. | 7.3.3.5 |
result.inspectionTypes.rescheduleRestriction.beforeScheduledTime.time | string | Inspections can only be rescheduled within the number of specified days or hours before this time ("hh:mm AM|PM") on the inspection date. | 7.3.3.5 |
result.inspectionTypes.resultGroup | string | The name of a grouping of Inspection results, usually indicative of a range of inspection scores. | 7.3.2 |
result.inspectionTypes.schdulePermission | string | Returns one of the scheduling permissions in Citizen Access:
|
9.0.0 |
result.inspectionTypes.text | string | The localized display text. | 7.3.2 |
result.inspectionTypes.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.inspectionTypes.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.inspectionTypes.unitNumber | string | The number of time units (see timeUnitDuration) comprising an inspection. | 7.3.2 |
result.inspectionTypes.units | double | The amount of time comprising the smallest time unit for conducting an inspection. | 7.3.2 |
result.inspectionTypes.value | string | The value for the specified parameter. | 7.3.2 |
result.recordId | string | The unique ID associated with a record. | 7.3.2 |
status | integer | The request status. | 7.3.2 |
{ "result": [ { "recordId": "ISLANDTON-14CAP-00000-000FK", "inspectionTypes": [ { "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", "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", "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", "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", "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", "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", "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", "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", "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", "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", "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", "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", "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", "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", "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", "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", "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", "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", "hasNextInspectionAdvance": "N" } ] } ], "status": 200 }