updateRecords 方法
目的
您可以使用 updateRecords 方法来更新或修改 Zoho Recruit 中的记录。
重要事项:使用 POST 方法而不是 GET 方法来传递这些参数。
请求 URL
XML 格式
若要在单次 API 调用中将单条记录更新到模块:
https://recruit.zoho.com.cn/recruit/private/xml/Module/updateRecords?authtoken=Auth Token&scope=recruitapi&version=2&id=Record ID&xmlData=XML Data
若要在单次 API 调用中将多条记录更新到模块:
https://recruit.zoho.com.cn/recruit/private/xml/Module/updateRecords?authtoken=AuthToken&scope=recruitapi&version=4&xmlData=XML Data
点击多记录更新以查看示例 xmlData 和多记录重复检查的响应。
备注:Module 指的是 Candidates(应聘者)、JobOpenings(空缺职位)、Clients(客户)、Interviews(面试)、Contacts(联系人)、CustomModule1(自定义模块1)、CustomModule2(自定义模块2)、CustomModule3(自定义模块3)、CustomModule4(自定义模块4) 和 CustomModule5(自定义模块5)。
请求参数
参数 | 数据类型 | 描述 |
authtoken* | 字符串 | 加密的字母数字字符串,用来对 Zoho 凭证进行身份验证。 |
scope* | 字符串 | 将值指定为 recruitapi |
id* | 字符串 | 指定记录的 uniqueID |
xmlData* | XML | 指定字段和对应值 |
wfTrigger | 布尔值 | 将值设置为 true 以在 Recruit 帐户中更新记录时触发工作流规则。默认情况下,此参数为 false。 |
newFormat | 整数(1 或 2) | newFormat=1:从 Recruit 帐户更新数据时排除具有“空”值的字段。 newFormat=2:从 Recruit 帐户更新数据时包括具有“空”值的字段。 |
版本 | 整数 | version = 2:这将基于最新 API 实施来获取响应。 version = 4:在单个 API 方法调用中更新多条记录。 |
* - 必备参数
补充说明
- 在 Zoho Recruit 帐户中更新数据时,将应用基于职位的安全机制(职位、角色、字段级安全和数据共享规则)。因此,使用具有最高职位(例如:招聘人员的管理员)和角色(例如:管理员)的用户 ID。此外,确保在字段级安全设置中启用所有字段。对于基于职位的安全设置,在生成 API 工单时请参见 安全管理。
- 在更新数据时,确保 date 和 time 分别为 MM/dd/yyyy 和 yyyy-MM-dd HH:mm:ss 格式。
更新记录的所有者
在通过 API 更新记录时,确保您指定记录所有者的邮箱地址或用户 ID。如果您使用记录所有者的名称,则记录将被分配至身份验证令牌中使用的默认登录凭证。如果您想使用 userID 来指定记录所有者,请将 <FL val="SMOWNERID">userID</FL> 标签添加到您的 xmlData 中。
示例
若要在 Zoho Recruit 中更新记录,请按照下面的步骤操作:
- URL 应如下所示:
https://recruit.zoho.com.cn/recruit/private/xml/Candidates/updateRecords - 参数应如下所示:
- authtoken:身份验证令牌
- scope:将值指定为 recruitapi。
- xmlData:这是 XML 字符串,格式应与在获取 API 期间以 XML 格式获取记录时相同。
- id:待更新记录的 id
- version:API 的版本(2 或 4)
XML 数据格式:
https://recruit.zoho.com.cn/recruit/private/xml/Candidates/updateRecords?newFormat=1&authtoken=Auth Token&scope=recruitapi&xmlData=XMLDATA
- authtoken=xy4gr1554712345fg
- scope=recruitapi
- xmlData= 如下所示
- id = 1000000019001
- version=2
<Candidates>
<row no="1">
<FL val="Source">Web Download</FL>
<FL val="Current Employer">Your Company</FL>
<FL val="First Name">Hannah</FL>
<FL val="Last Name">Smith</FL>
<FL val="Email">testing@testing.com</FL>
<FL val="Phone">1234567890</FL>
<FL val="Home Phone">0987654321</FL>
<FL val="Other Phone">1212211212</FL>
<FL val="Fax">02927272626</FL>
<FL val="Mobile">292827622</FL>
</row>
</Candidates>
带联系人映射的任务
https://recruit.zoho.com.cn/recruit/private/xml/Tasks/updateRecords?authtoken=AuthToken&scope=recruitapi
&version=2
&id=2000000017022
&xmlData=
<Tasks>
<row no="1">
<FL val="Subject">Meeting Hall</FL>
<FL val="Due Date">2009-04-22</FL>
<FL val="Status">Completed</FL>
<FL val="CONTACTID">2000000017027</FL>
</row>
</Tasks>
活动
https://recruit.zoho.com.cn/recruit/private/xml/Events/updateRecords?authtoken=AuthToken&scope=recruitapi
&version=2
&id=2000000017023
&xmlData=
<Events>
<row no="1">
<FL val="Subject">Conference</FL>
<FL val="Start DateTime">2009-08-04 01:00:00</FL>
<FL val="End DateTime">2009-08-05 01:00:00</FL>
<FL val="Venue">Plaza</FL>
<FL val="Send Notification Email">false</FL>
</row>
</Events>
联系人
https://recruit.zoho.com.cn/recruit/private/xml/Contacts/updateRecords?authtoken=AuthToken&scope=recruitapi
&version=2
&id=2000000017024
&xmlData=
<Contacts>
<row no="1">
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="Email">test@test.com</FL>
<FL val="Department">CG</FL>
<FL val="Phone">989898988</FL>
<FL val="Fax">99999999</FL>
<FL val="Mobile">99989989</FL>
</row>
</Contacts>
面试
https://recruit.zoho.com.cn/recruit/private/xml/Interviews/updateRecords?authtoken=491e5e3374b0132324lqs2f1scb18cd0&
version=2&scope=recruitapi&id=508020000000366001&xmlData=
<Interviews>
<row no="1">
<FL val="Interview Owner">VT</FL><FL val="Interview Name"><![CDATA[Interview1]]></FL><FL val="Client Name">Client 2</FL><FL val="Interviewer">john@zohocorp.com</FL><FL val="Type">General Interview</FL><FL val="Candidate Name">Mark</FL><FL val="Posting Title">Lookup check</FL><FL val="Start DateTime">2015-01-23 15:30:00</FL>
</row>
</Interviews>
‘CDATA’的使用
目的:将特殊字符视为纯文本而非 XML 数据
URL 格式:
示例 XML 数据:
作为 POST:
<Contacts>
<row no="1">
<FL val="First Name">Amy</FL>
<FL val="Last Name">Dawson</FL>
<FL val="Email">testing@testing.com</FL>
<FL val="Title">Manager</FL>
<FL val="Phone">1234567890</FL>
<FL val="Mobile">292827622</FL>
<FL val="Account Name"><![CDATA["A & A"]]></FL>
</row>
</Contacts>
多记录更新
目的
您可以使用 updateRecords 来在单个 updateRecords API 方法中更新多条记录。请注意,version=4 是必备参数。
我们已推出用于呈现每条记录的 API 结果状态的新代码。代码如下:
2001 = Record Updated Successfully
URL 格式:
https://recruit.zoho.com.cn/recruit/private/xml/Candidates/updateRecords?authtoken=AuthToken&scope=recruitapi&version=4&xmlData=
示例 XML 数据
<Candidates>
<row no="1">
<FL val="Current Employer">Company1</FL>
<FL val="Last Name">Last Name1</FL>
<FL val="Email">automation@recruit.com1</FL>
</row>
<row no="2">
<FL val="Current Employer">Company2</FL>
<FL val="Last Name">Last Name2</FL>
<FL val="Email">automation@recruit.com2</FL>
</row>
</Candidates>
示例响应
功能和响应如下所示:
<response uri="/recruit/private/xml/Candidates/insertRecords">
<result>
<row no="1">
<success>
<code>2001</code>
<details>
<FL val="Id">2000000178701</FL>
<FL val="Created Time">2013-02-11 17:55:04</FL>
<FL val="Modified Time">2013-02-11 17:55:04</FL>
<FL val="Created By">
<![CDATA[ aghil123 ]]>
</FL>
<FL val="Modified By">
<![CDATA[ aghil123 ]]>
</FL>
</details>
</success>
</row>
<row no="2">
<success>
<code>2001</code>
<details>
<FL val="Id">2000000178702</FL>
<FL val="Created Time">2013-02-11 17:55:04</FL>
<FL val="Modified Time">2013-02-11 17:55:04</FL>
<FL val="Created By">
<![CDATA[ aghil123 ]]>
</FL>
<FL val="Modified By">
<![CDATA[ aghil123 ]]>
</FL>
</details>
</success>
</row>
</result>
</response>
如果 version=4,有些记录包含错误,有些不包含,则功能和响应将如下所示:
<response uri="/recruit/private/xml/Candidates/insertRecords">
<result>
<row no="1">
<success>
<code>2001</code>
<details>
<FL val="Id">2000000178701</FL>
<FL val="Created Time">2013-02-11 17:55:04</FL>
<FL val="Modified Time">2013-02-11 17:55:04</FL>
<FL val="Created By">
<![CDATA[ aghil123 ]]>
</FL>
<FL val="Modified By">
<![CDATA[ aghil123 ]]>
</FL>
</details>
</success>
</row>
<row no="2">
<error>
<code>4832</code>
<details>You have given a wrong value for the field: Annual Revenue</details>
</error>
</row>
</result>
</response>
注:
- 如果您使用 version=4,那么您必须在 xmlData 内提供 Id。
- 开发人员现在可轻松地识别记录 id,因为响应中的记录详细信息按照与 xml 数据中的用户请求相同的方式给出。
- 请为版本传递值 2 或 4,因为旧实施将很快被弃用。
- 在单个 API 调用中可以更新最多 100 条记录。