This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

Working with Candidates in Zoho Recruit

Owned by Former user (Deleted)
Last updated: Aug 17, 2015 by Former user (Deleted)
2 min read

Overview

The following operations allow you to work with candidates. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with candidates, see Sample configuration. 

OperationDescription

associateJobOpening

Associates candidates with a job opening.

changeStatusChanges the status of a set of candidates to "hired" / "not hired".

Operation details

This section provides further details on the operations related to candidates.

Associating a candidate

The associateJobOpening operation associates candidates with a job opening.

associateJobOpening 
<zohorecruit.associateJobOpening>
	<jobIds>{$ctx:jobIds}</jobIds>
	<candidateIds>{$ctx:candidateIds}</candidateIds>
	<comments>{$ctx:comments}</comments>
	<status>{$ctx:status}</status>
	<version>{$ctx:version}</version>
</zohorecruit.associateJobOpening>
Properties
  • jobIds: The unique ID of the Job Opening record.
  • candidateIds: A comma-separated list of candidate IDs to associate with the above job ID.
  • comments : Specify the comments for the association.
  • status : Specify the status of the Candidate with the associated Job opening.
  • version : Fetch responses based on the latest API implementation.
Sample request

Following is a sample REST/JSON request that can be handled by the associateJobOpening operation.

Sample Request for associateJobOpening 
{
	"apiUrl" : "https://recruit.zoho.com",
	"authToken" : "8e8f36073ff4642cf23c2832b6f6722c",
	"scope" : "recruitapi",
	"jobId" : "291847000000064001",
	"candidateIds" : "456734350000004321",
	"responseFormat" : "json"
}
Related Zoho Recruit documentation

https://www.zoho.com/recruit/api-new/api-methods/associateJobopeningMethod.html

Changing the status of candidates

The changeStatus operation changes the status of a set of candidates to "hired" / "not hired" with respect to a job opening they are associated with.

changeStatus
<zohorecruit.changeStatus>
	<jobId>{$ctx:jobId}</jobId>
	<candidateIds>{$ctx:candidateIds}</candidateIds>
	<candidateStatus>{$ctx:candidateStatus}</candidateStatus>
	<comments>{$ctx:comments}</comments>
	<version>{$ctx:version}</version>
 </zohorecruit.changeStatus>
Properties
  • jobId: The unique ID of the Job Opening record for which the associated candidate status has to be changed.
  • candidateIds: A comma-separated list of candidate IDs for which the status has to be changed with respect to the job opening.
  • candidateStatus: The status of the resume with respect to the job opening, either "hired" or "not hired".
  • comments: The comments describing why the status is being changed.
  • version : Fetch responses based on the latest API implementation.
Sample request

Following is a sample REST/JSON request that can be handled by the changeStatus operation.

Sample Request for changeStatus 
{
	"apiUrl" : "https://recruit.zoho.com",
	"authToken" : "8e8f36073ff4642cf23c2832b6f6722c",
	"scope" : "recruitapi",
	"jobId" : "291847000000064001",
	"candidateIds" : "284957000000055762",
	"candidateStatus" : "Hired",
	"comments" : "Placed in Senior Java Development",
	"responseFormat" : "json"
}
Related Zoho Recruit documentation

https://www.zoho.com/recruit/api-new/api-methods/changeStatusMethod.html

Sample configuration

Following is a sample proxy service that illustrates how to connect to Zoho Recruit with the init operation and use the associateJobOpening operation. The sample request for this proxy can be found in associateJobOpening sample request. You can use this sample as a template for using other operations in this category.

Sample Proxy
<?xml version="1.0" encoding="UTF-8"?>
<proxy xmlns="http://ws.apache.org/ns/synapse" name="zohorecruit_associateJobOpening" transports="https,http" statistics="disable" trace="disable" startOnLoad="true">
	<target>
		<inSequence onError="faultHandlerSeq">
			<property name="apiUrl" expression="json-eval($.apiUrl)" />
			<property name="authToken" expression="json-eval($.authToken)" />
			<property name="module" expression="json-eval($.module)" />
			<property name="scope" expression="json-eval($.scope)" />
			<property name="responseFormat" expression="json-eval($.responseFormat)" />
			<property name="jobIds" expression="json-eval($.jobIds)" />
			<property name="candidateIds" expression="json-eval($.candidateIds)" />
			<property name="comments" expression="json-eval($.comments)" />
            <property name="status" expression="json-eval($.status)" />
            <property name="version" expression="json-eval($.version)" />
			<zohorecruit.init>
				<apiUrl>{$ctx:apiUrl}</apiUrl>
				<authToken>{$ctx:authToken}</authToken>
				<scope>{$ctx:scope}</scope>
				<responseFormat>{$ctx:responseFormat}</responseFormat>
			</zohorecruit.init>								
			<zohorecruit.associateJobOpening>
				<jobIds>{$ctx:jobIds}</jobIds>
				<candidateIds>{$ctx:candidateIds}</candidateIds>
				<comments>{$ctx:comments}</comments>
				<status>{$ctx:status}</status>
				<version>{$ctx:version}</version>
			</zohorecruit.associateJobOpening>
			<respond />
		</inSequence>
		<outSequence>
			<send />
		</outSequence>
	</target>
	<description />
</proxy>