Using this API, you can showcase all basic requirements for the candidate to fill out while submitting their application, along with the screening questions you wish to set for them.
.png)
Written by Nikita T
This API can be used when you wish to integrate your website with iSmartRecruit for all Active jobs and wish to customize the Job application as per your requirements for the candidates.
Using this API, you can showcase all basic requirements for the candidate to fill out while submitting their application, along with the screening questions you wish to set for them.
To know more about screening questions, please refer to our detailed article on Job screening questions. https://help.ismartrecruit.com/job-management/screening-questions
Step 1: Perform the below API to integrate Active jobs from iSmart to your website. This will generate the job ID for you.
Url - https://app.ismartrecruit.com/api/v1/candidate/0/jobs
Method - POST
apiKey - < Your>
Parameter Type - JSON
Request Parameter
{
"cndId":0
}
Note: You can pass other parameter values but given values are mandatory
Other Parameters You can add -
{
"active": true,
"clientId": 0,
"cndId": 0,
"fieldType": "string",
"maxPerPage": 0,
"orderBy": "ASC",
"orderType": "createdDate",
"startingAt": 0,
"vos": [
{
"fieldType": "string",
"key": "string",
"operant": "=",
"opt": "AND",
"parentOpt": "AND",
"split": true,
"value": "0"
}
]
}
Response -
{
"jobId": 1,
"clientId": 1,
"clientName": "ismartrecruit",
"jobTitle": ".Net Developer",
"dateOpened": "2021-11-30",
"targetDate": "2021-12-31",
"numberOfOpening": 1,
"recruiters": [
],
"managers": [
],
"questions": [
],
"jobType": "Full Time",
"location": ,
"country": ,
"jobPriority": 2,
"skillSet": " Application Developer, ASP.NET framework, Model-View-Controller (MVC), C#, Visual Basic .NET, HTML5/CSS3, REST, RPC, Agile methodologies",
"minWorkExp": "2",
"maxWorkExp": "3",
"minSalary": "45000",
"maxSalary": "50000",
"state": "Gujarat",
"inactive": false,
"custField1": "",
"custField2": "Computer Software",
"custField30": "",
"custField50": "",
"cndAllocated": true,
"jobOnWebsite": true,
"applyUrl": ",
"status": "Active",
"jobDescription": "",
"createdBy": ,
"createdDate": ,
"updatedBy": ,
"updatedDate":,
"imgName": "user.png",
"imagePath": "image/user.png",
"approverVOs": [
]
}
Postman Collection -
https://drive.google.com/file/d/1j47oZeNAbzY-ehK4UGiDUYe-kP8Aynon/view?usp=sharing
Step 2: Perform the below API to accept applicants as candidates and create their candidate profile in iSmart. This will generate the candidate ID for you.
Url - https://app.ismartrecruit.com/saveCandidateAPI
Method - POST
Header -
apiKey - < Your>
updateDuplicate -
Parameter Type - JSON
Parameter -
{
"cndName":"CANDIDATE NAME",
"email": "CANDIDATE EMAIL"
}
Note: You can pass other parameter values but given two values are mandatory
Other Parameters You can add -
{
"annualSalary": "string",
"assignedOn": "2022-12-22T13:17:11.472Z",
"blockEmail": true,
"blockReason": "string",
"blockedResumePath": "string",
"candidatePermanentAddress": "string",
"cndConsentStatus": "string",
"cndId": 0,
"cndJobRating": 0,
"cndName": "string",
"cndStatus": "string",
"cndStatusFeedBack": "string",
"cndStatusId": 0,
"cndStatusLogic": "string",
"consentDate": "2022-12-22T13:17:11.472Z",
"consentStatus": "string",
"createdBy": "string",
"createdDate": "2022-12-22T13:17:11.472Z",
"currencyType": "string",
"currentAddress": "string",
"currentCtc": "string",
"currentEmployer": "string",
"currentLocation": "string",
"custField1": "string",
"custField10": "string",
"custField11": "string",
"custField12": "string",
"custField13": "string",
"custField14": "string",
"custField15": "string",
"custField16": "string",
"custField17": "string",
"custField18": "string",
"custField19": "string",
"custField2": "string",
"custField20": "string",
"custField21": "string",
"custField22": "string",
"custField23": "string",
"custField24": "string",
"custField25": "string",
"custField26": "string",
"custField27": "string",
"custField28": "string",
"custField29": "string",
"custField3": "string",
"custField30": "string",
"custField31": "string",
"custField32": "string",
"custField33": "string",
"custField34": "string",
"custField35": "string",
"custField36": "string",
"custField37": "string",
"custField38": "string",
"custField39": "string",
"custField4": "string",
"custField40": "string",
"custField41": "string",
"custField42": "string",
"custField43": "string",
"custField44": "string",
"custField45": "string",
"custField46": "string",
"custField47": "string",
"custField48": "string",
"custField49": "string",
"custField5": "string",
"custField50": "string",
"custField6": "string",
"custField7": "string",
"custField8": "string",
"custField9": "string",
"designation": "string",
"dispCndNameId": "string",
"dob": "2022-12-22T13:17:11.472Z",
"downloadFileFlg": true,
"email": "string",
"eraseConsentDate": "2022-12-22T13:17:11.472Z",
"expUpdatedDate": "2022-12-22T13:17:11.472Z",
"expectedCtc": "string",
"facebook": "string",
"fileName": "string",
"functionalArea": "string",
"gdprDate": "2022-12-22T13:17:11.472Z",
"gdprDateStr": "string",
"gdprFlg": true,
"gender": "string",
"gmail": "string",
"google": "string",
"imagePath": "string",
"img": "string",
"imgName": "string",
"inactive": true,
"industry": "string",
"institution": "string",
"interviewDate": "2022-12-22T13:17:11.472Z",
"interviewId": "string",
"interviewTimeZone": "string",
"interviewType": "string",
"isAllocated": true,
"isBlock": true,
"jobLocation": "string",
"jobTitle": "string",
"jobType": "string",
"keySkills": "string",
"language": "string",
"linkedin": "string",
"maritalStatus": "string",
"mobile": "string",
"nationality": "string",
"note": "string",
"noticePeriod": "string",
"otherAttach": "string",
"otherAttach2": "string",
"passportNo": "string",
"password": "string",
"profileUpdatedDate": "2022-12-22T13:17:11.472Z",
"projectedExperience": 0,
"qualification": "string",
"requestConsentDate": "2022-12-22T13:17:11.472Z",
"resume": "string",
"resumeInHtml": "string",
"resumeInTxt": "string",
"resumePath": "string",
"resumeSource": "string",
"resumeSourceDisp": "string",
"score": 0,
"secondaryResumeInHtml": "string",
"secondaryResumeInTxt": "string",
"secondaryResumePath": "string",
"skype": "string",
"stackoverflow": "string",
"state": "string",
"telephone": "string",
"tmp": true,
"totalExperience": 0,
"twitter": "string",
"updatedBy": "string",
"updatedByCnd": "2022-12-22T13:17:11.472Z",
"updatedByCndFlg": true,
"updatedByCndStr": "string",
"updatedDate": "2022-12-22T13:17:11.472Z",
"website": "string",
"zip": "string"
}
Response -
{"title":"Success","message":"id_name","status":200}
Step 3: After capturing the Candidate ID & the Job ID, you can perform the below API.
For example - After performing steps 1 & 2, you have job id as 10 and candidate as 2. Hit the URL as below
https://app.ismartrecruit.com/api/v1/candidate/2/jobs/10/questions
URL - https://app.ismartrecruit.com/api/v1/candidate/{CND_ID}/jobs/{JOB_ID/questions
Method - POST
apiKey - < Your>
Parameter Type - JSON
Parameter -
[
{
"questionId": "5343535"
}
]
Note: You can pass other values but given one value are mandatory
Other Parameters you can add -
[
{
"ans": "string",
"answer": "string",
"answerList": [
"string"
],
"answerListDisp": [
"string"
],
"answerMap": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"answerType": "string",
"answerVOs": [
{
"answer": "string",
"correctAnsDispStr": "string",
"correctAnswer": true,
"indexId": 0
}
],
"cmb": true,
"compStrId": "string",
"controlName": "string",
"controlType": "string",
"correctValues": "string",
"createdBy": "string",
"createdDate": "2022-11-29T05:05:09.451Z",
"deleteFlg": true,
"disableKnockout": true,
"disabledFlg": true,
"dispCndNameId": "string",
"dispJobNameId": "string",
"duplicateFlg": true,
"editFlg": true,
"exporterDate": "string",
"fieldType": "string",
"fieldValues": "string",
"fromSearchFlg": true,
"funcName": "string",
"helpText": "string",
"hired": true,
"homeFlg": true,
"inactive": true,
"isHired": true,
"isOffered": true,
"jobId": 0,
"knockout": true,
"knockoutDispStr": "string",
"knockoutStr": "string",
"mandatory": true,
"mandatoryStr": "string",
"offered": true,
"order": 0,
"question": "string",
"questionId": "string",
"questionTrim": "string",
"questionnaireId": 0,
"questionnaireName": "string",
"questionnaireQuestionId": "string",
"removeContactFlg": true,
"resetFlg": true,
"saveCallFlg": true,
"saveFlg": true,
"selectedAns": [
"string"
],
"toggleFilter": true,
"updateCallFlg": true,
"updateFlg": true,
"updatedBy": "string",
"updatedDate": "2022-11-29T05:05:09.452Z",
"valModFlg": true,
"weightage": 0
}
]
Response - {"title":"Success","message":"SUCCESS_INSERT","status":200}
