智护士 ~ 大雅云平台接口
<p>[TOC]</p>
<h2>智护士接口</h2>
<pre><code class="language-text">请求用户登录接口获取Token</code></pre>
<h4>公共Header参数</h4>
<table>
<thead>
<tr>
<th>参数名</th>
<th>示例值</th>
<th>参数描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>token</td>
<td>.......</td>
<td>请求用户登录接口获取Token</td>
</tr>
</tbody>
</table>
<h4>公共Query参数</h4>
<table>
<thead>
<tr>
<th>参数名</th>
<th>示例值</th>
<th>参数描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>---</td>
<td>---</td>
<td>---</td>
</tr>
</tbody>
</table>
<h4>公共返回结构</h4>
<table>
<thead>
<tr>
<th>参数名</th>
<th>类型</th>
<th>备注</th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td>int</td>
<td>返回标记：成功标记=0，失败标记=1</td>
</tr>
<tr>
<td>msg</td>
<td>string</td>
<td>返回信息</td>
</tr>
<tr>
<td>data</td>
<td>object</td>
<td>返回的相关数据</td>
</tr>
</tbody>
</table>
<pre><code class="language-json">{
"code": 0,
"msg": null,
"data": []
}</code></pre>
<h2>1.0 用户登录接口</h2>
<pre><code class="language-text">暂无描述</code></pre>
<h4>接口URL</h4>
<blockquote>
<p><a href="http://119.91.62.180:9999/zhs/user/login">http://119.91.62.180:9999/zhs/user/login</a></p>
</blockquote>
<h4>请求方式</h4>
<blockquote>
<p>POST</p>
</blockquote>
<h4>Content-Type</h4>
<blockquote>
<p>form-data</p>
</blockquote>
<h4>请求Body参数</h4>
<table>
<thead>
<tr>
<th>参数名</th>
<th>示例值</th>
<th>参数类型</th>
<th>是否必填</th>
<th>参数描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>username</td>
<td>1809894@163.com</td>
<td>Text</td>
<td>是</td>
<td>用户名</td>
</tr>
<tr>
<td>password</td>
<td>11111</td>
<td>Text</td>
<td>是</td>
<td>密码</td>
</tr>
</tbody>
</table>
<h4>成功响应示例</h4>
<pre><code class="language-javascript">{
"code": 0,
"msg": "登录成功！",
"data": {
"token": "d512cf9c26261cab21b25e5351b25ef3",
"expire": 1659077197057,
"patientId": 15
}
}</code></pre>
<table>
<thead>
<tr>
<th>参数名</th>
<th>示例值</th>
<th>参数类型</th>
<th>参数描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td>-</td>
<td>Number</td>
</tr>
<tr>
<td>msg</td>
<td>登录成功！</td>
<td>String</td>
<td>返回文字描述</td>
</tr>
<tr>
<td>data</td>
<td>-</td>
<td>Object</td>
<td>返回数据</td>
</tr>
<tr>
<td>data.token</td>
<td>d512cf9c26261cab21b25e5351b25ef3</td>
<td>String</td>
<td>认证令牌</td>
</tr>
<tr>
<td>data.expire</td>
<td>1659077197057</td>
<td>Number</td>
<td>token过期时间</td>
</tr>
<tr>
<td>data.patientId</td>
<td>15</td>
<td>Number</td>
<td>居民ID</td>
</tr>
</tbody>
</table>
<h1>1.1 用户退出接口</h1>
<pre><code class="language-text">暂无描述</code></pre>
<h4>接口状态</h4>
<blockquote>
<p>已完成</p>
</blockquote>
<h4>接口URL</h4>
<blockquote>
<p><a href="http://119.91.62.180:9999/zhs/user/logout">http://119.91.62.180:9999/zhs/user/logout</a></p>
</blockquote>
<h4>请求方式</h4>
<blockquote>
<p>POST</p>
</blockquote>
<h4>Content-Type</h4>
<blockquote>
<p>form-data</p>
</blockquote>
<h4>请求Header参数</h4>
<table>
<thead>
<tr>
<th>参数名</th>
<th>示例值</th>
<th>参数类型</th>
<th>是否必填</th>
<th>参数描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>token</td>
<td>4691d4491b1e5d1a2e8c69592c47a691</td>
<td>Text</td>
<td>是</td>
<td>-</td>
</tr>
</tbody>
</table>
<h4>请求Query参数</h4>
<table>
<thead>
<tr>
<th>参数名</th>
<th>示例值</th>
<th>参数类型</th>
<th>是否必填</th>
<th>参数描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>zone</td>
<td>-</td>
<td>Text</td>
<td>是</td>
<td>-</td>
</tr>
</tbody>
</table>
<h4>成功响应示例</h4>
<pre><code class="language-javascript">{
"code": 0,
"msg": null,
"data": "退出成功"
}</code></pre>
<table>
<thead>
<tr>
<th>参数名</th>
<th>示例值</th>
<th>参数类型</th>
<th>参数描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td>-</td>
<td>Number</td>
</tr>
<tr>
<td>msg</td>
<td>-</td>
<td>Object</td>
<td>返回文字描述</td>
</tr>
<tr>
<td>data</td>
<td>退出成功</td>
<td>String</td>
<td>返回数据</td>
</tr>
</tbody>
</table>
<h1>2.0 获取设备绑定列表接口</h1>
<pre><code class="language-text">暂无描述</code></pre>
<h4>接口URL</h4>
<blockquote>
<p><a href="http://119.91.62.180:9999/zhs/breathing/getDeviceList/15">http://119.91.62.180:9999/zhs/breathing/getDeviceList/15</a></p>
</blockquote>
<h4>请求方式</h4>
<blockquote>
<p>GET</p>
</blockquote>
<h4>Content-Type</h4>
<blockquote>
<p>form-data</p>
</blockquote>
<h4>请求Header参数</h4>
<table>
<thead>
<tr>
<th>参数名</th>
<th>示例值</th>
<th>参数类型</th>
<th>是否必填</th>
<th>参数描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>token</td>
<td>afb20a1d71a1a4b1bd2ff486fd1eca64</td>
<td>Text</td>
<td>是</td>
<td>-</td>
</tr>
</tbody>
</table>
<h4>成功响应示例</h4>
<pre><code class="language-javascript">{
"code": 0,
"msg": null,
"data": [
{
"serialId": "YB20322200019",
"modelNo": "DM28-25ST-BP",
"connectedState": 0,
"mode": "CPAP",
"bindTime": null,
"deviceImg": "/appResource/image/png/black_black.png"
}
]
}</code></pre>
<table>
<thead>
<tr>
<th>参数名</th>
<th>示例值</th>
<th>参数类型</th>
<th>参数描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td>-</td>
<td>Number</td>
</tr>
<tr>
<td>msg</td>
<td>-</td>
<td>Object</td>
<td>返回文字描述</td>
</tr>
<tr>
<td>data</td>
<td>-</td>
<td>Object</td>
<td>返回数据</td>
</tr>
<tr>
<td>data.serialId</td>
<td>YB20322200019</td>
<td>String</td>
<td>序列号</td>
</tr>
<tr>
<td>data.modelNo</td>
<td>DM28-25ST-BP</td>
<td>String</td>
<td>设备型号编码</td>
</tr>
<tr>
<td>data.connectedState</td>
<td>-</td>
<td>Number</td>
<td>联网状态 0 离线 1在线</td>
</tr>
<tr>
<td>data.mode</td>
<td>CPAP</td>
<td>String</td>
<td>模式</td>
</tr>
<tr>
<td>data.bindTime</td>
<td>-</td>
<td>Object</td>
<td>绑定时间 MM-dd-yyyy HH:mm:ss</td>
</tr>
<tr>
<td>data.deviceImg</td>
<td>/appResource/image/png/black_black.png</td>
<td>String</td>
<td>设备图片,使用地址拼接</td>
</tr>
</tbody>
</table>
<h1>2.1 获取设备最后使用记录</h1>
<pre><code class="language-text">暂无描述</code></pre>
<h4>接口URL</h4>
<blockquote>
<p><a href="http://119.91.62.180:9999/zhs/breathing/getDeviceLastUseRecord">http://119.91.62.180:9999/zhs/breathing/getDeviceLastUseRecord</a></p>
</blockquote>
<h4>请求方式</h4>
<blockquote>
<p>POST</p>
</blockquote>
<h4>Content-Type</h4>
<blockquote>
<p>json</p>
</blockquote>
<h4>请求Header参数</h4>
<table>
<thead>
<tr>
<th>参数名</th>
<th>示例值</th>
<th>参数类型</th>
<th>是否必填</th>
<th>参数描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>token</td>
<td>4691d4491b1e5d1a2e8c69592c47a691</td>
<td>Text</td>
<td>是</td>
<td>-</td>
</tr>
</tbody>
</table>
<h4>请求Body参数</h4>
<pre><code class="language-javascript">{"serialId":"YB20322200019"}</code></pre>
<table>
<thead>
<tr>
<th>参数名</th>
<th>示例值</th>
<th>参数类型</th>
<th>是否必填</th>
<th>参数描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>serialId</td>
<td>YB20322200019</td>
<td>String</td>
<td>是</td>
<td>序列号</td>
</tr>
</tbody>
</table>
<h4>预执行脚本</h4>
<pre><code class="language-javascript">暂无预执行脚本</code></pre>
<h4>后执行脚本</h4>
<pre><code class="language-javascript">暂无后执行脚本</code></pre>
<h4>成功响应示例</h4>
<pre><code class="language-javascript">{
"code": 0,
"msg": null,
"data": {
"pressureAvg": "3.75",
"ahiAvg": "0.0",
"leakAvg": "6.12",
"cureTimeAvg": "1.23",
"greater4Hour": "0",
"utilityTime": "1.23",
"lastUsedTime": "07-05-2022 13:14:39"
}
}</code></pre>
<table>
<thead>
<tr>
<th>参数名</th>
<th>示例值</th>
<th>参数类型</th>
<th>参数描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td>-</td>
<td>Number</td>
</tr>
<tr>
<td>msg</td>
<td>-</td>
<td>Object</td>
<td>返回文字描述</td>
</tr>
<tr>
<td>data</td>
<td>-</td>
<td>Object</td>
<td>返回数据</td>
</tr>
<tr>
<td>data.pressureAvg</td>
<td>3.75</td>
<td>String</td>
<td>压力(cmH2O) - 平均</td>
</tr>
<tr>
<td>data.ahiAvg</td>
<td>0.0</td>
<td>String</td>
<td>AHI - 平均</td>
</tr>
<tr>
<td>data.leakAvg</td>
<td>6.12</td>
<td>String</td>
<td>漏气量 - 平均</td>
</tr>
<tr>
<td>data.cureTimeAvg</td>
<td>1.23</td>
<td>String</td>
<td>平均治疗时间 （h）</td>
</tr>
<tr>
<td>data.greater4Hour</td>
<td>0</td>
<td>String</td>
<td>大于4小时笔数</td>
</tr>
<tr>
<td>data.utilityTime</td>
<td>1.23</td>
<td>String</td>
<td>使用时长 （h）</td>
</tr>
<tr>
<td>data.lastUsedTime</td>
<td>07-05-2022 13:14:39</td>
<td>String</td>
<td>最后使用时间(MM-dd-yyyy HH:mm:ss)</td>
</tr>
</tbody>
</table>
<h1>2.2 获取设备数据(一天，一周，一月，三个月)</h1>
<pre><code class="language-text">暂无描述</code></pre>
<h4>接口状态</h4>
<blockquote>
<p>已完成</p>
</blockquote>
<h4>接口URL</h4>
<blockquote>
<p><a href="http://119.91.62.180:9999/zhs/breathing/getDevicePeriodData">http://119.91.62.180:9999/zhs/breathing/getDevicePeriodData</a></p>
</blockquote>
<h4>请求方式</h4>
<blockquote>
<p>POST</p>
</blockquote>
<h4>Content-Type</h4>
<blockquote>
<p>json</p>
</blockquote>
<h4>请求Header参数</h4>
<table>
<thead>
<tr>
<th>参数名</th>
<th>示例值</th>
<th>参数类型</th>
<th>是否必填</th>
<th>参数描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>token</td>
<td>4691d4491b1e5d1a2e8c69592c47a691</td>
<td>Text</td>
<td>是</td>
<td>-</td>
</tr>
</tbody>
</table>
<h4>请求Body参数</h4>
<pre><code class="language-javascript">{
"serialId":"YB20322200019",
"unitDate":"0",
"unitValue":1
}</code></pre>
<table>
<thead>
<tr>
<th>参数名</th>
<th>示例值</th>
<th>参数类型</th>
<th>是否必填</th>
<th>参数描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>serialId</td>
<td>YB20322200019</td>
<td>String</td>
<td>是</td>
<td>序列号</td>
</tr>
<tr>
<td>unitDate</td>
<td>0</td>
<td>String</td>
<td>是</td>
<td>0(天) 1(周) 2(月) 3(季度) 4(年) 9(自定义)</td>
</tr>
<tr>
<td>unitValue</td>
<td>1</td>
<td>Number</td>
<td>是</td>
<td>时间数值</td>
</tr>
</tbody>
</table>
<h4>成功响应示例</h4>
<pre><code class="language-javascript">{
"code": 0,
"msg": null,
"data": {
"pressureAvg": "0.0",
"ahiAvg": "0.0",
"leakAvg": "0.0",
"cureTimeAvg": "0.0",
"greater4Hour": "0",
"utilityTime": "0.0",
"lastUsedTime": null
}
}</code></pre>
<table>
<thead>
<tr>
<th>参数名</th>
<th>示例值</th>
<th>参数类型</th>
<th>参数描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td>-</td>
<td>Number</td>
</tr>
<tr>
<td>msg</td>
<td>-</td>
<td>Object</td>
<td>返回文字描述</td>
</tr>
<tr>
<td>data</td>
<td>-</td>
<td>Object</td>
<td>返回数据</td>
</tr>
<tr>
<td>data.pressureAvg</td>
<td>0.0</td>
<td>String</td>
<td>压力(cmH2O) - 平均</td>
</tr>
<tr>
<td>data.ahiAvg</td>
<td>0.0</td>
<td>String</td>
<td>AHI - 平均</td>
</tr>
<tr>
<td>data.leakAvg</td>
<td>0.0</td>
<td>String</td>
<td>漏气量 - 平均</td>
</tr>
<tr>
<td>data.cureTimeAvg</td>
<td>0.0</td>
<td>String</td>
<td>平均治疗时间 （h）</td>
</tr>
<tr>
<td>data.greater4Hour</td>
<td>0</td>
<td>String</td>
<td>大于4小时笔数</td>
</tr>
<tr>
<td>data.utilityTime</td>
<td>0.0</td>
<td>String</td>
<td>使用时长 （h）</td>
</tr>
<tr>
<td>data.lastUsedTime</td>
<td>-</td>
<td>Object</td>
<td>最后使用时间(YYYY-MM-dd HH:mm:ss)</td>
</tr>
</tbody>
</table>
<h1>2.3 获取设备统计图表数据</h1>
<pre><code class="language-text">暂无描述</code></pre>
<h4>接口状态</h4>
<blockquote>
<p>已完成</p>
</blockquote>
<h4>接口URL</h4>
<blockquote>
<p><a href="http://119.91.62.180:9999/zhs/breathing/getDeviceHistogramStatistic">http://119.91.62.180:9999/zhs/breathing/getDeviceHistogramStatistic</a></p>
</blockquote>
<h4>请求方式</h4>
<blockquote>
<p>POST</p>
</blockquote>
<h4>Content-Type</h4>
<blockquote>
<p>json</p>
</blockquote>
<h4>请求Header参数</h4>
<table>
<thead>
<tr>
<th>参数名</th>
<th>示例值</th>
<th>参数类型</th>
<th>是否必填</th>
<th>参数描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>token</td>
<td>4691d4491b1e5d1a2e8c69592c47a691</td>
<td>Text</td>
<td>是</td>
<td>-</td>
</tr>
</tbody>
</table>
<h4>请求Body参数</h4>
<pre><code class="language-javascript">{
"serialId":"YB20322200019",
"endDate":"2022-06-30",
"unitDate": "1"
}</code></pre>
<table>
<thead>
<tr>
<th>参数名</th>
<th>示例值</th>
<th>参数类型</th>
<th>是否必填</th>
<th>参数描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>serialId</td>
<td>YB20322200019</td>
<td>String</td>
<td>是</td>
<td>序列号</td>
</tr>
<tr>
<td>endDate</td>
<td>2022-06-30</td>
<td>String</td>
<td>是</td>
<td>截止时间</td>
</tr>
<tr>
<td>unitDate</td>
<td>2</td>
<td>String</td>
<td>是</td>
<td>0(天) 1(周) 2(月) 3(季度) 4(年) 9(自定义)</td>
</tr>
</tbody>
</table>
<h4>成功响应示例</h4>
<pre><code class="language-javascript">{
"code": 0,
"msg": null,
"data": {
"useTime": [
{
"greater4Num": "24.0",
"less4Num": "0.0",
"cureTime": "2022-06-24"
},
{
"greater4Num": "24.0",
"less4Num": "0.0",
"cureTime": "2022-06-25"
},
{
"greater4Num": "24.0",
"less4Num": "0.0",
"cureTime": "2022-06-26"
},
{
"greater4Num": "23.23",
"less4Num": "0.02",
"cureTime": "2022-06-27"
},
{
"greater4Num": "0.0",
"less4Num": "6.6",
"cureTime": "2022-06-28"
},
{
"greater4Num": "24.0",
"less4Num": "0.0",
"cureTime": "2022-06-29"
},
{
"greater4Num": "0",
"less4Num": "0",
"cureTime": "2022-06-30"
}
],
"pressure": [
{
"median": "3.71",
"max": "4.17",
"th95": "4.15",
"cureTime": "2022-06-24"
},
{
"median": "3.71",
"max": "4.55",
"th95": "4.15",
"cureTime": "2022-06-25"
},
{
"median": "3.71",
"max": "4.25",
"th95": "4.15",
"cureTime": "2022-06-26"
},
{
"median": "3.85",
"max": "16.06",
"th95": "3.94",
"cureTime": "2022-06-27"
},
{
"median": "3.7",
"max": "15.05",
"th95": "4.14",
"cureTime": "2022-06-28"
},
{
"median": "3.71",
"max": "4.17",
"th95": "4.15",
"cureTime": "2022-06-29"
},
{
"median": "0",
"max": "0",
"th95": "0",
"cureTime": "2022-06-30"
}
],
"ahi": [
{
"hi": "0.0",
"ahi": "0.0",
"ai": "0.0",
"cureTime": "2022-06-24"
},
{
"hi": "0.0",
"ahi": "0.0",
"ai": "0.0",
"cureTime": "2022-06-25"
},
{
"hi": "0.0",
"ahi": "0.0",
"ai": "0.0",
"cureTime": "2022-06-26"
},
{
"hi": "0.0",
"ahi": "0.0",
"ai": "0.0",
"cureTime": "2022-06-27"
},
{
"hi": "0.0",
"ahi": "0.0",
"ai": "0.0",
"cureTime": "2022-06-28"
},
{
"hi": "0.0",
"ahi": "0.0",
"ai": "0.0",
"cureTime": "2022-06-29"
},
{
"hi": "0",
"ahi": "0",
"ai": "0",
"cureTime": "2022-06-30"
}
],
"leak": [
{
"median": "6.17",
"th95": "6.18",
"cureTime": "2022-06-24"
},
{
"median": "6.17",
"th95": "6.18",
"cureTime": "2022-06-25"
},
{
"median": "6.17",
"th95": "6.18",
"cureTime": "2022-06-26"
},
{
"median": "6.06",
"th95": "6.17",
"cureTime": "2022-06-27"
},
{
"median": "6.11",
"th95": "6.12",
"cureTime": "2022-06-28"
},
{
"median": "6.14",
"th95": "6.15",
"cureTime": "2022-06-29"
},
{
"median": "0",
"th95": "0",
"cureTime": "2022-06-30"
}
]
}
}</code></pre>
<table>
<thead>
<tr>
<th>参数名</th>
<th>示例值</th>
<th>参数类型</th>
<th>参数描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td>-</td>
<td>Number</td>
</tr>
<tr>
<td>msg</td>
<td>-</td>
<td>Object</td>
<td>返回文字描述</td>
</tr>
<tr>
<td>data</td>
<td>-</td>
<td>Object</td>
<td>返回数据</td>
</tr>
<tr>
<td>data.useTime</td>
<td>-</td>
<td>Object</td>
<td>使用时间（小时） 直方图</td>
</tr>
<tr>
<td>data.useTime.greater4Num</td>
<td>24.0</td>
<td>String</td>
<td>≥ 4小时</td>
</tr>
<tr>
<td>data.useTime.less4Num</td>
<td>0.0</td>
<td>String</td>
<td>＜ 4小时</td>
</tr>
<tr>
<td>data.useTime.cureTime</td>
<td>2022-06-24</td>
<td>String</td>
<td>日期</td>
</tr>
<tr>
<td>data.pressure</td>
<td>-</td>
<td>Object</td>
<td>压力(cmH2O) 直方图</td>
</tr>
<tr>
<td>data.pressure.median</td>
<td>3.71</td>
<td>String</td>
<td>平均值</td>
</tr>
<tr>
<td>data.pressure.max</td>
<td>4.17</td>
<td>String</td>
<td>最大值</td>
</tr>
<tr>
<td>data.pressure.th95</td>
<td>4.15</td>
<td>String</td>
<td>P95</td>
</tr>
<tr>
<td>data.pressure.cureTime</td>
<td>2022-06-24</td>
<td>String</td>
<td>日期</td>
</tr>
<tr>
<td>data.ahi</td>
<td>-</td>
<td>Object</td>
<td>AHI指数 直方图</td>
</tr>
<tr>
<td>data.ahi.hi</td>
<td>0.0</td>
<td>String</td>
<td>hi</td>
</tr>
<tr>
<td>data.ahi.ahi</td>
<td>0.0</td>
<td>String</td>
<td>ahi</td>
</tr>
<tr>
<td>data.ahi.ai</td>
<td>0.0</td>
<td>String</td>
<td>ai</td>
</tr>
<tr>
<td>data.ahi.cureTime</td>
<td>2022-06-24</td>
<td>String</td>
<td>日期</td>
</tr>
<tr>
<td>data.leak</td>
<td>-</td>
<td>Object</td>
<td>漏气量 直方图</td>
</tr>
<tr>
<td>data.leak.median</td>
<td>6.17</td>
<td>String</td>
<td>平均值</td>
</tr>
<tr>
<td>data.leak.th95</td>
<td>6.18</td>
<td>String</td>
<td>P95</td>
</tr>
<tr>
<td>data.leak.cureTime</td>
<td>2022-06-24</td>
<td>String</td>
<td>日期</td>
</tr>
</tbody>
</table>