This resource allows you to retrieve and manipulate an employee's assignment to (or membership in) various groups. Group assignments are effective dated.
There are two types of employee groups: groups with inheritance and groups without inheritance.
- Groups with no inheritance simply make it easier to view a certain set of employees separately from other employees. The only impact is in the sequence of the list of employees and the ability to collapse the list.
- Groups With Inheritance make it easier to create and modify employee schedules in unison. When you apply a pattern, a shift, a paycode, or an availability status to a group with inheritance, that entity appears in the schedule of all the employees in the group. That entity can be modified or removed from the schedule of all employees with a single command. Individual shifts, paycodes, and availability can also be defined for specific employees at specific times. These entities are not inherited and must be managed at the employee level.
If you modify the schedule of individual employees in a group, the modified entity is un-linked from the group and will no longer be affected by any modification of the original group-based entity.
Operations
Add Group Memberships-Multiple Employees
POST /v1/commons/persons/schedule_groups/multi_create
Add Group Memberships-One Employee
POST /v1/commons/persons/schedule_groups
Remove Group Memberships-Multiple Employees
POST /v1/commons/persons/schedule_groups/multi_delete
Remove Group Memberships-One Employee
POST /v1/commons/persons/schedule_groups/apply_delete
Retrieve Group Memberships by ID
GET /v1/commons/persons/schedule_groups/{personId}
Retrieve Group Memberships by Person Number
GET /v1/commons/persons/schedule_groups
Retrieve Group Memberships-Multiple Employees
POST /v1/commons/persons/schedule_groups/multi_read
Update Group Memberships-Multiple Employees
POST /v1/commons/persons/schedule_groups/multi_upsert
Update Group Memberships-One Employee
PUT /v1/commons/persons/schedule_groups