POST
to /employees
to create an Employee,
to /vacancies
to create a Vacancy). The sequence diagram below shows the flow
for a single Employee. Its structure would be identical for other Entity types,
and adding multiple Employees is just a matter of repeating the flow.
After the initial creation, the Entity can be updated through its
Entity-specific endpoint, e.g. /employees/101
for an Employee with ID 101.
The lifecycle of each Entity is managed explicitly, meaning that you cannot
overwrite an existing Entity with a POST message. To update an Entity, you can
execute a PATCH call at its specific endpoint.
Providing Profile Feedback
After the creation of a skill profile for an Employee or Vacancy, you or your user might still have something to add (or remove). Taking this feedback into account makes for a win-win situation; improving the user experience, the quality of your data and the accuracy of any matches generated. This can be done by sending aPUT
request to respectively
the /employees/{external_id}/skill_profile
and /vacancies/{external_id}/skill_profile
endpoint.