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://core.ws.efinancialcareers.com/v1/resume-search?{search parameters} HTTP/1.1

The same request to pilot is the following:

GET https://core.ws.pilot.efinancialcareers.com/v1/resume-search?{search parameters} HTTP/1.1

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

For example, order-by=SECTOR&lang=FR.

Service allows to search by several locations: location={locationId}+{locationId}. In some cases, it’s required to use symbol code “%2B” instead of “+”. For example, location={locationId}%2B{locationId}.

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:

date-format = dd/MM/yyyy;
page = 1;
page-size = 30;
sort-order = ASC;
order-by = RESUME_ID;
lang = EN;
locale = current locale of the user (EN by default);
match-mode = ANY;
updated-within = THREE_MONTHS;
exact-location = false.

Name

Descriptions

Format

Example

Default

Location

Location Name

Radius

Work permit country code

Work Permit Name

Sector Name

SubSector Name

Sector

SubSector

Work experience Name

Work experience

Education Level Name

Education Level

Language spoken code

Language fluency code

Relocate location

Relocate location Name

Relocate radius

Position type name

Position type

Employment type name

Employment type

Travel rate name

Travel rate

Keywords

UpdatedWithin

MatchMode

Date format

Created within begin

Created within end

Updated within begin

Updated within end

Page

Page Size

Order by

Sort order

Reference number

Resume number

Locale return

Currency

Location Exact Match

General location id of job seeker

General location of job seeker

Area in selected location radius
linked to locationType

Permission to work in selected country or no restrictions

Business sector name

SubSector name in desired sector linked to Sector

Business sector name

SubSector name in desired sector linked to Sector

Number of years worked

Education received or degree

Languages spoken

Level of language proficiency linked to Language spoken

Search for persons who want to relocate to current locations

Contract conditions of employment

Time conditions of employment

Willing to travel

Keywords in resume title and attached doc to be searched for

Resume updated within

Type of keywords match

String representing pattern of date

Create resume date

Update resume date

Page to be shown

Limit total items shown on page

Criterium of ordering

Criterium of sorting

Search by defined resume reference number

Search by defined resume number

Define the language for locations names

Search by currency defined in resume

Flag for setting exact match for location names

location={locationId}+{locationId}

location-name={string}

location={locationId};{radius}

work-permit={locationId}

work-permit-name={string}

work-sector-name={string}+{string}

work-sector={sector code};{sub-sector code}+{sector code}

work-exp-name={string}

work-exp={code}

education-level-name={code}

education-level={code}

language={code};{code}

loc-or-wtr={locationId}

loc-or-wtr-name={string}

loc-or-wtr={locationId};{radius}

position-name={string}

position={code}

empl-type-name={string}

empl-type={code}

travel-rate-name={string}

travel-rate={code}

keywords={keywords}

updated-within={code}

match-mode={code}

date-format={string}

from-created-date={date}

to-created-date={date}

from-updated-date={date}

to-updated-date={date}

page={int}

page-size={int}

order-by={code}

sort-order={code}

refno={string}

resume-id={string}

lang={code}

currency={code}

exact-location={boolean}

int

string

int; int

string

int

string

int; int

string

int

string

int

string

date

int

string

string/int

location=7+10

location-name=Minsk

location=1;100

work-permit=7

work-permit-name=USA

work-sector-name=Accounting & Finance+Audit

work-sector=ACCOUNTING
_FINANCE;AUDIT or work-sector=ACCOUNTING
_FINANCE__AUDIT

work-exp-name=Ten years

work-exp=TEN_YEARS

education-level-name=School

education-level=EDUCATION_LEVEL_1

language=EN;FLUENT

loc-or-wtr=7

loc-or-wtr-name=Minsk

loc-or-wtr=25;2

position-name=Contract

position=CONTRACT

empl-type-name=Full time

empl-type=FULL_TIME

travel-rate=FIFTY_PERCENT

travel-rate-name=50%

keywords=TOP MANAGER

updated-within=OTHER

match-mode=ALL

date-format=yyyy-MM-dd

from-created-date=2001-01-01

to-created-date=2011-01-01

from-updated-date=2001-01-01

to-updated-date=2011-01-01

page=1

page-size=30

order-by=TITLE

sort-order=ASC

refno=99554+28226

resume-id=99554+28226

lang=EN

currency=GBP

exact-location=true

THREE_
MONTHS

0 (ANY)

dd/MM/yyyy

RESUME_ID

ASC

false

Keyword search

Search implements standard functionality of Endeca keyword search:

Search over Endeca search interface which includes several fields (Title, File Content, Position Type, Experience in current implementation)
Match modes
Allows Boolean search expressions with AND, OR, NOT, NEAR, ONEAR

Match Mode

Parameters in Code

Description

MatchAll

MatchPartial

MatchAny

MatchAllAny

MatchAllPartial

MatchPartialMax

MatchBoolean

ALL

PARTIAL

ANY

ALLANY

ALLPARTIAL

PARTIALMAX

BOOLEAN

Match all user search terms (that is, perform a conjunctive search). This is the default mode.

Match some user search terms.

Match at least one user search term.

Match all user search terms if possible, otherwise match at least one.

Match all user search terms if possible, otherwise match some. First use MatchAll mode and, if no results are returned, then use MatchPartial mode.

Match a maximal subset of user search terms. First use MatchAll mode and, if no results are returned, then return results matching all but one term, and so on.

Match using a Boolean query. The supported expressions are AND, OR, NOT, NEAR, ONEAR. Note: it is not possible to search with “NOT {any keyword}”. Use NOT to excude results from the initial search. Like, “Java NOT C#” – it will provide results with Java, but without C#.

Additional description can be found in “Endeca Developer’s Guide for Java” book.

Ordering

Results obtained by resume search can be ordered by several fields:

RESUME_ID, TITLE, SECTOR, LOCATION, EXPERIENCE, UPDATED in general only this fields will be returned for results preview.

Example: order-by=TITLE

Also it should be considered that location, sector, experience is returned as enumeration values or number.

Sort order

Sort ascending or descending considering order-by parameter.

ASC, DESC

Example: sort-order=ASC

Also it should be considered that location, sector, experience is returned as enumeration values or number.

Return Format