睡眠带

Last Updated on : 2024-06-05 03:15:12download

API 列表

action 描述
sleepace.checkData 预览报告读取状态
sleepace.dataList 查询报告列表
sleepace.readData 更新报告读取状态

预览报告状态

接口说明

预览报告读取状态。

接口地址

action: sleepace.checkData

请求参数

参数名 类型 说明 是否必填
device_id String 设备 ID
start_time Long 查询开始时间,单位:s
end_time Long 查询结束时间,单位:s

响应参数

参数名 类型 说明
code Integer 响应码(详情见 错误码
success Boolean 是否成功:
  • true:成功
  • false:失败
  • msg String 请求失败的信息,成功为空
    result List 报告预览信息

    result 说明

    参数名 类型 说明
    reportTime String 报告所属日期
    isRead Boolean 读取状态

    请求示例

    {
      "action": "sleepace.checkData",
      "params": {
            "device_id": "vdevo158458342700038",
        "start_time": 1584545400,
        "end_time": 1584583472
      }
    }
    

    响应示例

      {
          "result": ["{\"dataDate\":\"2018-11-21\",\"isRead\":true}"],
          "t":1542776517323
      }
    

    错误码

    以下为该接口常见的业务异常。更多的异常错误,请参见 全局错误码

    错误码 说明
    500 系统错误
    1106 权限非法

    查询报告列表

    接口说明

    查询报告列表

    接口地址

    action: sleepace.dataList
    

    请求参数

    参数名 类型 说明 是否必填
    device_id String 设备 ID
    report_time Long 查询报告日期,单位:s

    响应参数

    参数名 类型 说明
    code Integer 响应码(详情见 错误码
    success Boolean 是否成功:
  • true:成功
  • false:失败
  • msg String 请求失败的信息,成功为空
    result List 报告列表

    result 说明

    参数名 类型 说明
    date String 报告所属日期
    startTime Long 睡眠开始时间
    date String 报告所属日期
    wake Integer 清醒总时长(单位:分钟)
    scale Integer 分数
    lightSleepDuration Integer 浅睡眠总时长(单位:分钟)
    remSleepDuration Integer 中度睡眠总时长(单位:分钟)
    deepSleepDuration Integer 深度睡眠总时长(单位:分钟)
    mdDeepSleepPerc Integer 浅睡眠百分比
    mdRemSleepPerc Integer 中睡眠百分比
    mdLightSleepPerc Integer 浅睡百分比
    mdWakeSleepPerc Integer 起床前的那段清醒时间(单位:分钟)
    wakeTimes Integer 清醒次数
    apneaCount Integer 呼吸暂停总次数
    apneaDuration Integer 呼吸暂停时长(单位:秒)
    heartbeatPauseCount Integer 心跳暂停总次数
    heartbeatPauseDuration Integer 呼吸暂停总时长(单位:秒)
    outOfBedCount Integer 离床时间(单位:分钟)
    bodyMoveCount Integer 体动次数
    turningOverCount Integer 翻身次数
    avgHeartRate Integer 平均心率(n 次/分钟)
    avgBreathRate Integer 平均分析率(n 次/分钟)
    maxHeartRate Integer 最高心率(n 次/分钟)
    maxBreathRate Integer 最高呼吸率(n 次/分钟)
    minHeartRate Integer 最低呼吸率(n 次/分钟)
    tachycardiaDuration Integer 心跳过速时长(单位:秒)
    bradycardiaDuration Integer 心跳过缓时长(单位:秒)
    tachypneaDuration Integer 呼吸过速时长(单位:秒)
    bradypneaDuration Integer 入睡所花时间(单位:分钟)
    sleepCurveArray Array 睡眠曲线数组,计算方式:val/10,0:清醒 01:浅睡 12:中睡 2~3: 深睡
    breathRateArray Array 呼吸数组
    heartRateArray Array 心率数组
    turnOverArray Array 翻身数组
    advice String 详情见 备注说明

    advice 表示扣分项与建议,如下所示:

    {
      "comment":"简评等级,对应是《简评》等级",
      "commentIndex":"简评等级索引,commentIndex-1 对应《简评》排序",
      "advices":[
      {
        "name":"扣分项,对应《扣分项》name",
        "deductMark":"扣分",
        "params":"《扣分项》因素替换参数"
      }
      ]
    }
    

    请求示例

    {
      "action": "sleepace.dataList",
      "params": {
            "device_id": "vdevo158458342700038",
        "report_time": 1584545400
      }
    }
    

    响应示例

    {
        "result": [
                   {
                    "wakeTimes":0,
                     "apneaDuration":79,
                      "mdDeepSleepPerc":0,
                      "bradycardiaDuration":0,
                      "bradypneaDuration":2,
                      "outOfBedCount":0,
                      "scale":0,
                      "avgBreathRate":14,
                      "deepSleepDuration":0,
                      "duration":12,
                      "apneaCount":1,
                      "asleepTime":0,
                      "wake":0,
                      "sleepCurve":Array[12],
                      "tachypneaDuration":0,
                      "heartbeatPauseCount":0,
                      "startTime":1542766746,
                      "sleepEfficient":0,
                      "heartbeatPauseDuration":0,
                      "heartRateArray":Array[12],
                      "maxHeartRate":62,
                      "turningOverCount":2,
                      "dataDate":"2018-11-21 10:19:06",
                      "mdLightSleepPerc":0,
                      "mdWakeSleepPerc":0,
                      "tachycardiaDuration":0,
                      "mdRemSleepPerc":0,
                      "minBreathRate":12,
                      "bodyMoveCount":2,
                      "userId":0,
                      "mdWakeUpTime":0,
                      "turnOverArray":Array[12],
                      "lightSleepDuration":0,
                      "remSleepDuration":0,
                      "outOfBedDuration":0,
                      "breathRateArray":Array[12],
                      "minHeartRate":54,
                      "flaginvalid":0,
                      "bodyMoveLevel":0,
                      "avgHeartRate":58,
                      "maxBreathRate":16,
                      "reportTime":1542766746
                      }
                    ],
      "t":1542776517323
    }
    

    错误码

    以下为该接口常见的业务异常。更多的异常错误,请参见 全局错误码

    错误码 说明
    500 系统错误
    1106 权限非法

    更新报告状态

    接口说明

    更新报告读取状态。

    接口地址

    action: sleepace.readData
    

    请求参数

    参数名 类型 说明 是否必填
    device_id String 设备 ID
    report_time Long 报告日期,单位:s

    响应参数

    参数名 类型 说明
    code Integer 响应码(详情见 错误码
    success Boolean 是否成功:
  • true:成功
  • false:失败
  • msg String 请求失败的信息,成功为空
    result Boolean 结果

    请求示例

    {
      "action": "sleepace.readData",
      "params": {
            "device_id": "vdevo158458342700038",
        "report_time": 1584545400
      }
    }
    

    响应示例

    {
      "result":true,
      "t":1542776517323
    }
    

    错误码

    以下为该接口常见的业务异常。更多的异常错误,请参见 全局错误码

    错误码 说明
    500 系统错误
    1106 权限非法