This customizable operation returns all persons in the system according to the specified parameters. The where property is required. The index and count pagination properties are optional and default to 0 and 10,000, respectively.
The associated Access Control Point is LIGHT_WEIGHT_EMPLOYEE_RECORDS_READ.
The following examples demonstrate typical use cases for retrieving all persons.
Example 1
To return the most detailed response supported by this operation, use a request payload similar to the following example:
{
"where": {},
"index": 0,
"count": 1000
}
Since the returnPersonIdOnly Boolean defaults to false, the payload above is functionally identical to the following:
{
"where": {
"returnPersonIdOnly": false
},
"index": 0,
"count": 1000
}
Example 2
To return only the person IDs of all employees, use a request payload similar to the following example:
{
"index": 0,
"count": 1000,
"where": {
"returnPersonIdOnly": true
}
}
Example 3
To return all employees who currently have an active employee status, use a request payload similar to the following example:
{
"index": 0,
"count": 1000,
"where": {
"employmentStatus": "active"
}
}
Example 4
To return all employees who currently have an active employee status and an active user account status, use a request payload similar to the following example:
{
"index": 0,
"count": 1000,
"where": {
"employmentStatus": "active",
"userAccountStatus": "active"
}
}
Example 5
To return all employees who have an active employee status and an active user account status as of January 1, 2022, use a request payload similar to the following example:
{
"index": 0,
"count": 1000,
"where": {
"snapshotDate": "2022-01-01",
"employmentStatus": "active",
"userAccountStatus": "active"
}
}
Other Examples
The following collection of examples of valid requests covers other use cases:
{
"index": 0,
"count": 1000,
"where": {
" snapshotDate ": "2022-01-01",
"employmentStatus": "active",
"userAccountStatus": "active",
"returnPersonIdOnly": true
}
}
{
"index": 0,
"count": 1000,
"where": {
"snapshotDate": "2022-01-01",
"employmentStatus": "inactive",
"userAccountStatus": "inactive",
"returnPersonIdOnly": false
}
}
{
"index": 0,
"count": 1000,
"where": {
"snapshotDate": "2022-01-01",
"employmentStatus": "active",
"userAccountStatus": "inactive",
"returnPersonIdOnly": false
}
}
{
"index": 0,
"count": 1000,
"where": {
" snapshotDate": "2022-01-01",
"employmentStatus": "inactive",
"userAccountStatus": "active",
"returnPersonIdOnly": false
}
}