(Quick Reference)
Service: List of employees
Description: This web service returns the list of employees in JSON format.
URL:
https://BASE_URL/api/VERSION/employees
: GET
Parameters:
Pagination parameters:
| Name | Description | Type | Required | Possible values |
|---|
| max | Limits the number of resources requested to return. | Integer | no | |
| offset | Tells where to start returning records from the entire set of results. | Integer | no | |
| order | Orders ascending or descending. | Integer | no | asc,desc |
| sort | Orders the results by the specified field. | String | no | |
The max parameter is set to 100 by default.
Filters parameters:
| Name | Description | Type | Required | Example values |
|---|
| dateCreated_gt | Filters by the resource's creation date time and operator greater than | Date | no | 2016-08-15T14:52:48Z |
| dateCreated_gte | Filters by the resource's creation date time and operator greater than or equal | Date | no | |
| dateCreated_lt | Filters by the resource's creation date time and operator less than | Date | no | |
| dateCreated_lte | Filters by the resource's creation date time and operator less than or equal | Date | no | |
| lastUpdated_gt | Filters by the resource's last-modified date time and operator greater than | Date | no | |
| lastUpdated_gte | Filters by the resource's last-modified date time and operator greater than or equal | Date | no | |
| lastUpdated_lt | Filters by the resource's last-modified date time and operator less than | Date | no | |
| lastUpdated_lte | Filters by the resource's last-modified date time and operator less than or equal | Date | no | |
| reference | Wildcard search by the resource's reference | String | no | reference=Ref-6* , reference=*ef-6 , reference=*ef-6* |
Dates should be formatted as the ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ)
Success Output
Success case: response.status=200
{
"paging": {
"total": 20,
"max": 5,
"offset": 0,
"previous": null,
"next": "/api/v1.0/employees?max=5&sort=dateCreated&order=desc&offset=5"
},
"data": [
{
"id": 22,
"reference": "emp22",
"firstName": "Jane",
"lastName": "Doe",
"mobile": "001-555-555-1212",
"enabled": true,
"managerReference": "emp-00",
"employeeGroupReference": "60837-111",
"manager": {
"id": 3,
"reference": "emp-00",
"href": "/api/v1.0/employees/3"
},
"employeeGroup": {
"id": 1,
"reference": "60837-111",
"name": "Group1",
"href": "/api/v1.0/employeeGroups/1"
},
"avatar": null,
"organization": "entity1",
"dateCreated": "2016-08-17T13:45:17Z",
"lastUpdated": "2016-08-17T13:45:17Z"
},
…
]
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param",
"error_description": "The parameters [dateCreated_gta] you provided are not valid for this request."
}{
"error": "invalid_datetime_format",
"error_description": "Invalid datetime filter (not ISO-8601 formatted): [2016-08-1Z]"
} Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}
