TR Candidate API V2

Terminology

Click here for an overview of Terminology

Limits

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

URL Format

All the Web Service methods use a common convention in their URLs. The URLs consist of parts for customer alias and method name. E.g.:

https://recruiter-api.hr-manager.net/restful.svc/v2/{CUSTOMER-ALIAS}/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.

 

curl https://recruiter-api.hr-manager.net/restful.svc/v2/{CUSTOMER-ALIAS}/Candidates/ -H "apikey: {API-KEY-VALUE}" -H "Content-Type: application/json"

 

Items

The node for items include the list of position data objects.

{ "Id": 100, "ThirdPartyCandidateId": "", "Title": "", "FirstName": "John", "LastName": "Doe", "Email": "john.doe@hrmts.cool", "Birthdate": "/Date(-62135596800000)/", "Gender": 1, "HiredDateTimeUtc": "/Date(1523353751000+0200)/", "HiredInPositionId": 100, "HiredInDepartmentId": 100, "HiredInDepartmentThirdPartyId": "", "PositionList": [ { "Id": 100, "ThirdPartyPositionId": null, "Name": "Engineer", "Type": 1, "DepartmentId": 100, "DepartmentThirdPartyId": "", "ProjectThirdPartyId": "", "IsActive": true, "IsPublished": true, "ApplicationDueDateTimeUtc": "/Date(1524830400000)/", "PositionLeader": { "Id": 101, "ThirdPartyUserId": "", "Email": "", "Title": null, "FirstName": "", "LastName": "", "Details": null }, "Details": null } ], "Details": { "SecondLastName": "", "SecondaryEmail": "", "MaritalStatus": null, "Nationality": "", "Address": "", "Address2": "", "POBox": "", "Zip": "", "City": "", "Country": "", "PhonePrivate": "", "PhoneMobile": "", "PhoneWork": "", "PhoneFax": "", "WebSite": "", "YearsOfHigherEducation": "", "ProfileImageUrl": "", "EducationArea": null, "EducationLevel": null, "EducationTitle": null, "YearsOfExperience": "", "MainWorkArea": null, "MainWorkAreaRole": null, "YearsInMainWorkAreaRole": "", "CurrentEmployer": "", "CurrentPosition": "", "HasReferences": false, "PreferredLanguage": "Default", "SSN": "", "QueueNumber": 0, "IsInternal": false, "Rank": null, "LastLoginDateTimeUtc": "/Date(-62135596800000)/", "CreatedDateTimeUtc": "/Date(1522929200000)/", "LastUpdateddDateTimeUtc": "/Date(1523353767000)/", "RegistrationDateTimeUtc": "/Date(-62135596800000)/", "ExtendedProfile": null, "Assessment": null, "TagList": [], "DocumentList": null, "ActivityLogList": null, "CommunicationList": null, "ScreeningList": null, "ApplicationFormQuestionnaireList": null, "ProcessQuestionnaireList": null, "ExternalLinkList": null, "PropertyBag": [], "SpecialConditionTagList": [] } }

Candidates Query String Parameters

Following are the query string parameters dedicated for positions

Candidate Id

Parameter

canid

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

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

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

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

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

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

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

Parameter

inccov

Description

Send this parameter to include cover letter.

Value type

Boolean

Default value

False

Sample

.../?inccov=1

Include Questionnaire

Parameter

incquexml

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

Parameter

incdocbytes

Description

Send this parameter to include contents of the documents.

Value type

Boolean

Default value

False

Sample

../?incdocbytes=1

IncludeAll

Parameter

incall

Parameter

incall

Description

Send this parameter to include all in call

Value type

Boolean

Default value

False

Sample

../?incall=1