组织管理

组织管理相关接口

请求方式	API	描述
GET	/v1.0/iot-02/building/structures/actions/children-info	获取子组织
GET	/v1.0/iot-02/building/structures/actions/match-name	模糊查询组织
GET	/v1.0/iot-02/building/structures/actions/parents-info	获取所有上级组织
POST	/v1.0/iot-02/building/structures	添加组织
PUT	/v1.0/iot-02/building/structures	编辑组织
PUT	/v1.0/iot-02/building/structures/actions/move	移动组织
DELETE	/v1.0/iot-02/building/structures/{structure_id}	删除组织

获取子组织

功能描述

获取子组织。

接口地址

GET /v1.0/iot-02/building/structures/actions/children-info

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	query	项目ID	true
structureId	String	query	组织ID	true

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功。true：成功，false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13 位
result	Object	返回结果

result 参数说明

[
    {
        "structureId": "String //组织ID",
        "parentStructureId": "String //父组织ID",
        "structureName": "String //组织名称",
        "level": "int //组织层级",
        "projectId": "String //项目ID",
        "sort": "int //组织同层级排序值",
        "mobile": "String //手机号",
        "externalNo": "String //外部编号"
    }
]

请求示例

{
    "projectId":"1424615984265764***",
    "structureId":"1439128101413011***"
}

响应示例

{
    "result": [
        {
            "alias_code": "fuY**",
            "alias_code_path": "Sn0QFfu***",
            "external_no": "一级组织",
            "level": 1,
            "parent_structure_id": "1439128101413011***",
            "project_id": "1424615984265764***",
            "remark": "",
            "sort": 100000,
            "structure_id": "1439128403298041***",
            "structure_name": "一级组织00"
        },
        {
            "alias_code": "n0N**",
            "alias_code_path": "Sn0QFn0***",
            "external_no": "一级组织04",
            "level": 1,
            "parent_structure_id": "1439128101413011***",
            "project_id": "1424615984265764***",
            "remark": "",
            "sort": 200000,
            "structure_id": "1440882131684409***",
            "structure_name": "测试修改"
        }
    ],
    "success": true,
    "t": 1662709452591,
    "tid": "323259e2301311edaf4dfa23c521f7ba"
}

模糊查询组织

功能描述

模糊查询组织。

接口地址

GET /v1.0/iot-02/building/structures/actions/match-name

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	query	项目ID	true
structureName	String	query	组织名称	true

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功。true：成功，false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13 位
result	Object	返回结果

result 参数说明

[
    {
        "structureId": "String //组织ID",
        "parentStructureId": "String //父组织ID",
        "structureName": "String //组织名称",
        "level": "int //组织层级",
        "projectId": "String //项目ID",
        "sort": "int //组织同层级排序值",
        "mobile": "String //手机号",
        "externalNo": "String //外部编号"
    }
]

请求示例

{
    "projectId":"1424615984265764***",
    "structureName":"测试"
}

响应示例

同上

获取所有上级组织

功能描述

获取所有上级组织。

接口地址

GET /v1.0/iot-02/building/structures/actions/parents-info

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	query	项目ID	true
structureId	String	query	组织ID	true

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功。true：成功，false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13 位
result	Object	返回结果

result 参数说明

[
    {
        "structureId": "String //组织ID",
        "parentStructureId": "String //父组织ID",
        "structureName": "String //组织名称",
        "level": "int //组织层级",
        "projectId": "String //项目ID",
        "sort": "int //组织同层级排序值",
        "mobile": "String //手机号",
        "externalNo": "String //外部编号"
    }
]

请求示例

{
    "projectId":"1424615984265764***",
    "structureId":"1439128101413011***"
}

响应示例

同上

添加组织

功能描述

添加组织。

接口地址

POST /v1.0/iot-02/building/structures

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	body	项目ID	true
parentStructureId	String	body	父组织ID	true
structureName	String	body	组织名称	true
externalNo	String	body	外部编号	false

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功。true：成功，false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13 位
result	Object	返回结果

result 参数说明

String{}

请求示例

{
    "projectId":"1424615984265764***",
    "parentStructureId":"1439128101413011***",
    "structureName":"开放API测试组织"
}

响应示例

{
    "result": "1568143944687058944",
    "success": true,
    "t": 1662709625841,
    "tid": "99821b47301311edaf4dfa23c521f7ba"
}

编辑组织

功能描述

编辑组织。

接口地址

PUT /v1.0/iot-02/building/structures

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	body	项目ID	true
structureId	String	body	组织ID	true
structureName	String	body	组织名称	true
externalNo	String	body	外部编号	false

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功。true：成功，false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13 位
result	Object	返回结果

result 参数说明

boolean{}

请求示例

{
    "projectId":"1424615984265764***",
    "structureId":"1440882131684409***",
    "structureName":"测试修改"
}

响应示例

{
    "result": true,
    "success": true,
    "t": 1628669342514
}

移动组织

功能描述

移动组织。

接口地址

PUT /v1.0/iot-02/building/structures/actions/move

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	body	项目ID	true
positionRequest	Object	body	移动的组织	true
sortRequestList	List	body	移动导致需要修改排序的组织	false

positionRequest

参数名	类型	参数类型	说明	是否必需
structureId	String	body	移动的组织ID	true
parentStructureId	String	body	目标父组织ID	true
sort	int	body	目标父组织下的同层级排序值	false

sortRequestList

参数名	类型	参数类型	说明	是否必需
structureId	String	body	组织ID	true
sort	int	body	组织的同层级排序值	false

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功。true：成功，false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13 位
result	Object	返回结果

result 参数说明

boolean{}

请求示例

{
  "projectId": "String //项目ID",
  "positionRequest": {
    "structureId": "String //移动的组织ID",
    "parentStructureId": "String //目标父组织ID",
    "sort": "int //目标父组织下的同层级排序值"
  },
  "sortRequestList": [
    {
      "structureId": "String //组织ID",
      "sort": "int //同层级排序值"
    }
  ]
}

响应示例

{
    "result": true,
    "success": true,
    "t": 1628669342514
}

删除组织

功能描述

删除组织。

接口地址

DELETE /v1.0/iot-02/building/structures/{structure_id}

请求参数

参数名	类型	参数类型	说明	是否必需
structure_id	String	uri	组织ID	true
projectId	String	body	项目ID	true

返回参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功。true：成功，false：失败
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13 位
result	Object	返回结果

result 参数说明

boolean{}

请求示例

{
    "structureId": "组织ID",
    "projectId": "项目ID"
}

响应示例

{
    "result": true,
    "success": true,
    "t": 1628669342514
}

错误码

以下为该接口常见的业务异常。更多的异常错误，请参见全局错误码。

错误码	说明
500	系统错误