Use Case Description
This use case is for updating the details of an existing applicant whose onboarding process has been initiated, but yet to be completed. The endpoint takes applicantID, returned in the response for the initiate Onboarding request, as a parameter in the Uniform Resource Locator (URL) to identify the applicant. The schema of the payload for this endpoint remains the same as that of initiate onboarding. However, the response consists of either a success or failure message only and doesn't return any ID unlike the initiate onboarding request.
API Usage
|
Method |
URI |
Description |
GitHub Sample Request Payload |
GitHub Sample Response Payload |
|---|---|---|---|---|
| PUT | hcm/v2/applicants/{applicantid}/onboarding |
Update the existing applicant onboarding details. |
UpdateApplicant_Success_Response.json
|
|
| GET | hcm/v2/applicants/{applicantid}/onboarding/meta | Returns an applicant's metadata. |
NA |
Application Scope
The following canonicals need to be added to your application scope to enable this use case:
/hcm/integrationManagement/applicantOnboardingManagement/onboardingProcessManagement/
applicantOnboarding.meta.read
/hcm/integrationManagement/applicantOnboardingManagement/onboardingProcessManagement/
applicantOnboarding.modify
Request Header Parameters
There are no request header parameters.
Supported Actors
|
Request Parameter roleCode Value |
Usage |
|---|---|
| Practitioner | Update the existing applicant onboarding details as a practitioner. A system user is considered a practitioner. |
Fields Not Supported for Data Retrieval/Update
See Chapter 9 - Fields Not Supported for Data Retrieval/Update.
Sequence of Interactions
Data Dictionary
See Chapter 7 - Data Dictionary.
Responses
You may encounter exceptions outside your common success scenarios. You must account for these exceptions during your initial development.
See Chapter 8 - Responses. For more information, go to API Common Exceptions and Tips for Handling.
