downloadFile
Purpose
You can use this method to download files from Recruit to your system.
Request URL
XML Format:
https://recruit.zoho.com/recruit/private/xml/Candidates/downloadFile?authtoken=AuthToken&scope=recruitapi&id=Attachment Id&version=2
JSON Format:
https://recruit.zoho.com/recruit/private/json/Candidates/downloadFile?authtoken=AuthToken&scope=recruitapi&id=Attachment Id&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 |
|
referral, campaign, assessment, vendor, offer,
attachment,
forecast, note, call, event, task,
candidate, jobopening, client, department, interview, contact & custom (for all Custom Modules
)
|
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 the unique ID of the attachment (You can get the attachment id from the getRelatedRecords API). |
| version* |
Integer |
Use version=2: This will fetch responses based on the latest API implementation. |
Note:
Parameters marked with * are mandatory.
Your program can request only 15 downloadFile calls per 5 min. If API User requests more than 15 calls, system will block the API access for 15 min.
You can download files only from Attachments section in the Record Details Page.