API文档目录

获取所有树编码

  • 接口说明

所有获取组织的接口都需要treeCode参数,本接口提供获取所有treeCode接口,treeCode为0时代表国标树

  • 接口版本

v1

  • 接口地址

/api/resource/v1/unit/getAllTreeCode

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
Object Object true
  • 入参举例
{
  
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  total Number 总条数 false 2
  list Array List数据 false
   list[0] Object false
    treeCode String 树编码(长度1-255位) false 0
    treeName String 树名称(长度1-255位) false 国标目录
    capabilitySet String 能力集(该树下的监控点的能力集的集合,详见【数据字典】),取值参考【数据字典】,typeCode为xresmgr.capability_set false {“CAMERA”:"@motiontrack@remote_emer@"}
    intelligentSet String 智能能力集(该树下的监控点的智能能力集的集合,详见【数据字典】),取值参考【数据字典】,typeCode为xresmgr.intelligent_set false {“CAMERA”:"@alarm@"}
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “total”: 2,
     “list”: [
       {
         “treeCode”: “0”,
         “treeName”: “国标目录”,
         “capabilitySet”: “{\“CAMERA\”:\”@motiontrack@remote_emer@\"}",
         “intelligentSet”: " {\“CAMERA\”:\"@alarm@\"}"
      }
    ]
  }
}

分页获取区域列表

  • 接口说明

根据输入分页参数和树编码treeCode,分页返回对应树的所有区域。其中treeCode可通过【获取所有树编码】获取,treeCode为0代表国标树。

  • 接口版本

v1

  • 接口地址

/api/resource/v1/regions

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 pageNo Number true 指定第几页,从1开始 1
 pageSize Number true 每页返回的条数 20
 treeCode String false 树编号(默认0:国标树),可通过【获取所有树编码】获取 0
  • 入参举例
{
   “pageNo”: 1,
   “pageSize”: 20,
   “treeCode”: “0”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  total Number 总条数 false 1
  pageSize Number 当前分页记录数 false 20
  pageNo Number 当前页 false 1
  list Array 组织列表 false
   list[0] Object false
    indexCode String 组织编号(长度1-255位) false 083b2031c1db4f368f015fe2562e0012
    name String 组织名称(长度1-255位) false 全国
    parentIndexCode String 父组织编号(长度1-255位) false -1
    treeCode String 树编码 false 0
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “total”: 1,
     “pageSize”: 20,
     “pageNo”: 1,
     “list”: [
       {
         “indexCode”: “083b2031c1db4f368f015fe2562e0012”,
         “name”: “全国”,
         “parentIndexCode”: “-1”,
         “treeCode”: “0”
      }
    ]
  }
}

获取根区域信息

  • 接口说明

获取根区域信息,根区域信息作为【根据区域编号获取下一级区域列表】参数来获取根区域下的区域信息。

  • 接口版本

v1

  • 接口地址

/api/resource/v1/regions/root

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 treeCode String false 树编号(默认0,0代表国标树),可通过【获取所有树编码】获取 0
  • 入参举例
{
   “treeCode”: “0”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  total Number 总条数 false 1
  list Array List数据 false
   list[0] Object false
    indexCode String 组织编码(长度1-255位) false 083b2031c1db4f368f015fe2562e0012
    name String 名称(长度1-255位) false 全国
    parentIndexCode String 父组织编码(长度1-255位 false -1
    treeCode String 树编号 false 0
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “total”: 1,
     “list”: [
       {
         “indexCode”: “083b2031c1db4f368f015fe2562e0012”,
         “name”: “全国”,
         “parentIndexCode”: “-1”,
         “treeCode”: “0”
      }
    ]
  }
}

根据区域编号获取下一级区域列表

  • 接口说明

根据父区域编号获取下一层子区域列表,可以用此接口查询需要展开的区域列表。其中根区域的信息可以通过接口【获取根区域信息】获取

  • 接口版本

v1

  • 接口地址

/api/resource/v1/regions/subRegions

  • 请求方法

POST

  • 数据提交方式

application/json

  • 输入参数
字段名 类型 必填 描述 示例
 parentIndexCode String true 父组织编号 -1
 treeCode String false 树编号(默认0,0代表国标树),可通过【获取所有树编码】获取 0
  • 入参举例
{
   “parentIndexCode”: “-1”,
   “treeCode”: “0”
}
  • 返回值
参数名称 数据类型 属性描述 是否必填 示例
 code String 返回码(0表示成功,其他表示失败) false 0
 msg String 返回信息 false success
 data Object 返回数据 false
  total Number 总条数 false 1
  list Array List数据 false
   list[0] Object false
    indexCode String 组织编码(长度1-255位) false 083b2031c1db4f368f015fe2562e0012
    name String 名称(长度1-255位) false 全国
    parentIndexCode String 父组织编码(长度1-255位) false -1
    treeCode String 树编号(非必填) false 0
  • 返回值举例
{
   “code”: “0”,
   “msg”: “success”,
   “data”: {
     “total”: 1,
     “list”: [
       {
         “indexCode”: “083b2031c1db4f368f015fe2562e0012”,
         “name”: “全国”,
         “parentIndexCode”: “-1”,
         “treeCode”: “0”
      }
    ]
  }
}