Cascade Profile Assignments

You can assign, update, delete, and retrieve details about cascade profile assignments using operations against the v1/commons/persons/cascade_profile resource.

Prerequisites

A person's person ID is the same as the personKey and employee ID, and is not the same as the person number.

The person in this example has a person ID of 100 and a person number of 20190.

Example

In this example, we assign, verify, update, and delete a person's cascade profile assignments.

Create the assignment

The create request:

• uses personIdentity to identify the person using their person number
• uses assignmentProfile to define the cascade profile to assign

Note: Cascade profile assignments are not effective dated.

Example request

Call PUT /v1/commons/persons/cascade_profile with the following request payload.

{
  "personIdentity": {
    "personNumber": "20190"
  },
  "assignmentProfile": "Days Time Off"
}

Example response

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

{
  "assignmentProfile": "Days Time Off",
  "personIdentity": {
    "personNumber": "20190"
  }
}

Verify the assignment

To verify, you can call GET /v1/commons/persons/cascade_profile?person_number={personNumber} or GET /v1/commons/persons/cascade_profile/{personId}.

Calling GET /v1/commons/persons/cascade_profile?person_number=20190 or GET /v1/commons/persons/cascade_profile/{personId} returns:

{
  "assignmentProfile": "Days Time Off",
  "personIdentity": {
    "personNumber": "20190"
  }
}

Update the assignment

To update the person's cascade profile assignments, call PUT /v1/commons/persons/cascade_profile with the following request payload.

Note: The PUT operation replaces the existing cascade profile assignment with the new assignment.

Example request

{
  "personIdentity": {
    "personNumber": "20190"
  },
  "assignmentProfile": "All Cascades"
}

Example response

{
  "assignmentProfile": "All Cascades",
  "personIdentity": {
    "personNumber": "20190"
  }
}

Delete an assignment

To delete a person's cascade profile assignment, call DELETE /v1/commons/persons/cascade_profile with the following request payload.

{
  "personIdentity": {
    "personNumber": "20190"
  }
}

The system returns HTTP status 204 with no response body.

Note: You can verify the DELETE operation by calling GET /v1/commons/persons/cascade_profile?person_number=20190.