Resume API Documentation | Building your First Search Request

Building your First Search Request

Getting started with the new Search Resume API requires you to pull information from several different sources.The table below describes the main list of search parameters.

Parameters are optional and can be omitted. The same way, some parameters have default values. That means if there are no values for some parameters in the search request, service will use default values.

Joining of Search Parameters

To perform a Search Resume Request to production, send an authorised HTTPS GET request (see detailed description here):

GET https://candidate-search-api.efinancialcareers.com/api-search?{searchparameters}

The same request to pilot is the following:

GET https://candidate-search-api.pilotaws.efinancialcareers.com HYPERLINK "https://candidate-search-api.pilotaws.efinancialcareers.com/api-search"/api-search?

{search parameters}

It is possible to join several search parameters in one request. It can be done with the help of “&” symbol.

For example:

keyword=Java&page=1&pageSize=10.

Service allows to search by several value in one filter. It can be done with the help of “|” symbol.

For example:

filters.locationId=3865483|3577279

For filters.sectors and filters.languageLevels should use next schema: sector/subsector and language /languageLevel accordingly.
For example: filters.sectors=ASSET_MANAGEMENT/SALES_CLIENT_SERVICES|CAPITAL_MARKETS

filters.languageLevels=EN/COMPETENT|ES/BASIC

In some cases, it’s required to use symbol code “%7C” instead of “|”.

For example, filters.locationId=3865483%7C 3577279.

Search Parameters

Valid values of search parameters can be received with the help of Dictionary Service.

There is a list of default parameters below. They will be applied to the request by default if you don’t specify any of them in the request:

page = 1;

page-size = 10;

language = “en”;

matchMode = BOOLEAN;

Name

Example

Default Value

keywords

java developer

matchMode

BOOLEAN

language

sortOrder

ASC|DESC

orderBy

updatedDate or _score (sort by relevancy)

_score

pageSize

filters.updateDate

ONE_DAY|TWO_DAYS|THREE_DAYS

filters.locationId

103867

filters.radius

filters.radiusUnit

mi or km

filters.willingToReclocate

true or false

filters.workPermitLocation

119388

filters.sectors

CAPITAL_MARKETS/DOCUMENTATION_STRUCTURIN|CAPITAL_MARKETS/OTHER

filters.yearsExperience

NO_EXPERIENCE|ONE_THREE_YERAS_EXPERIENCE

filters.languageLevels

EN|US|CMN
EN/BASIC|FR/FIRST_LANGUAGE

filters.positionTypes

PERMANENT, TEMPORARY, CONTRACT, SELF_EMPLOYED, INTERNSHIPS_AND_GRADUATE_TRAINEE

filters.salaryAmount

50000

filters.salaryCurrency

GBP, USD, EUR, CHF, JPY, AUD, SGD, HKD, CNY, CAD, SEK, DKK, NOK, ISK, ZAR, AED, QAR, BHD, SAR, KWD, OMR, NZD, NGN, INR, RUB, MYR

filters.salaryPeriod

PER_HOUR, PER_DAY, PER_WEEK, PER_MONTH, PER_YEAR;

filters.travelRate

NONE, TWENTY_FIVE_PERCENTS, FIFTY_PERCENTS, SEVENTY_FIVE_PERCENTS

filters.availability

UNDEFINED, IMMEDIATELY, ONE_WEEK, ONE_MONTH, TWO_MONTH, THREE_MONTH, SIX_MONTH;

Boolean search

Boolean search allows you to combine keywords with ‘operators’ such as AND, OR, NOT, (brackets) and “quotation marks” to produce more relevant search results.

For example:

keywords= (developer OR engineer OR programmer) AND (java OR scala OR c# OR python OR C++ OR react OR cloud OR devops OR AWS angular OR javascript) NOT ("project manager")

Ordering

The results obtained when searching for resumes are ordered by relevance by default.

Results can be sorted by resume update date

Example: orderBy=updatedDate

Sort order

Sort ascending or descending considering order-by parameter.

ASC, DESC

Example: sort-order=ASC

Return Format

There is one return format available.: JSON

Updated Within

Returns resumes updated within defined age.