Interview Coordinator – GetQuestions API request
Api/Questions/GetQuestions
The process of finding the right person to fill a job vacancy might be simplified and summarised as follows : Use any of a number of methods to compile a list of applicants, review their CV’s, and then ask the most appropriate candidates a series of questions until you find the best person for the position.
Our Interview Coordinator ATS software provides an easy way to compile a list of questions that are appropriate to ask at each different stage of the candidate application and selection process. Hiring managers can collaborate with colleagues to create a list of customised “application questions”, “online screening questions”,” telephone interview questions” or “face to face interview questions”
The GetQuestions API method allows a website to retrieve a list of questions to be answered by the candidate at the “application” or “online screening” stages of the recruitment process.
For example, it can save a great deal of time and greatly help select which candidates will progress to the next stage, if you can ask a set of application questions which are specific to the role being filled, at the same time you ask a candidate to enter their details online and submit their CV.
Here is an example GetQuestions request using JSON format :
V2.api.interviewcoordinator
POST /api/Questions/GetQuestions
{“SessionId“: “TKLIFFGGHMHAEZQSLRKILVPHFQURJKQRITGEUIMWNXOPJXVHET”,”QuestionType“: “4”}
This API method is used at the stage of the application process when the candidate has already entered their details and uploaded any supporting documents. The candidate record is stored in the Interview Coordinator database and a unique candidateID value has been generated.
To maintain API security, the unique candidateID value is sent to the API server along with a hidden API key to generate a temporary “SessionID” value. The SessionID can only be used to verify a single API request and will identify the candidate and job title values. The QuestionType parameter value in a GetQuestions request is used to identify the “type” of question set.
The response to a GetQuestions API request will look similar to the example below. The information sent includes :-
- The Job Title of the vacancy to be filled.
- The first & last names of the candidate.
- The type of questions being asked.
- The total number of questions in the set.
- The number of questions already answered by the candidate
- The format of the answer required (Text required/optional & Video required/optional)
- The text string for each question
- Whether the individual question has already been answered by the candidate
Here is an example GetQuestion API response in JSON format
{“Status“: “OK”,”Content“:
{“CampaignJobTitle“: JobTitle,”Firstname“: “Peter”,”Lastname“: “Pan”,”QuestionsType“: “Application Questions”,”NumberOfQuestions“: 3,”QuestionsAnswered“: 1,”QuestionsSet“:
[
{“CampaignQuestionId“: 1255,”ResponseTypeText“: “RequiredText_1255”,”ResponseTypeVideo“: “OptionalVideo_1255”,”DisplayOrder“: 1,”QuestionContent“: “Application question text – question 1”,”Status“: “Answered”},
{“CampaignQuestionId“: 1256,”ResponseTypeText“: “DisableText_1256”,”ResponseTypeVideo“: “RequiredVideo_1256”,”DisplayOrder“: 2,”QuestionContent“: ” Application question text – question 2″,”Status“: “Pending”},
{“CampaignQuestionId“: 1257,”ResponseTypeText“: “DisableText_1257”,”ResponseTypeVideo“: “RequiredVideo_1257”,”DisplayOrder“: 3,”QuestionContent“: ” Application question text – question 3″,”Status“: “Pending”}
]
},”Errors“: null}
In this example response the candidate name is Peter Pan. There are 3 application questions. The first question requires a text answer and has already been answered by this candidate. The second and third questions require the candidate to submit a video answer and have not yet been answered.