添加记录 API

目录

目的

在表单中添加记录。共有两种类型的添加记录 API：添加员工 API - 用于将员工添加到您的机构，添加部门 API - 在您的 Zoho People 帐户中添加各种部门。

请求 URL

https://people.zoho.com.cn/people/api/forms/<inputType>/<formLinkName>/insertRecord?authtoken=<token>&inputData=<inputData>

注：

  • 请参阅 API 参考页以查看表单列表。必须以管理员身份登录才可查看该页面。

请求参数

authtoken 指定身份验证令牌
formLinkName 要获取 formLinkName，请使用“提取表单 API”。
inputType xml 或 json
inputData XML 输入：<Request><Record><field name="Labelname">value</field><field name="LabelName1">value1</field><field name="Labelname2">value2</field></Record></Request>
JSON input: {LabelName:'value',LabelName1:'value1',LabelName2:'value2'}

添加员工 API

要将员工添加到您的机构，请使用下面的 API 并提到 employee 而不是 formLinkName 关键字。

请求 URL

https://people.zoho.com.cn/people/api/employee/records?authtoken=<token>&xmlData=<xmlData>

请求参数

authtoken 指定身份验证令牌
xmlData 示例输入：<Request><Record><field name="Labelname">value</field><field name="LabelName1">value1</field><field name="Labelname2">value2</field></Record></Request>

添加部门 API

您可使用下面的 API 在 Zoho People 中逐个添加各种部门

请求 URL

https://people.zoho.com.cn/people/api/department/records?authtoken=<token>&xmlData=<xmlData>

authtoken 指定身份验证令牌
xmlData 示例输入：<Request><Record><field name="Labelname">value</field><field name="LabelName1">value1</field><field name="Labelname2">value2</field></Record></Request>

示例 - 添加记录 API

XML 请求：

https://people.zoho.com.cn/people/api/forms/xml/employee/insertRecord?authtoken=7d985878998943g4j09h43dd0b167dda34b&inputData=<Request><Record><field name='EmployeeID'>011</field><field name='FirstName'>steves</field><field name='LastName'>V</field><field name='EmailID'>steves@domain.com</field><field name='Marital_status'>Married</field></Record></Request>

JSON 请求：

https://people.zoho.com.cn/people/api/forms/json/employee/insertRecord?authtoken=7d985878998943g4j09h43dd0b167dda34b&inputData={EmployeeID:'011',FirstName:'steves',LastName:'V',EmailID:'steves@domain.com',Marital_status:'Married'}

XML 响应：

<?xml version=""1.0"" encoding=""UTF-8""?>
<response uri=""/api/forms/xml/employee/insertRecord"">
<status>
0</status>
<message>
Data added successfully</message>
<result>
<message>
Successfully Added</message>
</result>
</response>

JSON 响应：

{"response":{"message":"Data added successfully","result":{"message":"Successfully Added"},"status":0,"uri":"/api/forms/json/employee/insertRecord"}}

示例 - 添加员工 API

请求 URL：

https://people.zoho.com.cn/people/api/employee/records?authtoken=7d985878998943g4j09h43dd0b167dda34b &xmlData=<Request><Record><field name='EmployeeID'>011</field><field name='FirstName'>steves</field><field name='LastName'>V</field><field name='EmailID'>steves@domain.com</field><field name='Marital_status'>Married</field></Record></Request>

XML 响应：

<Response Status="1">
<message>Successfully Added</message>
</Response>

JSON 响应：

[{"message":"Successfully Added","Response":1}]

示例 - 添加部门 API

请求 URL：

https://people.zoho.com.cn/people/api/department/records?authtoken=7d985878998943g4j09h43dd0b167dda34b &xmlData=<Request><Record><field name='Department'>support</field><field name='MailAlias'>sohail@domain.com</field><field name='Department_Lead'>17</field><field name='testing'>17</field></Record></Request>

XML 响应：

<Response Status="1">
<message>Successfully Added</message>
</Response>

JSON 响应：

[{"message":"Successfully Added","Response":1}]

错误代码

请参阅错误代码。

注：

  • 使用 POST 方法而不是 GET 方法来传递参数。
  • 要为查找字段添加或编辑数据，您必须将记录 ID 作为值传递。例如，请考虑在员工表单中查找部门，并让部门设为财务部。在本例中，部门表单中财务的 RecordID 应作为值传递。