An overview of new Interview Coordinator (IC) API methods which control and configure the candidate application process.


In this article we will give a brief outline of the new API methods being developed and published for our Interview Coordinator (IC) applicant tracking (ATS) and video interview system.

As we have mentioned in previous articles, the additions to the IC API are designed to allow customer websites and 3rd party developers to interact with the IC database to build a fully customizable web based candidate application process which can easily be configured to match the most appropriate application process for specific vacancies.

Here is a list of API methods used in the customized candidate application process

../api/CreateCandidate/CreateNewCandidate

As the name suggests, the Create New Candidate API will create a new candidate record in the IC database and associate the new record with a specific vacancy/campaign. This, and all the other api methods can be called from any of the standard web programming languages.

When configuring a CreateNewCandidate API request, there are a series of compulsory and optional parameters which trigger server side logic functions. We will provide more details about these parameters in a following article, However, as an example, one of the default logic functions will use the candidate email address value to determine whether the candidate has already applied for the vacancy. If so, the api will send the appropriate notification response to the external website or program, so that it can react accordingly.

../api/UplaodDocuments/createCandidateDocuments

&

../api/UploadDocuments/uploadApplicationDocuments

As part of most vacancy application processes, the candidate will be required to upload one or more documents which support their application for the job being advertised.

The “createCandidateDocuments” and “uploadApplicationDocuments” API methods provide a way to upload documents into the Interview Coordinator database which will automatically be associated with a candidate record.

Both API methods achieve the same end result. However the difference lies in the “authentication” method used to determine whether the request originates from an authorised source. The createCandidateDocuments method uses the top level secret API key given to each IC customer / partner. The uploadApplicationDocuments method uses a SessionID authentication so that a browser based javascript or php program can upload documents but still maintain full API key security.

As with all the IC API methods, there will be optional parameters for this method, to allow for multiple different “use case” scenarios. One example is a parameter flag which tells the API logic how to respond if the upload documents task is the final part of application process – as opposed to an individual step in a longer, multi-stage process.

../api/Questions/GetQuestions

A GetQuestions API request will return a list of questions to be answered by the candidate as part of the vacancy application or candidate screening process. The request response will return the information on how the hiring manager has requested that the candidate respond to each question (I.E. a typed/text based response or a video based response) and also the “answered status” of each question, The answer status determines whether the candidate has already responded, or has yet to provide an answer for this question.

../api/Questions/GetAnswer

A request to this API method will get a response which provides the question status and any question responses already provided by the candidate.

../api/Questions/SaveAnswer

This API method is used to save the candidate text and/or video response to a specific question.

../api/Application/CompleteApplication

A CompleteApplication request will tell Interview Coordinator that the full application process is now complete and finished. The configurable parameters for this request will tell Interview Coordinator who to notify that an candidate application has been completed .

../api/Application/CheckApplication

This method is an individual subset of the logic used in the createnewCandidate request. It is used to determine whether the candidate has already applied for the vacancy

 

==================

Find out more …..

The Interview Coordinator (IC) API aims to make it easy for your own corporate careers website to interact directly with an Applicant Tracking and Video Interview system which manages the full recruitment process from application to hiring.

You can see an example of a site which uses the above API methods to configure multiple different application processes at : http://bootstrap.interviewcoordinator.com/vacancylist.html

If you would like to find out more about using the IC API to make your candidate application process more customizable and efficient, please contact sales@interviewcoordinator.com