Paths

用户新增

接口说明

新增用户信息

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-brm/1.0.0/user/add

请求Method

POST

数据提交格式

application/json

请求参数

参数名	必选	类型	说明
loginName	true	string	登录用户名
ownerCode	true	string	所属组织编码
isReuse	true	int	是否复用
personId	false	long	关联人员ID
roleIdList	true	array	用户关联角色
service	false	string	子系统编码,默认evo-thirdParty
defaultOrgCode	false	string	默认组织编码
macList	false	array	mac地址
macFlag	false	int	mac功能开启标志
periodFlag	false	int	用户有效期启用标志
validPeriod	false	Date	用户有效期

请求参数示例

{
    "loginName": "test_user",
    "ownerCode": "001001",
    "isReuse":1,
    "personId":10000,
    "roleIdList": [
        1004,
        1005
    ],
   "defaultOrgCode": "001",
   "updateAuth":1,
   "deleteAuth":1,
   "macList":[],
   "macFlag":2,
   "periodFlag":"",
   "validPeriod":"",
   "service":"evo-thirdParty"
}

返回参数

名称	类型	说明
success	boolean	接口返回是否成功
code	string	错误码：0-为无错误，非0-为具体错误码
errMsg	string	错误消息
data	object	返回数据对象
+id	int	新增用户ID

返回参数示例（成功）

 {
  "success": true,
  "code": "0",
  "errMsg": "",
  "data": {
    "id": "100005"
  }
}

返回参数示例（失败）

{
    "success": false,
    "data": {},
    "code": "28110033",
    "errMsg": "登录名称非法，必须是25位以内的非特殊字符"
}

用户信息更新

接口说明

更新用户信息

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-brm/1.0.0/user/update

请求Method

PUT

数据提交格式

application/json

请求参数

参数名	必选	类型	说明
id	true	long	用户ID，不支持修改
ownerCode	true	string	所属组织编码
isReuse	true	int	是否复用，选"是"则允许账号复用，同一账号可同时在多个终端登录
personId	false	long	关联人员ID
roleIdList	true	array	用户关联角色
service	false	string	子系统编码,默认evo-thirdParty
defaultOrgCode	false	string	默认组织编码
macList	false	array	mac地址
macFlag	false	int	mac功能开启标志
periodFlag	false	int	用户有效期启用标志
validPeriod	false	Date	用户有效期
loginName	true	string	登陆名,该字段不能修改，调用接口测试时需要传该字段，调用时不能修改该值；在页面操作时该输入框显示原来登陆名，并且禁止修改

请求参数示例

{
    "id":10005,
    "ownerCode": "001001",
    "isReuse":1,
    "personId":10000,
    "roleIdList": [
        1004,
        1005
    ],
    "defaultOrgCode": "001",
    "updateAuth":1,
    "deleteAuth":1,
    "macList":[],
    "macFlag":2,
    "periodFlag":"",
    "validPeriod":"",
    "service":"evo-thirdParty",
    "loginName":"lgm"
}

返回参数

名称	类型	说明
success	boolean	接口返回是否成功
code	string	错误码：0-为无错误，非0-为具体错误码
errMsg	string	错误消息
data	object	返回数据对象
+id	int	修改用户的ID

返回参数示例（成功）

 {
  "success": true,
  "code": "0",
  "errMsg": "",
  "data": {
    "id": "100005"
  }
}

返回参数示例（失败）

{
    "success": false,
    "data": {},
    "code": "28110032",
    "errMsg": "所属组织不能为空"
}

用户删除

接口说明

删除用户信息

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-brm/1.0.0/user/delete

请求Method

DELETE

数据提交格式

application/json

请求参数

参数名	必选	类型	说明
ids	true	string	多个用户id用逗号分割

请求参数示例

{
    "ids": "100005,100006"
}

返回参数

名称	类型	说明
success	boolean	接口返回是否成功
code	string	错误码：0-为无错误，非0-为具体错误码
errMsg	string	错误消息
data	object	返回数据对象
+successIds	array	成功删除的id
+faultIds	array	删除失败的id

返回参数示例（成功）

 {
  "success": true,
  "code": "0",
  "errMsg": "",
  "data": {
  }
}

返回参数示例（失败）

{
	"success":false,
	"code":"28**",
	"errMsg":"",
	"data":{
		"successIds":[],
		"faultIds":[]
	}
  }

用户详情查询

接口说明

获取用户详情信息

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-brm/1.0.0/user/{id}

请求Method

GET

数据提交格式

application/json

请求参数

参数名	必选	类型	说明
id	true	long	用户id

请求参数示例

/evo-apigw/evo-brm/1.0.0/user/2

返回参数

名称	类型	说明
success	boolean	接口返回是否成功
code	string	错误码：0-为无错误，非0-为具体错误码
errMsg	string	错误消息
data	object	返回数据对象
+id	long	用户id
+loginName	String	用户名
+userName	String	用户绑定人员名称
+isReuse	int	是否复用
+personId	long	绑定人员id
+ownerCode	string	所属组织编码
+isOnline	int	在离线
+roleIdList	array	用户绑定角色id
+isGuide	int	是否引导
+isInitialPassword	int	是否初始化密码
+privacyProtection	int	是否同意隐私保护
+facePath	String	人员的图片相对路径
+passwordStrength	boolean	用户密码强度校验结果 (true:需要修改密码,false:无需修改密码)
defaultOrgCode	string	默认组织编码，逻辑组织是L打头
macList	array	mac地址
macFlag	int	mac功能开启标志
periodFlag	int	用户有效期启用标志
validPeriod	Date	用户有效期

返回参数示例（成功）

{
    "success": true,
    "code": "0",
    "errMsg": "",
    "data": {
        "id": 3,
        "loginName": "11",
        "userName": "1",
        "ownerCode": "001",
        "isReuse": 0,
        "personId": 4,
        "roleIdList": [
            1
        ],
        "isOnline": 0,
        "periodFlag":1,
        "validPeriod":"2021-11-10 10:04:00",
        "macFlag":1,
        "macList":[],
        "isGuide": 0,
        "isInitialPassword": 1,
        "defaultOrgCode": "001",
        "privacyProtection": 0,
        "facePath": "1d398260-cb00-11e9-bd21-e8611f1a7521/20190830/1/16565929-cb04-11e9-a0bf-e8611f1a7521.jpg",
		"passwordStrength":true
    }
}

返回参数示例（失败）

{
	"success":false,
	"code":"28**",
	"errMsg":"",
	"data":{
	}
  }

用户有权限的菜单获取

接口说明

根据子系统编码和终端类型获取用户有权限的菜单

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-brm/1.0.0/user/privilege-menus

请求Method

GET

数据提交格式

application/json

请求参数

参数名	必选	类型	说明
terminal	true	string	菜单所属终端类型
systemCode	true	string	子系统编码上报菜单时候的子系统编码

请求参数示例

/evo-apigw/evo-brm/1.1.0/user/privilege-menus?systemCode=evo-brm&terminal=1

返回参数

名称	类型	说明
success	boolean	接口返回是否成功
code	string	错误码：0-为无错误，非0-为具体错误码
errMsg	string	错误消息
data	ValueVO	分页数据

ValueVO

名称	类型	说明
menuInfoList	List<MenuInfoVO>	数据列表

MenuInfoVO

名称	类型	说明
menuCode	string	菜单编码
uniqueMenuCode	string	菜单唯一编码
menuName	string	菜单名称
menuPath	string	导航栏菜单跳转路径

返回参数示例（成功）

{
  "success": true,
  "code": "0",
  "errMsg": "成功",
  "data": {
  	"menuInfoList":[
		   {
                "menuCode":"001",
                "uniqueMenuCode":"EVOBRM_001",
                "menuName":"menu.base.resource.manage",
                "menuPath":""
            },
            {
                "menuCode":"001001",
                "uniqueMenuCode":"EVOBRM_001001",
                "menuName":"menu.roleManage",
                "menuPath":"/bResource/#/roleManage"
            },
            {
                "menuCode":"001001001",
                "uniqueMenuCode":"EVOBRM_001001001",
                "menuName":"menu.role.view",
                "menuPath":""
            }
	  ]
  }
}

返回参数示例（失败）

{
    "success": false,
    "data": {},
    "code": "28**",
    "errMsg": ""
}

用户信息分页查询

接口说明

分页查询用户信息

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.2.0

接口URL

/evo-apigw/evo-brm/1.2.0/user/subsystem/page

请求Method

POST

数据提交格式

application/json

请求参数

参数名	必选	类型	说明
pageNum	false	int	当前页, 默认1
pageSize	false	int	每页记录数, 默认10
sort	false	string	排序字段: id（默认）、createDate、updateDate、LoginDate、ownerCode、loginName、personId
sortType	false	string	排序规则：正序-ASC，倒序-DESC（默认）
searchKey	false	int	模糊搜索关键字
userIdList	false	List	用户ID列表列表最大支持500
ownerCodeList	false	List	所属组织编码列表列表最大支持500
loginNameList	false	List	登录名称列表列表最大支持500
personIdList	false	List	绑定人员ID列表列表最大支持500
isReuse	false	Integer	是否复用
includeSubOwnerCodeFlag	false	boolean	是否包含下级组织节点,所属组织编码列表存在时生效,默认false

请求参数示例

{
	"pageNum": 1,
	"pageSize": 10,
	"sortType": "ASC",
	"sort": "personId",
	"userIdList":["4","2","3"],
	"ownerCodeList": ["001"],
	"loginNameList": ["moli","lkx"],
	"personIdList": [1,2,3],
	"isReuse":1,
	"searchKey":"moli"
}

返回参数

名称	类型	说明
success	boolean	接口返回是否成功
code	string	错误码：0-为无错误，非0-为具体错误码
errMsg	string	错误消息
data	object	返回数据对象
+id	long	用户id
+loginName	String	用户名
+aesPass	String	aes密文登陆密码
+encrypted	int	是否经过加密
+userType	String	用户类型
+userName	String	用户姓名
+isReuse	int	是否复用
+isOnline	int	在离线
+personId	long	绑定人员id
+ownerCode	string	所属组织编码
+stat	int	状态： 0-正常，1-锁定，2-冻结
+isDefault	int	是否系统默认用户
+memo	string	描述

返回参数示例（成功）

{
    "success": true,
    "data": {
        "pageData": [
            {
                "id": 2,
                "loginName": "moli",
                "aesPass": "111",
                "encrypted": 1,
                "userType": 1,
                "userName": "moli",
                "isReuse": 1,
                "isOnline": 0,
                "personId": 1,
                "ownerCode": "001",
                "stat": 0,
                "isDefault": 0,
                "memo": "11"
            }
        ],
        "currentPage": 1,
        "totalPage": 1,
        "pageSize": 10,
        "totalRows": 1
    },
    "code": "0",
    "errMsg": ""
}

返回参数示例（失败）

{
    "success": false,
    "data": {},
    "code": "28**",
    "errMsg": ""
}

批量新增用户信息
有一个用户不符合信息则全部失败
接口配套版本信息 智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.2.0

接口URL

/evo-apigw/evo-brm/1.2.0/user/subsystem/add-batch

请求Method

POST

数据提交格式

application/json

请求参数

参数名	必选	类型	说明
userAddList	true	List	用户列表
+loginName	true	string	登录用户名
+ownerCode	true	string	所属组织编码
+isReuse	true	int	是否复用
+personId	true	long	关联人员ID
+roleIdList	true	array	用户关联角色
+defaultOrgCode	false	string	默认组织编码

请求参数示例

{
	"userAddList": [{
		"loginName": "test_user6",
		"ownerCode": "001001",
		"isReuse": 1,
		"personId": 10000,
		"defaultOrgCode": "001",
		"updateAuth": 1,
		"deleteAuth": 1,
		"roleIdList": [1004,
			1006
		]
	}]
}

返回参数

名称	类型	说明
success	boolean	接口返回是否成功
code	string	错误码：0-为无错误，非0-为具体错误码
errMsg	string	错误消息
data	object	返回数据对象
+successList	ArrayList	新增用户ID
+errorList	ArrayList	验证失败登录名称列表

返回参数示例（成功）

{
    "success": true,
    "data": {
        "successList": [
            15
        ]
    },
    "code": "0",
    "errMsg": ""
}

返回参数示例（失败）

{
    "success": false,
    "data": {
        "errorList": [
            {
                "loginName": "test_user6"
            }
        ]
    },
    "code": "28110000",
    "errMsg": "已存在用户名为{0}的用户，请重新输入用户名"
}

用户保活

接口说明

定时验证心跳

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.2.0

接口URL

/evo-apigw/evo-brm/1.2.0/user/keepalive

请求Method

POST

数据提交格式

application/json

请求参数

参数名	必选	类型	说明
clientType	true	int	终端类型
magicId	true	string	用户登录magicId

请求参数示例

{
    "clientType":1,
    "magicId":"678789898xxfhtgjdf"
}

返回参数

名称	类型	说明
success	boolean	接口返回是否成功
code	string	错误码：0-为无错误，非0-为具体错误码
errMsg	string	错误消息
data	object	返回数据对象

返回参数示例（成功）

{
    "success": true,
    "code": "0",
    "data": {},
    "errMsg": "成功"
}

返回参数示例（失败）

{
    "success": false,
    "data": {},
    "code": "28110042",
    "errMsg": "客户端类型为不能空"
}

用户全量数据同步

接口说明

全量同步用户数据

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.2.0

接口URL

/evo-apigw/evo-brm/1.2.0/user/list-page

请求Method

POST

数据提交格式

application/json

请求参数

参数名	必选	类型	说明
pageNum	false	int	当前页, 默认1
pageSize	false	int	每页记录数, 默认10
sort	false	string	排序字段: id（默认）、createDate、updateDate、LoginDate、ownerCode、loginName、personId
sortType	false	string	排序规则：正序-ASC，倒序-DESC（默认）
searchKey	false	int	模糊搜索关键字
userIdList	false	List	用户ID列表列表最大支持500
ownerCodeList	false	List	所属组织编码列表列表最大支持500
loginNameList	false	List	登录名称列表列表最大支持500
personIdList	false	List	绑定人员ID列表列表最大支持500
isReuse	false	Integer	是否复用
includeSubOwnerCodeFlag	false	boolean	是否包含下级组织节点,所属组织编码列表存在时生效,默认false

请求参数示例

{
    "pageNum": 1,
    "pageSize": 10,
    "sortType": "ASC",
    "sort": "personId",
    "userIdList": [
        "4",
        "2",
        "3"
    ],
    "ownerCodeList": [
        "001"
    ],
    "loginNameList": [
        "moli",
        "lkx"
    ],
    "personIdList": [
        1,
        2,
        3
    ],
    "isReuse": 1,
    "searchKey": "moli",
    "includeSubOwnerCodeFlag": true
}

返回参数

名称	类型	说明
success	boolean	接口返回是否成功
code	string	错误码：0-为无错误，非0-为具体错误码
errMsg	string	错误消息
data	PageVO	分页数据

PageVO

名称	类型	说明
currentPage	int	当前页码
totalPage	int	总页数
pageSize	int	每页记录数
totalRows	int	总数
pageData	List<UserInfoVO>	数据列表

UserInfoVO

名称	类型	说明
id	long	用户id
loginName	String	用户名
loginNameExt	String	用户名（89系统一长度）
aesPass	String	aes密文登陆密码
encrypted	int	是否经过加密
userType	String	用户类型
userName	String	用户姓名
isReuse	int	是否复用
isOnline	int	在离线
personId	long	绑定人员id
ownerCode	string	所属组织编码
stat	int	状态：0-正常，1-锁定，2-冻结
isDefault	int	是否系统默认用户
memo	string	描述
defaultOrgCode	string	默认组织编码
roleIdList	array	用户绑定角色id

返回参数示例（成功）

{
    "success": true,
    "data": {
        "pageData": [
            {
                "id": 2,
                "loginName": "moli",
                "aesPass": "111",
                "encrypted": 1,
                "userType": 1,
                "userName": "moli",
                "isReuse": 1,
                "isOnline": 0,
                "personId": 1,
                "ownerCode": "001",
                "stat": 0,
                "isDefault": 0,
                "defaultOrgCode": "L04"
                "roleIdList": [
                    1
                ],
                "memo": "11"
            }
        ],
        "currentPage": 1,
        "totalPage": 1,
        "pageSize": 10,
        "totalRows": 1
    },
    "code": "0",
    "errMsg": ""
}

返回参数示例（失败）

{
    "success": false,
    "data": {},
    "code": "28**",
    "errMsg": ""
}