RChilli JD Rest API 3.0

Last updated: November 26, 2019

Overview

RChilli Inc. is a leading Hiring AI tool and Analytics Solutions Provider which has helped businesses in over 30 countries reach their full potential. We provide Web API to parse job description which converts any format job description to structured JSON output.

JD Parsing

JD parsing facilitates easy parsing of job descriptions by filtering information into fields.

There are two methods for JD (Job Description) parsing.

RChilli JD Parser Methods


a). Parsing by JD Text

b). Parsing by JD Binary Data

a). Parsing by JD Text

RChilli Web API allows you to parse JD text in base64 format.

Method Name in API: ParseJDText

Parameters

  • Base64Text (String) JD text in base64 format
  • UserKey (String) Valid UserKey as provided by RChilli
  • Version (String) 3.0
  • SubUserId (String) As per contract

Rest Request

{
    "base64text": "base64 string for jd text",
    "userkey": "your user key",
    "version": "3.0",

    "subuserid": "your subuser id as per agreement"
}

b). Parsing by JD Binary Data


RChilli web API allows you to parse JD using binary data in base64 format.

Method Name in API: ParseJD

Parameters

  • FileData (String) JD file binary data in base64.
  • FileName (String) JD filename with extension (eg. JdSoftwaredeveloper.doc)
  • UserKey(String) Valid UserKey as provided by RChilli.
  • Version (String) 3.0
  • SubUserId (String) As per contract.

Rest Request

{
    "filedata": "base 64 data for jd file",
    "filename": "jd file name with extenstion",
    "userkey": "your Userkey provided by RChilli",	
    "version": "3.0",
    "subuserid": "your sub user id as per agreement",
}

JSON Response

JSON response will be same for both the methods: 

{
    "JDParsedData": {
        "FileName": "",
        "ParsingDate": "",
        "JobProfile": {
            "Title": "",
            "Alias": "",
            "RelatedSkills": ""
        },
        "Organization": "",
        "StaffingAgency": "",
        "AboutOrganization": "",
        "JobLocation": {
            "Location": "",
            "City": "",
            "State": "",
            "Country": "",
            "IsoCountryCode": "",
            "ZipCode": ""
        },
        "JobCode": "",
        "JobType": "",
        "JobShift": "",
        "IsManagementJob": "",
        "IndustryType": "",
        "ExcecutiveType": "",
        "PostedOnDate": "",
        "ClosingDate": "",
        "ExperienceRequired": {
            "MinimumYearsExperience": "",
            "MaximumYearsExperience": ""
        },
        "ContractDuration": "",
        "HasContract": "",
        "SalaryOffered": {
            "minAmount": "",
            "maxAmount": "",
            "Currency": "",
            "Units": "",
            "Text": ""
        },
        "BillRate": {
            "minAmount": "",
            "maxAmount": "",
            "Currency": "",
            "Units": "",
            "Text": ""
        },
        "NoticePeriod": "",
        "NoOfOpenings": "",
        "Relocation": "",
        "Languages": "",
        "PreferredDemographic": {
            "Nationality": "",
            "Visa": "",
            "AgeLimit": "",
            "Others": ""
        },
        "Domains": [],
        "Qualifications": {
            "Preferred": [],
            "Required": []
        },
        "Certifications": {
            "Preferred": [],
            "Required": []
        },
        "Skills": {
            "Preferred": [{
                "Skill": "",
                "type": "",
                "alias": ""
            }],
            "Required": [{
                "Skill": "",
                "type": "",
                "alias": ""
            }]
        },
        "Responsibilities": "",
        "ContactEmail": "",
        "ContactPhone": "",
        "ContactPersonName": "",
        "InterviewType": "",
        "InterviewDate": "",
        "InterviewTime": "",
        "InterviewLocation": "",
        "TypeOfSource": "",
        "JobDescription": "",
        "JDHtmlData": ""
    }
}

Error Code and Error Messages

Error Code Error Message Error Code Error Message
1001 Userkey is required 1002 Subuser id is required
1003 Invalid user key 1004 Filename with file extension is required
1005 Key expired 1006 Resume credits exhausted
1007 Wrong resume URL 1008 Not Text Content
1009 Resume File Extension Not Supported 1010 Resume File does not exist on this URL
1011 Version Required 1012 Invalid Version
1013 This Version does not support your Agreement 1014 Corrupted data/No Content Found
1015 Unable to parse the content 1016 No Resume Content Found
1017 Wrong Version 1018 File size is too large for processing
1019 Unable to detect language 1020 Unable to open PDF Parser
1021 File conversion error 1041 Abbyy Error: Not enough credits to process documentS. Please add more pages to your application account
1042 Abbyy Error: Task Failed

If you have any comments or feedback on our documentation, please send them to us at: support@rchilli.com