操作

GET /订单

概括 为用户获得分页的订单列表
URL /api/v1/orders?page= {pagenum}＆pageSize= {零份} &ids=
/ api / v1 /订单吗?页面= {pagenum}页大小={页大小}&clientRef = {referenceId}
请求查询参数
  • pagenum- 返回的订单页数。可选，默认情况下返回第一页
  • 页大小-每页返回的订单数量。可选，默认情况下每页返回25个订单。页面大小必须在5到100之间
  • orderNumber-您可以通过指定订单号来检索特定的订单。可选，默认返回所有订单。如果指定了clientRef，则不能指定-否则返回403 Forbidden响应。
  • 参考文献-你可以检索与给定的引用id相关联的订单，就像在你的应用程序中使用的一样。可选，默认返回所有订单。如果指定了ids，则不能指定-否则返回403 Forbidden响应。
详细描述

使用此方法可检索用户的订单列表。数据将以JSON或XML的形式返回，这取决于Accept报头和/或URL扩展。

列表以分页方式返回。返回的结果将指示订单总数，以及每页的订单数以及所请求页面中的订单数，这使客户端可以迭代地检索用户的所有订单，如果需要。结果按照日期安置反向时间顺序排序。

列表中的每个订单实体都包含订单的摘要信息——它省略了注释和附件。要得到这些，执行a获得/订单/ {ordernum}与适当的订单号。

请参阅下面的响应订单实体的注释示例。
请求头
  • 授权-包含客户端/用户API密钥
  • 接受-指定响应的传递格式。必须是application/json或text/xml
回复 成功时，200 OK
响应标题 没有一个
身体的反应 一个<命令/>实体，具有用户订单列表。这包括有关有多少条订单的信息，以通过结果集启用完全分页。
错误代码 没有一个
带注释的示例响应 
/ * total_count results_per_page显示订单的总数可能结果中返回每个页面页面返回的页面数(基于)* /{“results_per_page”:“total_count”:28日8日“页面”:0,”命令 ": [ { /* 转速分配订单号* /“order_number”:"TC432432"， /*订单请求提供的客户端参考订单号*/ "client_ref": "6"， /*订单的总成本*/ "price": 56， /*订单的状态*/ " Status ": " transcripbing "， /*订单和附加服务的媒体附件音频的总长度(秒)。*/ "transcription": {"total_length_seconds": "300"， "verbatim": true， "timestamps": false} /*附件和注释没有按照列表中返回的顺序显示。对orders/{ordernum}执行GET以获取订单附件。*/} /*列表中剩余的订单*/]}
<！——total_count是订单总数results_per_page显示如何在每个页面返回结果页是页面返回的数量(基于0)——>    TC432432  6  56  < Status > transcription    300 < verb> true false   < /订单> < !——其余的匹配——>