火星接口文档

火星接口文档


客户信息

<p>[TOC]</p> <h5>简要描述</h5> <ul> <li>客户信息管理,用于记录检测客户的基本信息。</li> <li>客户身份证及手机号是客户在检测设备登录的依据。</li> <li>为方便客户检测,客户使用手机号登录时,密码统一为123456,目前暂不提供修改密码功能。</li> <li>客户订单检测完成后,客户将被禁止在设备上登录,直到新建一个订单。</li> </ul> <h5>请求URL</h5> <ul> <li><code>{BaseUrl}/Mind/EntCustomer/Create</code> 添加客户 <code>CustomerCreate</code> =&gt; <code>CustomerRsp</code></li> <li><code>{BaseUrl}/Mind/EntCustomer/Update</code> 更新客户 <code>CustomerUpdate</code> =&gt; <code>CustomerRsp</code></li> <li><code>{BaseUrl}/Mind/EntCustomer/Read</code> 读取客户 <code>IdReq</code> =&gt; <code>CustomerRsp</code></li> <li><code>{BaseUrl}/Mind/EntCustomer/TextSearch</code> 搜索客户 <code>IdReq</code> =&gt; <code>CustomerRsp</code> -搜索客户中的id表示搜索关键字,可以是id,mobile,idCard 三种,将返回手机号|身份证号|id 等于搜索值的记录</li> </ul> <h5>请求与响应类</h5> <h5>CusomerCreate 创建客户的请求类</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>姓名</td> </tr> <tr> <td style="text-align: left;">mobile</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>手机号 添加后不可修改</td> </tr> <tr> <td style="text-align: left;">idCard</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>身份证号,系统通过身份证号判断年龄和性别,年龄性别错误会影响检测准确性。务必准确填写。</td> </tr> <tr> <td style="text-align: left;">disabled</td> <td style="text-align: left;">否</td> <td style="text-align: left;">boolean</td> <td>禁用 默认否</td> </tr> <tr> <td style="text-align: left;">remark</td> <td style="text-align: left;">否</td> <td style="text-align: left;"></td> <td>string</td> <td>备注 否</td> </tr> </tbody> </table> <h5>CustomerUpdate 更新客户的请求类</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">必选</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>唯一</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>客户名称</td> </tr> <tr> <td style="text-align: left;">mobile</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>手机号</td> </tr> <tr> <td style="text-align: left;">idCard</td> <td style="text-align: left;">是</td> <td style="text-align: left;">string</td> <td>身份证号</td> </tr> <tr> <td style="text-align: left;">disabled</td> <td style="text-align: left;">否</td> <td style="text-align: left;">boolean</td> <td>禁用 默认否</td> </tr> <tr> <td style="text-align: left;">remark</td> <td style="text-align: left;">否</td> <td style="text-align: left;"></td> <td>string</td> <td>备注 否</td> </tr> </tbody> </table> <h5>CustomerRsp 返回客户详细信息的响应类</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;">id</td> <td style="text-align: left;">string</td> <td>唯一id</td> </tr> <tr> <td style="text-align: left;">createdOn</td> <td style="text-align: left;">datetime</td> <td>创建时间</td> </tr> <tr> <td style="text-align: left;">modifiedOn</td> <td style="text-align: left;">datetime</td> <td>最后修改时间</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">string</td> <td>客户姓名</td> </tr> <tr> <td style="text-align: left;">mobile</td> <td style="text-align: left;">string</td> <td>手机号</td> </tr> <tr> <td style="text-align: left;">idCard</td> <td style="text-align: left;">string</td> <td>身份证号</td> </tr> <tr> <td style="text-align: left;">age</td> <td style="text-align: left;">string</td> <td>年龄</td> </tr> <tr> <td style="text-align: left;">sex</td> <td style="text-align: left;">int</td> <td>性别 0 男 1 女</td> </tr> <tr> <td style="text-align: left;">verifyCode</td> <td style="text-align: left;">string</td> <td>用户在检测设备登录时的密码。一般建议客户通过身份证刷证登录,身份证无法读取时,用手机号+密码登录。为方便管理,验证码统一设置为 123456</td> </tr> <tr> <td style="text-align: left;">disabled</td> <td style="text-align: left;">boolean</td> <td>禁用 默认否</td> </tr> <tr> <td style="text-align: left;">remark</td> <td style="text-align: left;">string</td> <td>备注 否</td> </tr> </tbody> </table>

页面列表

ITEM_HTML