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
showCustomValue Boolean This parameter when set to true then the matched customValue will be returned in the response. Optional

JSON Request For Get Document Details - Resume

{
    "index": {
        "indexType": "Resume",
        "indexKey": "Use Your indexKey",
        "subUserId": "Use your subUserId"
    },
    "documentId": "202504140457PMResumeExperience",
    "showCustomValue": true,
    "fieldList": [
        "CurrentJobProfile",
        "JobProfile",
        "CurrentEmployer",
        "Employer",
        "Degree",
        "Institute",
        "Skill",
        "TotalExperienceRange",
        "City",
        "State",
        "Country",
        "ZipCode",
        "LanguageKnown",
        "Email",
        "FullName",
        "TitleName",
        "FirstName",
        "MiddleName",
        "LastName",
        "DateOfBirth",
        "Gender",
        "MaritalStatus",
        "Nationality",
        "Category",
        "SubCategory",
        "CurrentSalary",
        "CurrentSalaryCurrency",
        "CurrentSalaryUnit",
        "ExpectedSalary",
        "ExpectedSalaryCurrency",
        "ExpectedSalaryUnit",
        "TotalExperienceInMonths",
        "TotalExperienceInYear",
        "ResumeLanguage",
        "ResumeCountry",
        "ResumeDate",
        "InstituteCity",
        "InstituteState",
        "InstituteCountry",
        "LastInstitute",
        "CurrentEmployerCity",
        "CurrentEmployerState",
        "CurrentEmployerCountry",
        "EmployerCity",
        "EmployerState",
        "EmployerCountry",
        "CurrentJobAlias",
        "CurrentCity",
        "CurrentState",
        "CurrentCountry",
        "PreferredCity",
        "PreferredState",
        "PreferredCountry",
        "Specialization",
        "JobProfileHistory",
        "SkillHistory"
    ]
}

JSON Response For Get Document Details - Resume

{
    "document": {
        "id": "202504140457PMResumeExperience",
        "customField2": [
            "Value 2"
        ],
        "Shift": "Day",
        "customField1": "Value 1",
        "customField3.docField2": [
            "value 1",
            "value 2"
        ],
        "customField3.docField1": [
            "doc field value 1"
        ],
        "CurrentJobProfile": "Software Developer",
        "JobProfile": [
            "Junior Software Developer"
        ],
        "CurrentEmployer": "ABC Tech Solutions",
        "Employer": [
            "XYZ Technologies"
        ],
        "HighestDegree": [
            "Bachelor of Science"
        ],
        "Institute": [
            "University of New York"
        ],
        "Skill": [
            "Assisted",
            "Troubleshooting",
            "Collaborated With Cross-Functional Teams",
            "Version Control",
            "RESTful APIs",
            "Debugging",
            "Node.js",
            "Django",
            "GitHub",
            "Agile",
            "CI/CD",
            "React",
            "Git",
            "UX",
            "Database Queries",
            "MongoDB",
            "MySQL",
            "Code Reviews",
            "Mocha",
            "Jest",
            "Scalable Web Applications",
            "Web Applications",
            "Jenkins",
            "Application Performance",
            "Project Management",
            "Collaborative Development",
            "Best Practices",
            "User Engagement",
            "RESTful API Development",
            "Continuous Integration",
            "Agile/Scrum",
            "RESTful API",
            "Spring Boot",
            "JavaScript",
            "Python",
            "Scrum",
            "HTML",
            "Java",
            "API",
            "CSS",
            "MongoDB Docker",
            "PostgreSQL",
            "AWS",
            "SQL",
            "Integration Testing",
            "Unit Testing",
            "Selenium",
            "Visual Studio Code",
            "Postman",
            "Docker",
            "Cloud Services",
            "Heroku",
            "Task Management",
            "Weather Forecasting"
        ],
        "TotalExperienceRange": "5-8 YEAR",
        "City": "New York",
        "State": "NY",
        "Country": "USA",
        "Email": "johndoetwo@email.com",
        "FullName": "Johntwo Doetwo",
        "FirstName": "Johntwo",
        "LastName": "Doetwo",
        "Category": "Information",
        "SubCategory": "Software Developers and Programmers",
        "TotalExperienceInMonths": 60,
        "TotalExperienceInYear": 5.0,
        "ResumeLanguage": "English",
        "ResumeCountry": "USA",
        "ResumeDate": "2025-05-02T10:47:34.420Z",
        "InstituteCity": [
            "New York"
        ],
        "InstituteState": [
            "NY"
        ],
        "InstituteCountry": [
            "USA"
        ],
        "LastInstitute": "University of New York",
        "CurrentEmployerCity": "New York",
        "CurrentEmployerState": "NY",
        "CurrentEmployerCountry": "USA",
        "EmployerCity": [
            "New York"
        ],
        "EmployerState": [
            "NY"
        ],
        "EmployerCountry": [
            "USA"
        ],
        "CurrentJobAlias": [
            "app developer",
            "app development engineer",
            "app software developer",
            "application - developer",
            "application developer",
            "application developer it",
            "application engineer",
            "application engineering expert",
            "application engr",
            "application lead developer",
            "application programmer",
            "application programmer lead",
            "application software developer",
            "application software development engineer",
            "application software engineer",
            "application support developer",
            "application technology developer",
            "application technology engineer",
            "application technology engineering expert",
            "application technology engineering specialist",
            "application-engineer",
            "applications developer",
            "applications engineer",
            "applications lead developer",
            "applications programmer",
            "applications web developer",
            "applications-engineer",
            "certified programmer",
            "coder",
            "computer application developer",
            "computer application engineer",
            "computer applications developer",
            "computer applications engineer",
            "computer coder",
            "computer language coder",
            "computer programmer",
            "computer software developer",
            "computer software engineer",
            "computer software engr",
            "computer software professional",
            "computer support programmer",
            "computer systems programmer",
            "computer systems software engineer",
            "desktop application developer",
            "developer",
            "developer - application",
            "developer application",
            "developer applications",
            "developer it",
            "developer lead applications",
            "developer lead of applications",
            "developer of software",
            "developer of solutions",
            "developer software",
            "developer solutions",
            "developer-software",
            "development software engineer",
            "engineer - software",
            "engineer application development",
            "engineer of solution",
            "engineer of system application",
            "engineer software",
            "engineer software development",
            "engineer-application",
            "engineering programmer",
            "engr software",
            "engr",
            "apps dev",
            "enterprise software engineer",
            "enterprise solutions engineer",
            "in charge of programming",
            "independent software developer",
            "information technology application developer",
            "intermediate software engineer",
            "it applications programmer lead",
            "it developer",
            "it software engineer",
            "it solutions engineer",
            "lead app developer",
            "lead application developer",
            "lead applications developer",
            "lead applications programmer",
            "lead developer-applications",
            "lead solutions engineer",
            "lead web application developer",
            "lead-applications developer",
            "leader applications developer",
            "product application engineer",
            "product solution engineer",
            "product solutions engineer",
            "programmer",
            "programmer engineering",
            "s/w development engr",
            "sde",
            "soft developer",
            "soft. dev. engineer",
            "soft. development engineer",
            "software - engineer",
            "software application engineer",
            "software design and development engineer",
            "software design engineer",
            "software designer",
            "software dev engineer",
            "software dev engr",
            "software dev. engineer",
            "software developer applications",
            "software developer engineering",
            "software development engineer",
            "software development engr",
            "software development specialist",
            "software engineer",
            "software engineer - development",
            "software engineer - information technology",
            "software engineer developer",
            "software engineer web services",
            "software engineering engineer",
            "software integration developer",
            "software programmer",
            "software solutions developer",
            "software system designer",
            "software- designer",
            "software-developer",
            "solution developer",
            "solution development engineer",
            "solution engineer",
            "solutions dev",
            "solutions developer",
            "solutions engineer",
            "solutions engineer expert",
            "solutions engineering intern",
            "solutions programmer",
            "specialist software",
            "sys application engineer",
            "system application engineer",
            "system applications engineer",
            "system-application-engineer",
            "tech programmer",
            "technical - software engineer",
            "technical programmer",
            "technical soft developer",
            "technical solution engineer",
            "technical solutions engineer",
            "technology programmer",
            "technology software developer",
            "technology software engineer",
            "technology solution engineer",
            "windows application developer"
        ],
        "CurrentCity": [
            "New York"
        ],
        "CurrentState": [
            "NY",
            "New York"
        ],
        "CurrentCountry": [
            "USA"
        ],
        "Specialization": [
            "Computer Science"
        ],
        "DegreeSubject": [
            "Bachelor of Science in Computer Science"
        ]
    }
}

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"
        ]
    }
}