Dynamic Field Matching

Currently, the search and match API perform matching on all available entities within the Resume/JD. If the user wants to match with a specific entity in the resume/JD, they can use the dynamicMatchFields parameter in the API input.

The dynamicMatchFields is an optional parameter (query) that can be passed in the API request of Match, Match with ID, Match with Multiple Sub-User Ids, and One To One Match.
The dynamicMatchFields parameter can be applied on all the match type:
- JD to Resume
- JD to JD
- Resume to JD
- Resume to Resume

Sample Request Format - Index Type Resume

Note: Refer to the Matching Entities - Index Type Resume section below to know all the entities within the resume that can be utilized with the dynamicMatchFields parameter.

"dynamicMatchFields": {
        "JobProfile": [
            "CurrentJobProfile",
            "JobProfile",
            "CurrentJobAlias",
            "JobAlias"
        ],
        "Organization": [
            "CurrentEmployer",
            "Employer"
        ],
        "Skill": [
            "SkillHaveExp",
            "SkillWithoutExp",
            "SkillAlias"
        ],
        "Degree": [
            "HighestDegree",
            "Degree"
        ],
        "JobLocationCity": [
            "City",
            "CurrentCity",
            "CurrentEmployerCity",
            "PreferredCity",
            "EmployerCity"
        ],
        "JobLocationState": [
            "State",
            "CurrentState",
            "CurrentEmployerState",
            "PreferredState",
            "EmployerState"
        ],
        "JobLocationCountry": [
            "Country",
            "CurrentCountry",
            "CurrentEmployerCountry",
            "PreferredCountry",
            "EmployerCountry"
        ]
    },

Sample Request Format - Index Type JD

Note: Refer to the Matching Entities - Index Type Resume section below to know all the entities within the JD that can be utilized with the dynamicMatchFields parameter.

"dynamicMatchFields": {
        "Skill": [
            "RequiredSkillSet",
            "PreferredSkillSet",
            "AliasSkillSet",
            "JobProfileRelatedSkills"
        ]
    },

Matching Entities - Index Type Resume

Note:

The entity object that is not used within the dynamicMatchFields parameter will be considered by default for matching.
If you are using any object within the dynamicMatchFields parameter, then object must contain atleast one field to avoid error.

IndexType: Resume (JD to Resume, Resume to Resume)
- JobProfile
  - CurrentJobProfile
  - JobProfile
  - CurrentJobAlias
  - JobAlias
- Organization
  - CurrentEmployer
  - Employer
- Skill
  - SkillHaveExp
  - SkillWithoutExp
  - SkillAlias
- Degree
  - HighestDegree
  - Degree
- JobLocationCity
  - AddressCity
  - CurrentCity
  - CurrentEmployerCity
  - PreferredCity
  - EmployerCity
  - EducationCity
- JobLocationState
  - AddressState
  - CurrentState
  - CurrentEmployerState
  - PreferredState
  - EmployerState
  - EducationState
- JobLocationCountry
  - AddressCountry
  - CurrentCountry
  - CurrentEmployerCountry
  - PreferredCountry
  - EmployerCountry
  - EducationCountry

Matching Entities - Index Type JD

Note:

The entity object that is not used within the dynamicMatchFields parameter will be considered by default for matching.
If you are using any object within the dynamicMatchFields parameter, then object must contain atleast one field to avoid error.

IndexType: JD (Resume to JD, JD to JD)
- Skill
  - RequiredSkillSet
  - PreferredSkillSet
  - AliasSkillSet
  - JobProfileRelatedSkills

Error Code


Error Code	Error Message
2127	Invalid DynamicMatchField request.
2128	Invalid DynamicMatchField key {key}
2129	Invalid DynamicMatchField value {key}
2130	DynamicMatchField key {key} must be an array type
2131	DynamicMatchField key {key} must contain a value.