Gets all available status values for use in an inspection.
| Scope | inspections Deprecated scope name: get_settings_inspection_statuses |
| App Type | All |
| Authorization Type | Access token |
| URI | /v4/settings/inspections/statuses?lang={lang}&fields={fields}&group={group} |
| 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 |
| group | string | No | � | The group query parameter. | 7.3.2 |
| lang | String | No | � | Indicates the language applied. | 7.3.2 |
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
| Field | Type | Description | Automation Version |
|---|---|---|---|
| result[] | result{} | The inspection result status group. | 7.3.2 |
| result.group | string | The inspection status group. | 7.3.2 |
| result.results[] | result.results{} | Contains preset field values for inspection statuses. | 7.3.2 |
| result.results.displayOrder | long | The order of the item in comparison to the other items. | 7.3.2 |
| result.results.group | string | The inspection status group for the inspection status value. | 7.3.2 |
| result.results.maximumMajorViolation | long | Used with the maxMajorViolation field to define a range of the acceptable number of major violations for an inspection. | 7.3.2 |
| result.results.maximumScore | long | Used with the minScore field to define a range of acceptable values for an inspection. | 7.3.2 |
| result.results.minimumMajorViolation | long | Used with the maxMajorViolation field to define a range of the acceptable number of major violations for an inspection. | 7.3.2 |
| result.results.minimumScore | long | Used with the maxScore field to define a range of acceptable values for an inspection. | 7.3.2 |
| result.results.result | result.results.result{} | The returned result. | 7.3.2 |
| result.results.result.text | string | The localized display text. | 7.3.2 |
| result.results.result.value | string | The value for the specified parameter. | 7.3.2 |
| result.results.resultType | string | 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 | 7.3.2 |
| status | integer | The record status. | 7.3.3 |
{
"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"
}
}
]
}
}