企业接口文档

企业接口文档,易背调提供给企业使用的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/single</code></p> </blockquote> <h4><strong>请求方式</strong></h4> <blockquote> <p>POST</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;">packageId</td> <td style="text-align: left;">int</td> <td>套餐ID,不使用时填0</td> </tr> <tr> <td style="text-align: left;">itemIdAndMultis</td> <td style="text-align: left;">string</td> <td>调查项描述<br/>格式:调查项1:份数,调查项2:份数<br/>例子:1:1,14:1</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;">authType</td> <td style="text-align: left;">int</td> <td>授权方式:<br/>1:线下授权<br/>2:短信授权<br/>4:接口文件授权</td> </tr> <tr> <td style="text-align: left;">price</td> <td style="text-align: left;">int</td> <td>订单金额(单位:分)<br/><em>可以不传,传入则会校验正确性</em></td> </tr> <tr> <td style="text-align: left;">items</td> <td style="text-align: left;">list</td> <td>披露项结果 -&gt; <strong>ItemWithDisclosure</strong> <br/>授权方式为[短信授权]时可以不传(由候选人自行填写披露内容)</td> </tr> </tbody> </table> <h5>ItemWithDisclosure</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;">itemId</td> <td style="text-align: left;">int</td> <td>调查项ID</td> </tr> <tr> <td style="text-align: left;">sections</td> <td style="text-align: left;">list</td> <td>分段 -&gt; <strong>ItemWithDisclosureSection</strong> <br/>一种调查项可以有 n(n≥1)段</td> </tr> </tbody> </table> <h5>ItemWithDisclosureSection</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;">results</td> <td style="text-align: left;">list</td> <td>披露结果 -&gt; <strong>ItemWithDisclosureResult</strong></td> </tr> </tbody> </table> <h5>ItemWithDisclosureResult</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;">k</td> <td style="text-align: left;">string</td> <td>披露项key</td> </tr> <tr> <td style="text-align: left;">v</td> <td style="text-align: left;">string</td> <td>披露结果</td> </tr> </tbody> </table> <h4><strong>请求示例</strong></h4> <pre><code>{ "packageId": 0, "itemIdAndMultis": "1:1,14:1", "candidateName": "王大宝", "candidateIdCardNo": "310109199011220531", "candidatePhone": "13585590312", "authType": 2, "items": [] }</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>CreateOrderResp</strong></td> </tr> </tbody> </table> <h5>CreateOrderResp</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>订单号</td> </tr> <tr> <td style="text-align: left;">recordNos</td> <td style="text-align: left;">list<string></td> <td>背调号列表</td> </tr> </tbody> </table> <h4><strong>响应示例</strong></h4> <pre><code>{ "code": "000", "key": "CF6BF781AB82FEF5BFDF96B054ECEB15", "seq": "s20190415111700", "ts": "20190415152645", "sign": "7ed7892cc52021bccdbdfd5c93cbef6f", "msg": { "orderNo": "20190415152645093", "recordNos": [ "20190415152645093983751" ] } }</code></pre> <h4><strong>备注</strong></h4> <ul> <li><a href="https://www.showdoc.cc/ybd?page_id=1863843278019929" title="全局错误码">全局错误码</a></li> </ul>

页面列表

ITEM_HTML