Leave Administrator Assignments - Aggregated
You can assign an administrator to Leave employees. The employees passed in must be valid Leave employees. The administrator passed in must be a valid Timekeeper manager.
Prerequisites
A person ID is the same identifier as personKey and employee ID, and is not the same as a person number.
Example
In this example, we assign, verify, delete, and pass a request that makes no change to multiple people's Leave administrator assignments.
Create or update assignments
The create or update request:
- uses
personIdentityto identify the person using their person number - uses
administratorinsideleaveAdminto define the Leave administrator to assign
Example request
Call POST /v1/commons/persons/assignments/multi_upsert with the following request payload.
[
{
"personIdentity": {
"personNumber": "10020"
},
"personAssignments": {
"leaveAdmin": {
"administrator": {
"displayName": "Allen, Barry (444111)",
"fullName": "Allen, Barry",
"personNumber": "444111"
}
}
}
},
{
"personIdentity": {
"personNumber": "10030"
},
"personAssignments": {
"leaveAdmin": {
"administrator": {
"displayName": "Allen, Barry (444111)",
"fullName": "Allen, Barry",
"personNumber": "444111"
}
}
}
}
]
Example response
A success response returns HTTP status code 200 and a response body similar to the following example.
[
{
"personIdentity": {
"personNumber": "10020"
},
"personAssignments": {
"leaveAdmin": {
"administrator": {
"displayName": "Allen, Barry (444111)",
"fullName": "Allen, Barry",
"personNumber": "444111"
}
}
}
},
{
"personIdentity": {
"personNumber": "10030"
},
"personAssignments": {
"leaveAdmin": {
"administrator": {
"displayName": "Allen, Barry (444111)",
"fullName": "Allen, Barry",
"personNumber": "444111"
}
}
}
}
]
Verify assignments
You can use the bulk multi-read operation to verify assignments for multiple people at once.
Example request
To verify, call POST /v1/commons/persons/assignments/multi_read with the following request payload.
{
"where": {
"employees": {
"key": "personNumber",
"values": [
"10020",
"10030"
]
},
"personAssignments": [
"leaveAdmin"
]
}
}
Example response
A success response returns HTTP status code 200 and a response body similar to the following example.
[
{
"personIdentity": {
"personNumber": "10020"
},
"personAssignments": {
"leaveAdmin": {
"administrator": {
"displayName": "Allen, Barry (444111)",
"fullName": "Allen, Barry",
"personNumber": "444111"
}
}
}
},
{
"personIdentity": {
"personNumber": "10030"
},
"personAssignments": {
"leaveAdmin": {
"administrator": {
"displayName": "Allen, Barry (444111)",
"fullName": "Allen, Barry",
"personNumber": "444111"
}
}
}
}
]
Make no change to assignments
When working with large numbers of people, you may wish to pass a request payload that makes no changes to a person's Leave administrator assignments.
In the following example, the system makes no changes. Setting a null administrator and passing the unAssignExisting Boolean as false both result in no changes to a person's assignments.
Example request
Call POST /v1/commons/persons/assignments/multi_upsert with the following request payload.
[
{
"personIdentity": {
"personNumber": "10020"
},
"personAssignments": {
"leaveAdmin": {
"administrator":null
}
}
},
{
"personIdentity": {
"personNumber": "10030"
},
"personAssignments": {
"leaveAdmin": {
"unAssignExisting":false
}
}
}
]
Example response
A success response returns HTTP status code 200 and a response body similar to the following example.
[
{
"personIdentity": {
"personNumber": "10020"
},
"personAssignments": {
"leaveAdmin": {}
}
},
{
"personIdentity": {
"personNumber": "10030"
},
"personAssignments": {
"leaveAdmin": {}
}
}
]
Delete assignments
You can delete, or unassign, Leave administrator assignments. To delete our example's Leave administrator assignments, call POST /v1/commons/persons/assignments/multi_upsert using the unAssignExisting property.
Example request
Call POST /v1/commons/persons/assignments/multi_upsert with the following request payload.
[
{
"personIdentity": {
"personNumber": "10020"
},
"personAssignments": {
"leaveAdmin": {
"unAssignExisting": true
}
}
},
{
"personIdentity": {
"personNumber": "10030"
},
"personAssignments": {
"leaveAdmin": {
"unAssignExisting": true
}
}
}
]
Example response
A success response returns HTTP status code 200 and a response body similar to the following example.
[
{
"personIdentity": {
"personNumber": "10020"
},
"personAssignments": {
"leaveAdmin": {}
}
},
{
"personIdentity": {
"personNumber": "10030"
},
"personAssignments": {
"leaveAdmin": {}
}
}
]
Note: You can verify that the assignments were deleted by calling POST /v1/commons/persons/assignments/multi_read with a request payload specifying all of the affected person identities.
Updated about 1 year ago