Endpoint, Method and Parameter

The endpoints indicate how you access the resource, while the method indicates the allowed interactions (such as GET, POST, or DELETE) with the resource.

Job Zone API

The Job Zone API is defined as follows:

HTTP Request:

URL: https://plugin.rchilli.com/RChilliPlugin/rchilli/jobZone
Accept: application/json
Response Type: JSON

API Endpoint

The Job Zone API endpoint returns the parsed data in the JSON format. The Job Zone API endpoint is mention below:

/jobZone

API Method

The Job Zone API uses only the POST method.

Request Headers


Header	Data Type	Description
Content-Type	string	Indicates the input type of the incoming request body. The only supported value is `application/json`.

API Request Parameters

The Job Zone API requires the following request parameters in the JSON request format:


Name	Type	Description	Remarks
requesttype	String	This indicates the type of file data included in the request. If the file data contains a resume, the request type is 'Resume'; if it contains a job description (JD), the request type is 'JD',	Required
filedata	String	Resume binary data in base64	Required Note: if the jsondata passed in the request parameter, then the filedata becomes an optional parameter.
filename	String	Resume with name extension (e.g. resumeSample.docx). Supported extensions are doc / docx / dot / rtf / pdf / otd / dotx /docm / txt /htm /html /png / jpeg	Required
userkey	String	Valid User Key as provided by RChilli, see How to get user key.	Required
version	String	Valid version as provided by RChilli	Required
subuserid	String	Your unique subuser_id Note: Make sure that there is no space in your subuser_id	Required
jsondata	String	Parsed resume JSON data in the Base64 format	Optional

JSON Request For Job Zone API plugin

Below is the sample API Request in JSON Format:

{
    "requesttype": "Resume or JD",
    "filedata": "File data in base64",
    "filename": "File name with extension",
    "userkey": "Your API UserKey",
    "version": "1.0.0",
    "subuserid": "Use Your subuserid",
    "jsondata": "Parsed resume data in the JSON format"
}

API Response Parameters

Follow the below table for the Job Zone API response parameters details.


Name	Type	Description
score	String	This is the confidence score for the Job Profile that has matched with the particular job zone
JobZoneLable	String	This is the job zone level

JSON Response For Job Zone API plugin

Below is the sample API Response in JSON Format:

[
    {
        "JobZoneLable": 4,
        "score": "1.0"
    },
    {
        "JobZoneLable": 3,
        "score": "2.3093623e-15"
    },
    {
        "JobZoneLable": 5,
        "score": "1.0712076e-15"
    },
    {
        "JobZoneLable": 2,
        "score": "2.156028e-17"
    },
    {
        "JobZoneLable": 1,
        "score": "1.0737626e-19"
    }
]