Get All Inspection Grades

Gets all available grades for use in an inspection.

Resource Information

Scopeinspections

Deprecated scope name:   get_settings_inspection_grades

App TypeAll
Authorization TypeAccess token
URI /v4/settings/inspections/grades?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/grades

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'
     -H 'x-accela-appid: 635355074966095701'
     -X GET https://apis.accela.com/v4/settings/inspections/grades

Response Information

FieldTypeDescriptionAutomation Version
result[]result{}The inspection grade group.7.3.2
result.grades[]result.grades{}Contains the inspection grades.7.3.2
result.grades.graderesult.grades.grade{}The name of the inspection grade. 7.3.2
result.grades.grade.textstringThe localized display text.7.3.2
result.grades.grade.valuestringThe value for the specified parameter.7.3.2
result.grades.gradeImagestringThe link to an image file associated to the inspection grade.7.3.2
result.grades.groupstringThe inspection grade group for the inspection grade value.7.3.2
result.grades.maximumMajorViolationlongUsed with the maxMajorViolation field to define a range of the acceptable number of major violations for an inspection.7.3.2
result.grades.maximumScorelongUsed with the minScore field to define a range of acceptable values for an inspection.7.3.2
result.grades.minimumMajorViolationlongUsed with the maxMajorViolation field to define a range of the acceptable number of major violations for an inspection.7.3.2
result.grades.minimumScorelongUsed with the maxScore field to define a range of acceptable values for an inspection.7.3.2
result.groupstringThe inspection grade group. An inspection grade group is a set of predefined grades for inspections.7.3.2
statusintegerThe record status.7.3.3

Example

Sample Response Body

{
  "status": 200,
  "result": {
    "group": "",
    "grades": [
      {
        "maximumScore": 100,
        "minimumScore": 60,
        "group": "BLD_GG1",
        "grade": {
          "value": "Passed",
          "text": "Passed"
        }
      },
      {
        "maximumScore": 60,
        "minimumScore": 10,
        "group": "BLD_GG1",
        "grade": {
          "value": "Failed",
          "text": "Failed"
        }
      }
    ]
  }
}