getAssociatedCandidates
Purpose
You can use this method to get the data of the candidates who are associated with the job openings from third-party applications.
Request URL
XML Format:
https://recruit.zoho.com/recruit/private/xml/JobOpenings/getAssociatedCandidates?authtoken=AuthToken&scope=recruitapi&version=2
JSON Format:
https://recruit.zoho.com/recruit/private/json/JobOpenings/getAssociatedCandidates?authtoken=AuthToken&scope=recruitapi&version=2
For OAuth Authentication
| Header Name |
Value |
| Authorization |
Zoho-oauthtoken {access_token} |
Scopes
Scope=ZohoRecruit.modules.all
(or)
Scope=ZohoRecruit.modules.{scope_name}.{operation_type}
| Possible Scope Names (Case Sensitive) |
Operation Types |
|
candidate
|
ALL - Full access to the record READ - Get records from the module |
For Authtoken Authentication
| Parameter |
Data Type |
Description |
| authtoken* |
String |
Encrypted alphanumeric string to authenticate your Zoho credentials. |
| scope* |
String |
Specify the value as recruitapi |
Request Parameters
| Parameter | Data Type | Description |
| id* | String | Specify uniqueID of the Job Opening record. |
| version* | Integer | Use version=2: This will fetch responses based on the latest API implementation |
Note:
Parameters marked with * are mandatory.
Example
To associate Job Opening in Zoho Recruit using third-party applications.
Response Format:
<response uri="/recruit/private/xml/JobOpenings/getAssociatedCandidates">
<result>
<JobOpenings>
<row no="1">
<FL val="CANDIDATEID">50000000033009</FL>
<FL val="STATUS">Approved by client</FL>
</row>
<row no="2">
<FL val="CANDIDATEID">50000000027047</FL>
<FL val="STATUS">Waiting-for-Evaluation</FL>
</row>
<row no="3">
<FL val="CANDIDATEID">50000000035946</FL>
<FL val="STATUS">Waiting-for-Evaluation</FL>
</row>
<row no="4">
<FL val="CANDIDATEID">50000000036036</FL>
<FL val="STATUS">Approved by client</FL>
</row>
</JobOpenings>
</result>
</response>
<result>
<JobOpenings>
<row no="1">
<FL val="CANDIDATEID">50000000033009</FL>
<FL val="STATUS">Approved by client</FL>
</row>
<row no="2">
<FL val="CANDIDATEID">50000000027047</FL>
<FL val="STATUS">Waiting-for-Evaluation</FL>
</row>
<row no="3">
<FL val="CANDIDATEID">50000000035946</FL>
<FL val="STATUS">Waiting-for-Evaluation</FL>
</row>
<row no="4">
<FL val="CANDIDATEID">50000000036036</FL>
<FL val="STATUS">Approved by client</FL>
</row>
</JobOpenings>
</result>
</response>