IconCreated with Sketch.

YAPI 接口文档

YApi
  • 公共分类
    • EasyYAPI插件说明
  • 异常说明
    • 公共异常说明
  • 其他说明
    • Id生成规则
    • RSA加密密钥
    • 个推参数矩阵
    • 完整性校验规则说明
  • 用户账户相关
    • 发送手机号或者邮件重置密码验证码
    • 发送手机号或者邮箱注册验证码
    • 发送手机号注册验证码
    • 发送手机号重置密码验证码
    • 异常说明
    • 通过手机号或者邮箱注册
    • 通过手机号注册
    • 发送邮箱注册验证码
    • 邮箱验证码注册
    • 密码登录
    • 发送重置密码邮箱验证码
    • 通过验证码重置密码
    • 获取引导和密码设置状态
    • 查询用户信息
    • 头像上传
    • 添加或修改用户信息
    • 注销账户
    • 退出登录
  • 字典表接口
    • 查询字典下拉选项
  • 其他疾病用户预设相关
    • 添加或修改一个其他疾病
  • CGM设备相关
    • 异常说明
    • 配对
    • 获取设备信息
    • 更新设备状态
    • 解配
    • 获取用户设备历史,包括解配的
  • 趋势相关接口
    • 保存趋势数据
  • cgm数据相关
    • 异常说明
    • cgm数据上传接口
    • 分页查询用户数据
    • cgm数据更新接口
  • 校准相关
    • 异常说明
    • 保存校准数据
    • 分页查询校准
  • 设置相关
    • 异常说明
    • 查询用户设置
    • 更新用户设置
  • 泵设备相关
    • 异常说明
    • 泵设备绑定
    • 泵设备解配
    • 更新泵设置数据
    • 获取所有设备信息
  • 泵数据相关
    • 异常说明
    • 保存泵数据
    • 分页查询泵数据
  • 基础率预设值相关
    • 异常说明
    • 保存或修改基础率预设值
    • 查询基础率预设值
  • 大剂量预设值相关
    • 异常说明
    • 保存大剂量预设值数据
    • 查询大剂量预设值
  • 泵参数设置
    • 保存泵参数设置
    • 查询泵参数设置
  • 事件数据相关
    • 异常说明
    • 保存事件
    • 分页查询事件
  • 获取app信息
    • 获取app的相关信息
  • 版本更新相关
    • 查询版本历史
  • 数据分享授权
    • 返回值说明
    • 分享数据(非批量接口)
    • 删除分享关系
    • 分页查询
    • 通过授权id查授权信息
    • 修改授权数据。开关通知,设置昵称等
    • 获取前端缓存数据的用户最大个数
  • 推送相关
    • 保存cid
    • 通知和透传结构体
  • OTA相关接口
    • 获取OTA设置信息
    • 获取配置的最新变更时间
    • 保存ota结果,没有约束和校验。
  • 协议管理
    • 获取协议

闭环泵APP

闭环泵APP

公共分类

EasyYAPI插件说明

基本信息

Path: /backend/pump-cgm-sys/EasyYAPI_plugin_description

Method: GET

接口描述:

一定要将插件的Preferences(Settings) > EasyApi > Yapi 中的export mode换成ALWAYS_ASK,否则会有覆盖问题

请求参数

异常说明

公共异常说明

基本信息

Path: /backend/pump-cgm-sys////

Method: GET

接口描述:

所有接口除了登录、注册、重置密码接口都需要传递token
所有时间交互格式为:yyyy-MM-dd HH:mm:ssZ 或者 yyyy-MM-dd HH:mm:ss 加额外时区值

code data 说明
200 对应的数据 成功的返回值
499 / 流控返回值。接收到该返回,直接触发降级措施。
500 对应的失败报错(可能没有) 全局异常错误的返回值(兜底用)
501 userId长度错误
800-806 网关token的返回,token失效或被T 要求重新登录
800 token为空
801 token校验错误 不合法的token,无法解析
802 该账户已在其他设备登录
803 token校验错误,非本系统签发的token token格式正确,可以解析,但解析的结果中验证标识错误
804 账户被手动封禁
805 token过期了
806 没有访问该服务的权限 token是本系统其他应用签发的token。此token无法访问签发服务外的其他服务
601 图片敏感检测未通过 对图片的敏感校验。目前校验的是头像
602 图片检测报错失败,请重试 检测过程出现异常。需要记录反馈
701 未使用加密通讯
702 无法解密,加密通讯失败

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
token 是 用户信息中返回的token值

返回数据

名称类型是否必须默认值备注其他信息

其他说明

Id生成规则

基本信息

Path: /backend/pump-cgm-sys/se

Method: GET

接口描述:

sensorId = MD5(userId+deviceSn+startup[秒]+sensorIndex[二代=startup])
mainDeviceId= MD5(deviceSn+startup[秒])
calibrationId = MD5(sensorId+index)
frontRecordId = MD5(sensorId+index[二代=timeoffset,一代=eventIndex])

泵id:
image.png
事件id
image.png

请求参数

返回数据

名称类型是否必须默认值备注其他信息

RSA加密密钥

基本信息

Path: /backend/pump-cgm-sys/rsa

Method: GET

接口描述:

请求的密钥:
公:
MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCifgLBAr2MhgWLBJWtTuhtGC4f47eb5xs1Ys/GvYjS77h6aX9Zw2HIpovVRLITdd0bMjD4/VHnrC1bZOD/OeXchOTmjrVlIdKVeJK4RIrYc7oDSlWUYkBKDRqWLEUXS2CS0Fc1X6wa2Pub7G9e3ukV+orrJkMC0+YTEgn18iLUBQIDAQAB

返回的密钥:
私:MIICdgIBADANBgkqhkiG9w0BAQEFAASCAmAwggJcAgEAAoGBAI4fCLavIlpWS8HEyMS6YIT3KX0Udg7ny/6yUJ65OSP5XRLUiRGYufd2w1wastUltLuI0c/ffP/sHfYZhcIOykwyR8twh6spkuD/R1mjirV09Fl4jG/wChK9ce+VFs9mqNs4k61jWiGPo4sjofL3LbRvXi0478pK3IaHXRVuPhTbAgMBAAECgYAbDqN9DDixFC7WFB3Y/laz2c5nRsb3LYAz3ETnAwJy692hYR87X2V
ATLcCyP50//m5nmG7fqPwoUZO/Sru+BvhPgNU1T1zaY/q/FihkZJQfX2DErHvJq69tFI/wr8V80185RN/6W2eCsMnbTAHdUlZNyBSqjLEfNSkYwUOPfqvoQJBAJ+PprYac0YFuJXollvRlTiMDRPkW2IJ9wVdRZ5XyePk+2CFMkj7DDQE7Yxt2sAVxeLIXHK2oIlpO1oKJ/2rudECQQDkBPcQg2e3KitCFib4xfLAiqyzA4KzrFjMlDNZzx0ZJrmRGRv79Ahcw7pzvU3XlloX7kWXeZhlS
C5wSOjSkOLrAkAs/2PyYw8zJhXiIM+WYUqFwelGPNYQleLV3nHtr7A91quVkrqVnkbYvLMJMUnJddpylDKOHzayybx1LfwNK8qhAkEAqD4RnhmXGUsACA8YSk6kQvUPYDai5bew/aIMEaQEMF6mZS1FvK3ezbONi4COQxgo+adRqeaKT5Dm0uq4/0TwaQJAXVBeajTN4i3WN6Fr0DCuFRJDEWvYFdCVDgXvKtSVIheFWwst/rFwUjoOKndVLaDOKfnorKioPsIYd/EQ/z8SQw==

公钥加密,私钥解密

请求时,请求头有encryption: enabled 表示加密请求,当后台强制要求加密时(生产环境),该请求头必填,没有则会报错。


后台如果加密成功,返回头会有字段  encryption: enabled .其他情况均为未加密,按照未加密的情况处理

加密的请求与返回值结构
{
    “encryptData”:"加密的字符串"
}

请求参数

返回数据

名称类型是否必须默认值备注其他信息

个推参数矩阵

基本信息

Path: /backend/pump-cgm-sys/////////

Method: GET

接口描述:

应用名 安卓包名 IOS bundleID APP ID APP SECRET APP KEY MASTER SECRET 环境说明 参数origin值

请求参数

返回数据

名称类型是否必须默认值备注其他信息

完整性校验规则说明

基本信息

Path: /backend/pump-cgm-sys///////////////

Method: GET

接口描述:

完整性校验开启开关

请求头增加字段 integrity: enabled 表示校验开启

签名规则:
    先看示例:
最终请求体R:
{
    "body": {
        "name": "123"
    },
    "integrityData": {
        "randomStr": "c92aa233313a4e41b57f1ae3d19e1534",
        "timestamp": 1725349964314,
        "sign": "5bd14320f7073558d16c5c5137689b9"   //这个字段不参与签名
    }
}
这是一个接入完整性校验的请求body。相当于在原有请求的object外再加一层。原有请求参数存进body,签名参数存在新增的字段integrityData字段中.
其中randomStr是一个随机字符串。timestamp是毫秒级时间戳。sign是根据规则MD5后的签名。

sign的生成方式:获取请求体body中所有的叶子节点。拼接成query样式的key-value结构。只向下递归object类型的对象,数组保留数组格式。示例。
请求体A:
{
    "body": {
        "name": "123"
    },
    "integrityData": {
        "randomStr": "c92aa233313a4e41b57f1ae3d19e1534",
        "timestamp": 1725349964314,
    }
}
拼接后的字符串B=toQueryString(A):name=123&randomStr=c92aa233313a4e41b57f1ae3d19e1534&timestamp=1725349964314
sign = MD5(B) 后端校验时不区分大小写
最后将生成的签名存进integrityData字段里,如最先给出的示例。
返回值也一样,当完整性校验开关开启时,返回头也会携带标识参数 integrity: enabled。示例:
{
    "body": {
        "code": 705,
        "msg": ""
    },
    "integrityData": {
        "randomStr": "35963c8b35784a458d4b13b7b5545908",
        "timestamp": 1725442615043,
        "sign": "a6a74ae27d0541e3343ae4d733446f87"
    }
}
返回体结构定义和请求一致,实际返回体都在body里。

注意事项:
1.参与签名的参数只包含body里的json参数,不包括query。
2.基于上一条,get请求不需要参数签名。
3.返回值都是存放于body,返回值会进行完整性签名。
4.当遇到数据的时候保留原有格式的意思是指:records=[{...}]&other=12312&name=123 不需要深入数组对象中进行拆分key-value。
5.完整性校验和RSA加密规则相互独立。但一般需要一起使用。当同时使用完整性校验和RSA加密时,RSA加密的仍是整个请求体。encryptionData = RSA(R).

请求参数

用户账户相关

发送手机号或者邮件重置密码验证码

基本信息

Path: /backend/pump-cgm-sys/user/sendUpdatePasswordEmailOrPhoneVerificationCode

Method: GET

接口描述:

UC-C-O-6

请求参数

Query

参数名称 是否必须 示例 备注
username 否 手机号或邮箱

返回数据

名称类型是否必须默认值备注其他信息

发送手机号或者邮箱注册验证码

基本信息

Path: /backend/pump-cgm-sys/user/sendRegisterPhoneOrEmailVerificationCode

Method: GET

接口描述:

APP-SRS-1-1
UC-C-O-5

请求参数

Query

参数名称 是否必须 示例 备注
username 是 手机号或邮箱

返回数据

名称类型是否必须默认值备注其他信息

发送手机号注册验证码

基本信息

Path: /backend/pump-cgm-sys/user/sendRegisterPhoneVerificationCode

Method: GET

接口描述:

APP-SRS-1-1
UC-C-O-4

请求参数

Query

参数名称 是否必须 示例 备注
phone 是 用户手机号

返回数据

名称类型是否必须默认值备注其他信息

发送手机号重置密码验证码

基本信息

Path: /backend/pump-cgm-sys/user/sendUpdatePasswordPhoneVerificationCode

Method: GET

接口描述:

UC-C-O-7

请求参数

Query

参数名称 是否必须 示例 备注
phone 否 手机号

返回数据

名称类型是否必须默认值备注其他信息

异常说明

基本信息

Path: /backend/pump-cgm-sys/user

Method: GET

接口描述:

code data 说明 其他
10213 用户已注册 用户账户返回值
10106 用户未注册 用户账户中心返回值
10002 验证码错误 同上
79865 密码错误 同上
60000 用户已冻结 同上
60001 用户剩余一次尝试机会时提示用户还有一次机会 同上
10005 验证码频率限制 同上
500 邮箱格式错误
500 邮箱必填
500 手机号必填
500 密码必填
500 验证码必填
500 用户名必填
100009 敏感信息检测
100101 替换的手机号已被注册
100102 不受支持的头像类型
200100 邮件或短信发送失败
200202 登录失败

请求参数

返回数据

名称类型是否必须默认值备注其他信息

通过手机号或者邮箱注册

基本信息

Path: /backend/pump-cgm-sys/user/passCheckToken/registerByVerificationCodeWithPhoneOrEmail

Method: POST

接口描述:

APP-SRS-1-1
UC-C-O-3

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型是否必须默认值备注其他信息
usernamestring非必须用户名,直接使用该字段可以不区分手机号还是邮箱
passwordstring非必须密码,MD5后传递,小写
codestring非必须验证码

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ userIdstring非必须
├─ emailstring非必须
├─ tokenstring非必须
├─ phonestring必须

通过手机号注册

基本信息

Path: /backend/pump-cgm-sys/user/passCheckToken/registerByVerificationCodeWithPhone

Method: POST

接口描述:

APP-SRS-1-1
UC-C-O-2

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型是否必须默认值备注其他信息
passwordstring非必须密码,MD5后传递,小写
codestring非必须验证码
phonestring非必须兼容字段,手机号

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject非必须
├─ userIdstring非必须
├─ phonestring非必须
├─ tokenstring非必须

发送邮箱注册验证码

基本信息

Path: /backend/pump-cgm-sys/user/sendRegisterEmailVerificationCode

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
email 否

Body

{"type":"object","title":"empty object","properties":{"email":{"type":"string"}},"required":["email"]}

返回数据

名称类型是否必须默认值备注其他信息

邮箱验证码注册

基本信息

Path: /backend/pump-cgm-sys/user/passCheckToken/registerByVerificationCodeWithEmail

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型是否必须默认值备注其他信息
emailstring必须
codestring必须验证码
passwordstring必须密码。小写32的md5值

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
countnumber非必须
dataobject非必须
├─ userIdstring非必须
├─ emailstring非必须
├─ tokenstring非必须

密码登录

基本信息

Path: /backend/pump-cgm-sys/user/loginByPassword

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型是否必须默认值备注其他信息
usernamestring必须用户名,可以是手机号也可以是邮箱。这里不校验格式
passwordstring必须密码。MD5后的值。不要传递明文

返回数据

名称类型是否必须默认值备注其他信息
codenumber必须
msgstring必须
countnumber非必须
dataobject非必须
├─ userIdstring必须用户id
├─ phonestring非必须手机号登录的返回手机号
├─ emailstring非必须邮箱登录返回登录的邮箱
├─ tokenstring必须用户token
├─ concurrentPasswordTypestring必须0无密码1有密码

发送重置密码邮箱验证码

基本信息

Path: /backend/pump-cgm-sys/user/sendUpdatePasswordEmailVerificationCode

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
email 否 邮箱

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
msgstring必须

通过验证码重置密码

基本信息

Path: /backend/pump-cgm-sys/user/passCheckToken/resetPasswordByVerificationCode

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型是否必须默认值备注其他信息
userNamestring必须用户名,邮箱或手机号
codestring必须验证码
newPasswordstring必须新密码,小写32位MD5值

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
msgstring必须

获取引导和密码设置状态

基本信息

Path: /backend/pump-cgm-sys/userInformation/getGuideState

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

dataobject非必须返回数据
├─ isSettedPasswordinteger非必须1是否设置过密码默认0,1已在aidex中设置或忽略

mock: @integer

├─ isGuideinteger非必须1是否引导,0未引导,1已引导

mock: @integer

├─ isUnitGuideinteger非必须单位功能引导

查询用户信息

基本信息

Path: /backend/pump-cgm-sys/user/getUserInfo

Method: GET

接口描述:

疾病类型是整型数据,存的是字典表id值。

并发症(多选),治疗方案(多选)都是逗号拼接的字典列表的id值。

其他疾病为兼容自定义的32位id值,这里采用字符串,字典表的数字id可以直接传递或换成字符均可(后台兼容)

请求参数

Query

参数名称 是否必须 示例 备注
userId 否

返回数据

名称类型是否必须默认值备注其他信息
codenumber必须
msgstring必须
dataobject非必须该字段可能没有。如果没有则需要用户重新登录。一般不会发生
├─ userInformationIdstring必须主键
├─ phonestring非必须手机邮箱二选一
├─ emailstring非必须
├─ avatarstring非必须头像地址
├─ userIdstring必须
├─ namestring非必须昵称
├─ fullNamestring非必须全名
├─ gendernumber非必须1男2女3其他4他们
├─ birthDatestring非必须yyyy-MM-dd,生日
├─ heightnumber非必须身高
├─ bodyWeightnumber非必须体重
├─ diabetesTypenumber非必须疾病类型
├─ diabetesTypeDisplayNamestring非必须糖尿病类型展示字段
├─ diabetesTypeValueinteger非必须疾病类型value值
├─ diagnosisDatestring非必须确诊时间 yyyy-MM-dd HH:mm:ssZ
├─ complicationsstring非必须并发症(多选); 0无,1心血管并发症,2视网膜病变,3神经病变,4肾病,5糖尿病足,99其他
├─ complicationsDisplayNamestring非必须并发症展示字段,逗号拼接的
├─ treatmentstring非必须治疗方案
├─ treatmentDisplayNamestring非必须治疗方案展示字段,逗号拼接
├─ otherDiseasesstring非必须其他疾病
├─ otherDiseasesDisplayNamestring非必须其他疾病展示字段
├─ isGuidenumber非必须是否引导。0未引导,1已引导
├─ isSettedPasswordnumber非必须默认0,1已在aidex中设置或忽略

头像上传

基本信息

Path: /backend/pump-cgm-sys/user/userUploadAvatar

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type multipart/form-data 是 multipart/form-data

Query

参数名称 是否必须 示例 备注
userId 否

Body

参数名称 参数类型 是否必须 示例 备注
file file 是

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
msgstring必须
datastring必须图片的绝对路径

添加或修改用户信息

基本信息

Path: /backend/pump-cgm-sys/user/updateUserInformation

Method: POST

接口描述:

疾病类型是整型数据,存的是字典表id值。

并发症(多选),治疗方案(多选)都是逗号拼接的字典列表的id值。

其他疾病为兼容自定义的32位id值,这里采用字符串,字典表的数字id可以直接传递或换成字符均可(后台兼容)

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是 application/json

Query

参数名称 是否必须 示例 备注
userId 否

Body

名称类型是否必须默认值备注其他信息
avatarstring非必须头像地址
namestring非必须昵称
fullNamestring非必须全名
gendernumber非必须1男2女3其他4他们
birthDatestring非必须yyyy-MM-dd
heightnumber非必须
bodyWeightnumber非必须
diabetesTypenumber非必须疾病类型
diagnosisDatestring非必须确诊时间 yyyy-MM-dd HH:mm:ssZ
complicationsstring非必须并发症(多选); 0无,1心血管并发症,2视网膜病变,3神经病变,4肾病,5糖尿病足,99其他
treatmentstring非必须治疗方案
otherDiseasesstring非必须其他疾病
isGuideinteger非必须1表示已引导。系统默认0
isPairGuideinteger非必须

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
msgstring必须

注销账户

基本信息

Path: /backend/pump-cgm-sys/user/deleteAccount

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是 application/json

Body

名称类型是否必须默认值备注其他信息
passwordstring必须小写32位MD5值

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
msgstring必须

退出登录

基本信息

Path: /backend/pump-cgm-sys/user/logout

Method: GET

接口描述:

请求参数

Query

参数名称 是否必须 示例 备注
userId 否

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
msgstring必须

字典表接口

查询字典下拉选项

基本信息

Path: /backend/pump-cgm-sys/dictionary/findAllDictionaryList

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Query

参数名称 是否必须 示例 备注
type 否 1 字典类型。1 糖尿病类型,2治疗方案,3并发症,4其他疾病

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

dataobject []非必须返回数据

元素是否都不同: false

item 类型: object

├─ displayNamestring非必须string国际化展示名称

mock: @string

├─ dictionaryIdstring非必须主键

mock: @string

├─ typeinteger非必须1字典表类型1 糖尿病类型,2治疗方案,3并发症,4其他疾病

mock: @integer

├─ valuenumber非必须该字段在自定义其他疾病中为null

mock: @integer

其他疾病用户预设相关

添加或修改一个其他疾病

基本信息

Path: /backend/pump-cgm-sys/event/otherDiseasesUsrPreset/saveOrUpdateOtherDiseasesUsrPreset

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
recordsobject []非必须疾病名称

item 类型: object

├─ namestring必须

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

dataobject []非必须返回数据

item 类型: object

├─ otherDiseasesIdstring必须id
├─ namestring必须名称

CGM设备相关

异常说明

基本信息

Path: /backend/pump-cgm-sys///////

Method: GET

接口描述:

code data 说明 其他
300001 设备主键id不能为空 解配时提示
300002 设备model不能为空
300003 设备sn必传
300004 设备mac地址必传
300005 设备key必传
300006 startup必传
300007 startUpTimeZone必传
300008 sensorId必传
300100 用户已配对设备

如果以上字段在1 代中未使用的,就传递说明文字。比如MAC地址有一个端是没有的,就传递说明文字:e.g:安卓端没有MAC地址



所有时间交互格式为:yyyy-MM-dd HH:mm:ssZ

请求参数

返回数据

名称类型是否必须默认值备注其他信息

配对

基本信息

Path: /backend/pump-cgm-sys/cgmDevice/userDeviceRegister

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
deviceModelstring必须
sensorIdstring必须设备前端唯一键
sensorStartUpstring必须yyyy-MM-dd HH:mm:ssZ
startUpTimeZonestring必须设备时区id, 例子:Asia/Shanghai

mock: @string

sensorIndexstring非必须
deviceSnstring必须
deviceMacstring必须
deviceKeystring []必须byte [] 数组

item 类型: string

├─ 非必须
registerTimestring必须
etnumber非必须
isForceReplaceboolean非必须是否强制覆盖。默认false
dstOffsetstring非必须夏令时偏移量
sensorErrorTimeOffsetstring非必须0正常,更换传感器状态时间偏移量

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
msgstring必须
dataobject必须返回最后一条数据 ,CgmRecord
├─ deviceIdstring必须设备表id

获取设备信息

基本信息

Path: /backend/pump-cgm-sys/cgmDevice/getUserDeviceInfo

Method: GET

接口描述:

请求参数

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
msgstring必须
dataobject非必须
├─ deviceInfoobject非必须设备信息,如果用户没有绑定,不返回
├─ deviceIdstring必须
├─ userIdstring必须
├─ sensorIdstring必须
├─ sensorIndexstring非必须
├─ sensorStartUpstring必须
├─ startUpTimeZonestring必须
├─ deviceModelstring必须
├─ deviceSnstring必须
├─ deviceMacstring必须
├─ deviceKeystring必须
├─ registerTimestring必须
├─ unregisterTimestring必须
├─ etnumber非必须
├─ dstOffsetstring非必须
├─ sensorErrorTimeOffsetnumber非必须默认0,0正常,时间偏移量

更新设备状态

基本信息

Path: /backend/pump-cgm-sys/cgmDevice/deviceStatusUpdate

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
recordsobject []必须

item 类型: object

├─ deviceIdstring必须设备表id
├─ sensorErrorTimeOffsetnumber必须0正常,状态的时间偏移量

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
msgstring必须

解配

基本信息

Path: /backend/pump-cgm-sys/cgmDevice/deviceUnRegister

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
deviceIdstring必须设备表id

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
msgstring必须

获取用户设备历史,包括解配的

基本信息

Path: /backend/pump-cgm-sys/cgmDevice/getUserDeviceHistory

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

dataobject []非必须返回数据

元素是否都不同: false

item 类型: object

├─ sensorIndexinteger非必须1

mock: @integer

├─ registerTimestring非必须2023-06-16 13:09:17启用时间

mock: @timestamp

├─ startUpTimeZonestring必须string

mock: @string

├─ deviceKeynumber必须1设备密钥文件

mock: @byte

├─ sensorStartUpstring必须2023-06-16 13:09:17

mock: @timestamp

├─ dstOffsetstring非必须string夏令时偏移量

mock: @string

├─ deviceIdstring必须string主键

mock: @string

├─ userIdstring非必须string外键:tbl_user.pk_id

mock: @string

├─ deviceSnstring必须string设备sn

mock: @string

├─ sensorIdstring必须string

mock: @string

├─ etinteger非必须1传感器有效期

mock: @integer

├─ isForceReplacebool非必须false

mock: @boolean

├─ unregisterTimestring非必须2023-06-16 13:09:17停用时间

mock: @timestamp

├─ deviceMacstring必须string设备mac地址

mock: @string

├─ deviceModelstring必须string设备型号

mock: @string

├─ sensorErrorTimeOffsetstring非必须0正常,请更换传感器状态时间偏移量

趋势相关接口

保存趋势数据

基本信息

Path: /backend/pump-cgm-sys/userTrend/saveOrUpdateUserTrend

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
appTimestring非必须string时间

mock: @string

trendinteger非必须1趋势code:-99 未知,无趋势 -3 快速下降 -2 下降 -1 缓慢下降 0 平稳 1 缓慢上升 2 上升 3 快速上升

mock: @integer

trendIdstring非必须string

mock: @string

trendValuenumber非必须0.111111趋势值

mock: @float

historyStatusinteger非必须1历史状态

mock: @integer

dstOffsetstring非必须string偏移量

mock: @string

calTempinteger非必须1状态字段

mock: @integer

appTimeZonestring非必须string时区

mock: @string

bloodGlucosenumber非必须0.111111值

mock: @float

statusinteger非必须1状态

mock: @integer

isInstantboolean非必须是否最新

mock: @boolean

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

dataobject非必须返回数据
├─ appTimestring非必须string时间

mock: @string

├─ trendinteger非必须1趋势code:-99 未知,无趋势 -3 快速下降 -2 下降 -1 缓慢下降 0 平稳 1 缓慢上升 2 上升 3 快速上升

mock: @integer

├─ trendIdstring非必须string

mock: @string

├─ trendValuenumber非必须0.111111趋势值

mock: @float

├─ historyStatusinteger非必须1历史状态

mock: @integer

├─ dstOffsetstring非必须string偏移量

mock: @string

├─ calTempinteger非必须1状态字段

mock: @integer

├─ userIdstring非必须string用户id

mock: @string

├─ appTimeZonestring非必须string时区

mock: @string

├─ bloodGlucosenumber非必须0.111111值

mock: @float

├─ statusinteger非必须1状态

mock: @integer

cgm数据相关

异常说明

基本信息

Path: /backend/pump-cgm-sys///////////

Method: GET

接口描述:

code data 说明 备注
400001 前端frontRecordId必传
400002 用户id必传
400003 sensorid必传
400004 timeOffset必传
400005 更新时主键必传

请求参数

返回数据

名称类型是否必须默认值备注其他信息

cgm数据上传接口

基本信息

Path: /backend/pump-cgm-sys/cgmRecord/saveCgmRecord

Method: POST

接口描述:




请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
recordsobject []非必须

item 类型: object

├─ cgmRecordIdstring非必须

mock: @string

├─ frontRecordIdstring必须由前端生成

mock: @string

├─ userIdstring必须外键:tbl_user.pk_id

mock: @string

├─ sensorIdstring必须

mock: @string

├─ timeOffsetnumber必须血糖和原始数据的时间偏移量(time_offset)

mock: @integer

├─ glucosenumber非必须CGM血糖数据mgdL

mock: @float

├─ statusnumber非必须AidexxHistory::STATUS_inaidexxconstants.h

mock: @integer

├─ qualitynumber非必须

mock: @integer

├─ glucoseIsValidnumber非必须血糖有效性false:dataloss 默认1有效

mock: @integer

├─ rawOnenumber非必须nA

mock: @float

├─ rawTwonumber非必须nA

mock: @float

├─ rawVcnumber非必须V

mock: @float

├─ rawIsValidnumber非必须原始数据有效性false:dataloss 默认1有效

mock: @integer

├─ appTimestring非必须

mock: @string

├─ appTimeZonestring非必须时区id

mock: @string

├─ appCreateTimestring非必须
├─ dstOffsetstring非必须

mock: @string

├─ eventWarninginteger非必须
├─ trendValueinteger非必须趋势值
├─ appTimeOffsetinteger非必须单位:秒。 偏移量
├─ deviceStatusinteger非必须设备状态

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须返回码

mock: @integer

msgstring非必须返回信息

mock: @string

countnumber非必须返回数据总数

mock: @integer

dataobject []非必须返回数据 ,CgmRecord

item 类型: object

├─ cgmRecordIdstring非必须

mock: @string

├─ frontRecordIdstring必须由前端生成

mock: @string

├─ userIdstring必须外键:tbl_user.pk_id

mock: @string

├─ sensorIdstring必须

mock: @string

├─ autoIncrementColumnnumber非必须自增键

mock: @integer

├─ appCreateTimestring非必须

mock: @string

├─ timeOffsetnumber必须血糖和原始数据的时间偏移量(time_offset)

mock: @integer

├─ glucosenumber非必须CGM血糖数据mgdL

mock: @float

├─ statusnumber非必须AidexxHistory::STATUS_inaidexxconstants.h

mock: @integer

├─ qualitynumber非必须

mock: @integer

├─ glucoseIsValidnumber非必须血糖有效性false:dataloss

mock: @integer

├─ rawOnenumber非必须nA

mock: @float

├─ rawTwonumber非必须nA

mock: @float

├─ rawVcnumber非必须V

mock: @float

├─ rawIsValidnumber非必须原始数据有效性false:dataloss

mock: @integer

├─ appTimestring非必须
├─ appTimeZonestring非必须
├─ dstOffsetstring非必须
├─ eventWarningstring非必须
├─ trendValueinteger非必须趋势值
├─ appTimeOffsetinteger非必须单位:秒。 偏移量
├─ smoothnumber非必须平滑值
├─ smoothStateinteger非必须平滑状态1非固定,2已固定,0或null未计算

分页查询用户数据

基本信息

Path: /backend/pump-cgm-sys/cgmRecord/getCgmRecordsByPageInfo

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Query

参数名称 是否必须 示例 备注
pageNum 是 1 分页参数 页数(Integer)
pageSize 是 100 分页参数 条数(Integer)
startAutoIncrementColumn 否 示例:100 筛选自增列大于等于100的数据 自增列(Long).序号 大于等于。闭区间
endAutoIncrementColumn 否 示例:100 筛选自增列小于等于100的数据 自增列(Long).序号 小于等于。闭区间
orderStrategy 否 ASC 枚举值.排序规则 默认DESC 。排序规则只控制数据的排序,跟区间无关。不能控制方向
userId 否

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须返回码

mock: @integer

msgstring非必须返回信息

mock: @string

countnumber非必须返回数据总数

mock: @integer

dataobject []非必须返回数据 ,CgmRecord

item 类型: object

├─ cgmRecordIdstring必须

mock: @string

├─ frontRecordIdstring必须由前端生成

mock: @string

├─ userIdstring必须外键:tbl_user.pk_id

mock: @string

├─ deviceIdstring必须外键:tbl_user_device.pk_id

mock: @string

├─ sensorIdstring必须

mock: @string

├─ autoIncrementColumnnumber必须自增键

mock: @integer

├─ timeOffsetnumber非必须血糖和原始数据的时间偏移量(time_offset)

mock: @integer

├─ glucosenumber非必须CGM血糖数据mgdL

mock: @float

├─ statusnumber非必须AidexxHistory::STATUS_inaidexxconstants.h

mock: @integer

├─ qualitynumber非必须

mock: @integer

├─ glucoseIsValidnumber非必须血糖有效性false:data loss

mock: @integer

├─ rawOnenumber非必须nA

mock: @float

├─ rawTwonumber非必须nA

mock: @float

├─ rawVcnumber非必须V

mock: @float

├─ rawIsValidnumber非必须原始数据有效性false:dataloss

mock: @integer

├─ appTimestring非必须设备时间
├─ appTimeZonestring非必须
├─ appCreateTimestring非必须
├─ dstOffsetstring非必须
├─ eventWarningstring非必须
├─ trendValueinteger非必须趋势值
├─ appTimeOffsetinteger非必须单位:秒。 偏移量
├─ deviceStatusinteger非必须-1请更换传感器
├─ smoothnumber非必须平滑
├─ smoothStateinteger非必须平滑状态1非固定,2已固定,0或null未计算

cgm数据更新接口

基本信息

Path: /backend/pump-cgm-sys/cgmRecord/updateCgmRecord

Method: POST

接口描述:




请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
recordsobject []非必须

item 类型: object

├─ cgmRecordIdstring必须更新时主键必传

mock: @string

├─ sensorIdstring必须

mock: @string

├─ timeOffsetinteger必须
├─ rawOnenumber非必须nA

mock: @float

├─ rawTwonumber非必须nA

mock: @float

├─ rawVcnumber非必须V

mock: @float

├─ rawIsValidnumber非必须原始数据有效性false:dataloss 默认1有效

mock: @integer

├─ trendValueinteger非必须趋势值
├─ appTimeOffsetinteger非必须单位:秒。 偏移量
├─ deviceStatusinteger非必须设备状态-1请更换传感器

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须返回码

mock: @integer

msgstring非必须返回信息

mock: @string

校准相关

异常说明

基本信息

Path: /backend/pump-cgm-sys/cgmCalibration

Method: GET

接口描述:

code msg 说明
1200001 主键必填
1200002 useriD必传
1200003 sensorId必传

请求参数

返回数据

名称类型是否必须默认值备注其他信息

保存校准数据

基本信息

Path: /backend/pump-cgm-sys/cgmCalibration/saveCalibration

Method: POST

接口描述:




请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
recordsobject []非必须CgmCalibration

item 类型: object

├─ calibrationIdstring必须

mock: @string

├─ userIdstring必须

mock: @string

├─ sensorIdstring必须

mock: @string

├─ appTimestring非必须app时间

mock: @string

├─ appTimeZonestring非必须app时区

mock: @string

├─ dstOffsetstring非必须夏令时偏移量

mock: @string

├─ offsetnumber非必须

mock: @float

├─ cfnumber非必须

mock: @float

├─ timeOffsetnumber非必须

mock: @integer

├─ indexnumber非必须

mock: @integer

├─ referenceGlucosenumber非必须

mock: @float

├─ isValidnumber非必须

mock: @integer

返回数据

名称类型是否必须默认值备注其他信息
codenumber必须返回码

mock: @integer

msgstring必须返回信息

mock: @string

countnumber非必须返回数据总数

mock: @integer

dataobject []非必须返回数据 ,CgmCalibration

item 类型: object

├─ calibrationIdstring必须

mock: @string

├─ userIdstring必须

mock: @string

├─ sensorIdstring必须

mock: @string

├─ appTimestring非必须app时间

mock: @string

├─ appTimeZonestring非必须app时区

mock: @string

├─ dstOffsetstring非必须夏令时偏移量

mock: @string

├─ offsetnumber非必须

mock: @float

├─ cfnumber非必须

mock: @float

├─ timeOffsetnumber非必须

mock: @integer

├─ autoIncrementColumnnumber必须自增列

mock: @integer

├─ indexnumber非必须

mock: @integer

├─ referenceGlucosenumber非必须

mock: @float

├─ isValidnumber非必须

mock: @integer

分页查询校准

基本信息

Path: /backend/pump-cgm-sys/cgmCalibration/getCalibrationList

Method: GET

接口描述:

/**
         *分页查询校准
         *
         * @param pageNum
        * @param pageSize
        * @param userId 查询自己时可以不用传递
         * @param startAutoIncrementColumn  开始点,大于等于
        * @param endAutoIncrementColumn 自增列值结束点。小于等于
         * @param orderStrategy 排序规则(ASC,DESC),默认倒叙
         * @return java.lang.Object
         * @methodName getCalibrationList
         * @author xiaozhou
         * @date 2023/5/18
         */
        @GetMapping("getCalibrationList")
        public Response<List<CgmCalibration>> getCalibrationList(@RequestParam(defaultValue = "1") Integer pageNum, @RequestParam(defaultValue = "100") Integer pageSize,@RequestParam(required = false) String userId,@RequestParam(required = false)           Long startAutoIncrementColumn
                ,@RequestParam(required = false) Long endAutoIncrementColumn,@RequestParam(required = false) String orderStrategy)

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Query

参数名称 是否必须 示例 备注
pageNum 否 1
pageSize 否 100
userId 否




查询自己时可以不用传递
startAutoIncrementColumn 否




开始点,大于等于
endAutoIncrementColumn 否




自增列值结束点。小于等于
orderStrategy 否




排序规则(ASC,DESC),默认倒叙

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

dataobject []非必须返回数据

元素是否都不同: false

item 类型: object

├─ appTimestring非必须stringapp时间

mock: @string

├─ cfnumber非必须0.111111

mock: @float

├─ offsetnumber非必须0.111111

mock: @float

├─ isValidinteger非必须1

mock: @integer

├─ dstOffsetstring非必须string夏令时偏移量

mock: @string

├─ indexinteger非必须1

mock: @integer

├─ timeOffsetinteger非必须1

mock: @integer

├─ userIdstring必须string

mock: @string

├─ referenceGlucosenumber非必须0.111111

mock: @float

├─ sensorIdstring必须string

mock: @string

├─ autoIncrementColumninteger非必须1自增列

mock: @integer

├─ calibrationIdstring必须string

mock: @string

├─ appTimeZonestring非必须stringapp时区

mock: @string

countinteger非必须1返回 数据总数

mock: @integer

设置相关

异常说明

基本信息

Path: /backend/pump-cgm-sys/_

Method: GET

接口描述:

code data 说明
500001 设置主键id必传

请求参数

返回数据

名称类型是否必须默认值备注其他信息

查询用户设置

基本信息

Path: /backend/pump-cgm-sys/userSetting/getUserSetting

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

dataobject非必须返回数据
├─ pumpSignalMissingRateinteger非必须1泵信号丢失频率

mock: @integer

├─ lowAlertSwitchinteger非必须10开,1关

mock: @integer

├─ pumpSignalMissingSwitchinteger非必须1泵信号丢失开关

mock: @integer

├─ languagestring非必须string语言

mock: @string

├─ lowLimitMgnumber非必须0.111111低血糖阈值

mock: @float

├─ themeinteger非必须10深1浅

mock: @integer

├─ cgmSignalMissingAlertRateinteger非必须1单位:分钟

mock: @integer

├─ alertTypeinteger非必须11声音,2震动,3声音震动

mock: @integer

├─ userSettingIdstring必须string

mock: @string

├─ fastUpSwitchinteger非必须1快速上升

mock: @integer

├─ cgmSignalMissingSwitchinteger非必须1cgm系统丢失开关

mock: @integer

├─ fastDownSwitchinteger非必须1快速下降

mock: @integer

├─ timeZonestring非必须string使用的时区

mock: @string

├─ highAlertSwitchinteger非必须1高血糖开关

mock: @integer

├─ userIdstring必须string

mock: @string

├─ lowAlertRateinteger非必须1低血糖频率

mock: @integer

├─ highAlertRateinteger非必须1高血糖频率

mock: @integer

├─ urgentConnectstring非必须string紧急联系人

mock: @string

├─ highLimitMgnumber非必须0.111111高血糖阈值

mock: @float

├─ unitinteger非必须10mmol,1mg

mock: @integer

├─ replaceBaseboardSwitchinteger非必须1更换底板,默认0

mock: @integer

├─ cgmEtinteger非必须1cgm剩余有效时间

mock: @integer

├─ persistentHyperglycemiaSwitchinteger非必须1持续高血糖

mock: @integer

├─ usernamestring非必须string用户名

mock: @string

├─ replaceMedicationBoxSwitchinteger非必须1更换储药器。默认0

mock: @integer

更新用户设置

基本信息

Path: /backend/pump-cgm-sys/userSetting/updateUserSetting

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
pumpSignalMissingRateinteger非必须1泵信号丢失频率

mock: @integer

lowAlertSwitchinteger非必须10开,1关

mock: @integer

pumpSignalMissingSwitchinteger非必须1泵信号丢失开关

mock: @integer

languagestring非必须string语言

mock: @string

lowLimitMgnumber非必须0.111111低血糖阈值

mock: @float

themeinteger非必须10深1浅

mock: @integer

cgmSignalMissingAlertRateinteger非必须1单位:分钟

mock: @integer

alertTypeinteger非必须11声音,2震动,3声音震动

mock: @integer

userSettingIdstring必须string

mock: @string

fastUpSwitchinteger非必须1快速上升

mock: @integer

cgmSignalMissingSwitchinteger非必须1cgm系统丢失开关

mock: @integer

fastDownSwitchinteger非必须1快速下降

mock: @integer

timeZonestring非必须string使用的时区

mock: @string

highAlertSwitchinteger非必须1高血糖开关

mock: @integer

userIdstring非必须string

mock: @string

lowAlertRateinteger非必须1低血糖频率

mock: @integer

highAlertRateinteger非必须1高血糖频率

mock: @integer

urgentConnectstring非必须string紧急联系人

mock: @string

highLimitMgnumber非必须0.111111高血糖阈值

mock: @float

unitinteger非必须10mmol,1mg

mock: @integer

replaceBaseboardSwitchinteger非必须1更换底板,默认0

mock: @integer

cgmEtinteger非必须1cgm剩余有效时间

mock: @integer

persistentHyperglycemiaSwitchinteger非必须1持续高血糖

mock: @integer

usernamestring非必须string用户名

mock: @string

replaceMedicationBoxSwitchinteger非必须1更换储药器。默认0

mock: @integer

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

泵设备相关

异常说明

基本信息

Path: /backend/pump-cgm-sys/////11123

Method: GET

接口描述:

code 说明
3100000 主键必需
3100001 用户id必需
3100002 ACCESSID必需
3100003 sn必传
3100004 mac地址必传
3100005 加密key必传
300100 用户已配对设备

请求参数

返回数据

名称类型是否必须默认值备注其他信息

泵设备绑定

基本信息

Path: /backend/pump-cgm-sys/pumpDevice/register

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
registerTimestring必须2024-11-15 14:56:01+0800启用时间带时区

mock: @timestamp

deviceKeynumber非必须1设备密钥文件

mock: @byte

encryptionKeynumber必须1加密key

mock: @byte

eventIndexinteger非必须1索引

mock: @integer

userIdstring必须string外键:tbl_user.pk_id

mock: @string

deviceSnstring必须string设备sn

mock: @string

versionstring非必须string版本

mock: @string

capacityinteger非必须1容量

mock: @integer

accessIdnumber必须1

mock: @byte

isSetSettinginteger非必须1是否进行了设置

mock: @integer

isForceReplacebool非必须false是否强制配对。默认false。

mock: @boolean

deviceMacstring必须string设备mac地址

mock: @string

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

dataobject非必须
├─ pumpDeviceIdstring必须泵设备表主键。解配用

泵设备解配

基本信息

Path: /backend/pump-cgm-sys/pumpDevice/unRegister

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
registerTimestring非必须2024-11-15 14:56:01+0800启用时间

mock: @timestamp

deviceKeynumber非必须1设备密钥文件

mock: @byte

encryptionKeynumber非必须1加密key

mock: @byte

eventIndexinteger非必须1索引

mock: @integer

deviceSnstring非必须string设备sn

mock: @string

versionstring非必须string版本

mock: @string

capacityinteger非必须1容量

mock: @integer

accessIdnumber非必须1

mock: @byte

isSetSettinginteger非必须1是否进行了设置

mock: @integer

pumpDeviceIdstring必须string主键

mock: @string

isForceReplacebool非必须false

mock: @boolean

unregisterTimestring非必须2024-11-15 14:56:01+0800停用时间

mock: @timestamp

deviceMacstring非必须string设备mac地址

mock: @string

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

更新泵设置数据

基本信息

Path: /backend/pump-cgm-sys/pumpDevice/updatePumpInfo

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
registerTimestring非必须2024-11-15 14:56:01启用时间

mock: @timestamp

deviceKeynumber非必须1设备密钥文件

mock: @byte

encryptionKeynumber非必须1加密key

mock: @byte

eventIndexinteger非必须1索引

mock: @integer

userIdstring非必须string外键:tbl_user.pk_id

mock: @string

deviceSnstring非必须string设备sn

mock: @string

versionstring非必须string版本

mock: @string

capacityinteger非必须1容量

mock: @integer

accessIdnumber非必须1

mock: @byte

isSetSettinginteger非必须1是否进行了设置

mock: @integer

pumpDeviceIdstring非必须string主键

mock: @string

isForceReplacebool非必须false

mock: @boolean

unregisterTimestring非必须2024-11-15 14:56:01停用时间

mock: @timestamp

deviceMacstring非必须string设备mac地址

mock: @string

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

获取所有设备信息

基本信息

Path: /backend/pump-cgm-sys/pumpDevice/getPumpDeviceListWithUnRegister

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Query

参数名称 是否必须 示例 备注
userId 否 string

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

dataobject []非必须返回数据

元素是否都不同: false

item 类型: object

├─ registerTimestring非必须2024-11-15 14:56:01启用时间

mock: @timestamp

├─ deviceKeynumber非必须1设备密钥文件

mock: @byte

├─ encryptionKeynumber非必须1加密key

mock: @byte

├─ eventIndexinteger非必须1索引

mock: @integer

├─ userIdstring非必须string外键:tbl_user.pk_id

mock: @string

├─ deviceSnstring非必须string设备sn

mock: @string

├─ versionstring非必须string版本

mock: @string

├─ capacityinteger非必须1容量

mock: @integer

├─ accessIdnumber非必须1

mock: @byte

├─ isSetSettinginteger非必须1是否进行了设置

mock: @integer

├─ pumpDeviceIdstring非必须string主键

mock: @string

├─ isForceReplacebool非必须false

mock: @boolean

├─ unregisterTimestring非必须2024-11-15 14:56:01停用时间

mock: @timestamp

├─ deviceMacstring非必须string设备mac地址

mock: @string

countinteger非必须1返回 数据总数

mock: @integer

泵数据相关

异常说明

基本信息

Path: /backend/pump-cgm-sys/123

Method: GET

接口描述:

code msg 说明
3100006 记录时间必传 参数缺失。下同。
3100007 时区必传
3100008 容量必传
3100009 药量必传
3100010 基础率必传
3100011 大剂量必传
3100012 索引index必传
3100013 事件value值必传
3100014 事件等级必传
3100015 事件类型必传
3100016 事件端口必传
3100003 SN必传
3100001 用户id必传
3100000 设备表id必传

请求参数

保存泵数据

基本信息

Path: /backend/pump-cgm-sys/pumpData/savePumpData

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
recordsobject []非必须

元素是否都不同: false

item 类型: object

├─ pumpSnstring必须string泵序列号

mock: @string

├─ bolusRatenumber必须1.0大剂量 BolusRate

mock: @float

├─ recordTimeZonestring必须string记录时间的时区

mock: @string

├─ eventPortinteger必须1

mock: @integer

├─ eventIndexinteger必须1

mock: @integer

├─ eventTypeinteger必须1

mock: @integer

├─ userIdstring必须string

mock: @string

├─ basalRatenumber必须1.0基础率 BasalRate

mock: @float

├─ pumpDeviceIdstring必须string绑定后返回的设备表主键

mock: @string

├─ recordTimestring必须string设备记录时间

mock: @string

├─ eventValuenumber必须1.0

mock: @float

├─ eventLevelinteger必须1

mock: @integer

├─ remainingInsulininteger必须1药量 Reservoir

mock: @integer

├─ autoIncrementColumninteger必须1自增列

mock: @integer

├─ remainingCapacityinteger必须1电量 Battery

mock: @integer

├─ autoModelinteger非必须1是否自动模式,默认0不是,1是

mock: @integer

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

dataobject []非必须返回数据

元素是否都不同: false

item 类型: object

├─ pumpSnstring必须string泵序列号

mock: @string

├─ bolusRatenumber必须1.0大剂量 BolusRate

mock: @float

├─ recordTimeZonestring必须string记录时间的时区

mock: @string

├─ eventPortinteger必须1

mock: @integer

├─ eventIndexinteger必须1

mock: @integer

├─ eventTypeinteger必须1

mock: @integer

├─ userIdstring必须string

mock: @string

├─ basalRatenumber必须1.0基础率 BasalRate

mock: @float

├─ pumpDeviceIdstring必须string绑定后返回的设备表主键

mock: @string

├─ recordTimestring必须string设备记录时间

mock: @string

├─ eventValuenumber必须1.0

mock: @float

├─ eventLevelinteger必须1

mock: @integer

├─ remainingInsulininteger必须1药量 Reservoir

mock: @integer

├─ autoIncrementColumninteger必须1自增列

mock: @integer

├─ remainingCapacityinteger必须1电量 Battery

mock: @integer

├─ pumpRecordIdstring必须stringuserid+deviceid+datetime+timezone+mainid

mock: @string

├─ autoModelinteger非必须1是否自动模式,默认0不是,1是

mock: @integer

分页查询泵数据

基本信息

Path: /backend/pump-cgm-sys/pumpData/getPumpRecordsByPageInfo

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Query

参数名称 是否必须 示例 备注
pageNum 否 1 页码
pageSize 否 100 个数
userId 否 string 用户id,查询自己可以不传
startAutoIncrementColumn 否 1 起始点
endAutoIncrementColumn 否 1 结束点
orderStrategy 否 string 排序规则 ,ASC,DESC

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

dataobject []非必须返回数据

元素是否都不同: false

item 类型: object

├─ pumpSnstring必须string泵序列号

mock: @string

├─ bolusRatenumber必须1.0大剂量 BolusRate

mock: @float

├─ recordTimeZonestring必须string记录时间的时区

mock: @string

├─ eventPortinteger必须1

mock: @integer

├─ eventIndexinteger必须1

mock: @integer

├─ eventTypeinteger必须1

mock: @integer

├─ userIdstring必须string

mock: @string

├─ basalRatenumber必须1.0基础率 BasalRate

mock: @float

├─ pumpDeviceIdstring必须string绑定后返回的设备表主键

mock: @string

├─ recordTimestring必须string设备记录时间

mock: @string

├─ eventValuenumber必须1.0

mock: @float

├─ eventLevelinteger必须1

mock: @integer

├─ remainingInsulininteger必须1药量 Reservoir

mock: @integer

├─ autoIncrementColumninteger必须1自增列

mock: @integer

├─ remainingCapacityinteger必须1电量 Battery

mock: @integer

├─ pumpRecordIdstring必须stringuserid+deviceid+datetime+timezone+mainid

mock: @string

├─ autoModelinteger非必须1是否自动模式,默认0不是,1是

mock: @integer

countinteger非必须1返回 数据总数

mock: @integer

基础率预设值相关

异常说明

基本信息

Path: /backend/pump-cgm-sys/123_1734058041320

Method: GET

接口描述:

code msg 说明
3100001 用户id必传
3100018 settingIndex必传

请求参数

保存或修改基础率预设值

基本信息

Path: /backend/pump-cgm-sys/pumpBasalRatePrepareSetting/saveBasalRatePrepareSetting

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
recordsobject []非必须

元素是否都不同: false

item 类型: object

├─ settingIndexinteger必须1设置索引

mock: @integer

├─ valueArraystring非必须string数组值,逗号拼接

mock: @string

├─ isActiveinteger非必须10激活中,默认1

mock: @integer

├─ userIdstring必须string用户pid

mock: @string

├─ settingNamestring非必须string基础率设置名称

mock: @string

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
msgstring必须

查询基础率预设值

基本信息

Path: /backend/pump-cgm-sys/pumpBasalRatePrepareSetting/getBasalRatePrepareSetting

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Query

参数名称 是否必须 示例 备注
userId 否 string

返回数据

名称类型是否必须默认值备注其他信息
codenumber非必须
msgstring非必须
dataobject []非必须

item 类型: object

├─ basalRateBaseSettingIdstring必须主键
├─ userIdstring必须用户id
├─ settingNamestring必须预设名
├─ isActivenumber必须是否激活,0激活。默认1
├─ settingIndexnumber必须设置索引
├─ valueArraystring必须值数组。逗号拼接

大剂量预设值相关

异常说明

基本信息

Path: /backend/pump-cgm-sys/123_1734058041320_1734058046501

Method: GET

接口描述:

code msg 说明
3100001 用户id必传
3100019 MealPoint必传

请求参数

保存大剂量预设值数据

基本信息

Path: /backend/pump-cgm-sys/pumpBolusRatePrepareSetting/saveOrUpdate

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
recordsobject []非必须

元素是否都不同: false

item 类型: object

├─ mealPointinteger必须11早餐,2午餐,3晚餐,4加餐

mock: @integer

├─ bolusnumber非必须0.111111大剂量值

mock: @float

├─ userIdstring必须string用户id

mock: @string

├─ namestring非必须名称

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

查询大剂量预设值

基本信息

Path: /backend/pump-cgm-sys/pumpBolusRatePrepareSetting/getPumpBolusRatePrepareSetting

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

dataobject []非必须返回数据

元素是否都不同: false

item 类型: object

├─ mealPointinteger必须11早餐,2午餐,3晚餐,4加餐

mock: @integer

├─ bolusnumber非必须0.111111大剂量值

mock: @float

├─ userIdstring必须string用户id

mock: @string

├─ namestring非必须名称

泵参数设置

保存泵参数设置

基本信息

Path: /backend/pump-cgm-sys/pumpSetting/savePumpSetting

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
maxBolusstring非必须string最大大剂量

mock: @string

originBasalstring非必须string初始基础率

mock: @string

bolusRatestring非必须大剂量速率
effectiveTimestring非必须string胰岛素有效时间

mock: @string

quickBolusIncrementstring非必须string快速大剂量增量

mock: @string

lowReserveThresholdstring非必须string低药量报警阈值

mock: @string

sensitiveSilverstring非必须string敏感因子

mock: @string

bgRangestring非必须string血糖范围

mock: @string

quickBolusinteger非必须快速大剂量
tempBasalRateinteger非必须临时基础率速率
doubleBolusinteger非必须延长双波大剂量
bolusIncrementstring非必须string大剂量增量

mock: @string

defaultChostring非必须string碳水率

mock: @string

maximumBasalRatestring非必须string最大基础率速率

mock: @string

negativeCorrectioninteger非必须负校正因子
autoDeliverStopinteger非必须自动输注停止
bolusCalculatorSwitchinteger非必须大剂量计算器开关
lowBgstring非必须
highBgstring非必须
basalIncrementstring非必须基础率增量

返回数据

名称类型是否必须默认值备注其他信息
msgstring必须string返回信息

mock: @string

codeinteger必须1返回码

mock: @integer

查询泵参数设置

基本信息

Path: /backend/pump-cgm-sys/pumpSetting/getPumpSetting

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Query

参数名称 是否必须 示例 备注
userId 否 string

返回数据

名称类型是否必须默认值备注其他信息
msgstring必须string返回信息

mock: @string

codeinteger必须1返回码

mock: @integer

dataobject非必须
├─ maxBolusstring非必须string最大大剂量

mock: @string

├─ originBasalstring非必须string初始基础率

mock: @string

├─ bolusRatestring非必须大剂量速率
├─ effectiveTimestring非必须string胰岛素有效时间

mock: @string

├─ quickBolusIncrementstring非必须string快速大剂量增量

mock: @string

├─ lowReserveThresholdstring非必须string低药量报警阈值

mock: @string

├─ sensitiveSilverstring非必须string敏感因子

mock: @string

├─ bgRangestring非必须string血糖范围

mock: @string

├─ quickBolusinteger非必须快速大剂量
├─ tempBasalRateinteger非必须临时基础率速率
├─ doubleBolusinteger非必须延长双波大剂量
├─ bolusIncrementstring非必须string大剂量增量

mock: @string

├─ defaultChostring非必须string碳水率

mock: @string

├─ maximumBasalRatestring非必须string最大基础率速率

mock: @string

├─ negativeCorrectioninteger非必须负校正因子
├─ autoDeliverStopinteger非必须自动输注停止
├─ bolusCalculatorSwitchinteger非必须大剂量计算器开关
├─ lowBgstring非必须
├─ highBgstring非必须
├─ basalIncrementstring非必须基础率增量

事件数据相关

异常说明

基本信息

Path: /backend/pump-cgm-sys/123_1732093763517

Method: GET

接口描述:

code msg 说明
670001 用户id必传 参数缺失。下同。
670002 事件类型必传
670003 sn必传
670004 事件时间必传
670005 时区必传
670006 事件来源必传

请求参数

保存事件

基本信息

Path: /backend/pump-cgm-sys/event/save

Method: POST

接口描述:

event 备注 参数
1 高血糖报警
2 低血糖报警
3 CGMS传感器到达使用期限
4 CGMS传感器剩余寿命%s小时 hourOrDay 剩余多少小时提醒
7 传感器故障
8 血糖快速上升
9 血糖快速下降
10 发射器信号丢失
11 便携式控制器电量耗尽报警
12 PDA信号丢失
13 持续高血糖3小时
100 自动模式手动打开
101 自动模式手动关闭
102 排除留置针空气
105 基础率未设置
108 血糖记录 bloodGlucose 指血值
109 时区更改记录 lastBasalIdOrHistoryId 本地数据库泵体历史记录最大序号,

currentBasalIdOrZonePosition :当前时区序号
110 基础率更换记录 lastBasalIdOrHistoryId 上一次基础率分类序号
currentBasalIdOrZonePosition 当前序号
111 临时基础率取消
112 临时基础率运行 unitOrExtendsTime 单位  ;
bolusRateOrRawValue 单位为U的时候 rate * 160 ,单位为 %为百分比;
durationOrTotalExtends 时间S
totalBolusOrBasalId 当前基础率序号
113 APP日期更改
114 更换底板 hourOrDay; 使用天数 * 10
115 更换储药器 hourOrDay; 使用天数 * 10
116 泵体配对成功
117 泵体解配胰岛素泵
118 CGMS配对成功
119 CGMS解除配对成功
120 推杆定位错误
121 进入监护模式
122 退出监护模式
257 大剂量计算器事件 bgHighLimit 目标血糖上限、
bgLowLimit 目标血糖下限、
carbohydrate 碳水化合物
bloodGlucose 指血值
sensitiveSilver胰岛素敏感系数
defaultCho 碳水化合物系数
effectiveInsulin 活性胰岛素
negativeCorrection 负矫正因子
bolusValue 大剂量推荐值
bolusConfirmValue 大剂量实际输注值
259 碳水化物记录 carbohydratet 碳水化合物 mg
513 大剂量输注记录 totalBolusOrBasalId 大剂量总剂量
bolusRateOrRawValue 大剂量速率 U/s
durationOrTotalExtends 延长量剂量 U
unitOrExtendsTime 延长量时间单位 s

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
recordsobject []非必须

元素是否都不同: false

item 类型: object

├─ durationOrTotalExtendsnumber非必须0.111111临时基础率运行时间或延长量总剂量

mock: @float

├─ effectiveInsulinnumber非必须0.111111活性胰岛素

mock: @float

├─ lastBasalIdOrHistoryIdinteger非必须1上次基础率id或者historyId

mock: @integer

├─ currentBasalIdOrZonePositioninteger非必须1当前基础率序号或者时区序号

mock: @integer

├─ hourOrDayinteger非必须1事件值,类型为4时的小时数,更换底板和储药器记录的天数

mock: @integer

├─ sensitiveSilvernumber非必须0.111111敏感因子

mock: @float

├─ carbohydratenumber非必须0.111111碳水

mock: @float

├─ eventOrigininteger必须10APP,1泵,2CGM.事件来源

mock: @integer

├─ eventTimestring必须string时间

mock: @string

├─ bolusConfirmValuenumber非必须0.111111大剂量确认值

mock: @float

├─ bgHighLimitnumber非必须0.111111目标血糖上限

mock: @float

├─ snstring必须string设备序列号

mock: @string

├─ defaultChonumber非必须0.111111碳水率

mock: @float

├─ eventinteger必须1事件类型

mock: @integer

├─ totalBolusOrBasalIdnumber非必须0.111111大剂量总量或基础率id

mock: @float

├─ negativeCorrectioninteger非必须1负校正因子

mock: @integer

├─ bgLowLimitnumber非必须0.111111目标血糖下限

mock: @float

├─ bolusRateOrRawValuenumber非必须0.111111大剂量速率Us或者临时基础率值

mock: @float

├─ userIdstring必须string

mock: @string

├─ unitOrExtendsTimeinteger非必须1临时基础率单位( 0:U ;1:%)或延长量时间s

mock: @integer

├─ bloodGlucosenumber非必须0.111111指血

mock: @float

├─ eventTimeZonestring必须string时区

mock: @string

├─ bolusValuenumber非必须0.111111大剂量推荐值

mock: @float

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

dataobject []非必须返回数据

元素是否都不同: false

item 类型: object

├─ durationOrTotalExtendsnumber非必须0.111111临时基础率运行时间或延长量总剂量

mock: @float

├─ effectiveInsulinnumber非必须0.111111活性胰岛素

mock: @float

├─ lastBasalIdOrHistoryIdinteger非必须1上次基础率id或者historyId

mock: @integer

├─ currentBasalIdOrZonePositioninteger非必须1当前基础率序号或者时区序号

mock: @integer

├─ hourOrDayinteger非必须1事件值,类型为4时的小时数,更换底板和储药器记录的天数

mock: @integer

├─ sensitiveSilvernumber非必须0.111111敏感因子

mock: @float

├─ carbohydratenumber非必须0.111111碳水

mock: @float

├─ eventOrigininteger必须10APP,1泵,2CGM

mock: @integer

├─ eventTimestring必须string时间

mock: @string

├─ bolusConfirmValuenumber非必须0.111111大剂量确认值

mock: @float

├─ bgHighLimitnumber非必须0.111111目标血糖上限

mock: @float

├─ snstring必须string设备序列号

mock: @string

├─ defaultChonumber非必须0.111111碳水率

mock: @float

├─ eventinteger必须1事件类型

mock: @integer

├─ eventTimestampinteger非必须1时间戳

mock: @integer

├─ totalBolusOrBasalIdnumber非必须0.111111大剂量总量或基础率id

mock: @float

├─ eventIdstring必须stringsn+event+time+zone+origin

mock: @string

├─ negativeCorrectioninteger非必须1负校正因子

mock: @integer

├─ bgLowLimitnumber非必须0.111111目标血糖下限

mock: @float

├─ bolusRateOrRawValuenumber非必须0.111111大剂量速率Us或者临时基础率值

mock: @float

├─ userIdstring必须string

mock: @string

├─ unitOrExtendsTimeinteger非必须1单位或延长量时间s

mock: @integer

├─ bloodGlucosenumber非必须0.111111指血

mock: @float

├─ autoIncrementColumninteger必须1自增列

mock: @integer

├─ eventTimeZonestring必须string时区

mock: @string

├─ bolusValuenumber非必须0.111111大剂量推荐值

mock: @float

分页查询事件

基本信息

Path: /backend/pump-cgm-sys/event/getEventsByPageInfo

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Query

参数名称 是否必须 示例 备注
pageNum 否 1 页码
pageSize 否 100 个数
userId 否 string 用户id,查询自己可以不传递
startAutoIncrementColumn 否 1 起始点
endAutoIncrementColumn 否 1 结束点
orderStrategy 否 string 排序规则

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

dataobject []非必须返回数据

元素是否都不同: false

item 类型: object

├─ durationOrTotalExtendsnumber非必须0.111111临时基础率运行时间或延长量总剂量

mock: @float

├─ effectiveInsulinnumber非必须0.111111活性胰岛素

mock: @float

├─ lastBasalIdOrHistoryIdinteger非必须1上次基础率id或者historyId

mock: @integer

├─ currentBasalIdOrZonePositioninteger非必须1当前基础率序号或者时区序号

mock: @integer

├─ hourOrDayinteger非必须1事件值,类型为4时的小时数,更换底板和储药器记录的天数

mock: @integer

├─ sensitiveSilvernumber非必须0.111111敏感因子

mock: @float

├─ carbohydratenumber非必须0.111111碳水

mock: @float

├─ eventOrigininteger必须10APP,1泵,2CGM

mock: @integer

├─ eventTimestring必须string时间

mock: @string

├─ bolusConfirmValuenumber非必须0.111111大剂量确认值

mock: @float

├─ bgHighLimitnumber非必须0.111111目标血糖上限

mock: @float

├─ snstring必须string设备序列号

mock: @string

├─ defaultChonumber非必须0.111111碳水率

mock: @float

├─ eventinteger必须1事件类型

mock: @integer

├─ eventTimestampinteger非必须1时间戳

mock: @integer

├─ totalBolusOrBasalIdnumber非必须0.111111大剂量总量或基础率id

mock: @float

├─ eventIdstring必须stringsn+event+time+zone+origin

mock: @string

├─ negativeCorrectioninteger非必须1负校正因子

mock: @integer

├─ bgLowLimitnumber非必须0.111111目标血糖下限

mock: @float

├─ bolusRateOrRawValuenumber非必须0.111111大剂量速率Us或者临时基础率值

mock: @float

├─ userIdstring必须string

mock: @string

├─ unitOrExtendsTimeinteger非必须1单位或延长量时间s

mock: @integer

├─ bloodGlucosenumber非必须0.111111指血

mock: @float

├─ autoIncrementColumninteger必须1自增列

mock: @integer

├─ eventTimeZonestring必须string时区

mock: @string

├─ bolusValuenumber非必须0.111111大剂量推荐值

mock: @float

countinteger非必须1返回 数据总数

mock: @integer

获取app信息

获取app的相关信息

基本信息

Path: /backend/pump-cgm-sys/appInformation/getAppInformation

Method: GET

接口描述:

image.png
 目前有的测试数据

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Query

参数名称 是否必须 示例 备注
version 是 string 版本号
softwareModel 是 string app标识

返回数据

名称类型是否必须默认值备注其他信息
msgstring必须string返回信息

mock: @string

codeinteger必须1返回码

mock: @integer

dataobject非必须返回数据
├─ proxyNamestring非必须string代理名

mock: @string

├─ distring非必须stringdi

mock: @string

├─ companyNamestring非必须string公司名

mock: @string

├─ companyAddressstring非必须string公司地址

mock: @string

├─ releaseDatestring非必须string发布日期

mock: @string

├─ pistring非必须stringpi

mock: @string

├─ udistring非必须stringudi

mock: @string

├─ proxyInformationstring非必须string代理信息

mock: @string

├─ cnRegisterNumberstring非必须注册证编号
├─ cnProductNumberstring非必须许可证编号

版本更新相关

查询版本历史

基本信息

Path: /backend/pump-cgm-sys/appVersionControl/v2/passCheckToken/getAppVersionList

Method: GET

接口描述:

资源包以zip的形式保存.

可以用的测试包地址:https://static.pancares.com/vcs/resource/111.zip

image.png
以上各资源文件名固定不变

提供版本清单: version_menu.json

如果版本清单中没有某个资源得版本数据,则表示该资源数据被清空!!!

版本清单里记录当前各个资源得版本 .

示例:{"unit":"2023-06-02 11:09:25","insulin_sys":"2023-06-01 15:31:40","other_sys":"2023-06-01 15:04:21","language":"2023-05-26 14:52:07","exercise_sys":"2023-06-01 15:28:35","food_sys":"2023-06-01 15:32:01","medication_sys":"2023-06-01 15:31:09"."language_conf":"2023-09-08 10:06:00"}

key值固定不变。代表各个资源。
版本号用秒级更新时间戳代替。
语言清单文件名为:language_conf.json,

示例:[{"code":"en","chineseName":"英语","name":"English"},{"code":"zh-Hans-CN","chineseName":"简体中文","name":"简体中文"},{"code":"it","chineseName":"意大利语","name":"Italiano"}]

语言包文件名固定为:language.json,.

示例:[{"key":"10","value":"Datos solicitados incorrectos","language":"es"}]

单位文件名:unit.json 。

示例:[{"name":"U","value":0,"eventType":4,"isDefault":0,"ratio":1,"updateTime":"2023-06-08 16:12:54"},{"name":"min","value":0,"eventType":3,"isDefault":0,"ratio":1,"updateTime":"2023-06-08 16:13:03"},{"name":"h","value":1,"eventType":3,"isDefault":1,"ratio":60,"updateTime":"2023-06-08 16:12:59"},{"name":"mg","value":0,"eventType":2,"isDefault":0,"ratio":1,"updateTime":"2023-06-08 16:13:14"},{"name":"g","value":1,"eventType":2,"isDefault":1,"ratio":1000,"updateTime":"2023-06-08 16:13:16"},{"name":"piece","value":2,"eventType":2,"isDefault":1,"ratio":0.2,"updateTime":"2023-06-08 16:14:05"},{"name":"capsule","value":3,"eventType":2,"isDefault":1,"ratio":0.5,"updateTime":"2023-06-08 16:14:01"},{"name":"g","value":0,"eventType":1,"isDefault":0,"ratio":1,"updateTime":"2023-06-08 16:14:11"},{"name":"kg","value":1,"eventType":1,"isDefault":1,"ratio":1000,"updateTime":"2023-06-08 16:14:15"},{"name":"mL","value":2,"eventType":1,"isDefault":1,"ratio":1,"updateTime":"2023-06-08 16:14:17"},{"name":"L","value":3,"eventType":1,"isDefault":1,"ratio":1000,"updateTime":"2023-06-08 16:14:19"},{"name":"两","value":4,"eventType":1,"isDefault":1,"ratio":50,"language":"zh-Hans-CN","updateTime":"2023-06-08 16:45:50"},{"name":"斤","value":5,"eventType":1,"isDefault":1,"ratio":500,"language":"zh-Hans-CN","updateTime":"2023-06-08 16:45:53"}]

isDefault:   0表示默认单位
ratio:   对默认单位得比率
name:展示值
value:数据记录值
eventType:事件类型  1,饮食,2用药,3运动,4胰岛素
language: 语言特有得单位。如果该字段不存在,则表示通用单位。该语言id与国际化得语言id保持一致。

用药预设:medication_sys.json
示例:
[{"medicationSysPresetId":1,"language":"zh-Hans-CN","categoryName":"磺脲类胰岛素促泌剂","name":"格列本脲片","tradeName":"优降糖","updateTime":"2023-06-01 15:31:09"},{"medicationSysPresetId":2,"language":"zh-Hans-CN","categoryName":"磺脲类胰岛素促泌剂","name":"格列本脲片","manufacturer":"金石","updateTime":"2023-06-01 15:31:09"},{"medicationSysPresetId":3,"language":"zh-Hans-CN","categoryName":"磺脲类胰岛素促泌剂","name":"格列本脲片","manufacturer":"常乐","updateTime":"2023-06-01 15:31:09"},{"medicationSysPresetId":4,"language":"zh-Hans-CN","categoryName":"磺脲类胰岛素促泌剂","name":"格列本脲片","manufacturer":"三才石岐","updateTime":"2023-06-01 15:31:09"},{"medicationSysPresetId":5,"language":"zh-Hans-CN","categoryName":"磺脲类胰岛素促泌剂","name":"格列本脲片","manufacturer":"云鹏","updateTime":"2023-06-01 15:31:09"},{"medicationSysPresetId":6,"language":"zh-Hans-CN","categoryName":"磺脲类胰岛素促泌剂","name":"格列本脲片","manufacturer":"汾河","updateTime":"2023-06-01 15:31:09"},{"medicationSysPresetId":7,"language":"zh-Hans-CN","categoryName":"磺脲类胰岛素促泌剂","name":"格列本脲片","manufacturer":"太平洋","updateTime":"2023-06-01 15:31:09"},{"medicationSysPresetId":8,"language":"zh-Hans-CN","categoryName":"磺脲类胰岛素促泌剂","name":"格列本脲片","manufacturer":"瑞阳","updateTime":"2023-06-01 15:31:09"},{"medicationSysPresetId":9,"language":"zh-Hans-CN","categoryName":"磺脲类胰岛素促泌剂","name":"格列本脲片","manufacturer":"西南药业","updateTime":"2023-06-01 15:31:09"},{"medicationSysPresetId":10,"language":"zh-Hans-CN","categoryName":"磺脲类胰岛素促泌剂","name":"格列本脲片","manufacturer":"扬州艾迪","updateTime":"2023-06-01 15:31:09"}]

运动:exercise_sys.json
[{"exerciseSysPresetId":1,"name":"慢走(3km/h)","language":"zh-Hans-CN","intensityCategoryName":"低","hourKcalPerKg":2.63,"updateTime":"2023-06-01 15:28:34"},{"exerciseSysPresetId":2,"name":"中速走(4km/h)","language":"zh-Hans-CN","intensityCategoryName":"中","hourKcalPerKg":3.15,"updateTime":"2023-06-01 15:28:34"},{"exerciseSysPresetId":3,"name":"自然走(4.8km/h)","language":"zh-Hans-CN","intensityCategoryName":"中","hourKcalPerKg":3.47,"updateTime":"2023-06-01 15:28:34"},{"exerciseSysPresetId":4,"name":"快步走(5.6km/h)","language":"zh-Hans-CN","intensityCategoryName":"中","hourKcalPerKg":4.2,"updateTime":"2023-06-01 15:28:34"},{"exerciseSysPresetId":5,"name":"竞走(6.4km/h)","language":"zh-Hans-CN","intensityCategoryName":"中","hourKcalPerKg":5.25,"updateTime":"2023-06-01 15:28:34"},{"exerciseSysPresetId":6,"name":"慢跑","language":"zh-Hans-CN","intensityCategoryName":"高","hourKcalPerKg":7.35,"updateTime":"2023-06-01 15:28:34"},{"exerciseSysPresetId":7,"name":"跑步(8km/h)","language":"zh-Hans-CN","intensityCategoryName":"高","hourKcalPerKg":8.4,"updateTime":"2023-06-01 15:28:34"},{"exerciseSysPresetId":8,"name":"跑步(9.6km/h)","language":"zh-Hans-CN","intensityCategoryName":"高","hourKcalPerKg":10.5,"updateTime":"2023-06-01 15:28:34"},{"exerciseSysPresetId":9,"name":"走跑结合(慢跑时间<10min)","language":"zh-Hans-CN","intensityCategoryName":"高","hourKcalPerKg":6.3,"updateTime":"2023-06-01 15:28:34"},{"exerciseSysPresetId":10,"name":"步行下楼","language":"zh-Hans-CN","intensityCategoryName":"中","hourKcalPerKg":3.15,"updateTime":"2023-06-01 15:28:35"}]

饮食:food_sys.json
[{"foodSysPresetId":375,"name":"茄子(紫皮,长)","language":"zh-Hans-CN","categoryName":"蔬菜类","energyKcal":23,"protein":1,"fat":0.1,"carbohydrate":5.4,"quantity":100,"unit":0,"updateTime":"2023-06-06 16:40:48"},{"foodSysPresetId":376,"name":"香瓜茄","language":"zh-Hans-CN","categoryName":"蔬菜类","energyKcal":17,"protein":0.6,"fat":0,"carbohydrate":5.5,"quantity":100,"unit":0,"updateTime":"2023-06-06 16:40:48"},{"foodSysPresetId":377,"name":"番茄[西红柿]","language":"zh-Hans-CN","categoryName":"蔬菜类","energyKcal":20,"protein":0.9,"fat":0.2,"carbohydrate":4,"quantity":100,"unit":0,"updateTime":"2023-06-06 16:40:48"},{"foodSysPresetId":378,"name":"樱桃番茄[小西红柿]","language":"zh-Hans-CN","categoryName":"蔬菜类","energyKcal":22,"protein":1,"fat":0.2,"carbohydrate":5.8,"quantity":100,"unit":0,"updateTime":"2023-06-06 16:40:48"},{"foodSysPresetId":379,"name":"番茄(整个,罐头)","language":"zh-Hans-CN","categoryName":"蔬菜类","energyKcal":22,"protein":2,"fat":0.6,"carbohydrate":2.6,"quantity":100,"unit":0,"updateTime":"2023-06-06 16:40:49"},{"foodSysPresetId":380,"name":"奶柿子[西红柿]","language":"zh-Hans-CN","categoryName":"蔬菜类","energyKcal":15,"protein":0.6,"fat":0.1,"carbohydrate":3.2,"quantity":100,"unit":0,"updateTime":"2023-06-06 16:40:49"},{"foodSysPresetId":381,"name":"辣椒(红,尖,干)","language":"zh-Hans-CN","categoryName":"蔬菜类","energyKcal":295,"protein":15,"fat":12,"carbohydrate":52.7,"quantity":100,"unit":0,"updateTime":"2023-06-06 16:40:49"},{"foodSysPresetId":382,"name":"辣椒(红,小)","language":"zh-Hans-CN","categoryName":"蔬菜类","energyKcal":38,"protein":1.3,"fat":0.4,"carbohydrate":8.9,"quantity":100,"unit":0,"updateTime":"2023-06-06 16:40:49"},{"foodSysPresetId":383,"name":"辣椒(青,尖)","language":"zh-Hans-CN","categoryName":"蔬菜类","energyKcal":27,"protein":1.4,"fat":0.3,"carbohydrate":5.8,"quantity":100,"unit":0,"updateTime":"2023-06-06 16:40:49"},{"foodSysPresetId":384,"name":"甜椒[灯笼椒,柿子椒]","language":"zh-Hans-CN","categoryName":"蔬菜类","energyKcal":25,"protein":1,"fat":0.2,"carbohydrate":5.4,"quantity":100,"unit":0,"updateTime":"2023-06-06 16:40:49"},{"foodSysPresetId":385,"name":"甜椒(脱水)","language":"zh-Hans-CN","categoryName":"蔬菜类","energyKcal":324,"protein":7.6,"fat":0.4,"carbohydrate":76.6,"quantity":100,"unit":0,"updateTime":"2023-06-06 16:40:49"},{"foodSysPresetId":386,"name":"葫子","language":"zh-Hans-CN","categoryName":"蔬菜类","energyKcal":29,"protein":0.7,"fat":0.1,"carbohydrate":6.8,"quantity":100,"unit":0,"updateTime":"2023-06-06 16:40:49"},{"foodSysPresetId":387,"name":"秋葵[黄秋葵,羊角豆]","language":"zh-Hans-CN","categoryName":"蔬菜类","energyKcal":45,"protein":2,"fat":0.1,"carbohydrate":11,"quantity":100,"unit":0,"updateTime":"2023-06-06 16:40:49"},{"foodSysPresetId":388,"name":"白瓜","language":"zh-Hans-CN","categoryName":"蔬菜类","energyKcal":12,"protein":0.9,"fat":0,"carbohydrate":2.6,"quantity":100,"unit":0,"updateTime":"2023-06-06 16:40:49"},{"foodSysPresetId":389,"name":"菜瓜[生瓜,白瓜]","language":"zh-Hans-CN","categoryName":"蔬菜类","energyKcal":19,"protein":0.6,"fat":0.2,"carbohydrate":3.9,"quantity":100,"unit":0,"updateTime":"2023-06-06 16:40:49"},{"foodSysPresetId":390,"name":"冬瓜","language":"zh-Hans-CN","categoryName":"蔬菜类","energyKcal":12,"protein":0.4,"fat":0.2,"carbohydrate":2.6,"quantity":100,"unit":0,"updateTime":"2023-06-06 16:40:49"},{"foodSysPresetId":391,"name":"方瓜","language":"zh-Hans-CN","categoryName":"蔬菜类","energyKcal":14,"protein":0.8,"fat":0,"carbohydrate":3.1,"quantity":100,"unit":0,"updateTime":"2023-06-06 16:40:49"},{"foodSysPresetId":392,"name":"佛手瓜[棒瓜,菜肴梨]","language":"zh-Hans-CN","categoryName":"蔬菜类","energyKcal":19,"protein":1.2,"fat":0.1,"carbohydrate":3.8,"quantity":100,"unit":0,"updateTime":"2023-06-06 16:40:49"}]

胰岛素 insulin_sys.json
[{"insulinSysPresetId":1,"categoryName":"超速效胰岛素","name":"速效门冬胰岛素","language":"zh-Hans-CN","tradeName":"Fiasp","manufacturer":"诺和诺德","comment":"中国正在做临床","updateTime":"2023-06-01 15:31:40"},{"insulinSysPresetId":2,"categoryName":"超速效胰岛素","name":"赖脯胰岛素","language":"zh-Hans-CN","manufacturer":"通化东宝","comment":"中国正在做临床","updateTime":"2023-06-01 15:31:40"},{"insulinSysPresetId":3,"categoryName":"速效胰岛素类似物","name":"门冬胰岛素","language":"zh-Hans-CN","tradeName":"诺和锐","manufacturer":"诺和诺德","updateTime":"2023-06-01 15:31:40"},{"insulinSysPresetId":4,"categoryName":"速效胰岛素类似物","name":"门冬胰岛素","language":"zh-Hans-CN","tradeName":"锐秀霖","manufacturer":"甘李","updateTime":"2023-06-01 15:31:40"},{"insulinSysPresetId":5,"categoryName":"速效胰岛素类似物","name":"门冬胰岛素","language":"zh-Hans-CN","tradeName":"锐舒霖","manufacturer":"通化东宝","updateTime":"2023-06-01 15:31:40"},{"insulinSysPresetId":6,"categoryName":"速效胰岛素类似物","name":"门冬胰岛素","language":"zh-Hans-CN","tradeName":"优倍灵","manufacturer":"联邦","updateTime":"2023-06-01 15:31:40"},{"insulinSysPresetId":7,"categoryName":"速效胰岛素类似物","name":"赖脯胰岛素","language":"zh-Hans-CN","tradeName":"优泌乐","manufacturer":"礼来","updateTime":"2023-06-01 15:31:40"},{"insulinSysPresetId":8,"categoryName":"速效胰岛素类似物","name":"重组赖脯胰岛素","language":"zh-Hans-CN","tradeName":"速秀霖","manufacturer":"甘李","updateTime":"2023-06-01 15:31:40"},{"insulinSysPresetId":9,"categoryName":"速效胰岛素类似物","name":"谷赖胰岛素","language":"zh-Hans-CN","tradeName":"艾倍得","manufacturer":"赛诺菲","updateTime":"2023-06-01 15:31:40"},{"insulinSysPresetId":10,"categoryName":"短效胰岛素","name":"生物合成人胰岛素","language":"zh-Hans-CN","tradeName":"诺和灵R","manufacturer":"诺和","updateTime":"2023-06-01 15:31:40"},{"insulinSysPresetId":11,"categoryName":"短效胰岛素","name":"Willow insulin","language":"en","tradeName":"诺和灵R","manufacturer":"诺和","updateTime":"2023-02-14 17:10:40"},{"insulinSysPresetId":12,"categoryName":"短效胰岛素","name":"Moxian Castle insulin","language":"en","tradeName":"诺和灵R","manufacturer":"诺和","updateTime":"2023-02-15 15:52:41"},{"insulinSysPresetId":13,"categoryName":"短效胰岛素","name":"Takamagahara insulin","language":"en","tradeName":"诺和灵R","manufacturer":"诺和","updateTime":"2023-02-15 15:52:47"},{"insulinSysPresetId":14,"categoryName":"短效胰岛素","name":"Petit-déjeuné ","language":"fr","tradeName":"Dinner ","manufacturer":"Dinner ","updateTime":"2023-02-16 16:13:21"},{"insulinSysPresetId":15,"categoryName":"短效胰岛素","name":"Réglages","language":"fr","tradeName":"Dinner ","manufacturer":"Dinner ","updateTime":"2023-02-16 16:16:54"},{"insulinSysPresetId":16,"categoryName":"短效胰岛素","name":"Protéines ","language":"fr","tradeName":"Dinner ","manufacturer":"Dinner ","updateTime":"2023-02-16 16:14:36"}]

其他  other_sys.json
[{"otherDiseasesSysId":1,"name":"HighBloodPressure","language":"en","updateTime":"2023-06-01 15:04:21"},{"otherDiseasesSysId":2,"name":"高血压","language":"zh","updateTime":"2023-06-01 15:04:21"},{"otherDiseasesSysId":3,"name":"高脂血症","language":"zh","updateTime":"2023-06-01 15:04:21"}]



所有数据得updateTime为数据库更新时间,这里为冗余查询,可自行处理。

请求参数

Query

参数名称 是否必须 示例 备注
appId 是
project 是
os 是
appVersion 是 1.0.0 app当前版本
resourceVersion 是 1.0.0 资源当前版本

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
msgstring必须
dataobject非必须
├─ appUpdateInfoobject非必须
├─ isForceboolean必须全局是否强制true强制
├─ infoobject必须
├─ configIdstring必须
├─ downloadpathstring必须
├─ versionstring必须
├─ descriptionstring非必须
├─ sha256string非必须校验值。使用的是sha2-256生成的hex值.默认空串
├─ resourceUpdateInfoobject非必须
├─ isForceboolean必须全局是否强制
├─ infoobject必须
├─ configIdstring必须
├─ downloadpathstring必须
├─ versionstring必须
├─ descriptionstring非必须
├─ sha256string非必须校验值。使用的是sha2-256生成的hex值.默认空串

数据分享授权

返回值说明

基本信息

Path: /backend/pump-cgm-sys/us12321

Method: GET

接口描述:

code data 说明
200500 修改得时候id必传
200501 查看者用户名必传(手机,邮箱二选一)
200502 用户不存在
200503 不要分享给自己
200504 已经分享过了
200505 用户未授权查看数据

请求参数

返回数据

名称类型是否必须默认值备注其他信息

分享数据(非批量接口)

基本信息

Path: /backend/pump-cgm-sys/userAuthorization/saveOrUpdateUserAuthorization

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
readerAliasstring非必须string分享人给查看者设置的昵称

mock: @string

hideStateinteger非必须0是否隐藏,隐藏同时关闭所有推送 默认0.开

枚举: 1,0

mock: @integer

emergePushStateinteger非必须0紧急推送开关 默认0开

枚举: 0,1

mock: @integer

readerUserNamestring必须string冗余得数据查看者用户名

mock: @string

normalPushStateinteger非必须0普通是否推送 默认0开

枚举: 0,1

mock: @integer

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

删除分享关系

基本信息

Path: /backend/pump-cgm-sys/userAuthorization/deleteByIds

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
idsstring []非必须

元素是否都不同: false

item 类型: string

├─ 非必须string

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

分页查询

基本信息

Path: /backend/pump-cgm-sys/userAuthorization/findUserAuthorizationList

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Query

参数名称 是否必须 示例 备注
pageNum 否 1 分页参数
pageSize 否 100 分页参数
userId 否 用户id,查自己不需要传递
startAutoIncrementColumn 否 大于等于,自增列
endAutoIncrementColumn 否 小于等于,自增列
orderStrategy 否 排序顺序,默认倒叙
type 否 0 0查分享,不传或其他值则为关注

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

dataobject []非必须返回数据

元素是否都不同: false

item 类型: object

├─ providerAliasstring非必须string数据提供者的昵称。在关注列表中展示

mock: @string

├─ dataReaderIdstring非必须string查看者userID

mock: @string

├─ emergePushStateinteger非必须0紧急推送开关

mock: @integer

├─ dataProviderIdstring非必须string授权者userID

mock: @string

├─ userAuthorizationIdstring必须string主键

mock: @string

├─ userTrendobject非必须
├─ appTimestring非必须string时间

mock: @string

├─ trendnumber非必须趋势-99 未知,无趋势 -3 快速下降 -2 下降 -1 缓慢下降 0 平稳 1 缓慢上升 2 上升 3 快速上升
├─ trendValuenumber非必须趋势值。两位浮点数
├─ trendIdstring非必须string

mock: @string

├─ dstOffsetstring非必须string偏移量

mock: @string

├─ userIdstring非必须string用户id

mock: @string

├─ appTimeZonestring非必须string时区

mock: @string

├─ bloodGlucosenumber非必须0.111111值

mock: @float

├─ statusnumber非必须

mock: @integer

├─ historyStatusnumber非必须
├─ calTempnumber非必须
├─ readerAliasstring非必须string数据查看者的昵称,在分享列表中展示

mock: @string

├─ providerUserNamestring非必须string冗余得数据提供者用户名,在关注列表中没有昵称展示此名称

mock: @string

├─ hideStateinteger非必须0是否隐藏,隐藏同时关闭所有推送

mock: @integer

├─ cgmDeviceobject非必须我的关注列表,设备信息
├─ sensorIndexinteger非必须1

mock: @integer

├─ registerTimestring非必须2023-06-16 13:09:17启用时间

mock: @timestamp

├─ startUpTimeZonestring必须string

mock: @string

├─ deviceKeynumber必须1设备密钥文件

mock: @byte

├─ sensorStartUpstring必须2023-06-16 13:09:17

mock: @timestamp

├─ dstOffsetstring非必须string夏令时偏移量

mock: @string

├─ deviceIdstring必须string主键

mock: @string

├─ userIdstring非必须string外键:tbl_user.pk_id

mock: @string

├─ deviceSnstring必须string设备sn

mock: @string

├─ sensorIdstring必须string

mock: @string

├─ etinteger非必须1传感器有效期

mock: @integer

├─ isForceReplacebool非必须false

mock: @boolean

├─ unregisterTimestring非必须2023-06-16 13:09:17停用时间

mock: @timestamp

├─ deviceMacstring必须string设备mac地址

mock: @string

├─ deviceModelstring必须string设备型号

mock: @string

├─ sensorErrorTimeOffsetstring必须默认0,0正常,请更换传感器状态时间偏移量
├─ autoIncrementColumninteger非必须1自增列

mock: @integer

├─ readerUserNamestring必须string冗余得数据查看者用户名,在分享列表中没有昵称展示此名称

mock: @string

├─ normalPushStateinteger非必须0普通是否推送

mock: @integer

├─ informationobject非必须用户信息,分享列表就是数据查看者信息,关注列表就是数据提供者信息
├─ genderinteger非必须1性别

mock: @integer

├─ complicationsstring非必须string并发症(多选); 0无,1心血管并发症,2视网膜病变,3神经病变,4肾病,5糖尿病足,99其他

mock: @string

├─ openidstring非必须string微信id

mock: @string

├─ givenNamestring非必须string名

mock: @string

├─ diagnosisDatestring非必须2023-06-16 13:09:17确诊时间

mock: @timestamp

├─ diabetesTypeinteger非必须1糖尿病类型

mock: @integer

├─ avatarstring非必须string

mock: @string

├─ cidOrigininteger必须1

mock: @integer

├─ userIdstring非必须string外键:tbl_user.pk_id

mock: @string

├─ birthDatestring非必须string出生日期

mock: @string

├─ phonestring非必须string

mock: @string

├─ userInformationIdstring非必须string

mock: @string

├─ surnamestring非必须string姓

mock: @string

├─ getuiCidstring必须string个推id

mock: @string

├─ namestring非必须string名称

mock: @string

├─ middleNamestring非必须string中间名

mock: @string

├─ bodyWeightnumber非必须0.111111体重

mock: @float

├─ emailstring非必须string

mock: @string

├─ heightnumber非必须0.111111身高

mock: @float

├─ userSettingobject非必须关注列表返回;所有的开关默认都是0开启的,所有的提醒方式默认都是1声音2震动3声音震动 默认3
├─ userSettingIdstring非必须设置id
├─ userIdstring非必须用户id
├─ languagestring非必须语言,国际化缩写
├─ timeZonestring非必须时区id。字符串的。例子:Asia/Shanghai
├─ unitnumber非必须单位,0mmol,1mg 。默认0
├─ themenumber非必须主题,0深1浅 默认1
├─ alertTypenumber非必须提醒方式,1声音2震动3声音震动 默认3 下同
├─ alertRatenumber非必须提醒频率。单位分钟
├─ lowAlertSwitchnumber非必须低血糖提醒开关,0开启1关闭。
├─ lowLimitMgnumber非必须低血糖阈值,默认72
├─ highAlertSwitchnumber非必须高血糖开关
├─ highLimitMgnumber非必须高血糖阈值,默认180
├─ fastUpSwitchnumber非必须快速上升开关
├─ fastDownSwitchnumber非必须快速下降开关
├─ urgentLowAlertSwitchnumber非必须紧急低血糖开关
├─ urgentLowMgnumber非必须同上 默认54
├─ urgentAlertTypenumber非必须紧急低血糖提醒方式
├─ urgentAlertRatenumber非必须紧急低血糖频率
├─ signalMissingSwitchnumber非必须信号丢失提醒开关
├─ signalMissingAlertTypenumber非必须丢失提醒方式
├─ signalMissingAlertRatenumber非必须丢失提醒频率
├─ dataShowTypestring非必须
countinteger非必须1返回 数据总数

mock: @integer

通过授权id查授权信息

基本信息

Path: /backend/pump-cgm-sys/userAuthorization/findAuthorizationInfoById

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Query

参数名称 是否必须 示例 备注
authorizationId 否 string

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

dataobject非必须返回数据
├─ providerAliasstring非必须string数据提供者的昵称。在关注列表中展示

mock: @string

├─ dataReaderIdstring非必须string查看者userID

mock: @string

├─ emergePushStateinteger非必须0紧急推送开关

mock: @integer

├─ dataProviderIdstring非必须string授权者userID

mock: @string

├─ userAuthorizationIdstring必须string主键

mock: @string

├─ userTrendobject非必须
├─ appTimestring非必须string时间

mock: @string

├─ trendstring非必须string趋势

mock: @string

├─ trendIdstring非必须string

mock: @string

├─ dstOffsetstring非必须string偏移量

mock: @string

├─ userIdstring非必须string用户id

mock: @string

├─ appTimeZonestring非必须string时区

mock: @string

├─ bloodGlucosenumber非必须0.111111值

mock: @float

├─ readerAliasstring非必须string数据查看者的昵称,在分享列表中展示

mock: @string

├─ providerUserNamestring非必须string冗余得数据提供者用户名,在关注列表中没有昵称展示此名称

mock: @string

├─ hideStateinteger非必须0是否隐藏,隐藏同时关闭所有推送

mock: @integer

├─ cgmDeviceobject非必须我的关注列表,设备信息
├─ sensorIndexinteger非必须1

mock: @integer

├─ registerTimestring非必须2023-07-05 14:04:39启用时间

mock: @timestamp

├─ startUpTimeZonestring必须string

mock: @string

├─ deviceKeynumber必须1设备密钥文件

mock: @byte

├─ sensorStartUpstring必须2023-07-05 14:04:39

mock: @timestamp

├─ dstOffsetstring非必须string夏令时偏移量

mock: @string

├─ deviceIdstring必须string主键

mock: @string

├─ userIdstring非必须string外键:tbl_user.pk_id

mock: @string

├─ deviceSnstring必须string设备sn

mock: @string

├─ sensorIdstring必须string

mock: @string

├─ etinteger非必须1传感器有效期

mock: @integer

├─ isForceReplacebool非必须false

mock: @boolean

├─ unregisterTimestring非必须2023-07-05 14:04:39停用时间

mock: @timestamp

├─ deviceMacstring必须string设备mac地址

mock: @string

├─ deviceModelstring必须string设备型号

mock: @string

├─ autoIncrementColumninteger非必须1自增列

mock: @integer

├─ readerUserNamestring非必须string冗余得数据查看者用户名,在分享列表中没有昵称展示此名称

mock: @string

├─ normalPushStateinteger非必须0普通是否推送

mock: @integer

├─ informationobject非必须用户信息,分享列表就是数据查看者信息,关注列表就是数据提供者信息
├─ genderinteger非必须1性别

mock: @integer

├─ complicationsstring非必须string并发症(多选); 0无,1心血管并发症,2视网膜病变,3神经病变,4肾病,5糖尿病足,99其他

mock: @string

├─ openidstring非必须string微信id

mock: @string

├─ givenNamestring非必须string名

mock: @string

├─ diagnosisDatestring非必须2023-07-05 14:04:39确诊时间

mock: @timestamp

├─ diabetesTypeinteger非必须1糖尿病类型

mock: @integer

├─ avatarstring非必须string

mock: @string

├─ cidOrigininteger必须1

mock: @integer

├─ userIdstring非必须string外键:tbl_user.pk_id

mock: @string

├─ birthDatestring非必须string出生日期

mock: @string

├─ phonestring非必须string

mock: @string

├─ userInformationIdstring非必须string

mock: @string

├─ surnamestring非必须string姓

mock: @string

├─ getuiCidstring必须string个推id

mock: @string

├─ namestring非必须string名称

mock: @string

├─ middleNamestring非必须string中间名

mock: @string

├─ bodyWeightnumber非必须0.111111体重

mock: @float

├─ emailstring非必须string

mock: @string

├─ heightnumber非必须0.111111身高

mock: @float

├─ userSettingobject非必须所有的开关默认都是0开启的,所有的提醒方式默认都是1声音2震动3声音震动 默认3
├─ userSettingIdstring非必须设置id
├─ userIdstring非必须用户id
├─ languagestring非必须语言,国际化缩写
├─ timeZonestring非必须时区id。字符串的。例子:Asia/Shanghai
├─ unitnumber非必须单位,0mmol,1mg 。默认0
├─ themenumber非必须主题,0深1浅 默认1
├─ alertTypenumber非必须提醒方式,1声音2震动3声音震动 默认3 下同
├─ alertRatenumber非必须提醒频率。单位分钟
├─ lowAlertSwitchnumber非必须低血糖提醒开关,0开启1关闭。
├─ lowLimitMgnumber非必须低血糖阈值,默认72
├─ highAlertSwitchnumber非必须高血糖开关
├─ highLimitMgnumber非必须高血糖阈值,默认180
├─ fastUpSwitchnumber非必须快速上升开关
├─ fastDownSwitchnumber非必须快速下降开关
├─ urgentLowAlertSwitchnumber非必须紧急低血糖开关
├─ urgentLowMgnumber非必须同上 默认54
├─ urgentAlertTypenumber非必须紧急低血糖提醒方式
├─ urgentAlertRatenumber非必须紧急低血糖频率
├─ signalMissingSwitchnumber非必须信号丢失提醒开关
├─ signalMissingAlertTypenumber非必须丢失提醒方式
├─ signalMissingAlertRatenumber非必须丢失提醒频率

修改授权数据。开关通知,设置昵称等

基本信息

Path: /backend/pump-cgm-sys/userAuthorization/updateAuthorizationInfo

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body

名称类型是否必须默认值备注其他信息
providerAliasstring非必须string数据提供者的昵称。

mock: @string

readerAliasstring非必须string数据查看者的昵称。

mock: @string

hideStateinteger非必须0是否隐藏,隐藏同时关闭所有推送

mock: @integer

emergePushStateinteger非必须0紧急推送开关

mock: @integer

normalPushStateinteger非必须0普通是否推送

mock: @integer

userAuthorizationIdstring必须string主键

mock: @string

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

获取前端缓存数据的用户最大个数

基本信息

Path: /backend/pump-cgm-sys/userAuthorization/getClientDataCacheCount

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

datanumber非必须1个数

mock: @integer

推送相关

保存cid

基本信息

Path: /backend/pump-cgm-sys/user/getuiLogin

Method: POST

接口描述:

code data 说明
100007 cid必传
100008 origin来源必传





**个推测试appId:   ****nwQJTPvYSL86k4zuAkbUC1 **

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是 application/json

Query

参数名称 是否必须 示例 备注
userId 否

Body

名称类型是否必须默认值备注其他信息
getuiCidstring必须string个推id

mock: @string

cidOriginnumber必须来源,默认0,0测试,1国内 ,2国际mg 3国际mmol 会有增加,可以到个推矩阵中查看更多

返回数据

名称类型是否必须默认值备注其他信息
codestring必须
msgstring必须

通知和透传结构体

基本信息

Path: /backend/pump-cgm-sys/111

Method: GET

接口描述:

返回的透传消息为转义过的json字符串

因推送量的限制。cgm数据暂不进行透传,只发送高低血糖通知(IOS特殊对待,会发送个推渠道的透传,消息体里会有title和content)。而指血、事件只推送更新(删除),不推送添加。

msgType对应各自的事件结构。这是定义好的:-1,cgm数据无效,0cgm一般数据,1.cgm 高血糖,2.cgm低血糖,3紧急低,4饮食事件变更,5运动事件变更,6用药事件变更,7胰岛素事件变更,8其他事件变更,9指血数据变更, 10日志拉取

运动事件结构:
{"msgType":5,"detail":"{"deleteFlag":"1","appTime":"2023-06-29 00:00:00","exerciseId":"123","createTime":"2023-06-29 17:11:33.0","dstOffset":"1","autoIncrementColumn":"1750","updateTime":"2023-07-03 14:03:09.0","userId":"de84660965076704164eaa3c762f583d","appTimeZone":"Asia/Shanghai"}"}

用药事件结构:
{"msgType":6,"detail":"{"deleteFlag":"1","appTime":"2023-06-02 14:43:55","medicationId":"01ed3b58da0049c69253cddd3ba4da8f","createTime":"2023-06-02 16:10:24.0","dstOffset":"0","autoIncrementColumn":"1","updateTime":"2023-07-03 14:30:02.0","userId":"de84660965076704164eaa3c762f583d","appTimeZone":"Asia/Shanghai","moment":"0"}"}

饮食事件结构:
{"msgType":4,"detail":"{"deleteFlag":"1","appTime":"2023-06-12 17:23:02","createTime":"2023-06-12 17:26:21.0","foodId":"2239d6a6026b416a86372bca1f8d7fc1","dstOffset":"0","autoIncrementColumn":"210","updateTime":"2023-07-03 14:28:41.0","userId":"de84660965076704164eaa3c762f583d","appTimeZone":"Asia/Shanghai","moment":"3"}"}

胰岛素结构:
{"msgType":7,"detail":"{"deleteFlag":"1","appTime":"2023-06-02 13:30:00","createTime":"2023-06-02 16:24:36.0","dstOffset":"0","autoIncrementColumn":"1","updateTime":"2023-07-03 14:32:27.0","insulinId":"2031c01e808e4ca2963e537ea654b253","userId":"de84660965076704164eaa3c762f583d","appTimeZone":"Asia/Shanghai","moment":"0"}"}

其他事件结构:
{"msgType":8,"detail":"{"deleteFlag":"1","appTime":"2023-06-02 14:07:42","otherId":"2fdfc9f4324642488beadb80fde97c7a","createTime":"2023-06-02 14:41:05.0","dstOffset":"0","autoIncrementColumn":"1","updateTime":"2023-07-03 14:39:16.0","userId":"de84660965076704164eaa3c762f583d","content":"ddddddd","appTimeZone":"Asia/Shanghai"}"}

指血结构:
{"msgType":9,"detail":"{"appTime":"2023-06-13 17:00:42","createTime":"2023-06-13 18:08:04.0","dstOffset":"0","autoIncrementColumn":"138","updateTime":"2023-07-03 15:48:00.0","state":"1","bloodGlucoseMg":"396.0","bloodGlucoseId":"c85c7fd37b1948eb9db6924bb9ce20ca","userId":"de84660965076704164eaa3c762f583d","testTag":"5","appTimeZone":"Asia/Shanghai"}"}

日志拉取:
{"msgType":10}



通知中payload的结构体:因为是批量通知,所以会将所有通知接收者的userId和对应分享关系的id进行传递。

userId:   通知接收者的userId,
userAuthorizationId:  该通知对应的分享关系id.

{
    “userId”:“userAuthorizationId”
}

请求参数

返回数据

名称类型是否必须默认值备注其他信息

OTA相关接口

获取OTA设置信息

基本信息

Path: /backend/pump-cgm-sys/otaSetting/getLastVersionOtaSettingFile

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

dataobject []非必须返回数据

元素是否都不同: false

item 类型: object

├─ sha256string必须string校验码

mock: @string

├─ ossFileUrlstring必须string下载路径

mock: @string

├─ settingTypestring必须string类型的分类,枚举:1034_GX01S等

mock: @string

├─ versionstring必须string版本号,没有第四位,第四位不使用

mock: @string

├─ fileTypeinteger必须1文件类型,1软件

mock: @integer

├─ md5string必须string检验码

mock: @string

├─ aidexVersionstring必须二代是X 1代是G7

mock: @string

├─ settingVersionstring必须配置版本号

mock: @string

├─ settingContentstring必须配置内容

mock: @string

获取配置的最新变更时间

基本信息

Path: /backend/pump-cgm-sys/otaSetting/getOtaSettingLastUpdateTime

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

返回数据

名称类型是否必须默认值备注其他信息
msgstring必须string返回信息

mock: @string

codeinteger必须1返回码

mock: @integer

datastring非必须时间值

保存ota结果,没有约束和校验。

基本信息

Path: /backend/pump-cgm-sys/otaSetting/saveOtaResultBatch

Method: POST

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Body



名称类型是否必须默认值备注其他信息
recordsobject []非必须

元素是否都不同: false

item 类型: object

├─ resultstring非必须string结果.OTA:F/S/NA,SETTING:F/S/NA 。两个更新内容,F标识失败,S标识成功,NA标识未执行(无需升级)。 例如:OTA成功,配置失败的情况传值: OTA:S,SETTING:F OTA成功,配置无需升级的情况传值: OTA:S,SETTING:NA

先后顺序可以调换,逗号拼接

mock: @string

├─ appTimestring非必须stringota时间

mock: @string

├─ remarkstring非必须string备注,额外内容可以加这里

mock: @string

├─ snstring非必须stringsn号

mock: @string

├─ oldVersionstring非必须string旧版本;三个维度(APP:1.0.1,BOOT:1.0.0,SETTING:1.0.3)

mock: @string

├─ aidexVersionstring非必须string一代G7,二代X

mock: @string

├─ appTimeZonestring非必须string时区

mock: @string

├─ newVersionstring非必须string新版本;规则和oldVersion一致

mock: @string

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

协议管理

获取协议

基本信息

Path: /backend/pump-cgm-sys/policy/passCheckToken/getPolicyList

Method: GET

接口描述:

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 是

Query

参数名称 是否必须 示例 备注
appId 是 分支,同软件更新中appId的定义

返回数据

名称类型是否必须默认值备注其他信息
msgstring非必须string返回信息

mock: @string

codeinteger非必须1返回码

mock: @integer

dataobject []非必须返回数据

item 类型: object

├─ urlstring必须协议地址
├─ versionstring必须版本号
├─ policyTypestring必须类型。1用户手册,2隐私协议,3使用条款
├─ descriptionstring必须描述

Build by YMFE.