企业接口文档

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


查看订单详情

<h4><strong>接口描述</strong></h4> <blockquote> <p>查看订单详情(<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/detail</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;">orderNo</td> <td style="text-align: left;">string</td> <td>订单号</td> </tr> </tbody> </table> <h4><strong>请求示例</strong></h4> <pre><code>"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;">object</td> <td>订单详情 -&gt; <strong>OrderDetailResp</strong></td> </tr> </tbody> </table> <h5>OrderDetailResp</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;">surveyItemStr</td> <td style="text-align: left;">string</td> <td>调查项描述(调查项名)<br/>格式:调查项1名称:份数,调查项2名称:份数<br/>例子:身份信息核实:1,公共负面信息查询: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;">withdrawTime</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>OrderDetailRespRecord</strong></td> </tr> </tbody> </table> <h5>OrderDetailRespRecord</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;">candidatePhone</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;">identificationMatch</td> <td style="text-align: left;">boolean</td> <td>身份核实通过</td> </tr> <tr> <td style="text-align: left;">authTime</td> <td style="text-align: left;">string</td> <td>授权时间,格式:yyyy-MM-dd HH:mm:ss</td> </tr> <tr> <td style="text-align: left;">withdrawReason</td> <td style="text-align: left;">int</td> <td>退款原因<br/>1:取消(手机号码非本人实名认证)<br/>2:身份匹配失败<br/>3:内部异常<br/>4:取消(超时未授权)<br/>5:部分失败</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;">items</td> <td style="text-align: left;">list</td> <td>背调调查项 -&gt; <strong>OrderDetailRespItem</strong></td> </tr> </tbody> </table> <h5>OrderDetailRespItem</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;">surveyItemId</td> <td style="text-align: left;">int</td> <td>调查项ID</td> </tr> <tr> <td style="text-align: left;">surveyItemStr</td> <td style="text-align: left;">string</td> <td>调查项名</td> </tr> <tr> <td style="text-align: left;">icon</td> <td style="text-align: left;">string</td> <td>调查项icon(css)</td> </tr> <tr> <td style="text-align: left;">hasProblem</td> <td style="text-align: left;">boolean</td> <td>是否需要关注(当前调查项的任何一段需要关注,则需要关注)</td> </tr> <tr> <td style="text-align: left;">sections</td> <td style="text-align: left;">list</td> <td>分段 -&gt; OrderDetailRespSection<br/> <em>一种调查项可以有 n(n≥1)段</em></td> </tr> </tbody> </table> <h5>OrderDetailRespSection</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;">sectionIndex</td> <td style="text-align: left;">int</td> <td>分段索引,从1开始</td> </tr> <tr> <td style="text-align: left;">singlePrice</td> <td style="text-align: left;">int</td> <td>背调调查项单价(单位:分)</td> </tr> <tr> <td style="text-align: left;">hasProblem</td> <td style="text-align: left;">boolean</td> <td>是否需要关注</td> </tr> <tr> <td style="text-align: left;">status</td> <td style="text-align: left;">int</td> <td>背调调查项状态<br/>0:初始化<br/>1:待处理<br/>2:处理成功<br/>9:处理失败</td> </tr> </tbody> </table> <h4><strong>响应示例</strong></h4> <pre><code>{ "code": "000", "key": "CF6BF781AB82FEF5BFDF96B054ECEB15", "seq": "s20190415111700", "ts": "20190415184819", "sign": "b69dbc419e425239973ba91af519a936", "msg": { "orderNo": "20190415152645093", "surveyItemIds": "1:1,14:1", "surveyItemStr": "身份信息核实:1,公共负面信息查询:1", "title": "自定义订单", "channel": null, "price": 5500, "status": 30, "createTime": "2019-04-15 15:26:45", "paymentTime": null, "completeTime": null, "withdrawTime": null, "withdrawAmount": 0, "authType": 2, "records": [ { "recordNo": "20190415152645093983751", "candidateName": "袁重玉", "candidateIdCardNo": "310109198412******", "candidatePhone": "13585590312", "status": 30, "identificationMatch": false, "authTime": null, "withdrawReason": null, "withdrawAmount": 0, "items": [ { "surveyItemId": 1, "icon": "icon-shenfenyanzheng", "surveyItemStr": "身份信息核实", "hasProblem": false, "sections": [ { "singlePrice": 1500, "hasProblem": false, "status": 0 } ] }, { "surveyItemId": 14, "icon": "icon-shoukao", "surveyItemStr": "公共负面信息查询", "hasProblem": false, "sections": [ { "singlePrice": 4000, "hasProblem": false, "status": 0 } ] } ] } ] } }</code></pre> <h4><strong>备注</strong></h4> <ul> <li><a href="https://www.showdoc.cc/ybd?page_id=1863843278019929" title="全局错误码">全局错误码</a></li> </ul>

页面列表

ITEM_HTML