Leave Profile Assignments

Note: Leave Reasons are not a part of Leave Profiles. All Leave Reasons are available to all employees.

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 profile assignments.

Create or update assignments

The create or update request:

uses personIdentity to identify the person using their person number
uses leaveProfile inside personAssignments to define the Leave profile to assign

Note: Leave profile assignments are not effective dated.

Example request

Call POST /v1/commons/persons/assignments/multi_upsert with the following request payload.

[
    {
        "personIdentity": {
            "personNumber": "10032"
        },
        "personAssignments": {
            "leaveProfile": {
                "assignmentProfile": "DC Leave"
            }
        }
    },
    {
        "personIdentity": {
            "personNumber": "20032"
        },
        "personAssignments": {
            "leaveProfile": {
                "assignmentProfile": "Full Time Profile"
            }
        }
    }
]

Example response

A success response returns HTTP status code 200 and a response body similar to the following example.

[
    {
        "personIdentity": {
            "personNumber": "10032"
        },
        "personAssignments": {
            "leaveProfile": {
                "assignmentProfile": "DC Leave"
            }
        }
    },
    {
        "personIdentity": {
            "personNumber": "20032"
        },
        "personAssignments": {
            "leaveProfile": {
                "assignmentProfile": "Full Time Profile"
            }
        }
    }
]

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": [
        "10032","20032"
      ]
    },
    "personAssignments": [
    "leaveProfile"
  ]
  }
}

Example response

A success response returns HTTP status code 200 and a response body similar to the following example.

[
    {
        "personIdentity": {
            "personNumber": "10032"
        },
        "personAssignments": {
            "leaveProfile": {
                "assignmentProfile": "DC Leave"
            }
        }
    },
    {
        "personIdentity": {
            "personNumber": "20032"
        },
        "personAssignments": {
            "leaveProfile": {
                "assignmentProfile": "Full Time Profile"
            }
        }
    }
]

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 profile assignments.

In the following example, the system makes no changes. Setting a null assignmentProfile 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": {
            "leaveProfile": {
                "assignmentProfile":null
            }
        }
    },
    {
        "personIdentity": {
            "personNumber": "10030"
        },
        "personAssignments": {
            "leaveProfile": {
                "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": {
            "leaveProfile": {}
        }
    },
    {
        "personIdentity": {
            "personNumber": "10030"
        },
        "personAssignments": {
            "leaveProfile": {}
        }
    }
]

Delete assignments

You can delete, or unassign, Leave profile assignments. To delete our example's Leave profile 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": "10032"
        },
        "personAssignments": {
            "leaveProfile": {
               "unAssignExisting": true
            }
        }
    },
    {
        "personIdentity": {
            "personNumber": "20032"
        },
        "personAssignments": {
            "leaveProfile": {
                "unAssignExisting": true
            }
        }
    }
]

Example response

A success response returns HTTP status code 200 and a response body similar to the following example.

[
    {
        "personIdentity": {
            "personNumber": "10032"
        },
        "personAssignments": {
            "leaveProfile": {}
        }
    },
    {
        "personIdentity": {
            "personNumber": "20032"
        },
        "personAssignments": {
            "leaveProfile": {}
        }
    }
]

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.