使用说明
<h1>火星Api使用说明</h1>
<h3>操作步骤</h3>
<ol>
<li>获取AccessToken</li>
<li>添加分支机构</li>
<li>添加客户信息</li>
<li>添加订单</li>
<li>等待客户检测</li>
<li>获取订单,如果订单状态>=6,则可以获取报告详细信息</li>
<li>获取订单及报告详细信息</li>
</ol>
<h3>全局Url</h3>
<ul>
<li>测试地址 <code>https://Hx8.IntMars.cn/Api/{SubUrl}</code></li>
<li>正式地址 <code>https://ent.IntMars.cn/Api/{SubUrl}</code></li>
</ul>
<h3>请求说明</h3>
<ul>
<li>所有请求均采用Post方法。请求与响应均使用 application/json 为ContentType</li>
<li>除获取AccessToken请求外,所有请求均需拥有 Authorization 请求头,用于认证及授权，
例如 Authorization='<code>Bearer accesskey</code>'</li>
<li>请求数据均为json对象,如果无对象内容,则json值应为{};</li>
<li>部分请求对象类型为<code>IdReq</code>，其定义如下:</li>
</ul>
<h4>IdReq 全局响应类</h4>
<table>
<thead>
<tr>
<th>参数名</th>
<th>类型</th>
<th>说明</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>string</td>
<td>用于请求或响应只包含字符串的数据</td>
</tr>
</tbody>
</table>
<h5>示例</h5>
<pre><code>{
&quot;id&quot;:&quot;id detail &quot;
}</code></pre>
<h3>全局响应说明</h3>
<pre><code> 所有响应均返回统一的包装类。用于返回数据及状态</code></pre>
<h5>ApiRsp<T> 全局响应类</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;">status</td>
<td style="text-align: left;">int</td>
<td>状态码 为0时表示成功,其他状态为失败,999表示未知错误</td>
</tr>
<tr>
<td style="text-align: left;">title</td>
<td style="text-align: left;">string?</td>
<td>消息,状态码不为0时，展示错误信息，状态码为0时,为请求名称</td>
</tr>
<tr>
<td style="text-align: left;">data</td>
<td style="text-align: left;">T?</td>
<td>实际返回数据对象或对象列表,当statusCode>0时，为null</td>
</tr>
<tr>
<td style="text-align: left;">errors</td>
<td style="text-align: left;">map<string,string>?</td>
<td>错误列表,如果只有一个错误时,其key为 “_” 。当status==0时,为null,</td>
</tr>
</tbody>
</table>
<h5>全局响应示例</h5>
<pre><code> {
&quot;status&quot;: 0,
&quot;title&quot;:&quot;错误消息&quot;,
&quot;data&quot;: {...} 或 [array...],
errors:{
&quot;_&quot;:&quot;和title错误消息相同&quot;,
&quot;{other}&quot;:&quot;如果请求数据中的字段数据验证不通过,则key为字段名称,value为验证不通过的原因&quot;
}
}</code></pre>
<h5>常见错误代码</h5>
<pre><code>- 0 成功
- 10 数据校验失败
- 21 {xx对象}不存在
- 22 {xx对象}已存在
- 401 用户名或密码错误
- 403 没有权限调用当前接口
- 999 未知错误</code></pre>