Search Rule

Description

Every position has exactly one search rule. Search rules define periodicity and types of searches for that position.

API Schema

Field Name

Type

Description

UPD

Notes

id

String(50)

Unique ID

Ign.

 

positionId

String(50)

ID of position

+

 

withinDaysCount

int

Maximum age of resume to be searched

+

 

isActive

String(10)

Defines if this rule is active

-

True | False

startDate

ISO8601 datetime (string)

Defines when this rule starts generating searches

+

 

dayRepeat

int

Repeat search every X days (X is value of this field)

-

Don’t repeat search if 0 or not specified

finishDate

ISO8601 datetime (string)

Defines when this rule stops generating searches

-

Can be specified only if day_repeat is specified

searchProvider

String(256)

Defines where and how to search

+

See “<searchProvider> schema” below

maxResumesPerSource

int

Maximum number of resumes from each source

-

 

maxSearchDurationMins

int

Maximum search duration in minutes

-

 

creatorAccountId

String(50)

ID of account who created this search rule

Ign.

Read-only!

createdDate

ISO8601 datetime (string)

When search rule was created

Ign.

Read-only!

lastRunDate

ISO8601 datetime (string)

When this rule last generated a search

Ign.

Read-only!

nextRunDate

ISO8601 datetime (string)

When this rule will next generate a search

Ign.

Read-only!

<searchProvider> Schema

<searchProvider>
<localSearch>
<searchByKeywords>True|False</searchByKeywords>
<searchByDescription>True|False</searchByDescription>
</localSearch>
<externalSearch>
<searchInAllFreeSources>True|False</searchInAllFreeSources>
<searchInSeatSources>
<seatSource><id>[ANY]</id></seatSource>
<seatSource><id>XXX</id></seatSource>
<seatSource><id>YYY</id></seatSource>
</searchInSeatSources>
<webSearch>True|False</webSearch >
</externalSearch>
</searchProvider>
 

Notes on updating search rules:

  • All nodes in <searchProvider> are optional
  • If node is not present, the respective value(s) is not affected
  • If <searchInSeatSources> node is empty, search in paid and registered seat sources is disabled
  • If <searchInSeatSources> node contains special [ANY] source, other specified sources are ignored and search is performed in all seat sources