Resume Templater 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.

Resume Templater API

The Resume Templater API is defined as follows:

HTTP Request:
  • URL: https://plugin.rchilli.com/RChilliPlugin/rchilli/resumeTemplate
  • Accept: application/json
  • Response Type: JSON

API Endpoint

The Resume Templater API endpoint returns the parsed data in the JSON format. The Resume Templater endpoint is mention below:

/resumeTemplate

API Method

The Resume Templater 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 Resume Templater API requires the following request parameters in the JSON request format:
Note:
  1. If the templatekey (Optional) parameter is given then the corresponding template resume format will be created, for example, if you give TM002 as templatekey parameter, then the output resume will be in the TM002 sample template format. To know more on the sample templates, see Sample Templates.
  2. If the templatekey (Optional) parameter is not given then a template resume is created based on the default template key i.e TM001 sample template format.
  3. If the outputtype (Optional) parameter is not given then a template resume is created based on the default output type i.e pdf format.
  4. If the templatedata (Optional) parameter is given then a template resume is created based on customized template data.
  5. If the templatekey and templatedata (Optional) both parameters are given then a template resume is created based on the template data.
  6. if the jsondata passed in the request parameter, then only one credit will be reduced.
  7. if the jsondata passed in the request parameter, then the filedata becomes an optional parameter.
  8. if the jsondata and filedata are passed in the request parameter, then the jsondata will be used for the template creation.
Name Type Description Remarks
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 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 As per contract Required
outputtype String You can give doc/docx/rtf/pdf/html type Optional
templatekey String Valid template Key as provided by RChilli, see Sample Template Key details Optional
templatedata String Template binary data in base64. Supported extension is only dotx format template Optional
jsondata String Parsed resume JSON data in the Base64 format Optional

JSON Request For resume templater plugin

Below is the API Request in JSON Format:

{
  "filedata": "File data in base64",
  "filename": "File name with extension",
  "userkey": "Your API UserKey",
  "version": "1.0.0",
  "subuserid": "Your Company Name",
  "outputtype": "Extension of File (docx,pdf, etc.)",
  "templatekey": "Template format key",
  "templatedata": "Template data in base64",
  "jsondata": "Parsed resume data in the JSON format"
}

API Response Parameters

Follow the below table for the resume templater API response parameters details.
Name Type Description
OutputType String The document type of the output.
TemplateBase64 String The Template document output in the Base64 format.

JSON Response For resume templater plugin

Below is the API Response in JSON Format:
{
    "ResumeParserData": {
        ...
    },
    "OutputType": "",
    "TemplateBase64": ""
}