Get Document Detail
This API is used to get a particular indexed document detail by providing document ID.
API URL
The Get Document Details API uses the below URL:
https://searchengine.rchilli.com/RChilliSearchEngineAPI/RChilli/getDocumentDetail
API Endpoint
The Get Document Details API uses the below endpoint:/getDocumentDetail
API Method
The Get Document Details API uses only POST method.API Request Type
The Get Document Details API uses JSON request type.API 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 Parameters
To execute Get Document Details API, the following parameters in the JSON request are
needed:
Name | Type | Description | Remarks |
---|---|---|---|
indexType | String | Type of the file i.e Resume or JD | Required |
indexKey | String | Use your user key as shared by RChilli team | Required |
subUserId | String | Your user's unique_ID Note: Make sure
that there is no space in your subuser_id |
Optional |
documentId | Integer | This is the document ID of the document for which you want the details | Required |
fieldList | String | The fieldLists parameter is used in the Search and Match API request to customize the fields (entities) in the API response. For more details, refer Field Lists. | Optional |
JSON Request For Get Document Details - Resume
{
"index": {
"indexKey": "Your user key",
"indexType": "Resume",
"subUserId": "unique subuser id"
},
"documentId": "Document Id1"
}
JSON Response For Get Document Details - Resume
{
"document": {
"id": "Document Id1",
"ResumeLanguage": "English",
"ResumeCountry": "USA",
"FullName": "John Deo",
"FirstName": "John",
"LastName": "Deo",
"Category": "Health Care and Social Assistance",
"SubCategory": "Cardiovascular Technologists and Technicians",
"CurrentJobProfile": "Cardiologist",
"CurrentEmployer": "Henry Ford Hospital",
"TotalExperienceInMonths": 144,
"TotalExperienceInYear": 12.0,
"TotalExperienceRange": "GREATER THAN 10 YEAR",
"City": "Chicago",
"State": "IL",
"Country": "USA",
"Institute": [
"St. George's University School of Medicine",
"St. George's School of Medicine",
"Yale University",
"Carnegie Vanguard High School"
],
"Degrees": [
"Doctor of Medicine",
"Bachelor of Science",
"Secondary Education"
],
"Skill": [
"Interpreting Medical Research",
"Market Research and Analysis",
"PowerPoint Presentations",
"Clinical Research",
"Medical Research",
"Methodology",
"Communication Skills",
"Good Communication",
"Communication",
"Examinations",
"Preparing Blood Samples For Laboratory Tests",
"Giving Patients Injections Or Medications",
"Preparing Patients For Examination",
"Diagnose and Treat Human Injuries",
"Scheduling Patient Appointments",
"Maintaining Medical Records",
"Catheterization",
"Drawing Blood",
"Dentistry",
"Insurance",
"Billing",
"Science",
"Coding",
"Https",
"Fax"
],
"LanguageKnown": [
"French",
"Italian",
"Spanish"
]
}
}
JSON Request For Get Document Details - JD
{
"index": {
"indexKey": "Your user key",
"indexType": "JD"
},
"documentId": "Document Id1"
}
JSON Response For Get Document Details - JD
{
"document": {
"id": "Document Id1",
"JobProfile": "Software Developer",
"JobType": "Permanent Job, Full Time",
"JobLocation": [
"Mexico"
],
"JobLocationCity": "Mexico",
"MinimumYearsExperience": 8.0,
"MaximumYearsExperience": 10.0,
"Qualification": [
"BS Degree in Computer Science",
"B.Tech/B.E"
],
"Languages": [
"English"
]
}
}