组织新增

接口说明

新增组织信息

接口配套版本信息

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

接口版本

1.2.0

接口URL

/evo-apigw/evo-brm/1.2.0/organization/add

请求Method

POST

数据提交格式

application/json

请求参数

参数名必选类型说明
orgNametruestring组织名称,长度 1-25 位,允许输入的值：数字、字母、下划线、中文、横线、点 最大长度50个字符
orgPreCodetruestring上级组织编码
orgSnfalsestring组织唯一标识码
orgTypetruestring组织类型唯一编码 子系统可以自定义组织类型上报，具体参考组织类型
provincefalsestring省，具体参考省类型字典
cityfalsestring市，具体参考市类型字典
countyfalsestring县/小区
forbidBindUserfalseint是否禁止关联用户 :0-设置组织可以绑定用户， 1-锁定组织不可绑定用户
servicefalsestring服务唯一编码(子系统服务编码),固定值evo-thirdParty

请求参数示例

{
    "orgName":"组织6",
    "orgPreCode":"001",
    "orgSn":"15345w6334323152",
    "orgType":"org_base",
    "province":"2280",
    "city":"2281",
    "county":"2283",
    "forbidBindUser": 1,
    "service":"evo-thirdParty"
  }

返回参数

名称类型说明
successboolean接口返回是否成功
codestring错误码：0-为无错误，非0-为具体错误码
errMsgstring错误消息
dataobject返回数据对象
+orgCodestring新增组织编码

返回参数示例（成功）

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

返回参数示例（失败）

{
    "success": false,
    "data": {},
    "code": "28100000",
    "errMsg": "同级下存在同名组织"
}
组织更新

接口说明

更新组织信息

接口配套版本信息

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

接口版本

1.2.0

接口URL

/evo-apigw/evo-brm/1.2.0/organization/update

请求Method

PUT

数据提交格式

application/json

请求参数

参数名必选类型说明
orgNametruestring组织名称,长度 1-25 位,允许输入的值：数字、字母、下划线、中文、横线、点 最大长度50个字符
orgTypetruestring组织类型唯一编码 子系统可以自定义组织类型上报，具体参考组织类型
orgCodetruestring组织编码，不支持修改
provincefalsestring省，具体参考省类型字典
cityfalsestring市，具体参考市类型字典
countyfalsestring县/小区
forbidBindUserfalseint是否禁止关联用户 ：0-设置组织可以绑定用户， 1-锁定组织不可绑定用户
servicefalsestring子系统服务编码,默认evo-thirdParty
operateLocktrueobject操作权限锁 默认不锁定，被锁定的组织只有发起锁定的子系统才有相应操作权限，其他子系统在进行操作时会提示组织被锁定。使用场景一般是子系统不希望自己新增的组织被其他系统修改
+addfalseint添加组织权限是否锁定 ：0-解除锁定，1-添加锁定，锁定之后其他系统无法在锁定的组织下新增组织
+updatefalseint更新组织权限是否锁定 ：0-解除锁定，1-添加锁定，锁定之后其他系统无法更新锁定的组织
+deletefalseint删除组织权限是否锁定 ：0-解除锁定，1-添加锁定，锁定之后其他系统无法删除被锁定的组织
+addDevicefalseint添加设备权限是否锁定： 0-解除锁定，1-添加锁定,锁定之后其他子系统无法在被锁定的组织下添加设备

请求参数示例

{
    "orgName": "组织修改",
    "orgCode": "001015",
    "province": "140000",
    "city": "140100",
    "county": "140105",
    "forbidBindUser":1,
    "service":"evo-thirdParty"
}

返回参数

名称类型说明
successboolean接口返回是否成功
codestring错误码：0-为无错误，非0-为具体错误码
errMsgstring错误消息
dataobject返回数据对象
+orgCodestring新增组织编码

返回参数示例（成功）

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

返回参数示例（失败）

{
    "success": false,
    "data": {},
    "code": "28100000",
    "errMsg": "同级下存在同名组织"
}
组织删除

接口说明

删除组织信息

接口配套版本信息

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

接口版本

1.2.0

接口URL

/evo-apigw/evo-brm/1.2.0/organization/delete

请求Method

DELETE

数据提交格式

application/json

请求参数

参数名必选类型说明
orgCodestruearray删除组织编码数组

请求参数示例

{
    "orgCodes":["001002","001003"]
}

返回参数

名称类型说明

返回参数示例（成功）

{
    "success":true,
    "data":{

    },
    "code":"0",
    "errMsg":""
}

返回参数示例（失败）

{
    "success": false,
    "data": {},
    "code": "28100005",
    "errMsg": "组织节点不存在"
}
组织详情查询

接口说明

查询组织详情

接口配套版本信息

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

接口版本

1.2.0

接口URL

/evo-apigw/evo-brm/1.2.0/organization/{orgCode}

请求Method

GET

数据提交格式

--

请求参数

参数名必选类型说明
orgCodetruestring组织编码

请求参数示例

/evo-apigw/evo-brm/1.2.0/organization/001

返回参数

名称类型说明
successboolean接口返回是否成功
codestring错误码：0-为无错误，非0-为具体错误码
errMsgstring错误消息
dataobject返回数据对象
+idlong主键ID
+orgCodestring组织编码，从右减3位为父节点，根节点是001
+orgNamestring组织名称
+orgTypestring组织类型编码，具体参考组织类型
+orgSnstring组织唯一标识码
+sortint同级部门排序值
+provincestring省唯一编码
+citystring市唯一编码
+countystring县/小区唯一编码
+forbidBindUserint禁止关联用户： 1-禁止关联用户，0-可关联用户，默认可关联用户
+forbidBindServicestring禁止绑定用户的服务
+servicestring设置禁止关联用户的服务编码 子系统编码,默认evo-thirdParty
+domainIdstring级联节点的域id

返回参数示例（成功）

{
	"success": true,
	"data": {
		"service": "evo-thirdParty",
		"id": 9,
		"orgCode": "001002",
		"orgName": "组织1",
		"orgType": "org_base",
		"orgSn": "15345w633432334646",
		"sort": 2,
		"province": "110000",
		"city": "110101",
		"county": "",
		"orgPreCode": "001",
		"domainId": null,
		"forbidBindUser": 0,
		"forbidBindService": ""
	},
	"code": "0",
	"errMsg": ""
}

返回参数示例（失败）

{
    "success": false,
    "data": {},
    "code": "28100005",
    "errMsg": "组织节点不存在"
}
组织批量新增

接口说明

批量新增组织信息

接口配套版本信息

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

接口版本

1.0.0

接口URL

/evo-apigw/evo-brm/1.0.0/organization/batch-add

请求Method

POST

数据提交格式

application/json

请求参数

参数名必选类型说明
servicefalsestring子系统服务编码,默认evo-thirdParty
orgListtrueArray组织数组
+orgPreCodetruestring上级组织编码
+orgSnfalsestring组织唯一标识码
+orgNametruestring组织名称
+orgTypetruestring组织类型唯一编码，具体参考组织类型
+provincefalsestring省
+cityfalsestring市
+countyfalsestring县/小区
+forbidBindUserfalseint是否禁止关联用户： 0-设置组织可以绑定用户， 1-锁定组织不可绑定用户
+operateLockfalseobject操作权限锁
++addfalseint添加组织权限是否锁定 ：0-解除锁定，1-添加锁定，锁定之后其他系统无法在锁定的组织下新增组织
++updatefalseint更新组织权限是否锁定： 0-解除锁定，1-添加锁定，锁定之后其他系统无法更新锁定的组织
++deletefalseint删除组织权限是否锁定 ：0-解除锁定，1-添加锁定，锁定之后其他系统无法删除被锁定的组织
++addDevicefalseint添加设备权限是否锁定： 0-解除锁定，1-添加锁定,锁定之后其他子系统无法在被锁定的组织下添加设备

请求参数示例

{
	"service": "evo-thirdParty",
	"orgList": [{
			"orgName": "组织29",
			"orgPreCode": "001002",
			"orgSn": "15345w6312",
			"orgType": "org_base",
			"province": "2280",
			"city": "2281",
			"county": "2283",
			"operateLock": {
				"add": 1,
				"delete": 1,
				"update": 1,
				"addDevice": 1
			},
			"forbidBindUser": 0
		}, {
			"orgName": "组织33",
			"orgPreCode": "001003",
			"orgSn": "15345w6334235",
			"orgType": "org_base",
			"province": "2280",
			"city": "2281",
			"county": "2283",
			"operateLock": {
				"add": 1,
				"delete": 1,
				"update": 1,
				"addDevice": 1
			},
			"forbidBindUser": 1
		},
		{
			"orgName": "组织44",
			"orgPreCode": "001004",
			"orgSn": "15345w63123",
			"orgType": "org_province",
			"province": "2280",
			"city": "2281",
			"county": "2283",
			"operateLock": {
				"add": 1,
				"delete": 1,
				"update": 1,
				"addDevice": 1
			}
		}
	]
}

返回参数

名称类型说明
successboolean接口返回是否成功
codestring错误码：0-为无错误，非0-为具体错误码
errMsgstring错误消息
dataobject返回数据对象
+idint主键ID
+orgCodestring新增组织编码
+orgNamestring组织名称
+orgSnstring组织唯一标识码
+orgTypeString组织类型code，具体参考组织类型
+provincestring省
+citystring市
+countystring县/小区
+sortint同级组织排序值
+forbidBindUserint0-可关联用户，1-禁止关联用户， 默认关联用户
+forbidBindServicestring设置组织可以绑定用户的服务编码

返回参数示例（成功）

{
    "success": true,
    "data": {
        "value": [
            {
                "id": 18,
                "orgCode": "001002003",
                "orgName": "组织29",
                "orgType": "org_base",
                "orgSn": "15345w6312",
                "sort": 3,
                "province": "2280",
                "city": "2281",
                "county": "2283",
				"forbidBindUser": 0
            },
            {
                "id": 19,
                "orgCode": "001003003",
                "orgName": "组织33",
                "orgType": "org_base",
                "orgSn": "15345w6334235",
                "sort": 3,
                "province": "2280",
                "city": "2281",
                "county": "2283",
				"forbidBindUser": 1,
                "forbidBindService": "evo-brm"
            },
            {
                "id": 20,
                "orgCode": "001004003",
                "orgName": "组织44",
                "orgType": "org_province",
                "orgSn": "15345w63123",
                "sort": 3,
                "province": "2280",
                "city": "2281",
                "county": "2283"
            }
        ]
    },
    "code": "0",
    "errMsg": ""
}

返回参数示例（失败）

{
    "success": false,
    "data": {},
    "code": "28100002",
    "errMsg": "上级组织节点不存在"
}
组织分页查询

接口说明

分页获取组织信息

接口版本

1.2.0

接口URL

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

请求Method

POST

数据提交格式

application/json

请求参数

参数名必选类型说明
pageNumfalseint当前页, 默认1
pageSizefalseint每页记录数, 默认10
sortfalsestring排序字段（参数描述参考返回列表）：id（默认）、createDate、updateDate、sort、stat、allSort、orgCode、orgName、orgSn、orgType
sortTypefalsestring排序规则：正序-ASC 倒序-DESC（默认）
orgTypeListfalseList组织类型列表 列表最大支持500，具体参考组织类型
orgCodeListfalseList组织编码列表 列表最大支持500
orgSnListfalseList组织唯一标识码列表 列表最大支持500
preOrgCodefalseString父级组织编码列表
includeSubOrgCodeFlagfalseboolean是否包含子节点组织 preOrgCode参数存在时有效, 默认 false 不展示下级

请求参数示例

{
    "pageNum": 1,
    "pageSize": 10,
    "sortType": "DESC",
    "sort": "sort",
    "orgTypeList":["org_estate"],
    "orgCodeList": ["001002"],
    "orgSnList": ["951e9090-4db8-4173-840c-440688bee96b"],
    "preOrgCode":"001",
    "includeSubOrgCodeFlag":true
}

返回参数

名称类型说明
successboolean接口返回是否成功
codestring错误码：0-为无错误，非0-为具体错误码
errMsgstring错误消息
dataobject返回数据对象
+orgCodestring组织编码，从右减3位为父节点，根节点是001
+orgNamestring组织名称
+orgSnstring唯一标识码
+orgTypestring组织结构类型，具体参考组织类型
+provincestring省
+citystring市
+countystring县
+domainIdLong域ID
+statInteger状态
+sortInteger排序码
+allSortstring所有组排序织
+servicestring子系统服务编码,默认evo-thirdParty
+forbidBindUserInteger禁止绑定用户： 0-可绑定用户，1-不可绑定用户
+forbidBindServiceString禁止绑定用户服务

返回参数示例（成功）

{
    "success": true,
    "data": {
        "pageData": [
            {
                "service": "evo-thirdParty",
                "id": 46,
                "orgCode": "001002",
                "orgName": "临时节点",
                "orgSn": "951e9090-4db8-4173-840c-440688bee96b",
                "orgType": "org_estate",
                "province": "130000",
                "city": "1",
                "county": "1",
                "domainId": 2,
                "stat": 1,
                "sort": 2,
                "allSort": "1",
                "forbidBindUser": 0,
                "forbidBindService": "1"
            }
        ],
        "currentPage": 1,
        "totalPage": 1,
        "pageSize": 10,
        "totalRows": 1
    },
    "code": "0",
    "errMsg": ""
}
组织全量数据同步

接口说明

全量同步组织数据

接口配套版本信息

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

接口版本

1.2.0

接口URL

/evo-apigw/evo-brm/1.2.0/organization/page

请求Method

GET

数据提交格式

--

请求参数

参数名必选类型说明
pageNumfalseint当前页, 默认1
pageSizefalseint每页记录数, 默认10
orgPreCodefalseString组织父节点
maxRangeIdfalselong同步边界值

请求参数示例

https://10.55.200.22/evo-apigw/evo-brm/1.2.0/organization/page?pageNum=1&pageSize=10&orgPreCode=001&maxRangeId=100

返回参数

名称类型说明
successboolean接口返回是否成功
codestring错误码：0-为无错误，非0-为具体错误码
errMsgstring错误消息
dataPageVO分页数据

PageVO

名称类型说明
currentPageint当前页码
totalPageint总页数
pageSizeint每页记录数
totalRowsint总数
pageDataList<OrgInfoVO>数据列表

OrgInfoVO

名称类型说明
orgCodestring组织编码
orgNamestring组织名称
orgSnstring唯一标识码
orgTypestring组织结构类型，具体参考组织类型
provincestring省
citystring市
countystring县
domainIdLong域ID
statInteger状态
sortInteger排序码
allSortstring所有组排序织
servicestring子系统服务编码,默认evo-thirdParty
forbidBindUserInteger禁止绑定用户 ：0-可绑定用户，1-不可绑定用户
forbidBindServiceString禁止绑定用户服务

返回参数示例（成功）

{
    "success": true,
    "data": {
        "pageData": [
            {
                "service": "vims",
                "id": 46,
                "orgCode": "001002",
                "orgName": "临时节点",
                "orgSn": "951e9090-4db8-4173-840c-440688bee96b",
                "orgType": "org_estate",
                "province": "130000",
                "city": "1",
                "county": "1",
                "domainId": 2,
                "stat": 1,
                "sort": 2,
                "allSort": "1",
                "forbidBindUser": 0,
                "forbidBindService": "1"
            }
        ],
        "currentPage": 1,
        "totalPage": 1,
        "pageSize": 10,
        "totalRows": 1
    },
    "code": "0",
    "errMsg": ""
}