🎨 文档格式调整优化

This commit is contained in:
Frank 2023-12-20 11:48:09 +08:00
parent 2f4eb0abf3
commit 135bf18f2f
6 changed files with 682 additions and 642 deletions

View File

@ -15,7 +15,7 @@
| ------------ | ---- | ------------ | ------------------------------ |
| username | 是 | string | 填用户名或手机号 |
| password | 是 | string | 填用户密码或短信密码 |
- 请求范例:
@ -26,113 +26,117 @@
Set-Cookie: user="2|1:0|10:1407508841|4:user|8:YWRtaW4=|19bf2a8edd510eca173cecff546c446e3d800ae34ca3649ec56a566d2386e0de"; expires=Sun, 07 Sep 2014 14:40:41 GMT; Path=/
- 响应范例:
{
"obj": {
"_id": {
"$oid": "5bda53d2264251367f5a4385"
},
"username": "18838030850",
"nickname": "伟东",
"phone": "18838030850",
"devicetokens": [
{
"token_type": "android",
"token": "1a0018970a2e98b8f46",
"push_server": "jiguang",
"app": "aiqiangua2.0",
"is_enable_aliase": false,
"created_at": {
"$date": 1596816909955
}
},
{
"token_type": "android",
"token": "100d8559094809f80ca",
"push_server": "jiguang",
"uuid": "aiqiangua2.0|74ef4ed806e282ac",
"app": "aiqiangua2.0",
"brand": "motorola",
"phone_type": "xt1079",
"system_version": "21",
"is_enable_aliase": false,
"created_at": {
"$date": 1599846173229
}
},
{
"token_type": "ios",
"token": "191e35f7e029c78a600",
"push_server": "jiguang",
"uuid": "aiqiangua2.0|DBB4C34C-46F1-407C-B0B4-265FB438E3CF",
"app": "aiqiangua2.0",
"brand": "apple",
"phone_type": "iPhone12,5",
"system_version": "13.6.1",
"is_enable_aliase": false,
"created_at": {
"$date": 1603189431007
}
},
{
"token_type": "ios",
"token": "121c83f7604cef30bbb",
"push_server": "jiguang",
"uuid": "aiqiangua2.0|8F945CF7-31E5-4631-A93C-8B1A8F867C37",
"app": "aiqiangua2.0",
"brand": "apple",
"phone_type": "iPhone 5c (GSM)",
"system_version": "10.3.3",
"is_enable_aliase": false,
"created_at": {
"$date": 1603290768443
}
}
],
"weight": 80,
"height": 166,
"birthday": "2006-11-01",
"avatar": "18838030850.png",
"avatar_url": "/media/avatar/200/18838030850.jpg",
"community": {
"$oid": "5bed061726425171d55ab8a7"
},
"gender": "male",
"address": "科学城",
"location_enable": true,
"care_code": "32434385",
"devices": [],
"groups": [
{
"$oid": "5dc3cc002642513d1356da38"
},
{
"$oid": "5bdc212e26425136804939f0"
},
{
"$oid": "5cd902d626425177be24be3e"
},
{
"$oid": "5d52182c264251738f99f4ef"
},
{
"$oid": "5dcbc4e92642513d1356db10"
},
{
"$oid": "5f584f4c2642511f21c77c9f"
},
{
"$oid": "5f12c3762642517d70510f7d"
},
{
"$oid": "5f8eae282642510b4bd152f2"
}
],
"bluetoothdevices": [],
"sleepdevices": [
"d069e6fae982"
]
},
"success": true,
"obj_name": "person"
}
- 响应范例:
```json
{
"obj": {
"_id": {
"$oid": "5bda53d2264251367f5a4385"
},
"username": "18838030850",
"nickname": "伟东",
"phone": "18838030850",
"devicetokens": [
{
"token_type": "android",
"token": "1a0018970a2e98b8f46",
"push_server": "jiguang",
"app": "aiqiangua2.0",
"is_enable_aliase": false,
"created_at": {
"$date": 1596816909955
}
},
{
"token_type": "android",
"token": "100d8559094809f80ca",
"push_server": "jiguang",
"uuid": "aiqiangua2.0|74ef4ed806e282ac",
"app": "aiqiangua2.0",
"brand": "motorola",
"phone_type": "xt1079",
"system_version": "21",
"is_enable_aliase": false,
"created_at": {
"$date": 1599846173229
}
},
{
"token_type": "ios",
"token": "191e35f7e029c78a600",
"push_server": "jiguang",
"uuid": "aiqiangua2.0|DBB4C34C-46F1-407C-B0B4-265FB438E3CF",
"app": "aiqiangua2.0",
"brand": "apple",
"phone_type": "iPhone12,5",
"system_version": "13.6.1",
"is_enable_aliase": false,
"created_at": {
"$date": 1603189431007
}
},
{
"token_type": "ios",
"token": "121c83f7604cef30bbb",
"push_server": "jiguang",
"uuid": "aiqiangua2.0|8F945CF7-31E5-4631-A93C-8B1A8F867C37",
"app": "aiqiangua2.0",
"brand": "apple",
"phone_type": "iPhone 5c (GSM)",
"system_version": "10.3.3",
"is_enable_aliase": false,
"created_at": {
"$date": 1603290768443
}
}
],
"weight": 80,
"height": 166,
"birthday": "2006-11-01",
"avatar": "18838030850.png",
"avatar_url": "/media/avatar/200/18838030850.jpg",
"community": {
"$oid": "5bed061726425171d55ab8a7"
},
"gender": "male",
"address": "科学城",
"location_enable": true,
"care_code": "32434385",
"devices": [],
"groups": [
{
"$oid": "5dc3cc002642513d1356da38"
},
{
"$oid": "5bdc212e26425136804939f0"
},
{
"$oid": "5cd902d626425177be24be3e"
},
{
"$oid": "5d52182c264251738f99f4ef"
},
{
"$oid": "5dcbc4e92642513d1356db10"
},
{
"$oid": "5f584f4c2642511f21c77c9f"
},
{
"$oid": "5f12c3762642517d70510f7d"
},
{
"$oid": "5f8eae282642510b4bd152f2"
}
],
"bluetoothdevices": [],
"sleepdevices": [
"d069e6fae982"
]
},
"success": true,
"obj_name": "person"
}
```

View File

@ -19,99 +19,98 @@
- 响应范例
```json
{
"obj":{
"_id":{
"$oid":"54a38233bf483c6ddfec4b79"
"obj": {
"_id": {
"$oid": "54a38233bf483c6ddfec4b79"
},
"name":"测试社区",
"email":"test@test.com",
"telephone":"13399999999",
"administrators":[
"name": "测试社区",
"email": "test@test.com",
"telephone": "13399999999",
"administrators": [
{
"$oid":"53f722d5bf483c5bd03d0a80"
"$oid": "53f722d5bf483c5bd03d0a80"
}
],
"sos_url":"http://test.aiqiangua.com/12349xzOrgan/api/sos/happenSOSAction.do?",
"location_url":"",
"sosdata_url":"",
"heartratedata_url":"",
"pedometerdata_url":"",
"sleepdata_url":"",
"powerdata_url":"",
"falldata_url":"",
"token":"",
"created_at":{
"$date":1420030643432
"sos_url": "http://test.aiqiangua.com/12349xzOrgan/api/sos/happenSOSAction.do?",
"location_url": "",
"sosdata_url": "",
"heartratedata_url": "",
"pedometerdata_url": "",
"sleepdata_url": "",
"powerdata_url": "",
"falldata_url": "",
"token": "",
"created_at": {
"$date": 1420030643432
},
"$administrators":[
"$administrators": [
{
"_id":{
"$oid":"53f722d5bf483c5bd03d0a80"
"_id": {
"$oid": "53f722d5bf483c5bd03d0a80"
},
"username":"user01",
"password":"d5a99288b270b6c1989975fdb352425913c45e1640b35473ef9370fc",
"email":"user01@abc.com",
"nickname":"管理员",
"phone":"12345612349",
"telephone":"020-183849339",
"app":"aiqiangua2.0",
"devicetokens":[
],
"weight":65,
"step":60,
"age":50,
"height":175,
"avatar":"user01.tmp",
"avatar_url":"/media/avatar/200/user01.jpg",
"community":{
"$oid":"54a38233bf483c6ddfec4b79"
"username": "user01",
"password": "d5a99288b270b6c1989975fdb352425913c45e1640b35473ef9370fc",
"email": "user01@abc.com",
"nickname": "管理员",
"phone": "12345612349",
"telephone": "020-183849339",
"app": "aiqiangua2.0",
"devicetokens": [],
"weight": 65,
"step": 60,
"age": 50,
"height": 175,
"avatar": "user01.tmp",
"avatar_url": "/media/avatar/200/user01.jpg",
"community": {
"$oid": "54a38233bf483c6ddfec4b79"
},
"role":"user",
"gender":"male",
"address":"广州",
"created_at":{
"$date":1408734037917
"role": "user",
"gender": "male",
"address": "广州",
"created_at": {
"$date": 1408734037917
},
"updated_at":{
"$date":1408734037913
"updated_at": {
"$date": 1408734037913
},
"lastlogin_ip":"183.61.80.249",
"lastlogin_at":{
"$date":1473846870019
"lastlogin_ip": "183.61.80.249",
"lastlogin_at": {
"$date": 1473846870019
},
"lastlogin_by":"Java/1.6.0_25",
"enable":true,
"email_is_checked":false,
"phone_is_checked":false,
"push_sos_enable":false,
"push_fence_enable":false,
"push_abnormal_enable":false,
"push_message_enable":false,
"push_lowpower_enable":false,
"push_system_enable":false,
"push_fall_enable":true,
"push_env_enable":true,
"auth_updated_at":{
"$date":1473846882861
"lastlogin_by": "Java/1.6.0_25",
"enable": true,
"email_is_checked": false,
"phone_is_checked": false,
"push_sos_enable": false,
"push_fence_enable": false,
"push_abnormal_enable": false,
"push_message_enable": false,
"push_lowpower_enable": false,
"push_system_enable": false,
"push_fall_enable": true,
"push_env_enable": true,
"auth_updated_at": {
"$date": 1473846882861
},
"is_device_owner":false,
"devices":[
"is_device_owner": false,
"devices": [
"868219000223161"
],
"groups":[
"groups": [
{
"$oid":"579e0267264251061974b349"
"$oid": "579e0267264251061974b349"
}
]
}
]
},
"success":true,
"obj_name":"community"
"success": true,
"obj_name": "community"
}
```
@ -131,7 +130,7 @@
- 请求范例:
curl -v -A CURL -b cookies.txt http://127.0.0.1:8888/api/community/59718dfa264251292a48b5c2/devicesloc/
> GET /api/community/59718dfa264251292a48b5c2/devicesloc/ HTTP/1.1
> User-Agent: CURL
> Host: 127.0.0.1:8888
@ -139,7 +138,9 @@
> Cookie: ""2|1:0|10:1502846059|4:user|8:YWRtaW4y|f92dad6929734b005ea153a4585f3c02ea9f7a70432a0410518df8a108030f7d""
- 响应范例:
{
```json
{
"objs": [
{
"point": {
@ -161,5 +162,5 @@
"page": "",
"success": true,
"obj_name": "devices_location"
}
}
```

View File

@ -18,6 +18,8 @@
curl -v -A CURL -b cookies.txt http://127.0.0.1:8000/api/device/868219000099926
- 响应范例
```json
{
"obj": {
"_id": "866815030630127",
@ -478,6 +480,7 @@
"success": true,
"obj_name": "device"
}
```
@ -504,10 +507,11 @@ __请求范例__
__响应范例__
{
"success": true
}
```json
{
"success": true
}
```
# 设置提醒
@ -523,13 +527,13 @@ __响应范例__
- URL参数: alert id(1-5)
- 请求参数: 至少设置一个参数
| 名称 | 必须 | 类型 | 说明 |
| ------------ | ---- | ------------ | ------------------------------ |
| enable | 否 | Int | 0,1 |
| name | 否 | String | |
| alert_type | 否 | Int | 提醒类型 0 重复 1 仅一次 |
| cycle | 否 | Int | 周期 1 以星期为周期 2 以日期为周期 |
| time | 否 | String | time 预定的响铃时间1、 cycle=1时实例1001101+21+30+
| 名称 | 必须 | 类型 | 说明 |
| ---------- | ---- | ------ | -------------------------------------------------------- |
| enable | 否 | Int | 0,1 |
| name | 否 | String | |
| alert_type | 否 | Int | 提醒类型 0 重复 1 仅一次 |
| cycle | 否 | Int | 周期 1 以星期为周期 2 以日期为周期 |
| time | 否 | String | time 预定的响铃时间1、 cycle=1时实例1001101+21+30+ |
表示从周日、周一……周六的七天响铃的那天为1不响为0时间是21点30分。
2、 cycle=2时时间为YYYYMMDDHHmmSS实例 20150313213000 time的长度固定为14 |
@ -544,10 +548,11 @@ __响应范例__
- 响应范例
{
"success": true
}
```json
{
"success": true
}
```
@ -563,12 +568,12 @@ __响应范例__
- URL参数: id(1-10)
- 请求参数: 至少设置一个参数
| 名称 | 必须 | 类型 | 说明 |
| ------------ | ---- | ------------ | ------------------------------ |
| name | 否 | String | 号码昵称 |
| num | 否 | String | 亲情号码,可以是手机或固话 |
| dial_flag | 否 | Int | 0不设置为紧急呼叫号码,1设置为紧急呼叫号码 |
| clear | 否 | any | 清空设置,[例如id值为2如果发送的url带clear系统只处理clear命令则上述设置的亲情号2的参数无效若该设备以前存有亲情号码2则以前设置的亲情号码2也会被清空] |
| 名称 | 必须 | 类型 | 说明 |
| --------- | ---- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name | 否 | String | 号码昵称 |
| num | 否 | String | 亲情号码,可以是手机或固话 |
| dial_flag | 否 | Int | 0不设置为紧急呼叫号码,1设置为紧急呼叫号码 |
| clear | 否 | any | 清空设置,[例如id值为2如果发送的url带clear系统只处理clear命令则上述设置的亲情号2的参数无效若该设备以前存有亲情号码2则以前设置的亲情号码2也会被清空] |
- 请求范例
@ -578,9 +583,11 @@ __响应范例__
- 响应范例
{
"success": true
}
```json
{
"success": true
}
```
# 设置安全区域
@ -592,15 +599,15 @@ __响应范例__
- URL参数: id(1-10)
- 请求参数: 至少设置一个参数设置安全围栏时最好设置全部的参数除了参数clear外该参数是用于清空设置的。修改安全围栏也是调用这个接口
| 名称 | 必须 | 类型 | 说明 |
| ------------ | ---- | ------------ | ------------------------------ |
| enable | 否 | Int | 0,1 |
| name | 否 | String | |
| freq | 否 | Boolean | 0触发一天1每日触发 |
| time_begin | 否 | Int | 目标时间与当日0点之间相差的秒数。如8 a.m 8*60*60=28800 |
| time_end | 否 | Int | 同上 |
| safe_area | 否 | String | 经度在前纬度在后 x1,y1;x2,y2;xn,yn 一组由';'分隔的坐标,坐标用','分隔。且需要呈闭环如A,B,C,D4个点则应该上传的数据为 A;B;C;D;A |
| clear | 否 | any | 如果指定clear参数则上述参数全部无意义全部重设为缺省值 |
| 名称 | 必须 | 类型 | 说明 |
| ---------- | ---- | ------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| enable | 否 | Int | 0,1 |
| name | 否 | String | |
| freq | 否 | Boolean | 0触发一天1每日触发 |
| time_begin | 否 | Int | 目标时间与当日0点之间相差的秒数。如8 a.m 8*60*60=28800 |
| time_end | 否 | Int | 同上 |
| safe_area | 否 | String | 经度在前纬度在后 x1,y1;x2,y2;xn,yn 一组由';'分隔的坐标,坐标用','分隔。且需要呈闭环如A,B,C,D4个点则应该上传的数据为 A;B;C;D;A |
| clear | 否 | any | 如果指定clear参数则上述参数全部无意义全部重设为缺省值 |
- 请求范例
@ -609,23 +616,24 @@ __响应范例__
- 响应范例
{
"success": true
}
```json
{
"success": true
}
```
# 在线设备操作
合法的action如下
| action | 说明 |
| --------------- | ------------------------------ |
| ring | 响铃 |
| restart | 重启 |
| restore | 恢复出厂 |
| get_envvoice | 获取环境录音 | 无 | DeviceEnvVoice | 录音成功以后,如果配置有对应的分发提醒,会触发|
| action | 说明 |
| ------------ | ------------ |
| ring | 响铃 |
| restart | 重启 |
| restore | 恢复出厂 |
| get_envvoice | 获取环境录音 | 无 | DeviceEnvVoice | 录音成功以后,如果配置有对应的分发提醒,会触发 |
@ -639,10 +647,10 @@ __响应范例__
# 获取在线设备实时数据
合法的action如下
| action | 说明 | 参数及类型 | 返回对象 |
| ---------------------- | ------------- | ---------- | --------- |
| get_locationdataonce | 获取实时位置 | 无 | 无 | 30秒 (只能发一条定位数据)
| get_heartrate | 获取心率数据 | 无 | HeartRateData | 1分后上服务器取数据 |
| action | 说明 | 参数及类型 | 返回对象 |
| -------------------- | ------------ | ---------- | ------------- |
| get_locationdataonce | 获取实时位置 | 无 | 无 | 30秒 (只能发一条定位数据) |
| get_heartrate | 获取心率数据 | 无 | HeartRateData | 1分后上服务器取数据 |
@ -657,12 +665,11 @@ __响应范例__
- 响应范例:
{
"success": true
}
```json
{
"success": true
}
```
@ -673,12 +680,12 @@ __响应范例__
- 响应对象: [powerdata](./object.md#powerdata)
- 请求参数:
| 名称 | 必须 | 类型 | 说明 |
| --------------- | ---- | ------------ | ------------------------------ |
| device | 是 | string | 15位设备唯一序号 |
| time_begin | 否 | string | YYYYMMDD查询指定日期的数据 |
| type | 否 | string | 01,2,3 |
0开机,1关机,2正常电量显示,3低电 |
| 名称 | 必须 | 类型 | 说明 |
| ----------------------------------------------- | ---- | ------ | ---------------------------- |
| device | 是 | string | 15位设备唯一序号 |
| time_begin | 否 | string | YYYYMMDD查询指定日期的数据 |
| type | 否 | string | 01,2,3 |
| 0开机,1关机,2正常电量显示,3低电 |
__请求范例__
@ -693,6 +700,7 @@ __请求范例__
__响应范例__
```json
{
"objs": [
{
@ -900,6 +908,7 @@ __响应范例__
"success": true,
"obj_name": "powerdata"
}
```
# 查看设备定位数据
@ -910,10 +919,10 @@ __响应范例__
- 响应对象: [locationdata](./object.md#locationdata)
- 请求参数:
| 名称 | 必须 | 类型 | 说明 |
| --------------- | ---- | ------------ | ------------------------------ |
| device | 是 | string | 15位设备唯一序号 |
| time_begin | 否 | string | YYYYMMDD查询指定日期的数据 |
| 名称 | 必须 | 类型 | 说明 |
| ---------- | ---- | ------ | ---------------------------- |
| device | 是 | string | 15位设备唯一序号 |
| time_begin | 否 | string | YYYYMMDD查询指定日期的数据 |
__请求范例__
@ -927,6 +936,7 @@ __请求范例__
__响应范例__
```json
{
"objs": [
{
@ -996,8 +1006,10 @@ __响应范例__
"success": true,
"obj_name": "locationdata"
}
```
#批量获取设备在离线状态
# 批量获取设备在离线状态
- 地址: api/community/[community id]/devicesloc_new
- 方法: GET
- 验证方法: Cookie: user
@ -1008,6 +1020,8 @@ __响应范例__
curl -v -A CURL -b cookies.txt http://api.aiqiangua.com:8888/api/community/59c8ca7a54625923636d5ea4/devicesloc_new/?rows_per_page=20&page=1
- 响应范例
```json
{
"online_numbers": 1,
"objs": [
@ -1257,7 +1271,7 @@ __响应范例__
"success": true,
"obj_name": "devices_location"
}
```
@ -1269,10 +1283,10 @@ __响应范例__
- 响应对象: [pedometerdata](./object.md#pedometerdata)
- 请求参数:
| 名称 | 必须 | 类型 | 说明 |
| --------------- | ---- | ------------ | ------------------------------ |
| device | 是 | string | 15位设备唯一序号 |
| time_begin | 否 | string | YYYYMMDD查询指定日期的数据 |
| 名称 | 必须 | 类型 | 说明 |
| ---------- | ---- | ------ | ---------------------------- |
| device | 是 | string | 15位设备唯一序号 |
| time_begin | 否 | string | YYYYMMDD查询指定日期的数据 |
__请求范例__
@ -1285,6 +1299,8 @@ __请求范例__
> Cookie: "user="2|1:0|10:1473817034|4:user|16:MTg2ODA1NTUwNzA=|2768bb77396815e5a7ca9fe3c65dc8060943c57aeb078c746faf56036533aa12""
__响应范例__
```json
{
"objs": [
{
@ -1312,6 +1328,7 @@ __响应范例__
"success": true,
"obj_name": "pedometerdata"
}
```
# 查看设备心率数据
@ -1322,10 +1339,10 @@ __响应范例__
- 响应对象: [heartratedata](./object.md#heartratedata)
- 请求参数:
| 名称 | 必须 | 类型 | 说明 |
| --------------- | ---- | ------------ | ------------------------------ |
| device | 是 | string | 15位设备唯一序号 |
| time_begin | 否 | string | YYYYMMDD查询指定日期的数据 |
| 名称 | 必须 | 类型 | 说明 |
| ---------- | ---- | ------ | ---------------------------- |
| device | 是 | string | 15位设备唯一序号 |
| time_begin | 否 | string | YYYYMMDD查询指定日期的数据 |
__请求范例__
@ -1338,7 +1355,9 @@ __请求范例__
> Cookie: "user="2|1:0|10:1473817034|4:user|16:MTg2ODA1NTUwNzA=|2768bb77396815e5a7ca9fe3c65dc8060943c57aeb078c746faf56036533aa12""
__响应范例__
{
```json
{
"objs": [
{
"_id": {
@ -1364,11 +1383,7 @@ __响应范例__
"success": true,
"obj_name": "heartratedata"
}
```
@ -1380,10 +1395,10 @@ __响应范例__
- 响应对象: [replydata](./object.md#replydata)
- 请求参数:
| 名称 | 必须 | 类型 | 说明 |
| --------------- | ---- | ------------ | ------------------------------ |
| device | 是 | string | 15位设备唯一序号 |
| time_begin | 否 | string | YYYYMMDD查询指定日期的数据 |
| 名称 | 必须 | 类型 | 说明 |
| ---------- | ---- | ------ | ---------------------------- |
| device | 是 | string | 15位设备唯一序号 |
| time_begin | 否 | string | YYYYMMDD查询指定日期的数据 |
- 请求范例
curl -v -A CURL -b cookies.txt 'http://127.0.0.1:8888/api/replydata/?device=868219000099926
@ -1396,6 +1411,7 @@ __响应范例__
__响应范例__
```json
{
"objs": [
{
@ -1453,6 +1469,7 @@ __响应范例__
"success": true,
"obj_name": "replydata"
}
```
# 查看设备血压数据
@ -1461,10 +1478,10 @@ __响应范例__
- 验证方法: Cookie: user
- 响应对象: [BloodPressureData](./object.md#BloodPressureData)
- 请求参数:
| 名称 | 必须 | 类型 | 说明 |
| --------------- | ---- | ------------| ------------------------------ |
| device id | 是 | string | 15位设备唯一序号 |
| time_begin | 否 | string | YYYYMMDD查询指定日期的数据 |
| 名称 | 必须 | 类型 | 说明 |
| ---------- | ---- | ------ | ---------------------------- |
| device id | 是 | string | 15位设备唯一序号 |
| time_begin | 否 | string | YYYYMMDD查询指定日期的数据 |
- 请求范例
curl -v -A CURL -b cookies.txt 'http://127.0.0.1:8000/api/bloodpressuredata/?deviceid=868219000099988&depth=1&rows_per_page=1'
@ -1476,6 +1493,7 @@ __响应范例__
> Cookie: "user='2|1:0|10:1500426685|4:user|12:b3BlcmF0b3I=|00f680f1ea4e9cdf5f175f4bd76cf4c53f953bed74118417b8fc58917f5b926d""
- 响应范例:
```json
{
"objs": [
{
@ -1506,6 +1524,7 @@ __响应范例__
"success": true,
"obj_name": "bloodpressuredata"
}
```
# 查看设备血氧数据
@ -1516,10 +1535,10 @@ __响应范例__
- 响应对象: [heartratedata](./object.md#heartratedata)
- 请求参数:
| 名称 | 必须 | 类型 | 说明 |
| --------------- | ---- | ------------ | ------------------------------ |
| device | 是 | string | 15位设备唯一序号 |
| time_begin | 否 | string | YYYYMMDD查询指定日期的数据 |
| 名称 | 必须 | 类型 | 说明 |
| ---------- | ---- | ------ | ---------------------------- |
| device | 是 | string | 15位设备唯一序号 |
| time_begin | 否 | string | YYYYMMDD查询指定日期的数据 |
__请求范例__
@ -1531,7 +1550,10 @@ __请求范例__
> Accept: */*
> Cookie: "user="2|1:0|10:1473817034|4:user|16:MTg2ODA1NTUwNzA=|2768bb77396815e5a7ca9fe3c65dc8060943c57aeb078c746faf56036533aa12""
-- 响应范例
{
```json
{
"objs": [
{
"_id": {
@ -1599,8 +1621,7 @@ __请求范例__
"success": true,
"obj_name": "bloodoxygendata"
}
```
# 查看设备紧急呼叫
@ -1611,10 +1632,10 @@ __请求范例__
- 响应对象: [sosdata](./object.md#sosdata)
- 请求参数:
| 名称 | 必须 | 类型 | 说明 |
| --------------- | ---- | ------------ | ------------------------------ |
| device | 是 | string | 15位设备唯一序号 |
| time_begin | 否 | string | YYYYMMDD查询指定日期的数据 |
| 名称 | 必须 | 类型 | 说明 |
| ---------- | ---- | ------ | ---------------------------- |
| device | 是 | string | 15位设备唯一序号 |
| time_begin | 否 | string | YYYYMMDD查询指定日期的数据 |
- 请求范例:
@ -1628,7 +1649,8 @@ __请求范例__
- 响应范例:
{
```json
{
"objs": [
{
"_id": {
@ -1747,6 +1769,7 @@ __请求范例__
"success": true,
"obj_name": "sosdata"
}
```
@ -1759,9 +1782,9 @@ __请求范例__
- URL参数: device oid
- 请求参数:
| 名称 | 必须 | 类型 | 说明 |
| --------------- | ---- | ------------ | ------------------------------ |
| type | 否 | string | 0:Gps定位; 1:基站定位 |
| 名称 | 必须 | 类型 | 说明 |
| ---- | ---- | ------ | --------------------- |
| type | 否 | string | 0:Gps定位; 1:基站定位 |
- 请求范例:
@ -1769,7 +1792,8 @@ __请求范例__
- 响应范例:
{
```json
{
"obj": {
"remaining_power": 47,
"temperature": 25,
@ -1799,10 +1823,7 @@ __请求范例__
"success": true,
"obj_name": ""
}
```
# 获取设备环境音
@ -1816,6 +1837,9 @@ __请求范例__
curl -v -A CURL -b cookies.txt http://120.24.56.48:8889/api/device/866815030630127/deviceenvvoice/list/?depth=1
- 响应范例:
```json
{
"objs": [
{
@ -1850,5 +1874,6 @@ __请求范例__
"success": true,
"obj_name": "deviceenvvoice"
}
```

View File

@ -4,19 +4,21 @@ API概述
目录
----
- [请求格式](#请求格式)
- [GET](#GET)
- [POST](#POST)
- [对象输出参数](#对象输出参数)
- [分页参数](#分页参数)
- [嵌套参数](#嵌套参数)
- [简化参数](#简化参数)
- [排序参数](#排序参数)
- [响应格式](#响应格式)
- [返回单个对象](#返回单个对象)
- [返回多个对象](#返回多个对象)
- [返回失败](#返回失败)
- [错误码定义](#错误码定义)
- [API概述](#api概述)
- [目录](#目录)
- [请求格式](#请求格式)
- [GET](#get)
- [POST](#post)
- [对象输出参数](#对象输出参数)
- [分页参数](#分页参数)
- [嵌套参数](#嵌套参数)
- [简化参数](#简化参数)
- [排序参数](#排序参数)
- [响应格式](#响应格式)
- [返回单个对象](#返回单个对象)
- [返回多个对象](#返回多个对象)
- [返回失败](#返回失败)
- [错误码定义](#错误码定义)
# 请求格式
@ -46,10 +48,10 @@ POST命令参数可放在URL也可放在BODY中
当返回对象列表时,可以对列表进行分页
| 名称 | 必须 | 类型 | 说明 |
| ------------ | ---- | ------------ | ------------------------------ |
| page | | int | 页数1~N缺省1 |
| rows_per_page| | int | 每页行数缺省20 |
| 名称 | 必须 | 类型 | 说明 |
| ------------- | ---- | ---- | ---------------- |
| page | | int | 页数1~N缺省1 |
| rows_per_page | | int | 每页行数缺省20 |
## 嵌套参数
@ -58,17 +60,17 @@ POST命令参数可放在URL也可放在BODY中
- 原属性输出为ObjectID方式
- 新增一个以$开头的属性,形如"$[attr_name]", 其中attr_name为原属性名其内容是完整的json对象。
| 名称 | 必须 | 类型 | 说明 |
| ------------ | ---- | ------------ | ------------------------------ |
| depth | 否 | int | 嵌套层数(1-4)缺省2 |
| 名称 | 必须 | 类型 | 说明 |
| ----- | ---- | ---- | -------------------- |
| depth | 否 | int | 嵌套层数(1-4)缺省2 |
## 简化参数
输出简化后的对象只包含特定的属性。必须在定义对象时指出简化对象包含哪些属性如未指定则输出对象的前10个属性。
| 名称 | 必须 | 类型 | 说明 |
| ------------ | ---- | ------------ | ------------------------------ |
| small | | int | 1-完整0-简化。缺省为1 |
| 名称 | 必须 | 类型 | 说明 |
| ----- | ---- | ---- | ----------------------- |
| small | | int | 1-完整0-简化。缺省为1 |
## 排序参数
@ -76,9 +78,9 @@ POST命令参数可放在URL也可放在BODY中
当返回对象列表时,可以对列表进行排序。指定按哪几个属性进行排序。
| 名称 | 必须 | 类型 | 说明 |
| ------------ | ---- | ------------ | ------------------------------ |
| order_by | | string | 需要排序的属性名, 逆序用'-', 多个属性用','连接。如:'order_by=email,-username'表示先按email字典序然后按username逆序 |
| 名称 | 必须 | 类型 | 说明 |
| -------- | ---- | ------ | --------------------------------------------------------------------------------------------------------------------- |
| order_by | | string | 需要排序的属性名, 逆序用'-', 多个属性用','连接。如:'order_by=email,-username'表示先按email字典序然后按username逆序 |
# 响应格式
@ -89,16 +91,20 @@ POST命令参数可放在URL也可放在BODY中
当返回单个对象时,返回格式。 范例:
```json
{
"success": true, // 成功标志
"obj_name": "obj name", // 对象名
"obj": {"key1":"val1", "key2":"val2", ...} // 返回的对象内容
}
```
## 返回多个对象
当返回多个对象时,返回格式。范例:
```json
{
"success": true, // 成功标志
"obj_name": "obj name", // 对象名
@ -110,37 +116,40 @@ POST命令参数可放在URL也可放在BODY中
"page_current": intval, // 当前页号
}
}
```
## 返回失败
失败时返回错误码和出错信息。 范例:
```json
{
"success": false, // 成功标志
"error_code": 1, // 错误码
"error_desc": "error description", // 错误描述
"error_url": "/api/account/login", // 错误URL
}
```
# 错误码定义
| 返回码 | 错误信息 | 说明 |
| ------------ | -------- | ------------------------------ |
| 0 | 成功 | |
| 1 | 错误 | |
| 101 | 未授权 | 需登录 |
| 102 | 没有操作权限 | 没有相应的操作权限,不需重新登录 |
| 103 | 用户不存在 | |
| 104 | 用户已存在 | |
| 105 | 登录验证失败 | |
| 106 | 设备不在线 | |
| 201 | 缺少必填参数 | |
| 202 | 参数格式错误 | |
| 203 | 对象不存在 | |
| 204 | 参数取值错误 | |
| 301 | 数据库错误 | |
| 302 | 数据唯一性错误 | |
| 401 | 数据同步失败 | |
| 999 | 其它错误 | |
| 返回码 | 错误信息 | 说明 |
| ------ | -------------- | -------------------------------- |
| 0 | 成功 | |
| 1 | 错误 | |
| 101 | 未授权 | 需登录 |
| 102 | 没有操作权限 | 没有相应的操作权限,不需重新登录 |
| 103 | 用户不存在 | |
| 104 | 用户已存在 | |
| 105 | 登录验证失败 | |
| 106 | 设备不在线 | |
| 201 | 缺少必填参数 | |
| 202 | 参数格式错误 | |
| 203 | 对象不存在 | |
| 204 | 参数取值错误 | |
| 301 | 数据库错误 | |
| 302 | 数据唯一性错误 | |
| 401 | 数据同步失败 | |
| 999 | 其它错误 | |

View File

@ -31,84 +31,85 @@ __目录__
血氧数据
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
| time_begin | 发生时间 | DateTime | | | False | None | |
| bloodoxygendata | 血氧百分比 | Int | | | False | 0 | |
| measure_type | 测量类型 | Int | | | False | 0 | 0 定时测量、 1 硬件手动测量、 2 远程指令测量 |
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| --------------- | ---------- | ---------------------------- | -------- | -------- | -------- | ------ | -------------------------------------------- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
| time_begin | 发生时间 | DateTime | | | False | None | |
| bloodoxygendata | 血氧百分比 | Int | | | False | 0 | |
| measure_type | 测量类型 | Int | | | False | 0 | 0 定时测量、 1 硬件手动测量、 2 远程指令测量 |
# bloodpressuredata
血压数据
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
| time_begin | 发生时间 | DateTime | | | False | None | |
| dbp | 舒张压 | Int | | | False | 0 | |
| sbp | 收缩压 | Int | | | False | 0 | |
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| ---------- | -------- | ---------------------------- | -------- | -------- | -------- | ------ | ---- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
| time_begin | 发生时间 | DateTime | | | False | None | |
| dbp | 舒张压 | Int | | | False | 0 | |
| sbp | 收缩压 | Int | | | False | 0 | |
# cell
基站标识 -- LocationData 内嵌对象
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| mcc | MCC | String | | 3 | False | 000 | |
| mnc | MNC | String | | 3 | False | 000 | |
| lac | LAC | Int | | | False | 0 | |
| cid | CELLID | Int | | | False | 0 | |
| rssi | RSSI | Int | | | False | 0 | |
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| ------ | ------ | ------ | -------- | -------- | -------- | ------ | ---- |
| mcc | MCC | String | | 3 | False | 000 | |
| mnc | MNC | String | | 3 | False | 000 | |
| lac | LAC | Int | | | False | 0 | |
| cid | CELLID | Int | | | False | 0 | |
| rssi | RSSI | Int | | | False | 0 | |
# device
device实体可修改参数 -- X8 (开关类型的参数以0,1传参代表关闭和打开
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| sos_dial_cycle_times | 轮播次数1-9 | Int | | | True | 1 | SOS触发以后拨打SOS号码的循环次数,1是循环一次9是无限循环 |
| frequency_location | 位置上报频率 | Int | | | True | 60 | 单位分钟不建议低于10min |
| frequency_step | 记步上报频率 | Int | | | True | 30 | 单位分钟不建议低于30min |默认是30分钟
| frequency_heartrate | 心率、血压、血氧上报频率 | Int | | | True | 60 | 单位分钟不建议低于10min |
| theshold_heartrate_h | 心率上限 | Int | | | True | 140 | |
| theshold_heartrate_l | 心率下限 | Int | | | True | 40 | |
| incoming_restriction | 呼入限制 | Boolean | | | True | False | |
| profile | 情景模式 | Int | | | True | 2 | 1:振动 2:铃声 3:震动+铃声 4.无振无声 |
| sleep_period_begin | 睡眠开始时间 | String | | 14 | True | | 格式YYYYMMDDHHMMSS其中YYYYMMDD都用0填充实例00000000083000,8点30am |
| sleep_period_end | 睡眠结束时间 | String | | 14 | True | | 同上 |
| step_objective | 计步目标 | Int | | | True | 3000 | |
| pedometer_enable | 计步数据开关 | Boolean | | | False | False | |
| sleep_enable | 睡眠数据开关 | Boolean | | | False | False | |
| sim_phone | 移动用户卡号 | String | | 16 | False | | |
| fall_enable | 跌倒判断开关 | Boolean | | | False | 0 |
| track_enable | 轨迹开关 | Boolean | | | False | 0 |
| heartrate_enable | 心率定时测量开关 | Boolean | | | False | False | |
| bloodoxygen_enable | 血氧定时测量开关 | Boolean | | | False | False | |
| bloodpressure_enable | 血压定时测量开关 | Boolean | | | False | False | |
| heartrate_enable | 心率、血氧、血压定时测量开关 | Boolean | | | False | False | |
| power_down_enable | 智能省电模式 (该模式打开以后,定时测量全部关闭) | Boolean | | | False | False | |
| short_message_enable | 短信上传开关 | Boolean | | | False | False | |
| gps_enable | GPS模块开关 | Boolean | | | False | True | |
| alertreply_enable | 提醒答复开关 | Boolean | | | False | True | |
| theshold_bloodoxygen_h | 血氧上限 | Int | | | False | 98 | |
| theshold_bloodoxygen_l | 血氧下限 | Int | | | False | 93 | |
| systolic_pressure_h | 收缩压上限 | Int | | | False | 140 | |
| diastolic_pressure_l | 舒张压下限 | Int | | | False | 60 | |
| callmode | 来电接听模式 | Int | | | True | 0 | 0 禁止自动接听 1 来电立即自动接听 2 响铃30s后自动接听 3 响铃15s后自动接听 |
| sim_phone | 移动用户卡号 | String | | 16 | False | | |
| sim_phone_type | 移动用户卡类型 | String | | 8 | False | unicom | unicom:中国联通; cmcc:中国移动; ctcc:中国电信 |
| name | 设备名称 | String | | 32 | False | | |
| theshold_low_battery | 低电门限 | Int | | | True | 15 | |
| sos_sendmail | 紧急呼叫是否发送短信 | Boolean | | | True | False | |
| exercise_heartrate_h| 运动心率上限阈值默认180|int| | |True|180| |
| exercise_heartrate_l |运动心率下限阈值默认40 |int| | |True|40 | |
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| ---------------------- | -------------------------------------------------- | ------- | -------- | -------- | -------- | ------ | ------------------------------------------------------------------------- |
| sos_dial_cycle_times | 轮播次数1-9 | Int | | | True | 1 | SOS触发以后拨打SOS号码的循环次数,1是循环一次9是无限循环 |
| frequency_location | 位置上报频率 | Int | | | True | 60 | 单位分钟不建议低于10min |
| frequency_step | 记步上报频率 | Int | | | True | 30 | 单位分钟不建议低于30min | 默认是30分钟 |
| frequency_heartrate | 心率、血压、血氧上报频率 | Int | | | True | 60 | 单位分钟不建议低于10min |
| theshold_heartrate_h | 心率上限 | Int | | | True | 140 | |
| theshold_heartrate_l | 心率下限 | Int | | | True | 40 | |
| incoming_restriction | 呼入限制 | Boolean | | | True | False | |
| profile | 情景模式 | Int | | | True | 2 | 1:振动 2:铃声 3:震动+铃声 4.无振无声 |
| sleep_period_begin | 睡眠开始时间 | String | | 14 | True | | 格式YYYYMMDDHHMMSS其中YYYYMMDD都用0填充实例00000000083000,8点30am |
| sleep_period_end | 睡眠结束时间 | String | | 14 | True | | 同上 |
| step_objective | 计步目标 | Int | | | True | 3000 | |
| pedometer_enable | 计步数据开关 | Boolean | | | False | False | |
| sleep_enable | 睡眠数据开关 | Boolean | | | False | False | |
| sim_phone | 移动用户卡号 | String | | 16 | False | | |
| fall_enable | 跌倒判断开关 | Boolean | | | False | 0 |
| track_enable | 轨迹开关 | Boolean | | | False | 0 |
| heartrate_enable | 心率定时测量开关 | Boolean | | | False | False | |
| bloodoxygen_enable | 血氧定时测量开关 | Boolean | | | False | False | |
| bloodpressure_enable | 血压定时测量开关 | Boolean | | | False | False | |
| heartrate_enable | 心率、血氧、血压定时测量开关 | Boolean | | | False | False | |
| power_down_enable | 智能省电模式 (该模式打开以后,定时测量全部关闭) | Boolean | | | False | False | |
| short_message_enable | 短信上传开关 | Boolean | | | False | False | |
| gps_enable | GPS模块开关 | Boolean | | | False | True | |
| alertreply_enable | 提醒答复开关 | Boolean | | | False | True | |
| theshold_bloodoxygen_h | 血氧上限 | Int | | | False | 98 | |
| theshold_bloodoxygen_l | 血氧下限 | Int | | | False | 93 | |
| systolic_pressure_h | 收缩压上限 | Int | | | False | 140 | |
| diastolic_pressure_l | 舒张压下限 | Int | | | False | 60 | |
| callmode | 来电接听模式 | Int | | | True | 0 | 0 禁止自动接听 1 来电立即自动接听 2 响铃30s后自动接听 3 响铃15s后自动接听 |
| sim_phone | 移动用户卡号 | String | | 16 | False | | |
| sim_phone_type | 移动用户卡类型 | String | | 8 | False | unicom | unicom:中国联通; cmcc:中国移动; ctcc:中国电信 |
| name | 设备名称 | String | | 32 | False | | |
| theshold_low_battery | 低电门限 | Int | | | True | 15 | |
| sos_sendmail | 紧急呼叫是否发送短信 | Boolean | | | True | False | |
| exercise_heartrate_h | 运动心率上限阈值默认180 | int | | | True | 180 | |
| exercise_heartrate_l | 运动心率下限阈值默认40 | int | | | True | 40 | |
@ -116,302 +117,302 @@ device实体可修改参数 -- X8 (开关类型的参数以0,1传
device实体全部参数
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| did | 设备编号 | String | | 64 | True | None | |
| alerts | 提醒 | List: Embedded [SettingAlert](#settingalert) | | | False | | |
| sos_numbers | 亲情号码 | List: Embedded [SettingSosNumber](#settingsosnumber) | | | False | | |
| sos_dial_cycle_times | 轮播次数1-9 | Int | | | True | 1 | SOS触发以后拨打SOS号码的循环次数,1是循环一次9是无限循环 |
| sos_sendmail | 紧急呼叫是否发送短信 | Boolean | | | True | False | |
| sos_readmail | 紧急呼叫短信是否自动弹出 | Boolean | | | True | False | 其他设备参数,忽略 |
| sos_dial_cycle_mode | 轮播模式 | Int | | | True | 0 | 0仅拨打SOS号码 |
| frequency_location | 位置上报频率 | Int | | | True | 30 | 单位分钟不建议低于10min |
| frequency_step | 记步上报频率 | Int | | | True | 30 | 单位分钟不建议低于10mi |
| frequency_heartrate | 心率上报频率 | Int | | | True | 30 | 单位分钟不建议低于10mi |
| theshold_heartrate_h | 心率上限 | Int | | | True | 140 | |
| theshold_heartrate_l | 心率下限 | Int | | | True | 40 | |
| incoming_restriction | 呼入限制 | Boolean | | | True | False | |
| bluetooth_enable | 蓝牙开关 | Boolean | | | True | False | 仅在适配好的血压计同步功能上有用 |
| bluetooth_devices | 蓝牙设备 | String | | 256 | True | | 暂时废弃 |
| profile | 情景模式 | Int | | | True | 0 | 0铃声1震动2震动+铃声3无震无声S2系列无震动曲奇有 |
| sleep_period_begin | 睡眠开始时间 | String | | 14 | True | | 格式YYYYMMDDHHMMSS其中YYYYMMDD都用0填充实例00000000083000,8点30am |
| sleep_period_end | 睡眠结束时间 | String | | 14 | True | | 同上 |
| step_objective | 计步目标 | Int | | | True | 3000 | |
| theshold_sit | 久坐门限 | Int | | | True | 60 | |
| theshold_low_battery | 低电门限 | Int | | | True | 20 | |
| fences | 电子围栏 | List: Embedded [SettingFence](#settingfence) | | | False | | |
| pedometer_enable | 计步数据开关 | Boolean | | | False | False | |
| sleep_enable | 睡眠数据开关 | Boolean | | | False | False | |
| imei | 移动设备识别码 | String | | 16 | False | | |
| imsi | 移动用户识别码 | String | | 16 | False | | |
| type | 设备类型 | String | | 20 | False | BY102 | |
| sim_phone | 移动用户卡号 | String | | 16 | False | | |
| sim_phone_type | 移动用户卡类型 | String | | 8 | False | unicom | unicom:中国联通; cmcc:中国移动; ctcc:中国电信 |
| owner | 拥有人 | Reference: [Person](#person) | | | False | None | |
| name | 设备名称 | String | | 32 | False | | |
| created_at | 创建时间 | DateTime | | | True | now() | |
| updated_at | 更新时间 | DateTime | | | True | now() | |
| lastlogin_ip | 最近联网地址 | String | | 16 | False | | |
| lastlogin_at | 最近联网时间 | DateTime | | | False | now() | |
| active | 激活状态 | Boolean | | | True | False | | 建立家庭圈绑定了设备才显示true没有绑定设备显示false
| active_at | 首次激活时间 | DateTime | | | False | None | |
| online | 联网状态 | Boolean | | | True | False | |
| location_updated | 坐标更新 | Boolean | | | True | False | |
| location_updated_at | 坐标更新时间 | DateTime | | | True | | |
| last_location | 最新坐标 | Point | | | True | | |
| last_city | 城市 | String | | | True | | |
| last_address | 地址 | String | | | True | | |
| wear_flag | 佩戴状态 | Int | | | False | None | |
| wear_updated_at | 佩戴状态更新时间 | DateTime | | | False | None | 1未佩戴0已佩戴仅在测量心率的时候更新状态终端自己测量不会更新 |
| remaining_power | 剩余电量(% | Int | | | False | 0 | |
| remaining_power_updated_at | 电量状态更新时间 | DateTime | | | False | None | |
| wifi | WIFI | List: Embedded [WIFI](#wifi) | | | False | | |
| software_version | 软件版本 | String | | 48 | False | | |
| iccid1 | 移动用户iccid号1 | String | | 21 | False | None | |
| iccid2 | 移动用户iccid号2 | String | | 21 | False | None | |
| fence_notification_updated_at | 围栏通知更新时间 | DateTime | | | False | None | |
| fall_model | 跌倒模式设置 | String | | | False | 0 | |
| fall_enable | 跌倒判断开关 | Boolean | | | False | 0 |
| track_enable | 轨迹开关 | Boolean | | | False | 0 |
| heartrate_enable | 心率开关 | Boolean | | | False | False | |
| power_down_enable | 智能省电模式 | Boolean | | | False | False | |
| exercise_heartrate_h| 运动心率上限阈值默认180|int| | |True|180| |
| exercise_heartrate_l |运动心率下限阈值默认40 |int| | |True|40 | |
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| ----------------------------- | ------------------------- | ---------------------------------------------------- | -------- | -------- | -------- | ------ | --------------------------------------------------------------------- |
| did | 设备编号 | String | | 64 | True | None | |
| alerts | 提醒 | List: Embedded [SettingAlert](#settingalert) | | | False | | |
| sos_numbers | 亲情号码 | List: Embedded [SettingSosNumber](#settingsosnumber) | | | False | | |
| sos_dial_cycle_times | 轮播次数1-9 | Int | | | True | 1 | SOS触发以后拨打SOS号码的循环次数,1是循环一次9是无限循环 |
| sos_sendmail | 紧急呼叫是否发送短信 | Boolean | | | True | False | |
| sos_readmail | 紧急呼叫短信是否自动弹出 | Boolean | | | True | False | 其他设备参数,忽略 |
| sos_dial_cycle_mode | 轮播模式 | Int | | | True | 0 | 0仅拨打SOS号码 |
| frequency_location | 位置上报频率 | Int | | | True | 30 | 单位分钟不建议低于10min |
| frequency_step | 记步上报频率 | Int | | | True | 30 | 单位分钟不建议低于10mi |
| frequency_heartrate | 心率上报频率 | Int | | | True | 30 | 单位分钟不建议低于10mi |
| theshold_heartrate_h | 心率上限 | Int | | | True | 140 | |
| theshold_heartrate_l | 心率下限 | Int | | | True | 40 | |
| incoming_restriction | 呼入限制 | Boolean | | | True | False | |
| bluetooth_enable | 蓝牙开关 | Boolean | | | True | False | 仅在适配好的血压计同步功能上有用 |
| bluetooth_devices | 蓝牙设备 | String | | 256 | True | | 暂时废弃 |
| profile | 情景模式 | Int | | | True | 0 | 0铃声1震动2震动+铃声3无震无声S2系列无震动曲奇有 |
| sleep_period_begin | 睡眠开始时间 | String | | 14 | True | | 格式YYYYMMDDHHMMSS其中YYYYMMDD都用0填充实例00000000083000,8点30am |
| sleep_period_end | 睡眠结束时间 | String | | 14 | True | | 同上 |
| step_objective | 计步目标 | Int | | | True | 3000 | |
| theshold_sit | 久坐门限 | Int | | | True | 60 | |
| theshold_low_battery | 低电门限 | Int | | | True | 20 | |
| fences | 电子围栏 | List: Embedded [SettingFence](#settingfence) | | | False | | |
| pedometer_enable | 计步数据开关 | Boolean | | | False | False | |
| sleep_enable | 睡眠数据开关 | Boolean | | | False | False | |
| imei | 移动设备识别码 | String | | 16 | False | | |
| imsi | 移动用户识别码 | String | | 16 | False | | |
| type | 设备类型 | String | | 20 | False | BY102 | |
| sim_phone | 移动用户卡号 | String | | 16 | False | | |
| sim_phone_type | 移动用户卡类型 | String | | 8 | False | unicom | unicom:中国联通; cmcc:中国移动; ctcc:中国电信 |
| owner | 拥有人 | Reference: [Person](#person) | | | False | None | |
| name | 设备名称 | String | | 32 | False | | |
| created_at | 创建时间 | DateTime | | | True | now() | |
| updated_at | 更新时间 | DateTime | | | True | now() | |
| lastlogin_ip | 最近联网地址 | String | | 16 | False | | |
| lastlogin_at | 最近联网时间 | DateTime | | | False | now() | |
| active | 激活状态 | Boolean | | | True | False | | 建立家庭圈绑定了设备才显示true没有绑定设备显示false |
| active_at | 首次激活时间 | DateTime | | | False | None | |
| online | 联网状态 | Boolean | | | True | False | |
| location_updated | 坐标更新 | Boolean | | | True | False | |
| location_updated_at | 坐标更新时间 | DateTime | | | True | | |
| last_location | 最新坐标 | Point | | | True | | |
| last_city | 城市 | String | | | True | | |
| last_address | 地址 | String | | | True | | |
| wear_flag | 佩戴状态 | Int | | | False | None | |
| wear_updated_at | 佩戴状态更新时间 | DateTime | | | False | None | 1未佩戴0已佩戴仅在测量心率的时候更新状态终端自己测量不会更新 |
| remaining_power | 剩余电量(% | Int | | | False | 0 | |
| remaining_power_updated_at | 电量状态更新时间 | DateTime | | | False | None | |
| wifi | WIFI | List: Embedded [WIFI](#wifi) | | | False | | |
| software_version | 软件版本 | String | | 48 | False | | |
| iccid1 | 移动用户iccid号1 | String | | 21 | False | None | |
| iccid2 | 移动用户iccid号2 | String | | 21 | False | None | |
| fence_notification_updated_at | 围栏通知更新时间 | DateTime | | | False | None | |
| fall_model | 跌倒模式设置 | String | | | False | 0 | |
| fall_enable | 跌倒判断开关 | Boolean | | | False | 0 |
| track_enable | 轨迹开关 | Boolean | | | False | 0 |
| heartrate_enable | 心率开关 | Boolean | | | False | False | |
| power_down_enable | 智能省电模式 | Boolean | | | False | False | |
| exercise_heartrate_h | 运动心率上限阈值默认180 | int | | | True | 180 | |
| exercise_heartrate_l | 运动心率下限阈值默认40 | int | | | True | 40 | |
# devicetoken
终端标识 -- Person内嵌对象(爱牵挂用户体系
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| token_type | 设备类型 | String | | 10 | True | ios | ios:ios; android:android |
| token | 设备标识 | String | | 128 | True | None | |
| is_enable_aliase | 别名是否可用 | Boolean | | | True | False | |
| created_at | 创建时间 | DateTime | | | True | now() | |
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| ---------------- | ------------ | -------- | -------- | -------- | -------- | ------ | ------------------------ |
| token_type | 设备类型 | String | | 10 | True | ios | ios:ios; android:android |
| token | 设备标识 | String | | 128 | True | None | |
| is_enable_aliase | 别名是否可用 | Boolean | | | True | False | |
| created_at | 创建时间 | DateTime | | | True | now() | |
# group
家庭圈 (爱牵挂用户体系
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| id | | ObjectId | | | False | None | |
| owner | 拥有人 | Reference: [Person](#person) | | | True | None | |
| name | 组名称 | String | | | True | | |
| community | 社区 | Reference: [Community](#community) | | | False | None | |
| created_at | 创建时间 | DateTime | | | False | now() | |
| is_public | 是否公开 | Boolean | | | False | False | |
| members | 成员列表 | List: [Member](#member) | | | | | |
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| ---------- | -------- | ---------------------------------- | -------- | -------- | -------- | ------ | ---- |
| id | | ObjectId | | | False | None | |
| owner | 拥有人 | Reference: [Person](#person) | | | True | None | |
| name | 组名称 | String | | | True | | |
| community | 社区 | Reference: [Community](#community) | | | False | None | |
| created_at | 创建时间 | DateTime | | | False | now() | |
| is_public | 是否公开 | Boolean | | | False | False | |
| members | 成员列表 | List: [Member](#member) | | | | | |
# heartratedata
心率数据
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
| time_begin | 发生时间 | DateTime | | | False | None | |
| heartrate | 心率 | Int | | | False | 0 | |
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| ---------- | -------- | ---------------------------- | -------- | -------- | -------- | ------ | ---- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
| time_begin | 发生时间 | DateTime | | | False | None | |
| heartrate | 心率 | Int | | | False | 0 | |
# locationdata
定位数据
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
| time_begin | 发生时间 | DateTime | | | False | None | |
| type | 类型 | String | | | False | 0 | 0:Gps定位; 1:基站定位; 2基站定位CDMA; 99:纯wifi |
| is_reply | 是否为响应 | Boolean | | | False | False | |
| city | 城市 | String | | 16 | False | | |
| address | 地址 | String | | 128 | False | | |
| point | 坐标 | Point | | | False | None | |
| cell | CELL | List: Embedded [CELL](#cell) | | | False | | |
| wifi | WIFI | List: Embedded [WIFI](#wifi) | | | False | | |
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| ---------- | ---------- | ---------------------------- | -------- | -------- | -------- | ------ | ------------------------------------------------- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
| time_begin | 发生时间 | DateTime | | | False | None | |
| type | 类型 | String | | | False | 0 | 0:Gps定位; 1:基站定位; 2基站定位CDMA; 99:纯wifi |
| is_reply | 是否为响应 | Boolean | | | False | False | |
| city | 城市 | String | | 16 | False | | |
| address | 地址 | String | | 128 | False | | |
| point | 坐标 | Point | | | False | None | |
| cell | CELL | List: Embedded [CELL](#cell) | | | False | | |
| wifi | WIFI | List: Embedded [WIFI](#wifi) | | | False | | |
# member
小组成员 -- Person 通过 Member 跟 Group进行关联 (爱牵挂用户体系
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| id | | ObjectId | | | False | None | |
| group | 组 | Reference: [Group](#group) | | | True | None | |
| person | 成员 | Reference: [Person](#person) | | | True | None | |
| member_name | 关系 | String | | | False | | |
| is_default | 是缺省组 | Int | | | False | 0 | |
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| ----------- | -------- | ---------------------------- | -------- | -------- | -------- | ------ | ---- |
| id | | ObjectId | | | False | None | |
| group | 组 | Reference: [Group](#group) | | | True | None | |
| person | 成员 | Reference: [Person](#person) | | | True | None | |
| member_name | 关系 | String | | | False | | |
| is_default | 是缺省组 | Int | | | False | 0 | |
# pedometerdata
计步数据
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
| time_begin | 发生时间 | DateTime | | | False | None | |
| value | 累计步数 | Int | | | False | 0 | |
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| ---------- | -------- | ---------------------------- | -------- | -------- | -------- | ------ | ---- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
| time_begin | 发生时间 | DateTime | | | False | None | |
| value | 累计步数 | Int | | | False | 0 | |
# person
人员信息 (爱牵挂用户体系
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| id | | ObjectId | | | False | None | |
| username | 用户名 | String | | 16 | True | None | |
| password | 用户口令 | String | | 64 | True | None | |
| email | 注册邮箱 | Email | | 64 | False | None | |
| nickname | 别名 | String | | 64 | False | None | |
| phone | 手机号码 | String | | 15 | False | None | |
| telephone | 电话号码 | String | | 15 | False | None | |
| app | 服务名 | String | | 30 | True | aiqiangua | 标识登陆的app |
| devicetokens | 终端标识列表 | List: Embedded [DeviceToken](#devicetoken) | | | False | | |
| weight | 体重KG | Int | | | False | 0 | |
| step | 步长CM | Int | | | False | 0 | |
| age | 年龄(岁) | Int | | | False | 0 | |
| height | 身高CM | Int | | | False | 0 | |
| avatar | 头像文件 | String | | | False | None | |
| avatar_url | 头像 | String | | | False | /media/avatar/200/male.png | |
| community | 社区 | Reference: [Community](#community) | | | False | None | |
| role | 角色 | String | | 10 | True | user | user:用户; operator:操作员; superuser:超级管理员 |
| gender | 性别 | String | | 10 | True | male | male:男 ; female:女 |
| address | 地址 | String | | 64 | False | None | |
| created_at | 创建时间 | DateTime | | | True | now() | |
| updated_at | 更新时间 | DateTime | | | True | now() | |
| lastlogin_ip | 最近登录地址 | String | | 16 | False | None | |
| lastlogin_at | 最近登录时间 | DateTime | | | False | None | |
| lastlogin_by | 登录设备 | String | | | True | | |
| enable | 启用 | Boolean | | | False | False | 暂时没有使用 |
| email_is_checked | 邮箱已验证 | Boolean | | | False | False | |
| phone_is_checked | 手机已验证 | Boolean | | | False | False | |
| push_sos_enable | 允许SOS推送 | Boolean | | | False | False | |
| push_fence_enable | 允许电子围栏推送 | Boolean | | | False | False | |
| push_abnormal_enable | 允许健康数据推送 | Boolean | | | False | False | |
| push_message_enable | 允许家庭圈消息推送 | Boolean | | | False | False | |
| push_lowpower_enable | 允许低电推送 | Boolean | | | False | False | |
| push_system_enable | 允许系统消息推送 | Boolean | | | False | False | |
| auth_type | 授权类型 | String | | 10 | False | None | weibo:weibo; qq:qq; weixin:weixin |
| auth_uid | 授权唯一标识 | String | | 256 | False | None | |
| auth_updated_at | 更新时间 | DateTime | | | True | now() | |
| home | Home | String | | | False | None | |
| home_wifi | Home Wifi | String | | 32 | False | None | |
| devices | 设备列表 | List: [Device](#device) | | | | | |
| groups | 小组列表 | List: [Group](#group) | | | | | |
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| -------------------- | ------------------ | ------------------------------------------ | -------- | -------- | -------- | -------------------------- | ------------------------------------------------ |
| id | | ObjectId | | | False | None | |
| username | 用户名 | String | | 16 | True | None | |
| password | 用户口令 | String | | 64 | True | None | |
| email | 注册邮箱 | Email | | 64 | False | None | |
| nickname | 别名 | String | | 64 | False | None | |
| phone | 手机号码 | String | | 15 | False | None | |
| telephone | 电话号码 | String | | 15 | False | None | |
| app | 服务名 | String | | 30 | True | aiqiangua | 标识登陆的app |
| devicetokens | 终端标识列表 | List: Embedded [DeviceToken](#devicetoken) | | | False | | |
| weight | 体重KG | Int | | | False | 0 | |
| step | 步长CM | Int | | | False | 0 | |
| age | 年龄(岁) | Int | | | False | 0 | |
| height | 身高CM | Int | | | False | 0 | |
| avatar | 头像文件 | String | | | False | None | |
| avatar_url | 头像 | String | | | False | /media/avatar/200/male.png | |
| community | 社区 | Reference: [Community](#community) | | | False | None | |
| role | 角色 | String | | 10 | True | user | user:用户; operator:操作员; superuser:超级管理员 |
| gender | 性别 | String | | 10 | True | male | male:男 ; female:女 |
| address | 地址 | String | | 64 | False | None | |
| created_at | 创建时间 | DateTime | | | True | now() | |
| updated_at | 更新时间 | DateTime | | | True | now() | |
| lastlogin_ip | 最近登录地址 | String | | 16 | False | None | |
| lastlogin_at | 最近登录时间 | DateTime | | | False | None | |
| lastlogin_by | 登录设备 | String | | | True | | |
| enable | 启用 | Boolean | | | False | False | 暂时没有使用 |
| email_is_checked | 邮箱已验证 | Boolean | | | False | False | |
| phone_is_checked | 手机已验证 | Boolean | | | False | False | |
| push_sos_enable | 允许SOS推送 | Boolean | | | False | False | |
| push_fence_enable | 允许电子围栏推送 | Boolean | | | False | False | |
| push_abnormal_enable | 允许健康数据推送 | Boolean | | | False | False | |
| push_message_enable | 允许家庭圈消息推送 | Boolean | | | False | False | |
| push_lowpower_enable | 允许低电推送 | Boolean | | | False | False | |
| push_system_enable | 允许系统消息推送 | Boolean | | | False | False | |
| auth_type | 授权类型 | String | | 10 | False | None | weibo:weibo; qq:qq; weixin:weixin |
| auth_uid | 授权唯一标识 | String | | 256 | False | None | |
| auth_updated_at | 更新时间 | DateTime | | | True | now() | |
| home | Home | String | | | False | None | |
| home_wifi | Home Wifi | String | | 32 | False | None | |
| devices | 设备列表 | List: [Device](#device) | | | | | |
| groups | 小组列表 | List: [Group](#group) | | | | | |
# powerdata
开机数据
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
| time_begin | 发生时间 | DateTime | | | False | None | |
| type | 开/关机类型 | String | | | False | 0 | 0:开机; 1:关机; 2:电量上报; 3:低电通知 |
| remaining_power | 剩余电量(% | Int | | | False | 0 | |
| location | 低电时位置 | Reference: [LocationData](#locationdata) | | | False | None | |
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| --------------- | ------------ | ---------------------------------------- | -------- | -------- | -------- | ------ | -------------------------------------- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
| time_begin | 发生时间 | DateTime | | | False | None | |
| type | 开/关机类型 | String | | | False | 0 | 0:开机; 1:关机; 2:电量上报; 3:低电通知 |
| remaining_power | 剩余电量(% | Int | | | False | 0 | |
| location | 低电时位置 | Reference: [LocationData](#locationdata) | | | False | None | |
# settingalert
事件提醒 -- 内嵌对象
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| reply_enable 答复开关 Boolean | True | False | | 但是掉用接口使用 0,1 0是关闭1是打开
| seqid | 序号 | Int | | | True | None | |
| enable | 启用 | Boolean | | | True | False | |
| is_medicine | 用药 | Boolean | | | True | False | 仅用于app标识无实际意义 |
| name | 名称 | String | | 40 | True | | |
| alert_type | 提醒类型 | Int | | | True | 1 | 0、周期性提醒类似手机工作日闹钟类型 1、一次性提醒设定日期 |
| cycle | 周期 | Int | | | True | 1 | 1、以星期为周期对应上面的0,2、以日期为周期对应上面的1 |
| time | 时间 | String | | 14 | False | | 当alert_type=0时格式为 1001101+21+30+ 意义前7位对应周日、周一……周六需要提醒的那些天后面是HHMM中间用+号分割和结尾当alert_type=1时格式为YYYYMMDDHHMMSS 20150313213000 |
| media_length | 语音文件长度 | Int | | | False | 0 | 上传前需检查文件大小最大不得超过10KB建议在5K~8K之间否则会报错不需要传递这个参数服务器计算 |
| file_checksum | 语音文件(校验和) | Int | | | False | 0 | 服务器产生 |
| filename | 语音文件名 | String | | 64 | False | None | |
| url | 下载地址 | String | | 128 | False | None | 服务器产生 |
| created_at | 创建时间 | DateTime | | | False | None | |
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| ------------------------------- | ------------------ | -------- | -------- | ------------------------------------------ | -------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| reply_enable 答复开关 Boolean | True | False | | 但是掉用接口使用 0,1 0是关闭1是打开 |
| seqid | 序号 | Int | | | True | None | |
| enable | 启用 | Boolean | | | True | False | |
| is_medicine | 用药 | Boolean | | | True | False | 仅用于app标识无实际意义 |
| name | 名称 | String | | 40 | True | | |
| alert_type | 提醒类型 | Int | | | True | 1 | 0、周期性提醒类似手机工作日闹钟类型 1、一次性提醒设定日期 |
| cycle | 周期 | Int | | | True | 1 | 1、以星期为周期对应上面的0,2、以日期为周期对应上面的1 |
| time | 时间 | String | | 14 | False | | 当alert_type=0时格式为 1001101+21+30+ 意义前7位对应周日、周一……周六需要提醒的那些天后面是HHMM中间用+号分割和结尾当alert_type=1时格式为YYYYMMDDHHMMSS 20150313213000 |
| media_length | 语音文件长度 | Int | | | False | 0 | 上传前需检查文件大小最大不得超过10KB建议在5K~8K之间否则会报错不需要传递这个参数服务器计算 |
| file_checksum | 语音文件(校验和) | Int | | | False | 0 | 服务器产生 |
| filename | 语音文件名 | String | | 64 | False | None | |
| url | 下载地址 | String | | 128 | False | None | 服务器产生 |
| created_at | 创建时间 | DateTime | | | False | None | |
# settingfence
围栏 -- 内嵌对象
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| seqid | 序号 | Int | | | True | None | |
| freq | 每天 | Boolean | | | False | True | |
| enable | 启用 | Boolean | | | True | False | |
| name | 名称 | String | | 40 | True | | |
| time_begin | 起始时间 | Int | | | True | 0 | |
| time_end | 终止时间 | Int | | | True | 0 | |
| safe_area | 安全区域 | int | | | False | None | |
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| ---------- | -------- | ------- | -------- | -------- | -------- | ------ | ---- |
| seqid | 序号 | Int | | | True | None | |
| freq | 每天 | Boolean | | | False | True | |
| enable | 启用 | Boolean | | | True | False | |
| name | 名称 | String | | 40 | True | | |
| time_begin | 起始时间 | Int | | | True | 0 | |
| time_end | 终止时间 | Int | | | True | 0 | |
| safe_area | 安全区域 | int | | | False | None | |
# settingsosnumber
亲情号码 -- 内嵌对象
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| seqid | 序号 | Int | | | True | None | |
| name | 名称 | String | | 32 | True | | |
| num | 号码 | String | | 16 | True | | |
| dial_flag | 是否呼叫 | Boolean | | | True | False | 是否将亲情号码设置为SOS号码即在设备SOS时加入拨打循环 |
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| --------- | -------- | ------- | -------- | -------- | -------- | ------ | ------------------------------------------------------ |
| seqid | 序号 | Int | | | True | None | |
| name | 名称 | String | | 32 | True | | |
| num | 号码 | String | | 16 | True | | |
| dial_flag | 是否呼叫 | Boolean | | | True | False | 是否将亲情号码设置为SOS号码即在设备SOS时加入拨打循环 |
# sleepdata
睡眠数据
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
| time_begin | 发生时间 | DateTime | | | False | None | |
| time_end | 截止时间 | DateTime | | | False | None | |
| interval | 检测间隔 | Int | | | False | 30 | |
| total | 检测次数 | Int | | | False | 0 | |
| data | 睡眠数据 | List: Embedded [SleepDataSleep](#sleepdatasleep) | | | False | [] | X1无详细睡眠数据忽略此参数 |
| deep_sleep | | Sting | 深睡时长单位小时str(float) |
| light_sleep | | Sting | 浅睡时长单位小时str(float) |
| awake_time | | Sting | 清醒时长单位小时str(float) |
| total_sleep | | Sting | 睡眠总时长单位小时str(float) |
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| ----------- | -------- | ------------------------------------------------ | -------------------------------- | -------- | -------- | ------ | ---------------------------- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
| time_begin | 发生时间 | DateTime | | | False | None | |
| time_end | 截止时间 | DateTime | | | False | None | |
| interval | 检测间隔 | Int | | | False | 30 | |
| total | 检测次数 | Int | | | False | 0 | |
| data | 睡眠数据 | List: Embedded [SleepDataSleep](#sleepdatasleep) | | | False | [] | X1无详细睡眠数据忽略此参数 |
| deep_sleep | 是 | Sting | 深睡时长单位小时str(float) |
| light_sleep | 是 | Sting | 浅睡时长单位小时str(float) |
| awake_time | 是 | Sting | 清醒时长单位小时str(float) |
| total_sleep | 是 | Sting | 睡眠总时长单位小时str(float) |
# sosdata
呼叫数据
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
| time_begin | 发生时间 | DateTime | | | False | None | |
| type | 类型 | String | | | False | 0 | 0:Gps定位; 1:基站定位 |
| city | 城市 | String | | 16 | False | | |
| address | 地址 | String | | 128 | False | | |
| point | 坐标 | Point | | | False | None | |
| cell | CELL | List: Embedded [CELL](#cell) | | | False | | |
| wifi | WIFI | List: Embedded [WIFI](#wifi) | | | False | | |
| heartrate | 心率值 | Int | | | False | None | X1无此参数 |
| is_removed | 是否消除 | Boolean | | | False | False | |
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| ---------- | -------- | ---------------------------- | -------- | -------- | -------- | ------ | --------------------- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
| time_begin | 发生时间 | DateTime | | | False | None | |
| type | 类型 | String | | | False | 0 | 0:Gps定位; 1:基站定位 |
| city | 城市 | String | | 16 | False | | |
| address | 地址 | String | | 128 | False | | |
| point | 坐标 | Point | | | False | None | |
| cell | CELL | List: Embedded [CELL](#cell) | | | False | | |
| wifi | WIFI | List: Embedded [WIFI](#wifi) | | | False | | |
| heartrate | 心率值 | Int | | | False | None | X1无此参数 |
| is_removed | 是否消除 | Boolean | | | False | False | |
@ -420,33 +421,32 @@ device实体全部参数
设备环境音
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| user | 用户 | Reference: [Person](#person) | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| group | 拥有组 | Reference: [Group](#group) | | | False | None | |
| voice_time | 拾音时间 | DateTime | | | False | | |
| voice_type | 文件类型 | Int | | |False | 0 | |
| media_length | 长度 | Int | | | False | 0 | |
| filename | 文件名 | String | | 64 | False | | |
| url | 下载地址 | String | | 128 | False | | |
| created_at | 记录时间 | DateTime | | | False | now() | |
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| ------------ | -------- | ---------------------------- | -------- | -------- | -------- | ------ | ---- |
| user | 用户 | Reference: [Person](#person) | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| group | 拥有组 | Reference: [Group](#group) | | | False | None | |
| voice_time | 拾音时间 | DateTime | | | False | | |
| voice_type | 文件类型 | Int | | | False | 0 | |
| media_length | 长度 | Int | | | False | 0 | |
| filename | 文件名 | String | | 64 | False | | |
| url | 下载地址 | String | | 128 | False | | |
| created_at | 记录时间 | DateTime | | | False | now() | |
#replydata
答复数据 -- settingalert中reply_enable打开device中alertreply_enable打开硬件会将对应alert的处理结果答复上来
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| id | | ObjectId | | | True | None | |
| device | 设备 | Device | | | True | None | |
| time_begin | 发生时间 | DateTime | | | True | None | |
| reply_type | 答复类型 | Int | | | True | 0 | 0广播答复1提醒答复 |
| alert_name | 提醒名称 | string | | | False | None | 提醒的文本内容当reply=1时携带 |
| result | 答复结果 | Int | | | True | 0 | 0 用户未处理 1 用户已处理 |
| advert_id | 广播ID | | | | False | None | 当reply_type=0时携带 |
| advert_text| 广播文本 | | | | False | None | 当reply_type=0时携带 |
| created_at | 创建时间 | DateTime | | | True | None | |
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| ----------- | -------- | -------- | -------- | -------- | -------- | ------ | ------------------------------- |
| id | | ObjectId | | | True | None | |
| device | 设备 | Device | | | True | None | |
| time_begin | 发生时间 | DateTime | | | True | None | |
| reply_type | 答复类型 | Int | | | True | 0 | 0广播答复1提醒答复 |
| alert_name | 提醒名称 | string | | | False | None | 提醒的文本内容当reply=1时携带 |
| result | 答复结果 | Int | | | True | 0 | 0 用户未处理 1 用户已处理 |
| advert_id | 广播ID | | | | False | None | 当reply_type=0时携带 |
| advert_text | 广播文本 | | | | False | None | 当reply_type=0时携带 |
| created_at | 创建时间 | DateTime | | | True | None | |

View File

@ -20,6 +20,7 @@
- 响应范例
```json
{
"obj":{
"_id":{
@ -136,4 +137,4 @@
"success":true,
"obj_name":"person"
}
```