changeCandidateRating
Purpose
You can use this method to change the candidate rating with respect to the job openings in Zoho Recruit.
Note: Use the POST method to pass these parameters instead of GET method.
Request URL
XML Format:
https://recruit.zoho.com/recruit/private/xml/Candidates/changeCandidateRating?authtoken=AuthToken&scope=recruitapi&jobId=54290000000089027&candidateIds=54290000000022332,54290000000089027&rating=5.0&comments=Well Performed
JSON Format:
https://recruit.zoho.com/recruit/private/json/Candidates/changeCandidateRating?authtoken=AuthToken&scope=recruitapi&jobId=54290000000089027&candidateIds=54290000000022332,54290000000089027&rating=5.0&comments=Well Performed
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 |
|
candidaterating
|
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 |
| jobId |
String |
Specify uniqueID of the Job Opening record for which the associated candidate rating has to be changed. |
| candidateIds* |
String |
Specify candidate ids, separated by comma, for which the rating has to be changed, with respect to the job opening. |
| version* |
Integer |
Use version=2: This will fetch responses based on the latest API implementation |
| rating* |
Integer |
Specify the rating of the candidate with respect to the job opening. |
| comments |
String |
Specify the comments for the change in rating. |
Note: Parameters marked with * are mandatory.
Example
To change the rating of the candidates with respect to the job openings.
URL Format:
https://recruit.zoho.com/recruit/private/xml/Candidates/changeCandidateRating?authtoken=AuthToken&scope=recruitapi&jobId=54290000000089027&candidateIds=54290000000022332,54290000000089027&rating=5.0&comments=Well Performed
Response Format:
<response uri="/recruit/private/xml/Candidates/changeCandidateRating">
<result>
<Candidates>
<message>Rating updated successfully</message>
<recorddetail>
<FL val="CANDIDATEID">2179000001594148</FL>
</recorddetail>
</Candidates>
</result>
</response>
<result>
<Candidates>
<message>Rating updated successfully</message>
<recorddetail>
<FL val="CANDIDATEID">2179000001594148</FL>
</recorddetail>
</Candidates>
</result>
</response>