getMyRecords 方法
目录
目的
您可以使用 getMyRecords 方法按照 API 请求中指定的验证令牌所有者获取数据。
请求 URL
XML 格式：
https://crm.zoho.com.cn/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi
JSON 格式：
https://crm.zoho.com.cn/crm/private/json/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi
请求参数
| 参数 | 数据类型 | 说明 |
| authtoken* | 字符串 | 验证您的 Zoho 凭据的加密字母数字字符串。 |
| scope* | 字符串 | 将数值指定为crmapi |
| selectColumns | 字符串 | 从 CRM 模块中选择所需字段。 格式：模块（可选列） 示例：线索（姓、网站、邮件）或所有 |
| fromIndex | 整数值 | 默认值： 1 |
| toIndex | 整数值 | 默认值：20 最大值：200 |
| sortColumnString | 字符串 | 您可以在 CRM 中选择一个字段以便对数据进行排序。 示例：sortColumnString=Company 这里，数据排序将基于公司字段进行。 |
| sortOrderString | 字符串 | 排列顺序：升序或降序 如果您使用sortColumnString参数，默认情况下数据按升序排列。 |
| lastModifiedTime | 年-月-日 小时：分钟：秒 | 默认值：null 如果您指定了时间，已创建/修改的数据将在配置时间后获取。 |
| newFormat | 整数值（1 或 2） | newFormat=1： 获取来自您的 CRM 账户的数据时排除有 "null" 值的字段。 newFormat=2： 获取来自您的 CRM 账户的数据时将有 "null" 值的字段包括在内。 |
| 版本 | 整数值 | version = 1：（默认值）这将基于之前的 API 执行即在进行强化之前获取响应。 当前版本为 4。 |
* - 必填参数
注意：
- 参考发布说明页面了解关于 API 执行中进行的强化的更多信息。
错误代码
请参考错误代码。
其它说明
- 从您的 Zoho CRM 账户中检索数据时，基于角色的安全（角色、概要文件、字段级别的安全和数据共享规则）应用。 关于基于角色的安全设置，请参阅安全管理。
- fromIndex 和 toIndex 是可选参数。 默认情况下fromIndex 为 1 而 toIndex 为 20。
- sortColumnString 和 sortOrderString 也是可选参数
- lastModifiedTime参数的值应该采用年-月-日 小时：分钟：秒格式
示例
从 Zoho CRM 获取线索数据
https://crm.zoho.com.cn/crm/private/xml/Leads/getMyRecords?newFormat=1&authtoken=Auth Token&scope=crmapi
如需从其它模块获取数据，请将线索更换为账户、联系人、商机等
获取 200 条以上记录
默认情况下，您可获取每批 20 条记录。 但是您可以使用 toIndex 参数获取最多每批 200 条记录。 如果您想获取 200 条以上的记录，请执行下文给出的步骤：
迭代 1：fromIndex=1&toIndex=200
迭代 2：fromIndex=201&toIndex=400
获取升序的有“公司”名称的线索
sortColumnString=Company&sortOrderString=asc
获取降序的有“公司”名称的线索
sortColumnString=Company&sortOrderString=desc
在未指定 newFormat 参数的情况下获取线索
注意：
- 如果没有关于响应格式的指定时，默认值 "1" 分配给 newFormat 参数，即 newFormat = 1
https://crm.zoho.com.cn/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company,No of Employees,Annual Revenue,Created By,Created Time)
这将返回响应，如下所示：
<Leads>
<row no="1">
<FL val="LEADID">2000000022020</FL>
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Lead 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>
</Leads>
获取 "newFormat=2" 的线索
https://crm.zoho.com.cn/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=2&selectColumns=Leads(Lead Owner,First Name,Last Name,Company,Designation,Email,Phone,Fax,Mobile,Website,Lead Source,Lead Status,No of Employees,Annual Revenue)
这将返回响应，如下所示：
<Leads>
<row no="1">
<FL val="LEADID">2000000022020</FL>
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Zillium</FL>
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="Designation">null</FL>
<FL val="Email">null</FL>
<FL val="Phone">null</FL>
<FL val="Fax">null</FL>
<FL val="Mobile">null</FL>
<FL val="Website">null</FL>
<FL val="Lead Source">null</FL>
<FL val="Lead Status">null</FL>
<FL val="No of Employees">0</FL>
<FL val="Annual Revenue">0.0</FL>
</row>
</Leads>
从 Zoho CRM 获取前 25 条线索
https://crm.zoho.com.cn/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)&fromIndex=1&toIndex=25
获取有 "lastModifiedTime" 参数的线索
https://crm.zoho.com.cn/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)&lastModifiedTime=2010-04-21 11:09:23
注意：
- 如果您指定了时间，已修改的数据将在配置时间后获取。
从有 newFormat=1 参数的线索中选择所有字段
https://crm.zoho.com.cn/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=All
注意：
- 这将返回所有有数值的字段。
newFormat=2 时从线索中选择所有字段
https://crm.zoho.com.cn/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=2&selectColumns=All
注意：
- 这将返回所有字段，包括 null 值字段。
获取有 lastModifiedTime、fromIndex 和 toIndex 参数的线索
https://crm.zoho.com.cn/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)&lastModifiedTime=2010-04-21 11:09:23 &fromIndex=1&toIndex=25
测试程序
您可以使用所附程序运行并测试在您的 Java 环境中 getMyRecords 方法的工作效果。
Java 程序包含以下内容：
- 验证令牌生成格式
- 参数及其数值
- 方法的实际使用