...
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.
...
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 |
...