device-docking/爱牵挂/爱牵挂M1对外API/object.md
2023-12-20 11:07:38 +08:00

25 KiB
Executable File
Raw Blame History

如果是post请求把参数带到body里面禁止写到URL后面。URL后面带参数的全是get请求。 我们的测试服虽然get和post请求都可以使用但是要是用规范改post请求的时候必须post请求并且把参数放到body下不要放到URL后面。我们的正式服因为换过架构所以会更加规范修改接口必须是post且放到body下进行请求

对象定义

目录

bloodoxygendata

血氧数据

字段名 说明 类型 最小长度 最大长度 必填字段 缺省值 备注
id ObjectId False None
device 设备 Reference: 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 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

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 | |

device01

device实体全部参数

字段名 说明 类型 最小长度 最大长度 必填字段 缺省值 备注
did 设备编号 String 64 True None
alerts 提醒 List: Embedded SettingAlert False
sos_numbers 亲情号码 List: Embedded 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 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 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
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 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()

group

家庭圈 (爱牵挂用户体系

字段名 说明 类型 最小长度 最大长度 必填字段 缺省值 备注
id ObjectId False None
owner 拥有人 Reference: Person True None
name 组名称 String True
community 社区 Reference: Community False None
created_at 创建时间 DateTime False now()
is_public 是否公开 Boolean False False
members 成员列表 List: Member

heartratedata

心率数据

字段名 说明 类型 最小长度 最大长度 必填字段 缺省值 备注
id ObjectId False None
device 设备 Reference: 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 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 False
wifi WIFI List: Embedded WIFI False

member

小组成员 -- Person 通过 Member 跟 Group进行关联 (爱牵挂用户体系

字段名 说明 类型 最小长度 最大长度 必填字段 缺省值 备注
id ObjectId False None
group Reference: Group True None
person 成员 Reference: Person True None
member_name 关系 String False
is_default 是缺省组 Int False 0

pedometerdata

计步数据

字段名 说明 类型 最小长度 最大长度 必填字段 缺省值 备注
id ObjectId False None
device 设备 Reference: 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 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 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
groups 小组列表 List: Group

powerdata

开机数据

字段名 说明 类型 最小长度 最大长度 必填字段 缺省值 备注
id ObjectId False None
device 设备 Reference: 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 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

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

settingsosnumber

亲情号码 -- 内嵌对象

字段名 说明 类型 最小长度 最大长度 必填字段 缺省值 备注
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 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 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 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 False
wifi WIFI List: Embedded WIFI False
heartrate 心率值 Int False None X1无此参数
is_removed 是否消除 Boolean False False

#DeviceEnvVoice

设备环境音

字段名 说明 类型 最小长度 最大长度 必填字段 缺省值 备注
user 用户 Reference: Person False None
device 设备 Reference: Device False None
group 拥有组 Reference: 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 | |