智慧电梯-通用公共接口

[toc]

1 环境变量

默认环境1

| 参数名 | 字段值 | | —— | —— |

2 智慧电梯-通用公共接口

说明
联系方式
  • 联系人：
  • 邮箱：
  • 网址：//
文档版本
1.0.0

3 统计电梯运行数据

PUT /cronjob/runstates

请求参数(Query Param)

参数名称 默认值 描述
startDate   统计日期

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
version string   false  
statusCode int32   false  
message string   false  
isError boolean   false  
responseException object   false  
result object   false  
接口描述

4 统计告警数据

PUT /cronjob/warningstates

请求参数(Query Param)

参数名称 默认值 描述
startDate   指定日期

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
version string   false  
statusCode int32   false  
message string   false  
isError boolean   false  
responseException object   false  
result object   false  
接口描述

5 获取边缘设备配置信息接口

GET /edge/config

请求体(Request Body)

| 参数名称 | 数据类型 | 默认值 | 不为空 | 描述 | | —— | —— | —— | —— | —— |

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
totalPage int32   false  
pageSize int32   false  
total int32   false  
rows array[object]   false  
⇥ serialNo string   false  
⇥ floorHeight number   false  
⇥ liftControl boolean   false  
⇥ liftControlMinutes int32   false  
currentPage int32   false  
接口描述

6 取消梯控

POST /edge/cancelliftcontrol

请求体(Request Body)

| 参数名称 | 数据类型 | 默认值 | 不为空 | 描述 | | —— | —— | —— | —— | —— |

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
version string   false  
statusCode int32   false  
message string   false  
isError boolean   false  
responseException object   false  
result object   false  
接口描述

7 检查版本更新

GET /edge/latest

请求参数(Query Param)

参数名称 默认值 描述
model   当前版本

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
version string   false  
statusCode int32   false  
message string   false  
isError boolean   false  
responseException object   false  
result object   false  
接口描述

8 获取边缘端配置信息

GET /edge/info

请求参数(Query Param)

参数名称 默认值 描述
serialNo   设备序列号

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
liftId string   false 电梯Id
liftName string   false 电梯名称
xiaoquName string   false 所在小区名称
webSocket string   false Websocket
apiHost string   false api地址
edgeLocalIP string   false 边缘端本地IP
edgeLocalPort int32   false 边缘端本地端口
edgeRemotePort int32   false 边缘端远程端口
cameraRemotePort int32   false 摄像头远程端口
ftpServer string   false ftp
ftpServerPort int32   false ftp端口
ftpUser string   false ftp用户名
ftpPassword string   false ftp密码
wuyePhone string   false 物业电话
weibaoPhone string   false 维保电话
powerOnSchedule string   false 设备运行计划
接口描述

9 null

GET /enums

请求参数(Query Param)

参数名称 默认值 描述
enumTypeString    

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
version string   false  
statusCode int32   false  
message string   false  
isError boolean   false  
responseException object   false  
result object   false  
接口描述

10 查询文件

GET /files

请求参数(Query Param)

参数名称 默认值 描述
creatorId   创建这id
siteId   可不填
tag   可不填
type   可不填

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
version string   false  
statusCode int32   false  
message string   false  
isError boolean   false  
responseException object   false  
result object   false  
接口描述

11 获取文件

GET /files/info

请求参数(Query Param)

参数名称 默认值 描述
files   文件id数组
pathAsId   是否文件相对路径作为Id

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
version string   false  
statusCode int32   false  
message string   false  
isError boolean   false  
responseException object   false  
result object   false  
接口描述

12 获取指定文件

GET /files/{fileId}/download

地址参数（Path Variable）

参数名称 默认值 描述
fileId   文件Id

响应体

● 200 响应数据格式：JSON

接口描述

13 上传文件

POST /upload

请求参数(Query Param)

| 参数名称 | 默认值 | 描述 | | —— | —— | —— | |tag||文件标签|

请求体(Request Body)

参数名称 数据类型 默认值 不为空 描述
files array   false  

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
version string   false  
statusCode int32   false  
message string   false  
isError boolean   false  
responseException object   false  
result object   false  
接口描述

14 null

POST /ckeditorupload

请求体(Request Body)

参数名称 数据类型 默认值 不为空 描述
upload array   false  

响应体

● 200 响应数据格式：JSON

接口描述

15 null

GET /

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
version string   false  
statusCode int32   false  
message string   false  
isError boolean   false  
responseException object   false  
result object   false  
接口描述

16 null

PUT /

请求参数(Query Param)

参数名称 默认值 描述
liftId    

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
version string   false  
statusCode int32   false  
message string   false  
isError boolean   false  
responseException object   false  
result object   false  
接口描述

17 null

GET /discovery

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
version string   false  
statusCode int32   false  
message string   false  
isError boolean   false  
responseException object   false  
result object   false  
接口描述

18 null

GET /demopermission

请求参数(Query Param)

参数名称 默认值 描述
resource    

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
version string   false  
statusCode int32   false  
message string   false  
isError boolean   false  
responseException object   false  
result object   false  
接口描述

19 null

GET /logs

请求参数(Query Param)

参数名称 默认值 描述
Type    
Target    
EventName    
Tag    
UserId    
UserName    
StartDate    
EndDate    
Page   当前页
Size   每页数量
OrderField   排序字段
OrderDescending   排序字段

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
version string   false  
statusCode int32   false  
message string   false  
isError boolean   false  
responseException object   false  
result object   false  
接口描述

20 同步地区

GET /syncs/districtNames

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
version string   false  
statusCode int32   false  
message string   false  
isError boolean   false  
responseException object   false  
result object   false  
接口描述

21 null

GET /terms

请求参数(Query Param)

参数名称 默认值 描述
Types    
Ids    
Name    
ParentId    
Page   当前页
Size   每页数量
OrderField   排序字段
OrderDescending   排序字段

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
totalPage int32   false  
pageSize int32   false  
total int32   false  
rows array[object]   false  
⇥ id string   false  
⇥ code string   false  
⇥ name string   false  
⇥ type string   false  
⇥ description string   false  
⇥ orderWeight int32   false  
⇥ parentId string   false  
⇥ extField1 string   false  
⇥ extField2 string   false  
⇥ extField3 string   false  
⇥ extField4 string   false  
⇥ extField5 string   false  
⇥ extData string   false  
⇥ children array   false  
currentPage int32   false  
接口描述

22 创建字典

POST /terms

请求体(Request Body)

| 参数名称 | 数据类型 | 默认值 | 不为空 | 描述 | | —— | —— | —— | —— | —— |

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
version string   false  
statusCode int32   false  
message string   false  
isError boolean   false  
responseException object   false  
result object   false  
接口描述

23 获取code的子集

GET /terms/children

请求参数(Query Param)

参数名称 默认值 描述
Code    
Types    
ParentId    
Page   当前页
Size   每页数量
OrderField   排序字段
OrderDescending   排序字段

响应体

● 200 响应数据格式：JSON

接口描述

24 通过id获取省市县名

GET /terms/districtName

请求参数(Query Param)

参数名称 默认值 描述
ids   1,2,3

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
version string   false  
statusCode int32   false  
message string   false  
isError boolean   false  
responseException object   false  
result object   false  
接口描述

25 删除字典

DELETE /terms/{nodeId}

地址参数（Path Variable）

参数名称 默认值 描述
nodeId    

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
version string   false  
statusCode int32   false  
message string   false  
isError boolean   false  
responseException object   false  
result object   false  
接口描述

26 修改字典

PUT /terms/{nodeId}

地址参数（Path Variable）

| 参数名称 | 默认值 | 描述 | | —— | —— | —— | |nodeId|||

请求体(Request Body)

| 参数名称 | 数据类型 | 默认值 | 不为空 | 描述 | | —— | —— | —— | —— | —— |

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
version string   false  
statusCode int32   false  
message string   false  
isError boolean   false  
responseException object   false  
result object   false  
接口描述

27 获取回放信息

GET /video/replay

请求参数(Query Param)

参数名称 默认值 描述
liftId   电梯Id
startDate   开始时间
endDate   结束时间

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
id string   false 设备Id
url string   false 直播地址
expireTime string   false 过期时间
accessToken string   false 萤石云token
接口描述

28 获取直播信息

GET /video/live

请求参数(Query Param)

参数名称 默认值 描述
liftId   电梯Id

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
id string   false 设备Id
url string   false 直播地址
expireTime string   false 过期时间
accessToken string   false 萤石云token
接口描述

29 上报告警信息

POST /warning

请求体(Request Body)

| 参数名称 | 数据类型 | 默认值 | 不为空 | 描述 | | —— | —— | —— | —— | —— |

响应体

● 200 响应数据格式：JSON

参数名称 类型 默认值 不为空 描述
version string   false  
statusCode int32   false  
message string   false  
isError boolean   false  
responseException object   false  
result object   false  
接口描述