Foreword

The Job Portal API is a public RESTFul API, restricted to deliver data over vacancies (positions) created in the System. This API does not require any authentication, as this information is public anyways, and used on Customers' career pages.

The positions available through these methods are basically active projects that are currently published.

Attention

Please read the API Usage Notice before implementing API consumption. The api will by default get max 25 positions, to change this or do paging please read the section about common parameters for RESTFul apis.

Notice the API have a connection timeout on 180 seconds.

Base URL

The following is the base URL for the Job Portal API, where the <ALIAS> stands for the Customer alias configured in the System. The <FUNCTION> represents the exact function of the API being called:

https://recruiter-api.hr-manager.net/jobportal.svc/<ALIAS>/<FUNCTION>/

Transaction Status

Each data block returned by these methods include a TransactionStatus node that represents the success of the operation. The status node can contain either Success or Error. In case of error, the description node describes the error that may have occurred during the operation.

Job Portal API Success

Functions

Following is the list of functions available in the Job Portal API.

Retrieve a Single Position

The following are methods to retrieve a single position.

The parameter {positionId} is the id of the position/project as specified in the HR Manager Talent Recruiter, or returned by various other RESTFul methods. The position displays the data stored for the relevant active and published position in the system. The returned position data also includes URLs for advertisement pages and application form pages.

Retrieve List of All Positions

The following are methods to retrieve list of all positions.

Each position in the list displays the data stored for the relevant active and published positions in the system matching the search and filtering criteria. The returned position data also includes URLs for advertisement pages and application form pages. In addition to the list of available positions, the list contains the following counters:

PositionCountCustomer: Total available positions for the customer
PositionCountSearch: Total available positions matching the search and filtering criteria
PositionCountList: Total available positions in the current list
PositionCountSkipped: Total positions skipped in PositionCountSearch due to paging variables

Retrieve List of Departments

The following are methods to retrieve list of departments where positions are available.

Each department in the list displays the department id, the department name and the number of positions available for the department given the search and filtering criteria.

Retrieve List of Categories

The following are methods to retrieve list of categories that are defined for the available positions.

Each category in the list displays the category id, the category name and the number of positions available for the category given the search and filtering criteria.