getRecordById 方法
目的
您可以使用此方法按记录 ID 检索各条记录。
请求 URL
XML 格式:
https://recruit.zoho.com.cn/recruit/private/xml/Module/getRecordById?authtoken=Auth Token&scope=recruitapi&version=2&id=RecordID
JSON 格式:
https://recruit.zoho.com.cn/recruit/private/json/Module/getRecordById?&authtoken=Auth Token&scope=recruitapi&version=2&id=RecordID
备注:Module 指的是 Candidates(应聘者)、JobOpenings(空缺职位)、Clients(客户)、Interviews(面试)、Contacts(联系人)、CustomModule1(自定义模块1)、CustomModule2(自定义模块2)、CustomModule3(自定义模块3)、CustomModule4(自定义模块4) 和 CustomModule5(自定义模块5)。
请求参数
参数 | 数据类型 | 描述 |
authtoken* | 字符串 | 加密的字母数字字符串,用来对 Zoho 凭证进行身份验证。 |
scope* | 字符串 | 将值指定为 recruitapi |
id* | 字符串 | id:指定记录的唯一 ID。 |
newFormat | 整数(1 或 2) | newFormat=1:从 Recruit 帐户获取数据时排除具有“空”值的字段。newFormat=2:从 Recruit 帐户获取数据时包括具有“空”值的字段。 |
版本 | 整数 | version = 2:这将基于最新 API 实施来获取响应。 |
* - 必备参数
空缺职位特定参数
参数 | 数据类型 | 描述 |
publishURL | 布尔值 | 将值设置为 true 以获得职位详情 URL 和职位申请 URL。默认情况下,此值为 false。 注:仅当职位以 在网站中发布 形式发布时,职位 URL 才会显示。 |
示例
使用下面给出的 URL 按 ID 获取记录:
https://recruit.zoho.com.cn/recruit/private/xml/Candidates/getRecordById?authtoken=Auth Token&scope=recruitapi&version=2&id=ID
在不指定 newFormat 参数的情况下获取应聘者
备注:当没有响应格式的说明时,为 newFormat 参数指定默认值“1”,即 newFormat=1
https://recruit.zoho.com.cn/recruit/private/xml/Candidates/getRecordById?authtoken=Auth Token&scope=recruitapi&id=2000000022020&version=2&selectColumns=Candidates(First Name,Last Name,Email,Current Employer,Source,Phone)
这将返回下面这样的响应:
<Candidates>
<row no="1">
<FL val="CANDIDATEID">2000000022020</FL>
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Candidate Owner">John</FL>
<FL val="Company">Zillium</FL>
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="No of Employees">10</FL>
<FL val="Annual Revenue">1000.0</FL>
<FL val="SMCREATORID">2000000016908</FL>
<FL val="Created By">John</FL>
<FL val="Created Time">2010-03-16 10:04:52</FL>
<FL val="Modified Time">2010-03-16 10:04:52</FL>
</row>
</Candidates>