预约重新安排历史APIs
预约重新安排历史记录保存了所有预约的重新安排数据。它在预约模块中充当跟踪器,帮助您记录重新安排的活动。您可以使用预约重新安排历史记录API来获取、创建、更新和删除重新安排历史中的记录。
获取重新安排的预约历史
目的
获取重新安排预约的历史数据。
端点
- GET /Appointments_Rescheduled_History__s?fields={field1,field2..}
- GET /Appointments__s/{appointment_id}/Appointments_Rescheduled_History__s
请求详情
Request URL
{api-domain}/crm/{version}/Appointments_Rescheduled_History__s
获取特定预约的重新安排历史
{api-domain}/crm/{version}/Appointments__s/{appointment_id}/Appointments_Rescheduled_History__s
头部
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope=ZohoCRM.modules.appointments_rescheduled_history.{operation_type}
可能的操作类型
ALL - 完全访问重新安排的预约历史数据
READ - 获取重新安排的预约历史数据
参数
- fields字符串,获取所有重新安排的历史数据时必填
列出所有与您在此参数中指定的字段相关的重新安排的历史数据。请注意,您可以在此参数中包含最多50个字段API名称。 GET Fields API将为您提供预约重新安排历史模块中的现有字段API名称。
可能的值:多个字段API名称,用逗号分隔。例如:Rescheduled_From,Rescheduled_To。 - 页面整数,可选
从相应的页面获取重新安排历史的列表。默认值是1。
可能的值:仅正整数值。 - per_page整数,可选
获取每页可用的预约重新安排历史记录列表。默认值和可能的最大值是200。
可能的值:仅正整数值。 - sort_order字符串,可选
用于按升序或降序对重新安排的预约历史进行排序。
可能的值:asc - 升序,desc - 降序。默认值为'desc'。 - sort_by字符串,可选
根据字段如Rescheduled_From,Created_Time和Modified_Time对重新安排的历史进行排序。默认字段是'id'。
注意
- sort_order 适用于给定的 sort_by 字段。
- 预约重新安排历史API只跟踪预约的最近20次重新安排的详细信息。
- 重新安排的历史不会有当前的预约时间,这是预约的最后一次重新安排的时间。您可以从GET 预约 API获取最后一次重新安排的时间。如果特定预约的重新安排次数为1,将会抛出'无内容'的响应。
样本请求
可能的错误
- INVALID_DATAHTTP 400
您在请求URL中指定了错误的或已删除的预约ID。
解决方案:进行GET预约API调用,并提供有效的预约ID。 - INVALID_MODULEHTTP 400
您在请求URL中给出了无效的模块名称。
解决方案:在请求URL中使用Appointments_Rescheduled_History__s。在获取特定预约的重新安排历史时,您也可以与此模块一起使用Appointments__s。 - INVALID_REQUEST_METHODHTTP 400
您给出了无效的HTTP请求方法类型。
解决方案:在请求URL中只使用GET方法来访问此API。 - REQUIRED_PARAM_MISSINGHTTP 400
您未在参数中指定字段API名称。
解决方案:当您想获取所有预约的重新安排历史数据时,必须指定字段API名称。 - INVALID_TOKENHTTP 401
您使用了无效的oauth令牌。
解决方案:您使用的访问令牌已过期。请刷新您的令牌并重试。 - OAUTH_SCOPE_MISMATCHHTTP 401
您使用错误的oauth范围创建了授权令牌。
解决方案:使用ZohoCRM.modules.appointments_rescheduled_history.READ或ZohoCRM.modules.appointments_rescheduled_history.ALL范围来创建新的有效授权令牌。 - NO_PERMISSIONHTTP 403
您没有权限获取任何有关重新安排预约历史的数据。
解决方案:联系您的系统管理员。 - INVALID_URL_PATTERNHTTP 404
检查您是否正在尝试访问正确的URL。
解决方案:您提供了一个无效的请求URL。请参考上面的端点部分并提供一个有效的URL。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方案:服务器中出现意外且未处理的异常。请联系我们的支持团队。