🎨 文档格式调整优化

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

@ -27,7 +27,8 @@
Set-Cookie: user="2|1:0|10:1407508841|4:user|8:YWRtaW4=|19bf2a8edd510eca173cecff546c446e3d800ae34ca3649ec56a566d2386e0de"; expires=Sun, 07 Sep 2014 14:40:41 GMT; Path=/
- 响应范例:
{
```json
{
"obj": {
"_id": {
"$oid": "5bda53d2264251367f5a4385"
@ -135,4 +136,7 @@
},
"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"
}
```
@ -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 @@ __请求范例__
__响应范例__
{
```json
{
"success": true
}
}
```
# 设置提醒
@ -524,12 +528,12 @@ __响应范例__
- 请求参数: 至少设置一个参数
| 名称 | 必须 | 类型 | 说明 |
| ------------ | ---- | ------------ | ------------------------------ |
| ---------- | ---- | ------ | -------------------------------------------------------- |
| enable | 否 | Int | 0,1 |
| name | 否 | String | |
| alert_type | 否 | Int | 提醒类型 0 重复 1 仅一次 |
| cycle | 否 | Int | 周期 1 以星期为周期 2 以日期为周期 |
| time | 否 | String | time 预定的响铃时间1、 cycle=1时实例1001101+21+30+
| time | 否 | String | time 预定的响铃时间1、 cycle=1时实例1001101+21+30+ |
表示从周日、周一……周六的七天响铃的那天为1不响为0时间是21点30分。
2、 cycle=2时时间为YYYYMMDDHHmmSS实例 20150313213000 time的长度固定为14 |
@ -544,10 +548,11 @@ __响应范例__
- 响应范例
{
```json
{
"success": true
}
}
```
@ -564,7 +569,7 @@ __响应范例__
- 请求参数: 至少设置一个参数
| 名称 | 必须 | 类型 | 说明 |
| ------------ | ---- | ------------ | ------------------------------ |
| --------- | ---- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name | 否 | String | 号码昵称 |
| num | 否 | String | 亲情号码,可以是手机或固话 |
| dial_flag | 否 | Int | 0不设置为紧急呼叫号码,1设置为紧急呼叫号码 |
@ -578,9 +583,11 @@ __响应范例__
- 响应范例
{
```json
{
"success": true
}
}
```
# 设置安全区域
@ -593,7 +600,7 @@ __响应范例__
- 请求参数: 至少设置一个参数设置安全围栏时最好设置全部的参数除了参数clear外该参数是用于清空设置的。修改安全围栏也是调用这个接口
| 名称 | 必须 | 类型 | 说明 |
| ------------ | ---- | ------------ | ------------------------------ |
| ---------- | ---- | ------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| enable | 否 | Int | 0,1 |
| name | 否 | String | |
| freq | 否 | Boolean | 0触发一天1每日触发 |
@ -609,11 +616,12 @@ __响应范例__
- 响应范例
{
```json
{
"success": true
}
}
```
# 在线设备操作
@ -621,11 +629,11 @@ __响应范例__
合法的action如下
| action | 说明 |
| --------------- | ------------------------------ |
| ------------ | ------------ |
| ring | 响铃 |
| restart | 重启 |
| restore | 恢复出厂 |
| get_envvoice | 获取环境录音 | 无 | DeviceEnvVoice | 录音成功以后,如果配置有对应的分发提醒,会触发|
| get_envvoice | 获取环境录音 | 无 | DeviceEnvVoice | 录音成功以后,如果配置有对应的分发提醒,会触发 |
@ -640,8 +648,8 @@ __响应范例__
合法的action如下
| action | 说明 | 参数及类型 | 返回对象 |
| ---------------------- | ------------- | ---------- | --------- |
| get_locationdataonce | 获取实时位置 | 无 | 无 | 30秒 (只能发一条定位数据)
| -------------------- | ------------ | ---------- | ------------- |
| get_locationdataonce | 获取实时位置 | 无 | 无 | 30秒 (只能发一条定位数据) |
| get_heartrate | 获取心率数据 | 无 | HeartRateData | 1分后上服务器取数据 |
@ -657,12 +665,11 @@ __响应范例__
- 响应范例:
{
```json
{
"success": true
}
}
```
@ -674,11 +681,11 @@ __响应范例__
- 请求参数:
| 名称 | 必须 | 类型 | 说明 |
| --------------- | ---- | ------------ | ------------------------------ |
| ----------------------------------------------- | ---- | ------ | ---------------------------- |
| device | 是 | string | 15位设备唯一序号 |
| time_begin | 否 | string | YYYYMMDD查询指定日期的数据 |
| type | 否 | string | 01,2,3 |
0开机,1关机,2正常电量显示,3低电 |
| 0开机,1关机,2正常电量显示,3低电 |
__请求范例__
@ -693,6 +700,7 @@ __请求范例__
__响应范例__
```json
{
"objs": [
{
@ -900,6 +908,7 @@ __响应范例__
"success": true,
"obj_name": "powerdata"
}
```
# 查看设备定位数据
@ -911,7 +920,7 @@ __响应范例__
- 请求参数:
| 名称 | 必须 | 类型 | 说明 |
| --------------- | ---- | ------------ | ------------------------------ |
| ---------- | ---- | ------ | ---------------------------- |
| 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"
}
```
@ -1270,7 +1284,7 @@ __响应范例__
- 请求参数:
| 名称 | 必须 | 类型 | 说明 |
| --------------- | ---- | ------------ | ------------------------------ |
| ---------- | ---- | ------ | ---------------------------- |
| 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"
}
```
# 查看设备心率数据
@ -1323,7 +1340,7 @@ __响应范例__
- 请求参数:
| 名称 | 必须 | 类型 | 说明 |
| --------------- | ---- | ------------ | ------------------------------ |
| ---------- | ---- | ------ | ---------------------------- |
| 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"
}
```
@ -1381,7 +1396,7 @@ __响应范例__
- 请求参数:
| 名称 | 必须 | 类型 | 说明 |
| --------------- | ---- | ------------ | ------------------------------ |
| ---------- | ---- | ------ | ---------------------------- |
| device | 是 | string | 15位设备唯一序号 |
| time_begin | 否 | string | YYYYMMDD查询指定日期的数据 |
@ -1396,6 +1411,7 @@ __响应范例__
__响应范例__
```json
{
"objs": [
{
@ -1453,6 +1469,7 @@ __响应范例__
"success": true,
"obj_name": "replydata"
}
```
# 查看设备血压数据
@ -1462,7 +1479,7 @@ __响应范例__
- 响应对象: [BloodPressureData](./object.md#BloodPressureData)
- 请求参数:
| 名称 | 必须 | 类型 | 说明 |
| --------------- | ---- | ------------| ------------------------------ |
| ---------- | ---- | ------ | ---------------------------- |
| device id | 是 | string | 15位设备唯一序号 |
| time_begin | 否 | string | YYYYMMDD查询指定日期的数据 |
@ -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"
}
```
# 查看设备血氧数据
@ -1517,7 +1536,7 @@ __响应范例__
- 请求参数:
| 名称 | 必须 | 类型 | 说明 |
| --------------- | ---- | ------------ | ------------------------------ |
| ---------- | ---- | ------ | ---------------------------- |
| 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"
}
```
# 查看设备紧急呼叫
@ -1612,7 +1633,7 @@ __请求范例__
- 请求参数:
| 名称 | 必须 | 类型 | 说明 |
| --------------- | ---- | ------------ | ------------------------------ |
| ---------- | ---- | ------ | ---------------------------- |
| device | 是 | string | 15位设备唯一序号 |
| time_begin | 否 | string | YYYYMMDD查询指定日期的数据 |
@ -1628,7 +1649,8 @@ __请求范例__
- 响应范例:
{
```json
{
"objs": [
{
"_id": {
@ -1747,6 +1769,7 @@ __请求范例__
"success": true,
"obj_name": "sosdata"
}
```
@ -1760,7 +1783,7 @@ __请求范例__
- 请求参数:
| 名称 | 必须 | 类型 | 说明 |
| --------------- | ---- | ------------ | ------------------------------ |
| ---- | ---- | ------ | --------------------- |
| 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,9 +4,11 @@ API概述
目录
----
- [API概述](#api概述)
- [目录](#目录)
- [请求格式](#请求格式)
- [GET](#GET)
- [POST](#POST)
- [GET](#get)
- [POST](#post)
- [对象输出参数](#对象输出参数)
- [分页参数](#分页参数)
- [嵌套参数](#嵌套参数)
@ -47,9 +49,9 @@ POST命令参数可放在URL也可放在BODY中
当返回对象列表时,可以对列表进行分页
| 名称 | 必须 | 类型 | 说明 |
| ------------ | ---- | ------------ | ------------------------------ |
| ------------- | ---- | ---- | ---------------- |
| page | 否 | int | 页数1~N缺省1 |
| rows_per_page| | int | 每页行数缺省20 |
| rows_per_page | | int | 每页行数缺省20 |
## 嵌套参数
@ -59,7 +61,7 @@ POST命令参数可放在URL也可放在BODY中
- 新增一个以$开头的属性,形如"$[attr_name]", 其中attr_name为原属性名其内容是完整的json对象。
| 名称 | 必须 | 类型 | 说明 |
| ------------ | ---- | ------------ | ------------------------------ |
| ----- | ---- | ---- | -------------------- |
| depth | 否 | int | 嵌套层数(1-4)缺省2 |
## 简化参数
@ -67,7 +69,7 @@ POST命令参数可放在URL也可放在BODY中
输出简化后的对象只包含特定的属性。必须在定义对象时指出简化对象包含哪些属性如未指定则输出对象的前10个属性。
| 名称 | 必须 | 类型 | 说明 |
| ------------ | ---- | ------------ | ------------------------------ |
| ----- | ---- | ---- | ----------------------- |
| small | 否 | int | 1-完整0-简化。缺省为1 |
@ -77,7 +79,7 @@ POST命令参数可放在URL也可放在BODY中
| 名称 | 必须 | 类型 | 说明 |
| ------------ | ---- | ------------ | ------------------------------ |
| -------- | ---- | ------ | --------------------------------------------------------------------------------------------------------------------- |
| 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,23 +116,26 @@ 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 | 未授权 | 需登录 |

View File

@ -32,7 +32,7 @@ __目录__
血氧数据
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| --------------- | ---------- | ---------------------------- | -------- | -------- | -------- | ------ | -------------------------------------------- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
@ -46,7 +46,7 @@ __目录__
血压数据
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| ---------- | -------- | ---------------------------- | -------- | -------- | -------- | ------ | ---- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
@ -60,7 +60,7 @@ __目录__
基站标识 -- LocationData 内嵌对象
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| ------ | ------ | ------ | -------- | -------- | -------- | ------ | ---- |
| mcc | MCC | String | | 3 | False | 000 | |
| mnc | MNC | String | | 3 | False | 000 | |
| lac | LAC | Int | | | False | 0 | |
@ -73,9 +73,10 @@ __目录__
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_step | 记步上报频率 | Int | | | True | 30 | 单位分钟不建议低于30min | 默认是30分钟 |
| frequency_heartrate | 心率、血压、血氧上报频率 | Int | | | True | 60 | 单位分钟不建议低于10min |
| theshold_heartrate_h | 心率上限 | Int | | | True | 140 | |
| theshold_heartrate_l | 心率下限 | Int | | | True | 40 | |
@ -107,8 +108,8 @@ device实体可修改参数 -- X8 (开关类型的参数以0,1传
| 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 | |
| exercise_heartrate_h | 运动心率上限阈值默认180 | int | | | True | 180 | |
| exercise_heartrate_l | 运动心率下限阈值默认40 | int | | | True | 40 | |
@ -117,7 +118,7 @@ device实体可修改参数 -- X8 (开关类型的参数以0,1传
device实体全部参数
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| ----------------------------- | ------------------------- | ---------------------------------------------------- | -------- | -------- | -------- | ------ | --------------------------------------------------------------------- |
| did | 设备编号 | String | | 64 | True | None | |
| alerts | 提醒 | List: Embedded [SettingAlert](#settingalert) | | | False | | |
| sos_numbers | 亲情号码 | List: Embedded [SettingSosNumber](#settingsosnumber) | | | False | | |
@ -153,7 +154,7 @@ device实体全部参数
| updated_at | 更新时间 | DateTime | | | True | now() | |
| lastlogin_ip | 最近联网地址 | String | | 16 | False | | |
| lastlogin_at | 最近联网时间 | DateTime | | | False | now() | |
| active | 激活状态 | Boolean | | | True | False | | 建立家庭圈绑定了设备才显示true没有绑定设备显示false
| active | 激活状态 | Boolean | | | True | False | | 建立家庭圈绑定了设备才显示true没有绑定设备显示false |
| active_at | 首次激活时间 | DateTime | | | False | None | |
| online | 联网状态 | Boolean | | | True | False | |
| location_updated | 坐标更新 | Boolean | | | True | False | |
@ -175,8 +176,8 @@ device实体全部参数
| 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 | |
| exercise_heartrate_h | 运动心率上限阈值默认180 | int | | | True | 180 | |
| exercise_heartrate_l | 运动心率下限阈值默认40 | int | | | True | 40 | |
# devicetoken
@ -184,7 +185,7 @@ device实体全部参数
终端标识 -- Person内嵌对象(爱牵挂用户体系
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| ---------------- | ------------ | -------- | -------- | -------- | -------- | ------ | ------------------------ |
| token_type | 设备类型 | String | | 10 | True | ios | ios:ios; android:android |
| token | 设备标识 | String | | 128 | True | None | |
| is_enable_aliase | 别名是否可用 | Boolean | | | True | False | |
@ -196,7 +197,7 @@ device实体全部参数
家庭圈 (爱牵挂用户体系
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| ---------- | -------- | ---------------------------------- | -------- | -------- | -------- | ------ | ---- |
| id | | ObjectId | | | False | None | |
| owner | 拥有人 | Reference: [Person](#person) | | | True | None | |
| name | 组名称 | String | | | True | | |
@ -211,7 +212,7 @@ device实体全部参数
心率数据
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| ---------- | -------- | ---------------------------- | -------- | -------- | -------- | ------ | ---- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
@ -224,7 +225,7 @@ device实体全部参数
定位数据
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| ---------- | ---------- | ---------------------------- | -------- | -------- | -------- | ------ | ------------------------------------------------- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
@ -243,7 +244,7 @@ device实体全部参数
小组成员 -- Person 通过 Member 跟 Group进行关联 (爱牵挂用户体系
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| ----------- | -------- | ---------------------------- | -------- | -------- | -------- | ------ | ---- |
| id | | ObjectId | | | False | None | |
| group | 组 | Reference: [Group](#group) | | | True | None | |
| person | 成员 | Reference: [Person](#person) | | | True | None | |
@ -256,7 +257,7 @@ device实体全部参数
计步数据
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| ---------- | -------- | ---------------------------- | -------- | -------- | -------- | ------ | ---- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
@ -269,7 +270,7 @@ device实体全部参数
人员信息 (爱牵挂用户体系
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| -------------------- | ------------------ | ------------------------------------------ | -------- | -------- | -------- | -------------------------- | ------------------------------------------------ |
| id | | ObjectId | | | False | None | |
| username | 用户名 | String | | 16 | True | None | |
| password | 用户口令 | String | | 64 | True | None | |
@ -317,7 +318,7 @@ device实体全部参数
开机数据
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| --------------- | ------------ | ---------------------------------------- | -------- | -------- | -------- | ------ | -------------------------------------- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
@ -332,8 +333,8 @@ device实体全部参数
事件提醒 -- 内嵌对象
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| reply_enable 答复开关 Boolean | True | False | | 但是掉用接口使用 0,1 0是关闭1是打开
| ------------------------------- | ------------------ | -------- | -------- | ------------------------------------------ | -------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| reply_enable 答复开关 Boolean | True | False | | 但是掉用接口使用 0,1 0是关闭1是打开 |
| seqid | 序号 | Int | | | True | None | |
| enable | 启用 | Boolean | | | True | False | |
| is_medicine | 用药 | Boolean | | | True | False | 仅用于app标识无实际意义 |
@ -353,7 +354,7 @@ device实体全部参数
围栏 -- 内嵌对象
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| ---------- | -------- | ------- | -------- | -------- | -------- | ------ | ---- |
| seqid | 序号 | Int | | | True | None | |
| freq | 每天 | Boolean | | | False | True | |
| enable | 启用 | Boolean | | | True | False | |
@ -368,7 +369,7 @@ device实体全部参数
亲情号码 -- 内嵌对象
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| --------- | -------- | ------- | -------- | -------- | -------- | ------ | ------------------------------------------------------ |
| seqid | 序号 | Int | | | True | None | |
| name | 名称 | String | | 32 | True | | |
| num | 号码 | String | | 16 | True | | |
@ -380,7 +381,7 @@ device实体全部参数
睡眠数据
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| ----------- | -------- | ------------------------------------------------ | -------------------------------- | -------- | -------- | ------ | ---------------------------- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
@ -399,7 +400,7 @@ device实体全部参数
呼叫数据
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
|------- | ---- | ---- | -------- | -------- | -------- | ------ | ---- |
| ---------- | -------- | ---------------------------- | -------- | -------- | -------- | ------ | --------------------- |
| id | | ObjectId | | | False | None | |
| device | 设备 | Reference: [Device](#device) | | | False | None | |
| created_at | 记录时间 | DateTime | | | False | now() | |
@ -421,12 +422,12 @@ 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 | |
| voice_type | 文件类型 | Int | | | False | 0 | |
| media_length | 长度 | Int | | | False | 0 | |
| filename | 文件名 | String | | 64 | False | | |
| url | 下载地址 | String | | 128 | False | | |
@ -438,7 +439,7 @@ device实体全部参数
答复数据 -- settingalert中reply_enable打开device中alertreply_enable打开硬件会将对应alert的处理结果答复上来
| 字段名 | 说明 | 类型 | 最小长度 | 最大长度 | 必填字段 | 缺省值 | 备注 |
| ----------- | -------- | -------- | -------- | -------- | -------- | ------ | ------------------------------- |
| id | | ObjectId | | | True | None | |
| device | 设备 | Device | | | True | None | |
| time_begin | 发生时间 | DateTime | | | True | None | |
@ -446,7 +447,6 @@ device实体全部参数
| 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时携带 |
| 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"
}
```