Skip to main content

Class: VacancyClient

API client to make requests to the Vacancy API.

Constructors​

Constructor​

new VacancyClient(baseUrl, backend?): VacancyClient

Parameters​

baseUrl​

string

backend?​

HttpBackend = fetchBackend

Returns​

VacancyClient

Methods​

createCandidate()​

createCandidate(customerId, language, candidate, attachments, image?): Promise<CandidateResult>

Creates a new candidate for a vacancy.

Parameters​

customerId​

string

Your customer id.

language​

string

The language to request.

candidate​

CandidateUpload

The candidate to add to the vacancy.

attachments​

File[]

Attachments to upload.

image?​

File

Candidate image.

Returns​

Promise<CandidateResult>

getApplicationFormType()​

getApplicationFormType(customerId, language, applicationFormType?): Promise<ApplicationFormType>

Returns the setup for a Vacancy.

Parameters​

customerId​

string

Your customer id.

language​

string

The language to request.

applicationFormType?​

string = 'Standard'

The application form type to request.

Returns​

Promise<ApplicationFormType>

getSimpleVacancyList()​

getSimpleVacancyList(customerId, language, filtersAndConfiguration?): Promise<SimpleVacancyDetails[]>

Returns a less detailed list of vacancies.

Parameters​

customerId​

string

Your customer id.

language​

string

The language to request.

filtersAndConfiguration?​

VacancyListFilters & VacancyListConfiguration

Filters and configuration to apply to the request.

Returns​

Promise<SimpleVacancyDetails[]>

getVacancyDetails()​

getVacancyDetails(customerId, id, language, filters?): Promise<VacancyDetails>

Returns a single vacancy.

Parameters​

customerId​

string

Your customer id.

id​

string

The id of the vacancy.

language​

string

The language to request.

filters?​

VacancyDetailsFilters

The filters to apply to the request.

Returns​

Promise<VacancyDetails>

getVacancyDetailsConfiguration()​

getVacancyDetailsConfiguration(customerId, language): Promise<VacancyDetailsConfiguration>

Returns the site settings for Vacancy.

Parameters​

customerId​

string

Your customer id.

language​

string

The language to request.

Returns​

Promise<VacancyDetailsConfiguration>

getVacancyList()​

getVacancyList(customerId, language, filtersAndConfiguration?): Promise<VacancyDetails[]>

Returns a detailed list of vacancies.

The result of this API should be cached and reused.

Parameters​

customerId​

string

Your customer id.

language​

string

The language to request.

filtersAndConfiguration?​

VacancyListFilters & VacancyListConfiguration

Filters and configuration to apply to the request.

Returns​

Promise<VacancyDetails[]>

getVacancyListConfiguration()​

getVacancyListConfiguration(customerId, language): Promise<VacancyListConfiguration>

Returns the site settings for Vacancy List.

Parameters​

customerId​

string

Your customer id.

language​

string

The language to request.

Returns​

Promise<VacancyListConfiguration>