Use Case Description
A successful API call creates an In progress hire applicant and launches the Employee Setup Wizard in order to complete the hire.
API Usage
|
Method |
Uniform Resource Identifier (URI) |
Description |
GitHub Sample Request Payload |
GitHub Sample Response Payload |
|---|---|---|---|---|
| POST |
hcm/v2/applicant.onboard |
Starts the applicant onboarding process. |
|
|
| GET | hcm/v2/applicant.onboard/meta | Returns an applicant's metadata. |
NA |
Application Scope
The canonical URI corresponding to the Applicant Onboard V2 API needs to be added in the Consumer Application Registry (CAR) for the subscription following which a user can access this API and make successful API calls.
The following canonicals need to be added to your application scope to enable this use case:
/hcm/integrationManagement/applicantOnboardingManagement/onboardingProcessManagement/
applicant.onboard
/hcm/integrationManagement/applicantOnboardingManagement/onboardingProcessManagement/
applicant.onboard.meta.read
Request Header Parameters
There are no request header parameters.
Supported Actors
|
Request Parameter roleCode Value |
Usage |
|---|---|
| Practitioner | Starts the applicant onboarding process as a practitioner. A system user is considered a practitioner. |
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.
