服务 API
服务模块包含公司提供的所有服务的数据,如墙面粉刷、家政服务、汽车和摩托车服务、空调维修等。服务API帮助您创建新服务、检索或搜索服务记录、更新服务详情以及删除现有服务。它们还帮助您根据各种业务需求配置服务偏好。
获取服务
目的
获取符合您的搜索条件的服务数据。
端点
- GET /Services__s
- GET /Services__s/{service_id}
请求详情
请求 URL
{api-domain}/crm/{version}/Services__s
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope=ZohoCRM.modules.services.{operation_type}
可能的操作类型
全部 - 完全访问服务数据
读取 - 获取服务数据
参数
- fields string,获取所有服务数据时为必填项
根据您在此参数中指定的字段列出所有服务数据。请注意,您最多可以在此参数中包含50个字段API名称。获取字段API将为您提供服务模块中现有的字段API名称。
可能的值:多个字段API名称,逗号分隔。例如:Last_Name,Email。 - cvid long, optional
获取在此键中指定的自定义视图中的预约列表。您可以从获取自定义视图 API中获取自定义视图 ID。您不能将此参数与 "sort_by" 参数一起使用。
可能的值:{custom_view_id}。 - page_token string,分页获取超过2000个服务时必需
您可以使用 "page" 参数在没有 "page_token" 的情况下获取最多2000个服务。要获取超过2000个服务,您必须在请求中包含 "page_token" 参数。此参数的值取自第一次 GET Services 调用响应中的 "next_page_token" 键。此令牌值是用户特定的,如果您使用其他用户的令牌,系统将抛出错误。
页面令牌与参数绑定,并在24小时内过期。此外,您不能将此参数与 "page" 参数一起使用。 - page integer, optional
获取相应页面的服务列表。默认值为1。请注意,不能将此参数与 "page_token" 参数一起使用。
可能的值:仅正整数值。 - per_page integer,optional
获取每页可用的服务列表。默认值和最大可能值为200。
可能的值:仅正整数。 - sort_order string, optional
用于按升序或降序对可用服务列表进行排序。
可能的值: asc - 升序, desc - 降序。默认值为 'desc'。 - sort_by string, optional
根据字段id、Created_Time和Modified_Time对服务进行排序。默认值为 'id'。请注意,不能将此参数与 "cvid" 参数一起使用。
注意
- sort_order 适用于给定的 sort_by 字段。
- 如果您的需求是获取少于 2000 个服务,请使用 "page" 和 "per_page" 参数(page=1 到 10,per_page=200)。
- 如果您想分页获取超过 2000 个服务,请使用您在第一个响应中收到的 "page_token" 参数。您需要传递从响应中收到的页面令牌,并使用参数 page=10 来获取 2001 到 2200 的服务。如果有更多服务,API 响应将包含 "next_page_token" 和 "previous_page_token" 以便于分页。
使用连续请求中的页面令牌,您可以导航并获取最多 100,000 个服务。 - 在上述两种情况下,每次请求获取的最大服务数量仅为 200。
- 在检索多个服务时,子表单数据不会被检索。您必须在请求 URL 中指定单个服务 ID 以获取子表单中的数据。
- 当合规设置中的 通过 API 限制数据访问 选项被 禁用 时,包含敏感健康数据的字段值将被检索。如果该选项被启用,值将为 null。有关更多详细信息,请参阅 HIPAA 合规性。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Services__s?fields=Service_Name,Location,Job_Sheet_Required"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"可能的错误
- AMBIGUITY_DURING_PROCESSINGHTTP 400
您不能同时使用 cvid 和 sort_by,以及 page 和 page_token
解决方案:在请求中使用 "cvid" 或 "sort_by" 参数。同样,在请求中使用 "page" 或 "page_token"。 - DISCRETE_PAGINATION_LIMIT_EXCEEDEDHTTP 400
在不使用 page_token 参数的情况下,您只能获取前 2000 条记录。
解决方案:如果您想获取超过 2000 条服务记录,必须使用 "page_token" 参数。 - EXPIRED_VALUEHTTP 400
您的页面令牌已过期。
解决方案:page_token 从生成时起仅在 24 小时内有效。 - INVALID_DATAHTTP 400
您使用了无效的 page_token 或者是由其他用户生成的 page_token。
解决方案: page_token 是特定于用户的。请使用从您的 API 调用中生成的 page_token。 - INVALID_MODULEHTTP 400
您在请求URL中提供了无效的模块名称。
解决方案:您只能在请求URL中使用Services__s。 - INVALID_REQUEST_METHODHTTP 400
您提供了无效的 HTTP 请求方法类型。
解决方案:在请求 URL 中仅使用 GET 方法来访问此 API。 - LIMIT_EXCEEDEDHTTP 400
您已超出字段限制。
解决方案:在“fields”参数中最多只能包含50个字段API名称。 - TOKEN_BOUND_DATA_MISMATCHHTTP 400
您指定了无效的 page_token 或输入参数被添加、更改或删除。
解决方案:page_token 与请求中使用的参数绑定。不要更改参数,并使用响应中的 page_token。 - PAGINATION_LIMIT_EXCEEDEDHTTP 400
您只能使用 page_token 参数获取最多前 100,000 条记录。
解决方案:您可以在 GET Services API 的响应中使用 page_token 参数获取最多 100,000 条记录。 - REQUIRED_PARAM_MISSINGHTTP 400
您未能在参数中指定字段 API 名称或页面令牌。
解决方案: 当您想获取所有服务的数据时,必须指定字段 API 名称。页面令牌是获取超过 2000 个服务所必需的。 - INVALID_TOKENHTTP 401
您使用了无效的oauth令牌。
解决方案:您使用的访问令牌已过期。请刷新您的令牌并重试。 - OAUTH_SCOPE_MISMATCHHTTP 401
您使用错误的 OAuth 范围创建了授权令牌。
解决方案:使用 ZohoCRM.modules.services.READ 或 ZohoCRM.modules.services.ALL 范围来创建一个新的有效授权令牌。 - NO_PERMISSIONHTTP 403
您没有权限获取任何服务数据。
解决方案:联系您的系统管理员。 - INVALID_URL_PATTERNHTTP 404
检查您是否尝试访问正确的URL。
解决方案:您提供了一个无效的请求URL。请参考端点部分并提供一个有效的URL。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方案:服务器中出现意外且未处理的异常。请联系我们的支持团队。
示例响应
Copied{
"data": [
{
"Job_Sheet_Required": "Yes",
"Service_Name": "Bike Service",
"id": "5545974000002098054",
"Location": "Business Address"
},
{
"Job_Sheet_Required": "Yes",
"Service_Name": "Car Service",
"id": "5545974000002098022",
"Location": "Business Address"
},
{
"Job_Sheet_Required": "Yes",
"Service_Name": "AC Repair",
"id": "5545974000002098002",
"Location": "Client Address"
},
{
"Job_Sheet_Required": "No",
"Service_Name": "Wall Painting",
"id": "5545974000000488035",
"Location": "Business Address"
}
],
"info": {
"per_page": 200,
"next_page_token": null,
"count": 4,
"sort_by": "id",
"page": 1,
"previous_page_token": null,
"page_token_expiry": null,
"sort_order": "desc",
"more_records": false
}
}