Candidates

Definition

A Candidate is an individual who is applying for a job at your organisation.

Once a Candidate is created, the following information can be captured:

  • Their personal details.
  • Evidence of the training and qualifications they need for the job they’re applying for.
  • Interview and shortlist details.
  • Onboarding information and documents, such as tax details, fair work information statement, bank details, etc

At the present moment, the enableHR API exposes the personal details of Candidates.

Candidates can enter this information themselves via our self-service portal (eSS). Captured data can (or not) go through a staged approval process.

Once they have completed the onboarding process, candidates are converted into an employee.

enableHR API current exposure for Candidates:

  • Actions:
    • List existing Candidates
    • Create, retrieve and update a Candidate
    • Merge two Candidates together
    • Convert a Candidate to an Employee
  • Fields:
    • Personal information (excluding custom fields)

List all Candidates

Use this action to return a filtered list of all candidates in an Account.

Candidates are individuals who are applying for jobs. If they are successful, they can be converted to Employees.
Candidates are created and stored in Branches.
Candidates are not billed in enableHR, as opposed to Employees, Contractors and Volunteers.
List Candidates
MethodGET: List Candidates
ParametersAccount ID - Unique identifier of the Account
Response
Field Name on the ScreenDetailsExample
Candidate NumberA unique number assigned to the candidate by the user creating the candidate14345
First NameFirst name of the candidateMichael
Last NameSurname or last name of the candidateJohnson
Date of BirthBirthdate of the candidate1978-09-28
GenderGender of the candidatePossible Values: Male, Female, Non_Binary, Not_Stated
Position TitlePosition title of the candidateManager
WkDays in SystemNumber of weekdays (Monday-Friday) the candidate has been in the system5
StatusStatus of the candidate profilePossible Values: Current, Not Current
BranchBranch under which the candidate existsBrighton Store
Parent BranchParent branch of candidate’s branchIf exists – /Trumps Inc/Brighton Store.
If doesn’t exist - /Brighton Store.
enableHR Candidates
enableHR Candidate

Retrieve a Candidate

Use this action to retrieve the details of a candidate.

Candidates are individuals who are applying for jobs. If successful, they are then converted to Employees.
Candidates can use our Self-Service portal (eSS) to capture a lot of information about themselves.
Should a Candidate be converted to an Employee, this information will be copied across to the Employee record.
Retrieve Candidate
MethodGET: Retrieve Candidate
ParametersAccount ID - Unique identifier of the Account.
Candidate ID - Unique identifier of the Candidate
Response
Field Name on the ScreenDetailsExample
Candidate NumberCandidate number as stored in enableHR12345
TitleHonorific of the candidatePossible Values: Mr, Mrs, Ms, Miss, Dr
First NameFirst name of the candidateMichael
Last NameSurname or last name of the candidateJohnson
Middle NameMiddle name of the candidateK
Preferred NameCandidate’s preferred nameMike
Nick NameShort name called at workplaceMickey
Date of BirthBirthdate of the candidate1998-10-21
Linked PositionLinked Position for the candidateDirector
BranchName of the branch the candidate is underBrighton Store
Parent BranchParent branch of candidate’s branchIf exists – /Trumps incorporated/Brighton Store
If doesn’t exist - /Brighton Store
Weekdays in SystemSince how many days the candidate profile is in the system15
StatusCurrent Status of the candidatePossible Values: Current, Not Current
Line1:Line 1 of the addressSuite 3
Line2:Line 2 of the address1234 Pacific Highway
Suburb:Suburb of the candidateSydney Town
State:State where the suburb is locatedNSW
Post Code:Postal code of the suburb2002
Country:Country of the suburbAustralia
Line1:Line 1 of the postal addressSuite 3
Line2:Line 2 of the postal address1234 Pacific Highway
Suburb:Suburb of the candidateSydney Town
State:State where the suburb is locatedNSW
Post Code:Postal code of the suburb2002
Country:Country of the suburbAustralia
Email (Work)Work Email addressMichel.Johnsomn@abc.com
Email (Home)Personal Email addressMichel.Johnsomn@gmail.com
Phone number (Home)Home phone number08 4044 0999
Mobile Phone (Home)Personal mobile phone number0404 404 040
GenderGender of the candidatePossible Values: Male, Female, Non_Binary, Not_Stated
Position TitleThe title of the position associated to the candidate (Manager, CTO, CEO)Manager
Proposed Commencement DateProposed start date of the employment for the candidate2021-09-15
Created byThe username of the enableHR user who created the candidateTom@blitz.com.au
New Candidate IDWhen a candidate is transferred, they are given a new candidate id.
This field contains value only when a candidate is transferred.
3436f492c93bc25a4d2cb48c96664c1a
Old Candidate IDThis is the candidate Id of a candidate prior to his transfer.
This field contains value only if the candidate has been transferred.
54393bc26664c1a5a4d62cb48c9f492c
enableHR Employee Details
enableHR Employee Details

Create a Candidate

Use this action to create a new Candidate.

Candidates are individuals who are applying for jobs. If successful, they are then converted to Employees.
Candidates can use our Self-Service portal (eSS) to capture a lot of information about themselves.
Should a Candidate be converted to an Employee, this information will be copied to the Employee record.
Candidates are created in branches. The ‘Branch ID’, the ‘First Name’ and ‘Last Name’ of the Candidates, are the only mandatory fields when creating a Candidate.
Create Candidate
MethodPOST: Create Candidate
ParametersAccount ID - Unique identifier of the Account.
Branch ID - Unique identifier of the Branch
Accepted Fields
Field NameDetailsExample
Branch ID - Mandatory
Unique ID of the branch39c4e9b0418e4236b6a8ac4bce927a9e
TitleHonorific of the candidatePossible Values: Mr, Mrs, Ms, Miss, Dr
First Name - Mandatory
First name of the candidateRajesh
Last Name - Mandatory
Surname or last name of the candidatePowar
Middle NameMiddle name of the candidateK
Preferred NameCandidate’s preferred nameRaj
Nick NameShort name called at workplaceRaj
Position TitlePosition for which the candidate will be recruited
(free text, not related to the company org chart)
Managing Director
GenderGender of the candidatePossible Values: Male, Female, Non_Binary, Not_Stated
Date of BirthBirthdate of the candidate2000-12-29
Candidate StatusCurrent status of the candidatePossible Values: Current, Not Current
Candidate NumberUnique number allocated to the candidate12345
Line1:Line 1 of the addressSuite 3
Line2:Line 2 of the address1234 Pacific Highway
Suburb:Suburb of the candidateSydney Town
State:State where the suburb is locatedNSW
Post Code:Postal code of the suburb2002
Country:Country of the suburbAustralia
Line1:Line 1 of the postal addressSuite 3
Line2:Line 2 of the postal address1234 Pacific Highway
Suburb:Suburb of the candidateSydney Town
State:State where the suburb is locatedNSW
Post Code:Postal code of the suburb2002
Country:Country of the suburbAustralia
Email (W)Work Email addressRajesh.Powar@abc.com
Email (h)Personal Email addressRajesh.Powar@gmail.com
Phone number (h)Home phone number08 4044 0999
Mobile PhonePersonal mobile phone number0404 404 040
Commencement DateProposed start date of employment2021-09-23
GenderGender of the candidatePossible Values: Male, Female, Non_Binary, Not_Stated
Position TitleThe title of the position associated to the candidate (Manager, CTO, CEO)Manager
Proposed Commencement DateProposed start date of the employment for the candidate2021-09-15
Created byThe username of the enableHR user who created the candidateTom@blitz.com.au
New Candidate IDWhen a candidate is transferred, they are given a new candidate id.
This field contains value only when a candidate is transferred.
3436f492c93bc25a4d2cb48c96664c1a
Old Candidate IDThis is the candidate Id of a candidate prior to his transfer.
This field contains value only if the candidate has been transferred.
54393bc26664c1a5a4d62cb48c9f492c
enableHR Candidate Details
enableHR Candidate Details

Update a Candidate

Use this action to update a Candidate.

Most of the candidate fields can be updated using this action. However it cannot be used to move a candidate from one branch to another, you need to use the specific “Transfer a Candidate” action for this.
Update Candidate
MethodPUT: Update Candidate
ParametersAccount ID - Unique identifier of the Account.
Branch ID - Unique identifier of the Branch.
Candidate ID - Unique identifier of the Candidate.
Accepted Fields
Field NameDetailsExample
Branch ID - Mandatory
Branch information of the candidate
How to retrieve the Branch ID
Unique ID of branch: 39c4e9b0418e4236b6a8ac4bce927a9e
TitleHonorific of the candidatePossible Values: Mr, Mrs, Ms, Miss, Dr
First Name - Mandatory
First name of the candidateRajesh
Last Name - Mandatory
Surname or last name of the candidatePowar
Middle NameMiddle name of the candidateK
Preferred NameCandidate’s preferred nameRaj
Nick NameShort name called at workplacePower
GenderGender of the candidatePossible Values: Male, Female, Non_Binary, Not_Stated
Date of BirthBirthdate of the candidate2000-12-29
Position TitlePosition for which the candidate will be recruitedStorekeeper
Candidate StatusCurrent status of the candidatePossible Values: Current, Not Current
Line1:Line 1 of the addressSuite 3
Line2:Line 2 of the address1234 Pacific Highway
Suburb:Suburb of the candidateSydney Town
State:State where the suburb is locatedNSW
Post Code:Postal code of the suburb2002
Country:Country of the suburbAustralia
Candidate NumberCandidate number allocated to the associate12345
Line1:Line 1 of the postal addressSuite 3
Line2:Line 2 of the postal address1234 Pacific Highway
Suburb:Suburb of the candidateSydney Town
State:State where the suburb is locatedNSW
Post Code:Postal code of the suburb2002
Country:Country of the suburbAustralia
Email (W)Work Email addressRajesh.Powar@abc.com
Email (h)Personal Email addressRajesh.Powar@gmail.com
Phone number (h)Home Phone number08 4044 0999
Mobile PhonePersonal mobile phone number0404 404 040
Candidate NumberUnique number assigned by the company.0064
Commencement DateProposed start date of employment2021-09-22
Position TitleThe title of the position associated to the candidate (Manager, CTO, CEO)Manager
Proposed Commencement DateProposed start date of the employment for the candidate2021-09-15
Created byThe username of the enableHR user who created the candidateTom@blitz.com.au
New Candidate IDWhen a candidate is transferred, they are given a new candidate id.
This field contains value only when a candidate is transferred.
3436f492c93bc25a4d2cb48c96664c1a
Old Candidate IDThis is the candidate Id of a candidate prior to his transfer.
This field contains value only if the candidate has been transferred.
54393bc26664c1a5a4d62cb48c9f492c
enableHR Candidate DetailsenableHR Candidate Details

Merge two Candidates

Use this action to merge two Candidates together.

This function is generally used when an applicant has applied for multiple positions, which means there will be more than one Candidate records created for the same person. Merging these records will allow for all the documentation to be combined in the one Candidate rather than spread across many duplicate records. All personal and contact details of the Candidate (source) will be merged into the Candidate (destination) during this process. Once the merge is complete, the source Candidate will be deactivated.
Merge Candidates
MethodPOST: Merge Candidates
ParametersAccount ID - Unique identifier of the Account.
Candidate ID - Unique identifier of the Candidate.
Accepted Fields
Field NameDetailsExample
Mandatory – Candidate ID
Unique ID of the source candidate from whom the data will be taken
and merged with the candidate ID provided in the input parameters
48bfac081fc4457c84936fe123976097
enableHR Merge Records

Convert a Candidate into an Employee

Use this action to convert a Candidate into an Employee.

All the personal details of the Candidate will be copied across to the Employee, as well as all the Candidate’s documents and notes. Any incomplete checklist that was opened against the Candidate record will be archived.
To convert a Candidate, the only mandatory field is the Commencement Date of employment. Once the conversion is complete, the status of the Candidate will become ‘Converted’ and the Candidate won’t appear in the active list of Candidates anymore.
Convert Candidate into Employee
MethodPOST: Convert Candidate to Employee
ParametersAccount ID - Unique identifier of the Account.
Candidate ID - Unique identifier of the Candidate.
Accepted Fields
Field NameDetailsExample
Mandatory - Commencement Date
Proposed start date of employment2021-09-25
enableHR Create Employee from Candidate
© 2022 enableHR · All rights reserved