企业接口文档

企业接口文档,易背调提供给企业使用的API


订单查询

<h4><strong>接口描述</strong></h4> <blockquote> <p>根据条件查询订单,最多返回1000条记录(<a href="https://www.showdoc.cc/ybd?page_id=1865243955181250" title="需验证">需验证</a>)</p> </blockquote> <h4><strong>请求URL</strong></h4> <blockquote> <p><a href="https://www.showdoc.cc/ybd?page_id=1865243955181250" title="通讯地址 + 企业api基础链接">通讯地址 + 企业api基础链接</a> + <code>/order/list</code></p> </blockquote> <h4><strong>请求方式</strong></h4> <blockquote> <p>GET</p> </blockquote> <h4><strong>请求参数</strong></h4> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">fromTime</td> <td style="text-align: left;">string</td> <td>订单创建起始时间 yyyyMMddHHmmss</td> </tr> <tr> <td style="text-align: left;">toTime</td> <td style="text-align: left;">string</td> <td>订单创建结束时间 yyyyMMddHHmmss</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">int</td> <td>订单状态<br/>0:全部<br/>-10:已取消<br/>30:待支付<br/>40:进行中<br/>50:已完成</td> </tr> <tr> <td style="text-align: left;">authType</td> <td style="text-align: left;">int</td> <td>授权方式:<br/>0:全部<br/>1:线下授权<br/>2:短信授权<br/>3:硬件授权<br/>4:接口文件授权</td> </tr> <tr> <td style="text-align: left;">orderNo</td> <td style="text-align: left;">string</td> <td>订单号(非必填)</td> </tr> <tr> <td style="text-align: left;">candidateIdCardNo</td> <td style="text-align: left;">string</td> <td>候选人身份证号码(非必填)</td> </tr> </tbody> </table> <h4><strong>请求示例</strong></h4> <pre><code>"fromTime"="20190415000000" "toTime"="20190415235959" "status"=0 "authType"=0 "orderNo"="20190415152645093"</code></pre> <h4><strong>响应结果</strong></h4> <blockquote> <p><a href="https://www.showdoc.cc/ybd?page_id=1873739988592287" title="响应结构">响应结构</a></p> </blockquote> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">string</td> <td>响应码</td> </tr> <tr> <td style="text-align: left;">key</td> <td style="text-align: left;">string</td> <td>企业key(<em>同请求中的参数</em>),参考<a href="https://www.showdoc.cc/ybd?page_id=1864080192995858" title="准备工作">准备工作</a></td> </tr> <tr> <td style="text-align: left;">seq</td> <td style="text-align: left;">string</td> <td>业务流水号(<em>同请求中的参数</em>)</td> </tr> <tr> <td style="text-align: left;">ts</td> <td style="text-align: left;">string</td> <td>时间戳,服务器处理请求的时间,格式为”yyyyMMddHHmmss”</td> </tr> <tr> <td style="text-align: left;">sign</td> <td style="text-align: left;">string</td> <td>响应摘要签名,规则同<a href="https://www.showdoc.cc/ybd?page_id=1865243955181250" title="请求签名">请求签名</a></td> </tr> <tr> <td style="text-align: left;">msg</td> <td style="text-align: left;">list</td> <td>订单信息 -&gt; <strong>OrderListResp</strong></td> </tr> </tbody> </table> <h5>OrderListResp</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">orderNo</td> <td style="text-align: left;">string</td> <td>订单号(<em>同请求中的订单号</em>)</td> </tr> <tr> <td style="text-align: left;">surveyItemIds</td> <td style="text-align: left;">string</td> <td>调查项描述(ID)<br/>格式:调查项1:份数,调查项2:份数<br/>例子:1:1,14:1</td> </tr> <tr> <td style="text-align: left;">title</td> <td style="text-align: left;">string</td> <td>套餐名</td> </tr> <tr> <td style="text-align: left;">channel</td> <td style="text-align: left;">string</td> <td>支付方式<br/>wx-jsapi:微信JSAPI支付<br/>wx-h5:微信H5支付<br/>wx-native:微信PC扫码支付<br/>wx-app:APP微信支付<br/>alipay:支付宝支付<br/>balance:余额支付</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">int</td> <td>订单状态:<br/>-10:已取消<br/>30:待支付<br/>40:进行中<br/>50:已完成</td> </tr> <tr> <td style="text-align: left;">authType</td> <td style="text-align: left;">int</td> <td>授权方式:<br/>1:线下授权<br/>2:短信授权<br/>3:硬件授权<br/>4:接口文件授权</td> </tr> <tr> <td style="text-align: left;">price</td> <td style="text-align: left;">int</td> <td>订单金额(单位:分)</td> </tr> <tr> <td style="text-align: left;">createTime</td> <td style="text-align: left;">string</td> <td>创建时间,格式:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">paymentTime</td> <td style="text-align: left;">string</td> <td>支付时间,格式:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">completeTime</td> <td style="text-align: left;">string</td> <td>完成时间,格式:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">withdrawAmount</td> <td style="text-align: left;">int</td> <td>退款金额(单位:分)</td> </tr> <tr> <td style="text-align: left;">records</td> <td style="text-align: left;">list</td> <td>调查列表 -&gt; <strong>OrderListRespRecord</strong></td> </tr> </tbody> </table> <h5>OrderListRespRecord</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">recordNo</td> <td style="text-align: left;">string</td> <td>背调号</td> </tr> <tr> <td style="text-align: left;">candidateName</td> <td style="text-align: left;">string</td> <td>候选人姓名</td> </tr> <tr> <td style="text-align: left;">candidateIdCardNo</td> <td style="text-align: left;">string</td> <td>候选人身份证号码</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">int</td> <td>背调状态:<br/>-10:已取消<br/>30:待支付<br/>40:待授权<br/>45:背调中<br/>50:已出报告</td> </tr> <tr> <td style="text-align: left;">withdrawAmount</td> <td style="text-align: left;">int</td> <td>退款金额(单位:分)</td> </tr> </tbody> </table> <h4><strong>响应示例</strong></h4> <pre><code>{ "code": "000", "key": "CF6BF781AB82FEF5BFDF96B054ECEB15", "seq": "s20190415111700", "ts": "20190513141603", "sign": "da5e762f87fdcb6d75e4a696632c1cd6", "msg": [ { "orderNo": "20190415152645093", "createTime": "2019-04-15 15:26:45", "paymentTime": "2019-04-15 18:58:55", "completeTime": "2019-04-18 10:29:23", "title": "自定义订单", "channel": "balance", "surveyItemIds": "1:1,14:1", "authType": 2, "price": 5500, "withdrawAmount": 5500, "status": 50, "records": [ { "recordNo": "20190415152645093983751", "candidateName": "袁重玉", "candidateIdCardNo": "31010919841208053X", "status": -10, "withdrawAmount": 5500 } ] } ] }</code></pre> <h4><strong>备注</strong></h4> <ul> <li><a href="https://www.showdoc.cc/ybd?page_id=1863843278019929" title="全局错误码">全局错误码</a></li> </ul>

页面列表

ITEM_HTML