getRecords 方法

目的

您可以使用 getRecords 方法来获取 API 请求中指定的所有用户数据。

请求 URL

XML 格式：
https://recruit.zoho.com.cn/recruit/private/xml/Module/getRecords?authtoken=Auth Token&scope=recruitapi

JSON 格式：
https://recruit.zoho.com.cn/recruit/private/json/Module/getRecords?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	字符串	模块（可选列），即“应聘者（姓、网站、邮箱）”或全部
fromIndex	整数	默认值 - 1
toIndex	整数	默认值 - 20 最大值 - 200
sortColumnString	字符串	如果您使用 sortColumnString 参数，默认情况下，数据会按升序排列。
sortOrderString	字符串	默认值 - asc 如果想按降序排列，您必须传递 sortOrderString=desc。
lastModifiedTime	日期时间	默认值：null 如果您指定时间，则将获取在配置时间之后修改的数据。
newFormat	整数	newFormat=1：从 Recruit 帐户插入数据时排除具有“空”值的字段。 newFormat=2：从 Recruit 帐户插入数据时包括具有“空”值的字段。
版本	整数	version=2：这将基于最新 API 实施来获取响应。 version=4：在单个 API 方法调用中获取多条记录。

* - 必备参数

空缺职位特定参数

参数

数据类型

描述

publishURL

布尔值

将值设置为 true 以获得职位详情 URL 和职位申请 URL。默认情况下，此值为 false。

注：仅当职位以 在网站中发布 形式发布时，职位 URL 才会显示。

捕获错误

Recruit API 提供独特的错误代码，以便在 Recruit 和您的应用程序之间同步数据时轻松排除编程问题。若要了解有关各种错误代码和相应定义的更多信息，请参阅错误代码。

补充说明

从 Zoho Recruit 检索数据时，会应用用户的字段级安全设置。因此，若要获取所有用户数据，请使用具有最高职位（例如：招聘人员的管理员）和角色（例如：管理员）的用户 ID。

fromIndex 和 toIndex 是可选参数。默认情况下，fromIndex 为 1，toIndex 为 20。

sortColumnString 和 sortOrderString 也是可选参数。

lastModifiedTime 参数的值应为 yyyy-MM-dd HH:mm:ss 格式。

示例

按客户名称排序（降序），以 JSON 格式获取从 20 至 200 的所有帐户

URL 格式：

https://recruit.zoho.com.cn/recruit/private/json/Clients/getRecords?newFormat=1&authtoken=sbdjEDBDJ445791323
&scope=recruitapi&fromIndex=20&toIndex=200&sortColumnString=Client Name&sortOrderString=desc&version=2

以 XML 格式获取自 2008-05-27 00:00:00 之后修改/创建的所有帐户

URL 格式：

https://recruit.zoho.com.cn/recruit/private/xml/Clients/getRecords?newFormat=1&authtoken=sbdjEDBDJ1323
&scope=recruitapi&lastModifiedTime=2008-05-27 00:00:00&version=2

使用 version = 2 获取应聘者

它将返回下面这样的响应：

<FL val="Last Name">Gossling</FL>

<FL val="Email">varunteja.ch+4@zohocorp.com</FL>

<FL val="Source">Varun</FL>

</row>

</Candidates>

在不指定 newFormat 参数的情况下获取应聘者

备注：当没有响应格式的说明时，为 newFormat 参数指定默认值“1”，即 newFormat=1

https://recruit.zoho.com.cn/recruit/private/xml/Candidates/getRecords?authtoken=Auth Token&scope=recruitapi&fromIndex=1&toIndex=20&selectColumns=Candidates(First Name,Last Name,Email,Current Employer,Source,Phone,City,Highest Qualification Held)&version=2

它将返回下面这样的响应：

<Candidates>
<row no="1">
<FL val="CANDIDATEID">292147000000107425</FL><FL val="First Name">Edwin</FL><FL val="Last Name">A</FL><FL val="Email">edwinraj.p@gmail.com, edwinirudaya@yahoo.com</FL><FL val="Phone">+919884351702</FL><FL val="City">Pammal</FL><FL val="Current Employer">AVAcorp Technologies Pvt Ltd</FL><FL val="Highest Qualification Held">B.Tech Information Technology</FL><FL val="Source">Imported by parser</FL>
</row>
</Candidates>

使用 newFormat=2 获取

https://recruit.zoho.com.cn/recruit/private/xml/Candidates/getRecords?authtoken=Auth Token&scope=recruitapi
&newFormat=2&selectColumns=Candidates(Candidate Owner,First Name,Last Name,Company,Designation,Email,Phone,Fax,Mobile,Website,Candidate Source,Candidate Status,No of Employees,Annual Revenue)

这将返回下面这样的响应：

<Candidates>
<row no="1">
<FL val="CANDIDATEID">292147000000107430</FL><FL val="First Name">Jobs</FL><FL val="Last Name">Find People</FL><FL val="Email">null</FL><FL val="Phone">null</FL><FL val="City">null</FL><FL val="Current Employer">null</FL><FL val="Highest Qualification Held">null</FL><FL val="Source">Imported by parser</FL>
</row>

</Candidates>

使用 fromIndex=1,toIndex=25 调用

备注：这将返回 1 到 25 条记录。

使用 lastModifiedTime 调用

备注：如果您指定时间，则将获取在配置时间之后修改的数据。

使用 newFormat=1 从应聘者模块选择所有字段

https://recruit.zoho.com.cn/recruit/private/xml/Candidates/getRecords?authtoken=Auth Token&scope=recruitapi

&newFormat=1&selectColumns=All&version=2

备注：这将返回所有具有值的字段。

使用 newFormat=2 从应聘者模块选择所有字段

https://recruit.zoho.com.cn/recruit/private/xml/Candidates/getRecords?authtoken=Auth Token&scope=recruitapi
&newFormat=2&selectColumns=All&version=2

备注：这将返回所有字段，包括空值字段。

使用 lastModifiedTime、fromIndex 和 toIndex 调用

顶部

还是没有找到您要寻找的内容？

写信给我们：support@zohocorp.com.cn

Recruit 帮助