提交驾驶舱接口文档

2023-07-22 17:30:20 +08:00 · 2023-07-22 17:30:20 +08:00 · f8054b55e3
commit f8054b55e3
parent 96a08c68e9
1 changed files with 0 additions and 0 deletions
--- a/驾驶舱接口说明书.docx
+++ b/驾驶舱接口说明书.docx
@ -0,0 +1,383 @@
+
+概述
+	本文主要描述了地方服务平台与驾驶舱之间的接口定义；
+
+接口
+
+通用格式
+请求
+	以下接口均为POST接口；
+	Content-Type：application/json；
+
+通用响应
+                                    字段
+                                    类型
+                                    名称
+                                    描述
+respCode
+String
+错误码
+0：成功
+其余皆为失败
+respDesc
+String
+返回描述
+
+respData
+Object
+返回负载
+具体格式见对应接口中的响应负载
+
+
+家庭数据获取
+描述
+获取家庭数据信息，其中包括地区家庭总数、地区当前在线家庭数量；
+URI：/api/v1/szjt/hcc/queryNum
+请求
+                                    字段
+                                    类型
+                                    名称
+                                    描述
+addressCode
+String
+地区编码
+
+
+响应负载
+                                    字段
+                                    类型
+                                    名称
+                                    描述
+data
+Object
+
+
+onlineNum
+int
+当前在线家庭数量
+
+totalNum
+int
+家庭总数
+
+childAreaList
+Object[]
+子地区家庭数量
+
++areaCode
+String
+地区编码
+
++areaName
+String
+地区名称
+
++totalNum
+int
+地区家庭总数
+
++onlineNum
+int
+地区在线家庭数量
+
+
+用户数据获取
+描述
+获取用户数据信息，其中包括家庭用户总数、用户活跃数数量；
+URI：/api/v1/szjt/user/queryNum
+请求
+                                    字段
+                                    类型
+                                    名称
+                                    描述
+addressCode
+String
+地区编码
+
+type
+int
+查询方式
+0：天
+1：月
+2：年
+
+响应负载
+                                    字段
+                                    类型
+                                    名称
+                                    描述
+data
+Object
+
+
+totalNum
+int
+总数
+
+dataList
+
+
+
+liveNum
+int
+活跃数
+
+
+
+
+
+
+服务数据获取
+描述
+获取服务数据信息，其中包括应用服务总数、应用服务日活数量；
+URI：/api/v1/szjt/mp/queryNum
+请求
+                                    字段
+                                    类型
+                                    名称
+                                    描述
+topLimit
+int
+取前几位
+为空取所有
+
+响应负载
+                                    字段
+                                    类型
+                                    名称
+                                    描述
+data
+Object
+
+
+totalNum
+int
+总数
+
+mpList
+Object[]
+应用服务
+
++name
+String
+服务名称
+
++icon
+String
+服务图标
+
++id
+String
+服务ID
+
++liveNum
+int
+活跃数
+
+
+用户档案获取
+描述
+获取服务数据信息，其中包括应用服务总数、应用服务日活数量；
+URI：/api/v1/szjt/user/queryArchiveList
+请求
+                                    字段
+                                    类型
+                                    名称
+                                    描述
+pageNo
+int
+页码
+
+pageSize
+int
+页大小
+
+type
+int
+类型
+为空也查所有
+0：所有
+1：婴幼儿（0-3岁）
+2：儿童（4-12岁）
+3：青少年（13-18岁）
+4：青年（19-39岁）
+5：中年（40-59岁）
+6：老年（ > 60岁）
+
+响应负载
+                                    字段
+                                    类型
+                                    名称
+                                    描述
+data
+Object
+
+
+totalNum
+int
+总数
+
+hasNext
+boolean
+是否有下一页
+
+totalPage
+int
+总页数
+
+dataList
+Object[]
+档案列表
+
++name
+String
+姓名
+
++birthday
+String
+出生年月
+
++sex
+int
+性别
+0：男
+1：女
++height
+int
+身高
+单位：cm
++flagList
+Object[]
+标签列表
+
+++ flagName
+String
+标签名
+
+
+
+获取用户健康档案数据
+描述
+获取服务数据信息，其中包括应用服务总数、应用服务日活数量；
+URI：/api/v1/szjt/user/queryDataList
+请求
+                                    字段
+                                    类型
+                                    名称
+                                    描述
+pageNo
+int
+页码
+
+pageSize
+int
+页大小
+
+archiveId
+int
+档案ID
+
+hccId
+String
+家庭ID
+
+dataType
+String
+查询的数据类别
+详见数据类别定义
+dataTypeSub
+String
+数据类别子类
+
+
+响应负载
+                                    字段
+                                    类型
+                                    名称
+                                    描述
+data
+Object
+
+
+totalNum
+int
+总数
+
+hasNext
+boolean
+是否有下一页
+
+totalPage
+int
+总页数
+
+dataList
+Object[]
+档案列表
+
++dataType
+String
+数据类别
+
++dataTypeSub
+String
+数据类别子类
+
++value
+String
+数据
+
++unit
+String
+单位
+
++createTime
+String
+时间
+
+
+家庭列表获取
+描述
+获取家庭信息列表；
+URI：/api/v1/szjt/hcc/queryList
+请求
+                                    字段
+                                    类型
+                                    名称
+                                    描述
+addressCode
+String
+地区编码
+
+
+响应负载
+                                    字段
+                                    类型
+                                    名称
+                                    描述
+data
+Object
+
+
+homeList
+Object[]
+家庭列表
+
++hccId
+String
+家庭ID
+
++address
+String
+家庭地址
+
++online
+int
+状态
+0：离线
+1：在线
++areaCode
+String
+家庭所属地区
+
+