public class

JobviteModule

extends Object
java.lang.Object
   ↳ org.mule.modules.jobvite.JobviteModule
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Jobvite can be used to get information about candidates and new hires for your company jobs.

Summary

Fields
private String apiKey The API key issued by Jobvite.
private String apiSecret The secret for this service, issued by Jobvite.
private String endpoint The Jobvite endpoint.
private JobviteClient jobviteClient
Public Constructors
JobviteModule()
Public Methods
synchronized void connect(String apiKey, String apiSecret)
Connect
String connectionId()
The key to identify the connection
synchronized void disconnect()
Destroys the session
Iterable<CandidateType> getCandidates(String candidateState, Date dateStart, Date dateEnd)
Get information about candidates.
String getEndpoint()
Returns the endpoint.
Iterable<NewHireType> getNewHires(Date dateStart, Date dateEnd)
Get information about new hires.
boolean isConnected()
void setEndpoint(String endpoint)
Sets the endpoint.
void setJobviteClient(JobviteClient jobviteClient)
void updateCandidates(Map<String, String> candidateUpdates)
Changes the status of a group of candidates.
String updateEmployees(String companyId, String importerEmail, String reportEmail, boolean doNotSyncOnWarnings, boolean overwriteEmployeeNamesAndEmail, List<Map<String, Object>> employeeUpdates)
Changes the status of a group of Employees.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

private String apiKey

The API key issued by Jobvite.

private String apiSecret

The secret for this service, issued by Jobvite.

private String endpoint

The Jobvite endpoint. Production: https://api.jobvite.com/v1/ Staging: https://api-stg.jobvite.com/v1/

private JobviteClient jobviteClient

Public Constructors

public JobviteModule ()

Public Methods

public synchronized void connect (String apiKey, String apiSecret)

Connect

Parameters
apiKey The API key for the user
apiSecret Used for sensitive data encryption. Please refer to http://www.handshake-app.com/help/kb/api/api-authentication
Throws
ConnectionException

public String connectionId ()

The key to identify the connection

public synchronized void disconnect ()

Destroys the session

public Iterable<CandidateType> getCandidates (String candidateState, Date dateStart, Date dateEnd)

Get information about candidates.

Parameters
candidateState CandidateState
dateStart DateStart
dateEnd DateEnd
Returns
  • List of candidates

public String getEndpoint ()

Returns the endpoint.

Returns
  • with the endpoint.

public Iterable<NewHireType> getNewHires (Date dateStart, Date dateEnd)

Get information about new hires.

Parameters
dateStart DateStart
dateEnd DateEnd
Returns
  • List of candidates

public boolean isConnected ()

public void setEndpoint (String endpoint)

Sets the endpoint.

Parameters
endpoint With the endpoint.

public void setJobviteClient (JobviteClient jobviteClient)

Parameters
jobviteClient

public void updateCandidates (Map<String, String> candidateUpdates)

Changes the status of a group of candidates.

Parameters
candidateUpdates Map that for every entry, has for key the applicationId of the candidate (RecordInfoType -> id), and for value the new status for it (RecordInfoType -> status). Each entry it is a candidate update. Example of an entry: CandidateType candidate = some candidate; map.put(candidate.getCandidateRecordInfo().getId().get(0).getIdValue().get(0).getValue(), "Offer Accepted")

public String updateEmployees (String companyId, String importerEmail, String reportEmail, boolean doNotSyncOnWarnings, boolean overwriteEmployeeNamesAndEmail, List<Map<String, Object>> employeeUpdates)

Changes the status of a group of Employees.

Parameters
companyId The id of the company.
importerEmail The mail of the importer.
reportEmail The report email.
doNotSyncOnWarnings Do not sync on warnings flag.
overwriteEmployeeNamesAndEmail Overwrite employee names and email flag.
employeeUpdates A Map for every employee that is going to be updated.
Returns
  • the status of the request.