...
All the Web Service methods use a common convention in their URLs. The URLs consist of parts for customer alias , API key and method name. E.g.:
https://recruiter-api.hr-manager.net/restful.svc/v2/{CUSTOMER-ALIAS}/{API-KEY}/Candidates/
When calling an API method, simply replace these parts with proper values.
Calling the above API requires an API Key with the key name "apikey". This should be sent as a request header. Below is a curl example to fetch candidates for a customer using restful service passing API Key and value in the request header. |
|
Items
The node for items include the list of position data objects.
...
Following are the query string parameters dedicated for positions
Candidate Id
Parameter | canid |
|---|---|
Description | Send this parameter to filter the list with a single candidate. Retrieving a single candidate returns full details of the candidate. |
Value type | Integer |
Default value | none |
Sample | …/?canid=1 |
Position Id
Parameter | posid |
|---|---|
Description | Send this parameter to filter the list with a single position id. |
Value type | Integer |
Default value | none |
Sample | …/?posid=1 |
Gender
Parameter | gender |
|---|---|
Description | Send this parameter to filter the list with candidates’ gender. The valid values are M for males and F for females. Skip this parameter to list both males and females. |
Value type | Text |
Default value | none |
Sample | .../?gender=F |
Hired
Parameter | hired |
|---|---|
Description | Send this parameter to filter the list with hired candidates |
Value type | Boolean |
Default value | False |
Sample | .../?hired=1 |
Hired After
Parameter | hiredafter |
|---|---|
Description | Send this parameter to filter the list with candidates hired after a given date and time. The date and time must be specified as GMT+0 (UTC). |
Value type | DateTime [Format: YYYYMMDD or YYYYMMDD-hhmmss] |
Default value | None |
Sample | …/?hiredafter=20171231 …/?hiredafter=20171231-160000 |
Include DocGen
Parameter | incdocgen |
|---|---|
Description | Send this parameter to include documents generated with DocGen. Note that you must specify a candidate before you can retreive the documents, |
Value type | Boolean |
Default value | False |
Sample | .../?incdocgen=1 |
Include Digitally signed documents
Parameter | incsigneddoc |
|---|---|
Description | Send this parameter to include documents which are digitally signed (currently we only support Penneo). Note that you must specify a candidate before you can retrieve the documents, |
Value type | Boolean |
Default value | False |
Sample | .../?incsigneddoc=1 |
Include Cover Letter
Parameter | inccov |
|---|---|
Description | Send this parameter to include cover letter. |
Value type | Boolean |
Default value | False |
Sample | .../?inccov=1 |
Include Questionnaire
Parameter | incquexml |
|---|---|
Description | Send this parameter to include the questionnaire object with candidate's answers. Note that you must provide a canid (candidateId)and posid (projectId) in order to retreive the questionnaire data. |
Value type | Boolean |
Default value | False |
Sample | .../?incquexml=1 |
Include Document Bytes
Parameter | incdocbytes |
|---|---|
Description | Send this parameter to include contents of the documents. |
Value type | Boolean |
Default value | False |
Sample | ../?incdocbytes=1 |
IncludeAll
Parameter | incall |
|---|---|
Description | Send this parameter to include all in call |
Value type | Boolean |
Default value | False |
Sample | ../?incall=1 |