API Directory

Using this API, user will be able to create a new candidate.

Request

POST https://altrecruit.peoplestrong.com/api/v1/candidate

Request body

The request body takes a complete NewCandidateRequest resource, containing the following writable properties:

{
    "aadhar": "string",
    "currentAddress": {
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "country": "string",
        "pincode": "string",
        "state": "string"
    },
    "dateOfBirth": "string",
    "education": [
        {
            "degree": "string",
            "endDate": "string",
            "institute": "string",
            "percentage": "string",
            "startDate": "string"
        }
    ],
    "expInMonths": "number",
    "expInYears": "number",
    "expectedSalary": "number",
    "faceBookProfile": "string",
    "firstName": "string",
    "fresher": "string",
    "functionalArea": "string",
    "gender": "string",
    "googlePlusProfile": "string",
    "inReview": "boolean",
    "industryName": "string",
    "internationalID": "string",
    "internshipExperience": [
        {
            "companyName": "string",
            "endDate": "string",
            "jobDescription": "string",
            "jobTitle": "string",
            "startDate": "string"
        }
    ],
    "jobCode": "string",
    "landlineNumber": "string",
    "languages": [
        "string"
    ],
    "lastName": "string",
    "linkedInProfile": "string",
    "localFirstName": "string",
    "localLastName": "string",
    "localMiddleName": "string",
    "localNickName": "string",
    "middleName": "string",
    "mobileNumber": "string",
    "nickName": "string",
    "noticePeriod": "number",
    "panNumber": "string",
    "passportNumber": "string",
    "permanentAddress": {
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "country": "string",
        "pincode": "string",
        "state": "string"
    },
    "primaryEmail": "string",
    "reasonForLeaving": "string",
    "referenceSource": "string",
    "resume": "string",
    "resumeExtension": "string",
    "secondaryEmail": "string",
    "skills": [
        "string"
    ],
    "title": "string",
    "twitterProfile": "string",
    "voterID": "string",
    "workExperience": [
        {
            "companyName": "string",
            "ctc": "number",
            "currencyCode": "string",
            "currentEmployer": "string",
            "endDate": "string",
            "jobDescription": "string",
            "jobTitle": "string",
            "startDate": "string"
        }
    ]
}

Properties

Name Type Description Additional
aadhar string

Candidate aadhar

Optional
currentAddress object

Candidate current address

Optional
currentAddress.addressLine1 string

Current addressLine1

Optional
currentAddress.addressLine2 string

Current addressLine2

Optional
currentAddress.city string

Current city

Optional
currentAddress.country string

Current country

Optional
currentAddress.pincode string

Current pincode

Optional
currentAddress.state string

Current state

Optional
dateOfBirth string

Candidate date of birth

Optional
education[] array Optional
education[].degree string

Degree

Optional
education[].endDate string

End date

Optional
education[].institute string

Institute

Optional
education[].percentage string

Percentage

Optional
education[].startDate string

Start date

Optional
expInMonths number

experience in months

Optional
expInYears number

experience in years

Optional
expectedSalary number

Expected salary

Optional
faceBookProfile string

Candidate faceBook profile

Optional
firstName string

Candidate first name

Optional
fresher string

Candidate work detail

Optional
functionalArea string

Candidate functional area

Optional
gender string

Candidate gender

Optional
googlePlusProfile string

Candidate googlePlus profile

Optional
inReview boolean

Inreview

Optional
industryName string

Candidate industry

Optional
internationalID string

Candidate international ID

Optional
internshipExperience[] array Optional
internshipExperience[].companyName string

Company name

Optional
internshipExperience[].endDate string

End date

Optional
internshipExperience[].jobDescription string

Job description

Optional
internshipExperience[].jobTitle string

Job titel

Optional
internshipExperience[].startDate string

Start date

Optional
jobCode string

Job code

Optional
landlineNumber string

Candidate landline number

Optional
languages[] array of string

Languages

Optional
lastName string

Candidate last name

Optional
linkedInProfile string

Candidate linkedIn profile

Optional
localFirstName string

Candidate local first name

Optional
localLastName string

Candidate local last name

Optional
localMiddleName string

Candidate local middle name

Optional
localNickName string

Candidate local nick name

Optional
middleName string

Candidate middle name

Optional
mobileNumber string

Candidate mobile number

Optional
nickName string

Candidate nick name

Optional
noticePeriod number

notice period

Optional
panNumber string

Candidate pan number

Optional
passportNumber string

Candidate passport number

Optional
permanentAddress object

Candidate permanent address

Optional
permanentAddress.addressLine1 string

Permanent addressLine1

Optional
permanentAddress.addressLine2 string

Permanent addressLine2

Optional
permanentAddress.city string

Permanent city

Optional
permanentAddress.country string

Permanent country

Optional
permanentAddress.pincode string

Permanent pincode

Optional
permanentAddress.state string

Permanent state

Optional
primaryEmail string

Candidate primary email

Optional
reasonForLeaving string

Reason for leaving

Optional
referenceSource string

Reference source

Optional
resume string

Resume byte stream

Optional
resumeExtension string

Extension of resume file

Optional
secondaryEmail string

Candidate email

Optional
skills[] array of string

Skills

Optional
title string

Candidate title

Optional
twitterProfile string

Candidate twitter profile

Optional
voterID string

Candidate voter ID

Optional
workExperience[] array Optional
workExperience[].companyName string

Company name

Optional
workExperience[].ctc number

CTC

Optional
workExperience[].currencyCode string

Currency code

Optional
workExperience[].currentEmployer string

Current employer

Optional
workExperience[].endDate string

End date

Optional
workExperience[].jobDescription string

Job description

Optional
workExperience[].jobTitle string

Job title

Optional
workExperience[].startDate string

Start date

Optional

Authorisation

This request requires the use of one of following authorisation methods: API key OAuth2.

For OAuth 2 authorisation, the following scopes are required:

Scope Description
read read records
write modify records

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

successful operation

NewCandidateResponse
400 Bad Request

Bad Request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

405 Method Not Allowed

Method Not Allowed

426

API rate limit exceeded

429

API rate limit exceeded

500 Internal Server Error

Internal Server Error

default

successful operation


Explore this API

body

Request body adding a candidate

Request Content-Type
Response Content-Type

Choose an authorisation method:

API key API key to be used for request
Access Token Access token to be used for request
Try it out!