Area API | GET Data

API Summary

Endpoint	https://api.feedback.house/api/planning/area/v1/query
Method	GET
Format	JSON

API Pagination

This api always return a object that contains pagination information like those below. This object will have fields iterative and informative. If you don't pass values for skip or limit, it will assume skip: 0 and limit: 100 by default.

Iterative

Name	Description
skip	Specify a number for record return
limit	Specify a threshold for record return

Informative

Name	Description
totalCount	Total count of records
hasPreviousPage	If has a previous page of records
hasNextPage	If has a next page of records

  "pageInfo": Object {
    "hasNextPage": false,
    "hasPreviousPage": false,
    "limit": 100,
    "skip": 0,
    "totalCount": 7,
  },

API details

This endpoint allows querying and retrieving Area data. This API will return the most recent and updated Area as possible.

Given the size of your company you may need to paginate this API in other to retrieve all resources.

Response

This API will return multiple areas in an array of Area (in the format of an array of objects).

areas: [
 { 
    "id": "507f1f77bcf86cd799439011", 
    "name": "Area 1", 
    "users": [
      "507f1f77bcf86cd7911",
      "507f1f77bcf86cd7912",
      "507f1f77bcf86cd7913",
    ], 
    active: true,
    ...
 },
 { 
    "id": "507f1f77bcf86cd799439022", 
    "name": "Area 2", 
    "managers":[
         "507f1f77bcf86cd7994",
         "232507f1f77bcf86cd"
        ], 
    ... 
},
{
    "id": "507f1f77bcf86cd799439033", 
    "name": "Area 3", 
    "parent": "507f1f77bcf86cd799439011",
    ...
}
 ...
]

When no areas are found the array will be empty

areas: []

Error reporting

For each request the API will evaluate each area individually and will report errors per area.

Example for a response with errors:

{
    "status": "ERROR",
    "message": "Invalid search query",
}

Response Fields for each area

The only required fields are name and one of the primary key fields; We strongly recommend that you use additional keys to control how areas are created, otherwise this can lead to duplicated areas.

id [Unique]

Unique ID for this Area. This field is a primary key and should be used whenever this area needs to be updated.

This field can and should be used as primary key to detect if Area will be created or updated when using the Update or create API area Update or Create

name [String]

The area full name. This field is required.

users [[UserId]]

Users that belongs this Area. This field is an array of UserIds users: ["507f1f77bcf86cd7994","507f1f77bcf86cd1234"].

managers [[UserId]]

Users that will have extra privileges for this Area. This field is an array of UserIds managers: ["507f1f77bcf86cd7994","507f1f77bcf86cd1234"].

active [{true,false}]

This field defines if the area is active or not. Valid options are true, false.

parent [AreaId]

Parent Area of this Area. This indicates if this Area is a child of another Area. This setting is optional and is used when setting hierarchies.

businessDivision [BusinessDivisionID]

This field defines the Business Division of Area. This needs to be a valid Business Division ID.

allowCandidatesApply [{true,false}]

If your company have the ATS module enabled this field indicates if this Area is listed on the ATS module as eligible for candidates applications.

tags [[String]]

Arbitrary tags associated with this Area.

Tags can also be expressed in key value format, when using :. Tags that uses the format of key:value, enhancing reports and statics. Example: project:secret, status:new, valid:yes