How to Create and Update Employee Skills

Prerequisites

Before starting, ensure you have the following:

• Access to Safety and Skills APIs.
• An API Client (Client ID and Secret) used to generate an authentication token for API utilization.
• API Client must possess necessary scopes: dis:read dis:write skills:read skills:write on token generation.

📘

Refer to the Getting Started with Request Tokens guide for details on how to authenticate.

Step 1: Retrieve Business Units

🔄

Use the Setups GET Business Units endpoint for this step.

Purpose: Get the list of business units within your organization. The returned code is required for retrieving employees in the next step.

Response: The response will provide one or more business units with a code field, this code is your businessUnitCode. Choose a businessUnitCode and use it for the next steps.

Step 2: Retrieve Employees in a Business Unit

🔄

Use the Setups GET Employees endpoint with the previously acquired business unit code for this step.

Purpose: Retrieve employees within the business unit.

Response: The response will provide a list of employees, each employee has a code field. This code is the EmployeeCode which is necessary to identify a specific Employee and manage their skills using the API.

Step 3: Retrieve Available Skills

🔄

Use the Skills GET a List of Skills endpoint for this step.

Purpose: Get the list of available skills that can be assigned to employees.

Response: The response will include a list of skills available to be assigned. You will need the Name or Course Code to assign an existing skill to an employee.

🔗

If the skill you want doesn't exist, you can create a new skill using the Skills POST Endpoint

Step 4: Assign or Update Skills for an Employee

🔄

Use the Skills EmployeeSkills POST upsert endpoint for this step.

Purpose: Once you have the employee code that references the employee you want and the skill name and/or CourseCode, you can now assign or update skills for the employee.

Response: The response will confirm the skill assignment or update for the selected employee.

🔗

You can archive/dismiss a skill if it is invalid or no longer in use. To do this, you can change the IsDismissed field to true when sending a request to the EmployeeSkills POST Endpoint

Additional Notes

🔄

You may use the Import List of Skills POST Endpoint to upsert multiple skills at a time for multiple employees. This endpoint is more advanced than the one covered in this guide.

🛑

Deleting a skill using the Skills DELETE Endpoint will delete the targeted skill for ALL employees.

Troubleshooting

⚠️

If you encounter any issues, please refer to the Getting Started with Request Tokens guide or contact support for further assistance.