[toc]
参数名 | 字段值 |
---|
v1.0
GET /role/member
请求参数(Query Param)
参数名称 默认值 描述 role_id 角色id 响应体
● 200 响应数据格式:JSON
获取角色成员
DELETE /role/member
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 users_id string false 用户ids。例:[1,2,3] 响应体
● 200 响应数据格式:JSON
批量移除角色成员
PUT /role/member
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 user_id int32 false 用户id 响应体
● 200 响应数据格式:JSON
移除角色成员
GET /role/role
请求参数(Query Param)
参数名称 默认值 描述 role_id 角色id 响应体
● 200 响应数据格式:JSON
获取角色
POST /role/role
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 role_name string true 角色名称 role_describe string false 角色描述 role_permission string false 角色权限 响应体
● 200 响应数据格式:JSON
添加角色
DELETE /role/role
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 role_id int32 false 角色id 响应体
● 200 响应数据格式:JSON
删除角色
PUT /role/role
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 role_id int32 false 角色id role_name string false 角色名称 role_describe string false 角色描述 role_permission string false 角色权限 响应体
● 200 响应数据格式:JSON
修改角色
GET /role/role_list
请求参数(Query Param)
参数名称 默认值 描述 page_size 每页记录数量,默认:20 page 页数 响应体
● 200 响应数据格式:JSON
获取角色列表
DELETE /data/batch_delete_template
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 template_ids string true 模版id列表。例:[1,2,3] 响应体
● 200 响应数据格式:JSON
批量删除模版
GET /data/building
请求参数(Query Param)
参数名称 默认值 描述 building_id 楼宇id 响应体
● 200 响应数据格式:JSON
获取楼宇列表
POST /data/building
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 building_name string false 楼宇名 building_area string false 楼宇面积 building_floor string false 建筑楼层 trem string false 建筑年限 date string false 建成日期 contact_person string false 联系人 contact_information string false 联系人方式 building_introduction string false 楼宇简介 picture string false 楼宇图片 响应体
● 200 响应数据格式:JSON
增加楼宇
DELETE /data/building
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 building_id int32 false 楼宇id 响应体
● 200 响应数据格式:JSON
删除楼宇
PUT /data/building
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 building_id int32 false 楼宇id building_name string false 楼宇名 building_area string false 楼宇面积 building_floor string false 建筑楼层 trem string false 建筑年限 date string false 建成日期 contact_person string false 联系人 contact_information string false 联系人方式 building_introduction string false 楼宇简介 picture string false 楼宇图片 响应体
● 200 响应数据格式:JSON
修改楼宇
GET /data/building_list
响应体
● 200 响应数据格式:JSON
获取楼宇列表
GET /data/company
请求参数(Query Param)
参数名称 默认值 描述 company_id 公司id 响应体
● 200 响应数据格式:JSON
获取公司信息
POST /data/company
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 management_unit string false 管理单位 custodian_unit string false 托管单位 introduction string false 楼宇简介 contact_person string false 联系人 contact_information string false 联系人方式 picture string false 公司图片 响应体
● 200 响应数据格式:JSON
添加公司信息
PUT /data/company
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 company_id int32 false 公司id management_unit string false 管理单位 custodian_unit string false 托管单位 introduction string false 楼宇简介 contact_person string false 联系人 contact_information string false 联系人方式 picture string false 公司图片 响应体
● 200 响应数据格式:JSON
修改公司信息
GET /data/template
请求参数(Query Param)
参数名称 默认值 描述 template_id 模版id 响应体
● 200 响应数据格式:JSON
获取模版详情
POST /data/template
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 template_name string false 模版名称 template_format string false 模版格式 report_type string false 报告类型 introduction string false 模版简介 template_file string false 模版文件 template_type int32 false 模版类型 0:报表,1:报告 响应体
● 200 响应数据格式:JSON
添加报表模版
DELETE /data/template
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 template_id int32 false 模版id 响应体
● 200 响应数据格式:JSON
删除模版
PUT /data/template
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 template_id int32 false 模版id template_name string false 模版名称 template_format string false 模版格式 report_type string false 报告类型 introduction string false 模版简介 template_file string false 模版文件 template_type int32 false 模版类型 0:报表,1:报告 响应体
● 200 响应数据格式:JSON
修改模版信息
GET /data/template_list
请求参数(Query Param)
参数名称 默认值 描述 page_size 每页记录数量,默认:20 page 第几页 template_name 模版名称 template_format 模版格式 template_type 模版类型 0:报表,1:报告 report_type 报告类型 响应体
● 200 响应数据格式:JSON
模版列表
GET /data/underlying_system
响应体
● 200 响应数据格式:JSON
获取底层系统
POST /data/underlying_system
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 picture string false 楼宇图片 响应体
● 200 响应数据格式:JSON
添加底层系统
GET /log/log_export
响应体
● 200 响应数据格式:JSON
日志导出
GET /log/log_list
请求参数(Query Param)
参数名称 默认值 描述 page_size 每页记录数量,默认:20 page 第几页 module 系统模块 name 操作人员 operation_type 操作类型 operation_status 操作状态 start_time 开始时间 end_time 结束时间 响应体
● 200 响应数据格式:JSON
日志列表
DELETE /organization/batch_delete_company
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 company_ids string false 公司ids。例:[1,2,3] 响应体
● 200 响应数据格式:JSON
批量删除公司
GET /organization/company
请求参数(Query Param)
参数名称 默认值 描述 company_id 公司id 响应体
● 200 响应数据格式:JSON
获取公司详情
POST /organization/company
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 company_name string true 公司名 logo string false 商标 abbreviation string false 公司简称 code string false 统一社会信用代码 registered_address string false 注册地址 business_address string false 经营地址 legal_person_name string false 法人姓名 company_code string false 公司编码 staff_size string false 编制人数 on_guard_size string false 在岗人数 响应体
● 200 响应数据格式:JSON
添加公司
DELETE /organization/company
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 company_id int32 True 公司id 响应体
● 200 响应数据格式:JSON
删除公司
PUT /organization/company
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 company_id int32 false 公司id company_name string true 公司名 logo string false 商标 abbreviation string false 公司简称 code string false 统一社会信用代码 registered_address string false 注册地址 business_address string false 经营地址 legal_person_name string false 法人姓名 company_code string false 公司编码 staff_size string false 编制人数 on_guard_size string false 在岗人数 响应体
● 200 响应数据格式:JSON
修改公司详情
GET /organization/company_list
请求参数(Query Param)
参数名称 默认值 描述 page_size 每页记录数量,默认:20 page 页数 响应体
● 200 响应数据格式:JSON
获取公司列表
GET /organization/department
请求参数(Query Param)
参数名称 默认值 描述 department_id 部门id 响应体
● 200 响应数据格式:JSON
获取部门详情
POST /organization/department
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 company_id string false 上级公司 department_name string false 部门名 principal string false 负责人 liaison_officer string false 接口人 duplicate_name string false 拍重名 on_guard string false 在岗人数 freelance_staff string false 自由员工 cooperation_staff string false 协作员工 thirdparty_staff string false 第三方员工 censure string false 职责 响应体
● 200 响应数据格式:JSON
添加部门
DELETE /organization/department
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 department_id string false 部门id 响应体
● 200 响应数据格式:JSON
删除部门
PUT /organization/department
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 department_id string false 部门id company_id string false 上级公司 department_name string false 部门名 principal string false 负责人 liaison_officer string false 接口人 duplicate_name string false 拍重名 on_guard string false 在岗人数 freelance_staff string false 自由员工 cooperation_staff string false 协作员工 thirdparty_staff string false 第三方员工 censure string false 职责 响应体
● 200 响应数据格式:JSON
修改部门详情
GET /organization/department_list
请求参数(Query Param)
参数名称 默认值 描述 company_id 公司id 响应体
● 200 响应数据格式:JSON
获取公司下部门列表
GET /permission/auth_permission
请求参数(Query Param)
参数名称 默认值 描述 path 请求url 响应体
● 200 响应数据格式:JSON
权限认证
GET /permission/permission
响应体
● 200 响应数据格式:JSON
获取权限配置信息
GET /information/floor_configuration
请求参数(Query Param)
参数名称 默认值 描述 id 配置id 响应体
● 200 响应数据格式:JSON
获取楼层地图信息配置
POST /information/floor_configuration
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 name string false 配置名称 location string false 楼层位置 use string false 楼层用途 remark string false 备注 attachment string false 附件 响应体
● 200 响应数据格式:JSON
添加楼层地图信息配置
DELETE /information/floor_configuration
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 id string false 配置id 响应体
● 200 响应数据格式:JSON
删除楼层地图信息配置
PUT /information/floor_configuration
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 id string false 配置id name string false 配置名称 location string false 楼层位置 use string false 楼层用途 remark string false 备注 attachment string false 附件 响应体
● 200 响应数据格式:JSON
修改楼层地图信息配置
GET /information/information_list
响应体
● 200 响应数据格式:JSON
信息列表
GET /information/staff_configuration
请求参数(Query Param)
参数名称 默认值 描述 id 配置id 响应体
● 200 响应数据格式:JSON
获取安保人员信息配置
POST /information/staff_configuration
响应体
● 200 响应数据格式:JSON
DELETE /information/staff_configuration
响应体
● 200 响应数据格式:JSON
PUT /information/staff_configuration
响应体
● 200 响应数据格式:JSON
POST /login
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 username string true 用户名 password string true 密码 响应体
● 200 响应数据格式:JSON
登入
GET /message/message
请求参数(Query Param)
参数名称 默认值 描述 message_id 消息id 响应体
● 200 响应数据格式:JSON
获取消息详情
POST /message/message
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 name string false 消息名称 pipeline string false 通道配置 staff string false 人员配置: all role:角色id company:公司id send_time string false 发送时间 immediately, 2020-10-20 10:10:10 title string false 标题 content string false 内容 style string false 样式 type string false 消息类型 响应体
● 200 响应数据格式:JSON
新增消息
PUT /message/message
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 message_id string false 消息id name string false 消息名称 pipeline string false 通道配置 staff string false 人员配置: all role: company: send_time string false 发送时间 immediately 2020-10-20 10:10:10 title string false 标题 content string false 内容 style string false 样式 type string false 消息类型 响应体
● 200 响应数据格式:JSON
修改消息
GET /message/message_list
响应体
● 200 响应数据格式:JSON
消息列表
DELETE /users/batch_delete_user
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 users_id string true 用户id列表。例:[1,2,3] 响应体
● 200 响应数据格式:JSON
批量删除用户
PUT /users/batch_modify_user_status
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 users_id string true 用户id列表。例:[1,2,3] status int32 true 用户状态 0为正常,1为禁用 响应体
● 200 响应数据格式:JSON
批量修改用户状态,激活、禁用
GET /users/export_data
响应体
● 200 响应数据格式:JSON
导出用户数据
GET /users/user
请求参数(Query Param)
参数名称 默认值 描述 id 用户id 响应体
● 200 响应数据格式:JSON
获取用户详情
POST /users/user
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 username string true 用户名 password string true 密码 photograph string false 照片 name string false 姓名 phone string false 电话 string false 邮箱 company string false 公司 department string false 部门 role string false 角色 permission string false 权限 on_job_status string false 在职状态 duty string false 职务 nationality string false 国籍 响应体
● 200 响应数据格式:JSON
添加用户
DELETE /users/user
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 id string false 用户id 响应体
● 200 响应数据格式:JSON
删除用户
PUT /users/user
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 id string false 用户id username string true 用户名 password string true 密码 photograph string false 照片 name string false 姓名 phone string false 电话 string false 邮箱 company string false 公司 department string false 部门 role string false 角色 permission string false 权限 on_job_status string false 在职状态 duty string false 职务 nationality string false 国籍 响应体
● 200 响应数据格式:JSON
更新用户详情
GET /users/user_list
请求参数(Query Param)
参数名称 默认值 描述 status 用户状态 page_size 每页记录数量 page 第几页 响应体
● 200 响应数据格式:JSON
获取用户列表
PUT /users/user_status
请求体(Request Body)
参数名称 数据类型 默认值 不为空 描述 id int32 true 用户id status int32 true 用户状态 响应体
● 200 响应数据格式:JSON
修改用户状态,激活、禁用