This is an overall explanation of the steps involved:
Mining Job Application Questions: The process starts by sending an HTTP request to the UBIO API with the URL of the job post form and a unique jobPostId. This request "mines" the job application questions from the web page and adds them to the UBIO database.
Retrieving Job Application Questions: Once the job post questions are mined and stored in the database, you can retrieve them using another API call. You provide the jobPostId to fetch the corresponding questions.
The service to mine job questions may have a few different states along its run: queued, processing, failed and mined answers/questions.
When status is failed, jobs should be recreated (possibly, with new params) manually, as the mining service doesn't have a mechanism for auto-retry.
When answers/questions are present in response retrieved, the service succeeded mining questions for job post.
Creating a Job Post Application: To make a job post application on behalf of a user, you need to initiate an automation job using the AutomationCloud API. The inputs required for the application are obtained from the retrieved job application questions. These inputs should be passed to the API endpoint as key-value pairs.
Terms and Conditions: Before submitting the application, the user must consent to the terms and conditions specified.
Submission: The application has been submitted, and you can confirm its status.
This process enables the automation of job applications by extracting application questions, retrieving them when needed, and using the obtained information to create job post applications through the AutomationCloud API.
To access the API, authenticate your requests using basic HTTP authentication. Include a SECRET_KEY value as the username, which will be provided by UBIO. Use your SECRET_KEY and follow instructions for authentication.
In order to allow your users to apply for job posts, they need to be added to the UBIO database. This process ensures that the job application questions are “mined” from the job post web page so that you are able to use them to build the application forms on your website.
The mining process is performed by sending an HTTP request to the UBIO API with the URL of the job post form on the ATS and your jobPostId, which you will use to refer to the job post going forward.
The jobPostId is confirmed in the response - as well as the status of the related mining job. When mining a new job this will be queued or processing.
Making a further submission with the same jobPostId will result in overriding the previous results once the mining is complete.
Once a job post has been "mined", its questions can be retrieved from the database with the following API call. The jobPostId must be the same value as the jobPostId value used when initally mining the job post questions.
The response returned depends upon the status of the "mining" job. It may be queued, processing, failed or will return the complete list of questions when complete as per the example below.
Mining jobs with answers/questions or status failed in response, means they reached a final state. When status is failed, jobs should be recreated (possibly, with new params) manually, as the mining service doesn't have a mechanism for auto-retry.
The response includes a serviceId value. This will be used when making an automation - and is required to ensure the correct automation service is used when the job application is made.
Also included in the response are the answers used when 'mining' the job post. This can be useful when preparing test applications.
👆 Mining failed. Note that, error code may be "JobErrorEarlyFail" which is temporary, and a definitive code will be placed soon.
{"jobPostId":"testJobXYZ","serviceId":"5a6aa018-3547-465a-932f-89254c3bbf2f","answers":[{"id":"how-did-you-hear-about-us","value":"Job Board"},{"id":"countryregion","value":"United States Of America"},"..."],"questions":[{"key":"availableDynamicQuestions:fe5b1f787abead6a73c5200cde99254a2e1fd049","data":[{"id":"how-did-you-hear-about-us","question":"How Did You Hear About Us?","inputType":"SelectOne","options":[{"answer":"AGEFIPH","conditionalQuestions":[]},{"answer":"Campus Recruitment Fair","conditionalQuestions":[]},"..."],"mandatory":true,"hidden":false,"label":"My Information"},"..."]},{"key":"availableDynamicQuestions:a09a81f1154ac113429c58de52ed9bba97755d8b","data":[{"id":"what-is-your-gender","question":"What is your gender?","inputType":"SelectOne","options":[{"answer":"Divers (Germany and Austria only)","conditionalQuestions":[]},{"answer":"Female","conditionalQuestions":[]},"..."],"hidden":false,"label":"Voluntary Disclosures"},"..."]},"..."]}
# Making a job post application on behalf of a user
In order to make an application to a job post on behalf of a user, you must initiate an automation job with the AutomationCloud API (please note “automation job” is our internal term for an automation session and has no relation to “job post”).
The inputs required for the job post application will be defined by the response from the question retrieval service. These must be passed to the API endpoint by key as per the standard Automation Cloud documentation. Refer to Automation Cloud - Create a Job API.
The serviceId used can be found via the /find endpoint.
This request will return an id value - this is the jobId and is used to interact with the automation job once it has been created.
To check the status of the job application, refer to the 'job' created in the previous POST request. Use the jobId to query the /jobs endpoint, which will return the job's status. It will confirm whether the job was successful. In case of failure, an error code and message will be included.
