Get All Inspection Statuses

Gets all available status values for use in an inspection.

Resource Information

Scopeinspections

Deprecated scope name:   get_settings_inspection_statuses

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

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
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

Example

Sample Request Head

GET https://apis.accela.com/v4/settings/inspections/statuses?group=BLD_STANDARD

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/statuses?group=BLD_STANDARD

Response Information

FieldTypeDescriptionAutomation Version
result[]result{}The inspection result status group.7.3.2
result.groupstringThe inspection status group.7.3.2
result.results[]result.results{}Contains preset field values for inspection statuses.7.3.2
result.results.displayOrderlongThe order of the item in comparison to the other items.7.3.2
result.results.groupstringThe inspection status group for the inspection status value.7.3.2
result.results.maximumMajorViolationlongUsed with the maxMajorViolation field to define a range of the acceptable number of major violations for an inspection.7.3.2
result.results.maximumScorelongUsed with the minScore field to define a range of acceptable values for an inspection.7.3.2
result.results.minimumMajorViolationlongUsed with the maxMajorViolation field to define a range of the acceptable number of major violations for an inspection.7.3.2
result.results.minimumScorelongUsed with the maxScore field to define a range of acceptable values for an inspection.7.3.2
result.results.resultresult.results.result{}The returned result.7.3.2
result.results.result.textstringThe localized display text.7.3.2
result.results.result.valuestringThe value for the specified parameter.7.3.2
result.results.resultTypestringThe 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 app7.3.2
statusintegerThe record status.7.3.3

Example

Sample Response Body

{
  "status": 200,
  "result": {
    "group": "BLD_STANDARD",
    "results": [
      {
        "displayOrder": 1,
        "resultType": "APPROVED",
        "group": "BLD_STANDARD",
        "result": {
          "value": "Passed",
          "text": "Passed"
        }
      },
      {
        "displayOrder": 2,
        "resultType": "DENIED",
        "group": "BLD_STANDARD",
        "result": {
          "value": "Rejected",
          "text": "Rejected"
        }
      },
      {
        "displayOrder": 3,
        "resultType": "APPROVED",
        "group": "BLD_STANDARD",
        "result": {
          "value": "Partial",
          "text": "Partial"
        }
      },
      {
        "displayOrder": 4,
        "resultType": "DENIED",
        "group": "BLD_STANDARD",
        "result": {
          "value": "Cancelled",
          "text": "Cancelled"
        }
      },
      {
        "displayOrder": 5,
        "resultType": "APPROVED",
        "group": "BLD_STANDARD",
        "result": {
          "value": "OK for Service",
          "text": "OK for Service"
        }
      }
    ]
  }
}