Swap Recommendations Settings Profiles

This resource provides a set of operations that allows you to manipulate Scheduling swap recommendation settings.

When employees request to swap shifts, recommendations show employees a list of shifts in order from the best matches. The best matches have a rating of the closeness of the match and a message that describes the reason for the recommendation.

To generate recommendations, the system considers the following:

• The employee's history of shift swaps:
  • Often swap with specific employees
  • Often work a specific day
  • Often work a specific combination of days
  • Often work a specific job
  • Often work at a specific location
• The employee's explicit preferences:
  • Match a preferred job
  • Match a preferred availability
  • Match a preferred work zone
  • Willingness to work more hours
• The employee's inferred preferences:
  • Similarity to the shift that is offered
  • Similarity to a shift that the employee usually works
  • Shift duration
  • Shift time
  • Shift job or location
  • Match to skills & certification
  • Work with a person that the employee often works with
  • Work with friends

Operations

---

Create Swap Recommendations Settings Profile
POST /v1/scheduling/setup/swap_recommendations_settings

---

Delete Swap Recommendations Settings Profile
DELETE /v1/scheduling/setup/swap_recommendations_settings/{id}

---

Retrieve All Swap Recommendations Settings Profiles or by Name
GET /v1/scheduling/setup/swap_recommendations_settings

---

Retrieve Swap Recommendations Settings Profile by ID
GET /v1/scheduling/setup/swap_recommendations_settings/{id}

---

Retrieve Swap Recommendations Settings Profiles
POST /v1/scheduling/setup/swap_recommendations_settings/multi_read

---

Update Swap Recommendations Settings Profile
PUT /v1/scheduling/setup/swap_recommendations_settings/{id}