Get All Inspectors

Gets a list of inspectors in the agency database.

Resource Information

Scopeinspections

Deprecated scope name:   get_inspectors

App TypeAgency
Authorization TypeAccess token
URI /v4/inspectors?lang={lang}&department={department}
HTTP MethodGET
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
departmentstringNo Get All Departments The name of the department where the inspector works. 7.3.2
langStringNo Indicates the language applied.7.3.2

Example

Sample Request Head

GET https://apis.accela.com/v4/inspectors?department=ISLANDTON/BUILDING/NA/NA/NA/NA/NA

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/inspectors?department=ISLANDTON/BUILDING/NA/NA/NA/NA/NA

Response Information

FieldTypeDescriptionAutomation Version
resultresult{} 7.3.2
result.departmentresult.department{}The name of the department where the inspector works. 7.3.2
result.department.textstringThe localized display text.7.3.2
result.department.valuestringThe value for the specified parameter.7.3.2
result.firstNamestringThe contact's first name. This field is only active when the Contact Type selected is Individual.7.3.2
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.lastNamestringThe last name (surname). 7.3.2
result.middleNamestringThe middle name. 7.3.2
statusintegerThe record status.7.3.3

Example

Sample Response Body

{
  "status": 200,
  "result": [
    {
      "firstName": "Mobile",
      "lastName": "Inspector",
      "id": "MINSPECTOR",
      "department": {
        "value": "ISLANDTON/BUILDING/NA/NA/NA/NA/NA",
        "text": "Building"
      }
    },
    {
      "firstName": "Building",
      "lastName": "Admin",
      "id": "BUILDADMIN",
      "department": {
        "value": "ISLANDTON/BUILDING/NA/NA/NA/NA/NA",
        "text": "Building"
      }
    },
    {
      "firstName": "Building",
      "lastName": "Inspector",
      "id": "BINSPECTOR",
      "department": {
        "value": "ISLANDTON/BUILDING/NA/NA/NA/NA/NA",
        "text": "Building"
      }
    },
    {
      "firstName": "Building",
      "lastName": "Daily",
      "id": "BUILDDAILY",
      "department": {
        "value": "ISLANDTON/BUILDING/NA/NA/NA/NA/NA",
        "text": "Building"
      }
    },
    {
      "firstName": "Brad",
      "lastName": "Islandton",
      "id": "BRADP",
      "department": {
        "value": "ISLANDTON/BUILDING/NA/NA/NA/NA/NA",
        "text": "Building"
      }
    },
    {
      "firstName": "Mobile",
      "lastName": "Developer",
      "id": "MDEVELOPER",
      "department": {
        "value": "ISLANDTON/BUILDING/NA/NA/NA/NA/NA",
        "text": "Building"
      }
    },
    {
      "id": "RCAREL",
      "department": {
        "value": "ISLANDTON/BUILDING/NA/NA/NA/NA/NA",
        "text": "Building"
      }
    },
    {
      "firstName": "Wesley",
      "middleName": "A",
      "lastName": "Ruiz",
      "id": "WRUIZ",
      "department": {
        "value": "ISLANDTON/BUILDING/NA/NA/NA/NA/NA",
        "text": "Building"
      }
    },
    {
      "firstName": "R",
      "lastName": "Mok",
      "id": "RMOK",
      "department": {
        "value": "ISLANDTON/BUILDING/NA/NA/NA/NA/NA",
        "text": "Building"
      }
    },
    {
      "firstName": "Chuck",
      "lastName": "Spink",
      "id": "CSPINK",
      "department": {
        "value": "ISLANDTON/BUILDING/NA/NA/NA/NA/NA",
        "text": "Building"
      }
    },
    {
      "firstName": "Jeff",
      "lastName": "Roberts",
      "id": "JEFFR",
      "department": {
        "value": "ISLANDTON/BUILDING/NA/NA/NA/NA/NA",
        "text": "Building"
      }
    }
  ]
}