getSearchRecords 方法
目的
您可以使用此方法以按所选列的表达式搜索记录。
请求 URL
XML 格式
https://recruit.zoho.com.cn/recruit/private/xml/Module/getSearchRecords?authtoken=Auth Token&scope=recruitapi
JSON 格式
https://recruit.zoho.com.cn/recruit/private/json/Module/getSearchRecords?authtoken=Auth Token&scope=recruitapi
备注:Module 指的是 Candidates(应聘者)、JobOpenings(空缺职位)、Clients(客户)、Interviews(面试)、Contacts(联系人)、CustomModule1(自定义模块1)、CustomModule2(自定义模块2)、CustomModule3(自定义模块3)、CustomModule4(自定义模块4) 和 CustomModule5(自定义模块5)。
请求参数
参数 | 数据类型 | 描述 |
authtoken* | 字符串 | 加密的字母数字字符串,用来对 Zoho 凭证进行身份验证。 |
scope* | 字符串 | 将值指定为 recruitapi |
selectColumns* | 字符串 | 模块(可选列),即“应聘者(姓、网站、邮箱)”或全部 |
searchCondition* | XML | (创建人|=|用户名) |
newFormat | 整数(1 或 2) | newFormat=1:从 Recruit 帐户插入数据时排除具有“空”值的字段。 newFormat=2:从 Recruit 帐户插入数据时包括具有“空”值的字段。 |
fromIndex | 整数 | 默认值 - 1 |
toIndex | 整数 | 默认值 - 20 最大值 - 200 |
version* | 整数 | version = 2:这将基于最新 API 实施来获取响应。 |
* - 必备参数
空缺职位特定参数
参数 | 数据类型 | 描述 |
publishURL | 布尔值 | 将值设置为 true 以获得职位详情 URL 和职位申请 URL。默认情况下,此值为 false。 注:仅当职位以 在网站中发布 形式发布时,职位 URL 才会显示。 |
正则表达式
在使用此方法时,确保 selectColumns 和 searchCondition 参数设置为必填。您可以在 API 请求中指定以下表达式:
- Is 或 =
- isn't 或 <>
- contains(*srcString*)
- starts with(srcString*)
- ends with(*srcString)
- doesn't contain
- < 或 is before
- > 或 is after
- <=
- =>
示例
示例 1
如果您想要从“应聘者”模块中选择姓、目前工作单位、邮箱、手机号码,且邮箱应包含“@sample.com”,则搜索 API 请求应如下所示:
https://recruit.zoho.com.cn/recruit/private/xml/Candidates/getSearchRecords?authtoken=Auth Token&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Current Employer,Email,Mobile)&searchCondition=(Email|contains|*@sample.com*)
示例 2
如果您想要从“应聘者”模块中选择姓、邮箱、网站、经验年数,且经验年数应大于 2,则搜索 API 请求应如下所示:
https://recruit.zoho.com.cn/recruit/private/xml/Candidates/getSearchRecords?authtoken=Auth Token&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Email,Website,Experience in Years)&searchCondition=(Experience in Years|>|2)
示例 3
如果您想要从“应聘者”模块中选择姓、邮箱且公司应以“Zoho”开头,则搜索 API 请求应如下所示:
https://recruit.zoho.com.cn/recruit/private/xml/Candidates/getSearchRecords?authtoken=Auth Token&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Email)&searchCondition=(Current Employer|starts with|Zoho*)
使用等号 (=) 的示例
https://recruit.zoho.com.cn/recruit/private/xml/Candidates/getSearchRecords?authtoken=Auth Token&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(First Name,Last Name,Email)&searchCondition=(Email|=|test@test.com)
使用小于号 (<) 的示例
备注:将所有空值整数字段替换为“0”。未包含值的整数字段将不会包括在搜索中。
https://recruit.zoho.com.cn/recruit/private/xml/Candidates/getSearchRecords?authtoken=Auth Token&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Email,Current Employer)
&searchCondition=(customfield1|<|1000)
使用“包含”的示例
https://recruit.zoho.com.cn/recruit/private/xml/Candidates/getSearchRecords?authtoken=Auth Token&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Email,Current Employer)
&searchCondition=(Current Employer|contains|*oho*)
使用“开始字符”的示例
https://recruit.zoho.com.cn/recruit/private/xml/Candidates/getSearchRecords?authtoken=Auth Token&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Email,Current Employer)
&searchCondition=(Current Employer|starts with|zoho*)
使用“结束字符”的示例
https://recruit.zoho.com.cn/recruit/private/xml/Candidates/getSearchRecords?authtoken=Auth Token&scope=recruitapi&version=2&newFormat=1&selectColumns=Candidates(Last Name,Email,Current Employer)
&searchCondition=(Current Employer|ends with|*zoho)