addRecords 方法
目的
您可以使用 addRecords 方法将记录插入所需的 Zoho Recruit 模块。
重要事项:使用 POST 方法而不是 GET 方法来传递这些参数。
请求 URL
XML 格式:
https://recruit.zoho.com.cn/recruit/private/xml/Module/addRecords?authtoken=AuthToken&scope=recruitapi&version=2&xmlData=Your XML Data
备注:Module(模块) 指的是 Candidates(应聘者)、JobOpenings(空缺职位)、Clients(客户)、Interviews(面试)、Contacts(联系人)、CustomModule1(自定义模块1)、CustomModule2(自定义模块2)、CustomModule3(自定义模块3)、CustomModule4(自定义模块4)和 CustomModule5(自定义模块5)。
请求参数
参数 | 数据类型 | 描述 |
authtoken* | 字符串 | 加密的字母数字字符串,用来对 Zoho 凭证进行身份验证。 |
scope* | 字符串 | 将范围指定为 recruitapi |
xmlData* | XML | 这是 XML 字符串,格式应与已提取记录的 XML 格式中的 getRecords 相同。 |
wfTrigger | 布尔值 | 将值设置为 true 以在将记录插入 Recruit 帐户时触发工作流规则。默认情况下,此参数为 false。 |
duplicateCheck | 整数 | 将值设置为“1”以检查重复记录并抛出一个错误响应,或设置为“2”以检查重复记录,如果存在重复,则同样地进行更新。 |
isApproval | 布尔值 | 默认情况下,记录会直接插入。若要让记录保持为审批模式,请将值设置为 true。您可为应聘者、联系人使用此参数 |
newFormat | 整数 | newFormat=1:从 Recruit 帐户插入数据时排除具有“空”值的字段。 newFormat=2:从 Recruit 帐户插入数据时包括具有“空”值的字段。 |
version* | 整数 | version = 1:(默认值)这将基于之前的 API 实施提取响应,即作出增强之前。 version = 2:这将基于最新 API 实施来提取响应。 version = 4:在单个 API 方法调用中添加多条记录并将为多条记录触发重复检查功能。 |
* - 必备参数
重复检查字段
模块名称 | 重复检查字段 |
应聘者 | 邮箱 |
联系人 | 邮箱 |
客户 | 客户名 |
空缺职位 | 职位标题 |
面试 | 面试名称 |
补充说明
在 Zoho Recruit 帐户中插入数据时,将应用基于职位的安全机制(职位、角色、字段级安全和数据共享规则)。因此,使用具有最高职位(例如:招聘人员的管理员)和角色(例如:管理员)的用户 ID。此外,确保在字段级安全设置中启用所有字段。对于基于职位的安全设置,在生成身份验证令牌时请参见 安全管理。
在插入数据时,确保日期和时间分别为 Mm/dd/yyyy 和 yyyy-MM-dd Hh:mm:ss 格式。
示例
从第三方应用程序将记录插入 Zoho Recruit
URL 格式:
https://recruit.zoho.com.cn/recruit/private/xml/Candidates/addRecords?authtoken=AuthToken&scope=recruitapi&duplicateCheck=( 1 OR 2 )&version=4&xmlData=
XMLDATA 示例:
<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 >
示例 应聘者 XMLDATA
<Candidates>
<row no="1">
<FL val="SMOWNERID">2000000016714</FL>
<FL val="Candidate Owner">Scott@zohotest.com</FL>
<FL val="Source">John</FL>
<FL val="Current employer"><![CDATA[VS&Co]]>
</FL><FL val="First Name">John</FL>
<FL val="Last Name">Gossling</FL>
<FL val="Email">john@zohocorp.com</FL>
<FL val="Phone">1234567890</FL>
<FL val="Candidate Status">Qualified</FL>
<FL val="Is Hot Candidate">true</FL>
<FL val="Salutation">Mr.</FL>
<FL val="Street">Street One</FL>
<FL val="City">Chennai</FL>
<FL val="State">Tamil Nadu</FL>
<FL val="Zip Code">6000001</FL>
<FL val="Country">India</FL>
</row>
</Candidates>
带有联系人和客户查找的示例任务 XMLDATA
<Tasks>
<row no="1">
<FL val="SMOWNERID">2000000016714</FL>
<FL val="Task Owner">Scott@zohotest.com</FL>
<FL val="Subject">Demo Call</FL>
<FL val="Due Date">11/23/2009</FL>
<FL val="CONTACTID">2000000018443</FL>
<FL val="SEID">2000022218013</FL>
<FL val="SEMODULE">Clients</FL>
<FL val="Status">In Progress</FL>
<FL val="Priority">Highest</FL>
<FL val="Send Notification Email">false</FL>
<FL val="Description">Sample Desc</FL>
</row>
</Tasks>
带有联系人和客户查找的示例任务 XMLDATA
<Tasks>
<row no="1">
<FL val="SMOWNERID">2000000016714</FL>
<FL val="Task Owner">Scott@zohotest.com</FL>
<FL val="Subject">Demo Call</FL>
<FL val="Due Date">11/23/2009</FL>
<FL val="CONTACTID">2000000018443</FL>
<FL val="SEID">2000022218013</FL>
<FL val="SEMODULE">Accounts</FL>
<FL val="Status">In Progress</FL>
<FL val="Priority">Highest</FL>
<FL val="Send Notification Email">false</FL>
<FL val="Description">Sample Desc</FL>
</row>
</Tasks>
插入备注并关联到主模块
XML 格式:
https://recruit.zoho.com.cn/recruit/private/xml/Notes/addRecords?authtoken=Auth Token&scope=recruitapi&version=2
XMLDATA 示例:
<Notes>
<row no="1">
<FL val="entityId">6000000119069</FL><FL val="Note Type">Meeting</FL><FL val="Type Id">6000000021005</FL><FL val="Note Content"><![CDATA[hello]]></FL><FL val="Parent Module">Candidates</FL>
</row>
</Notes>
在这里,entityID 是主记录(应聘者、客户、联系人等)的唯一 ID。
Type Id 是您可从 getNoteTypes API 获取的备注类型 ID。
为记录分配所有者
在通过 API 插入记录时,确保您指定记录所有者的邮箱地址或用户 ID。如果您使用记录所有者的名称,则记录将被分配至身份验证令牌中使用的默认登录凭证。如果您想使用 userID 来指定记录所有者,请将 <FL val="SMOWNERID">userID</FL> 标签添加到您的 xmlData 中。
任务
https://recruit.zoho.com.cn/recruit/private/xml/Tasks/addRecords?authtoken=Auth Token&scope=recruitapi
&version=2&
xmlData=
<Tasks>
<row no="1">
<FL val="Subject">Call</FL>
<FL val="Due Date">2009-04-20</FL>
<FL val="Status">Deferred</FL>
<FL val="CONTACTID">2000000017017</FL>
</row>
</Tasks>
活动
https://recruit.zoho.com.cn/recruit/private/xml/Events/addRecords?authtoken=Auth Token&scope=recruitapi
&version=2
&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">United States</FL>
<FL val="Send Notification Email">True</FL>
</row>
</Events>
带有联系人和客户映射的活动
https://recruit.zoho.com.cn/recruit/private/xml/Events/addRecords?authtoken=Auth Token&scope=recruitapi
&version=2
&xmlData=
<Events>
<row no="1">
<FL val="Subject">Conference</FL>
<FL val="Start DateTime">2009-09-24 01:00:00</FL>
<FL val="End DateTime">2009-09-25 01:00:00</FL>
<FL val="Venue">Chennai</FL>
<FL val="CONTACTID">2000000055003</FL>
<FL val="SEID">2000000055007</FL>
<FL val="SEMODULE">Clients</FL>
</row>
</Events>
客户
https://recruit.zoho.com.cn/recruit/private/xml/Clients/addRecords?authtoken=Auth Token&scope=recruitapi
&version=2
&xmlData=
<Clients>
<row no="1">
<FL val="Client Name"><![CDATA[V3 Client]]></FL>
<FL val="Parent Client"><![CDATA[Client 2]]></FL>
<FL val="Client Manager">john@zohocorp.com</FL>
<FL val="Website">www.zillum.com</FL>
<FL val="Industry">Real estate</FL>
<FL val="Fax">99999999</FL>
</row>
</Clients>
联系人
https://recruit.zoho.com.cn/recruit/private/xml/Contacts/addRecords?authtoken=Auth Token&scope=recruitapi
&version=2
&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">999999999</FL>
<FL val="Fax">99999999</FL>
<FL val="Mobile">99989989</FL>
</row>
</Contacts>
利用联系人和客户查找插入通话
<Calls>
<row no="1">
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Subject">Product Support</FL>
<FL val="Call Type">Inbound</FL>
<FL val="Call Purpose">Prospecting</FL>
<FL val="CONTACTID">2000000018001</FL>
<FL val="SEID">2000000018003</FL>
<FL val="SEMODULE">Clients</FL>
<FL val="Call Start Time">2011-06-10 22:10:00</FL>
<FL val="Call Duration">60:00</FL>
<FL val="Description">Required Product Demo</FL>
<FL val="Billable">true</FL>
<FL val="Call Result">Successful</FL>
</row>
</Calls>
利用应聘者查找插入通话
<Calls>
<row no="1">
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Subject">Demo</FL>
<FL val="Call Type">Inbound</FL>
<FL val="Call Purpose">Prospecting</FL>
<FL val="SEID">2000000017201</FL>
<FL val="SEMODULE">Candidates</FL>
<FL val="Call Start Time">2011-06-10 22:10:00</FL>
<FL val="Call Duration">60:00</FL>
<FL val="Description">Demo Call</FL>
<FL val="Billable">true</FL>
<FL val="Call Result">Successful</FL>
</row>
</Calls>
‘CDATA’的使用
目的:将特殊字符视为纯文本而非 XML 数据
URL 格式:
https://recruit.zoho.com.cn/recruit/private/xml/Contacts/addRecords?version=2&authtoken=Auth Token&scope=recruitapi
示例 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="Job Title">Manager</FL>
<FL val="Phone">1234567890</FL>
<FL val="Mobile">292827622</FL>
<FL val="Account Name"><![CDATA["A & A"]]></FL>
</row>
</Contacts>
插入多条记录
URL 格式:https://recruit.zoho.com.cn/recruit/private/xml/Candidates/addRecords?version=2&authtoken=Auth Token&scope=recruitapi
XMLDATA 示例:
<Candidates>
<row no="1"><FL val="Last Name">testing</FL><FL val="Email">test1@test.com</FL></row>
<row no="2"><FL val="Last Name">testing</FL><FL val="Email">test2@test.com</FL></row>
<row no="3"><FL val="Last Name">testing</FL><FL val="Email">test3@test.com</FL></row>
<row no="4"><FL val="Last Name">testing</FL><FL val="Email">test4@test.com</FL></row>
<row no="5"><FL val="Last Name">testing</FL><FL val="Email">test5@test.com</FL></row>
<row no="6"><FL val="Last Name">testing</FL><FL val="Email">test6@test.com</FL></row>
<row no="7"><FL val="Last Name">testing</FL><FL val="Email">test7@test.com</FL></row>
<row no="8"><FL val="Last Name">testing</FL><FL val="Email">test8@test.com</FL></row>
<row no="9"><FL val="Last Name">testing</FL><FL val="Email">test9@test.com</FL></row>
<row no="10"><FL val="Last Name">testing</FL><FL val="Email">test10@test.com</FL></row>
:
:
:
<row no="100"><FL val="Last Name">testing</FL><FL val="Email">test100@test.com</FL></row>
</Candidates >
备注:
- 在使用 addRecords 方法插入多条记录时:
- 我们在版本 2 中支持多条记录的重复检查
- 符合条件的记录将不会触发工作流规则
- 在插入多条记录时将仅考虑前 100 条记录。
多条记录的重复检查
目的:您可以使用 addRecords 来触发多条记录的重复检查功能。请注意,version=4 是必备参数。
我们已推出用于呈现每个记录的 API 结果状态的三段新代码。代码如下:
2000 = 记录已成功添加
2001 = 记录已成功更新
2002 = 记录已存在
URL 格式:
https://recruit.zoho.com.cn/recruit/private/xml/Candidates/addRecords?authtoken=AuthToken&scope=recruitapi&duplicateCheck=( 1 OR 2 )&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>
示例响应
如果 duplicateCheck=1,version=4,存在一些该邮箱地址的记录,有些记录不存在,则功能和响应将如下所示:
<response uri=/recruit/private/xml/Candidates/addRecords>
<result>
<row no=1>
<success>
<code>2000</code>
<details>
<FL val=Id>2000000120006</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>2002</code>
<details>
<FL val=Id>2000000120007</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>
如果 duplicateCheck=1,version=4,不存在该邮箱地址的记录,则功能和响应将如下所示:
<response uri=/recruit/private/xml/Candidates/addRecords>
<result>
<row no=1>
<success>
<code>2000</code>
<details>
<FL val=Id>2000000120006</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>2000</code>
<details>
<FL val=Id>2000000120007</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>
如果 duplicateCheck=1,version=4,存在该邮箱地址的记录,则功能和响应将如下所示:
<response uri="/recruit/private/xml/Candidates/addRecords">
<result>
<row no="1">
<success>
<code>2002</code>
<details>
<FL val="Id">2000000120006</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>2002</code>
<details>
<FL val="Id">2000000120007</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>
如果 duplicateCheck=2,version=4,不存在该邮箱地址的记录,则功能和响应将如下所示:
<response uri="/recruit/private/xml/Candidates/addRecords">
<result>
<row no="1">
<success>
<code>2000</code>
<details>
<FL val="Id">2000000120006</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>2000</code>
<details>
<FL val="Id">2000000120007</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>
如果 duplicateCheck=2,version=4,存在该邮箱地址的记录,则功能和响应将如下所示:
<response uri="/recruit/private/xml/Candidates/addRecords">
<result>
<row no="1">
<success>
<code>2001</code>
<details>
<FL val="Id">2000000120006</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">2000000120007</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>
如果 duplicateCheck=2,version=4,存在该邮箱地址的一些记录,有些记录不存在,则功能和响应将如下所示:
<response uri="/recruit/private/xml/Candidates/addRecords">
<response uri="/recruit/private/xml/Candidates/addRecords">
<result>
<row no="1">
<success>
<code>2001</code>
<details>
<FL val="Id">2000000120006</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>2000</code>
<details>
<FL val="Id">2000000120007</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/addRecords">
<result>
<row no="1">
<success>
<code>2001</code>
<details>
<FL val="Id">2000000120006</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>您对该字段所提供的值不正确:年收入</details>
</error>
</row>
</result>
</response>
注:
- 邮箱地址是应聘者模块的重复检查字段。对于其它模块,重复检查字段不一样。如需了解更多信息,请阅读 - https://www.zoho.com/recruit/help/api/addrecords.html#Duplicate_Check_Field
- 开发人员现在可轻松地识别记录 id,因为响应中的记录详细信息是按照 xml 数据中的用户请求方式给出的。
- 您必须将 version=2 传递到参数 URL 以进行多条记录的重复检查。