人员通行授权

API 列表

请求方式	API	描述
GET	/v1.0/iot-02/building/access-auth-rules/actions/list-auth-structure	已授权组织树
GET	/v1.0/iot-02/building/access-auth-rules/actions/match-auth-structure	已授权组织，根据名称模糊查询
GET	/v1.0/iot-02/building/access-auth-rules/actions/list-auth-person	已授权人员列表
POST	/v1.0/iot-02/building/access-auth-rules/actions/add-rules	按组织/人员/人员群组授权
POST	/v1.0/iot-02/building/access-auth-rules/actions/generate-auth	应用当前 authId 的规则
POST	/v1.0/iot-02/building/access-auth-rules/actions/query-rules	授权规则列表
PUT	/v1.0/iot-02/building/access-auth-rules/actions/delete-by-source	按组织/人员删除权限
PUT	/v1.0/iot-02/building/access-auth-rules/actions/edit-by-channels	按出入口编辑有效期
PUT	/v1.0/iot-02/building/access-auth-rules/actions/delete-by-channels	按出入口删除权限
GET	/v1.0/iot-02/building/access-auth-rules/actions/channel-detail	出入口群组/出入口详情

已授权组织树

功能描述

已授权组织树。

接口地址

GET /v1.0/iot-02/building/access-auth-rules/actions/list-auth-structure

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	body	项目 ID	是
structureId	String	body	父组织结构 ID	是

返回参数

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

result 参数说明

[
  {
    "structureId": "String //结构 ID",
    "parentStructureId": "String //结构父级 ID，没有父级为 null",
    "structureName": "String //结构名称",
    "level": "int //层级，0 表示最顶级",
    "projectId": "String //项目 ID，项目类型必须有值",
    "remark": "String //备注",
    "sort": "int //层级内排序",
    "externalNo": "String //扩展字段一（用作外部编号）",
    "aliasCode": "String //节点 code",
    "aliasCodePath": "String //节点 codePath"
  }
]

请求示例

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

响应示例

[
  {
    "structureId": "结构 ID",
    "parentStructureId": "结构父级 ID，没有父级为 null",
    "structureName": "结构名称",
    "level": "层级，0 表示最顶级",
    "projectId": "项目 ID，项目类型必须有值",
    "remark": "备注",
    "sort": "层级内排序",
    "externalNo": "扩展字段一（用作外部编号）",
    "aliasCode": "节点 code",
    "aliasCodePath": "节点 codePath"
  }
]

根据名称模糊查询已授权组织

功能描述

根据名称，模糊查询已授权组织。

接口地址

GET /v1.0/iot-02/building/access-auth-rules/actions/match-auth-structure

请求参数

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

返回参数

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

result 参数说明

[
  {
    "structureId": "String //结构 ID",
    "parentStructureId": "String //结构父级 ID，没有父级为 null",
    "structureName": "String //结构名称",
    "level": "int //层级，0 表示最顶级",
    "projectId": "String //项目 ID，项目类型必须有值",
    "remark": "String //备注",
    "sort": "int //层级内排序",
    "externalNo": "String //扩展字段一（用作外部编号）",
    "aliasCode": "String //节点 code",
    "aliasCodePath": "String //节点 codePath"
  }
]

请求示例

{
  "structureName": "组织名称",
  "projectId": "项目 ID"
}

响应示例

[
  {
    "structureId": "结构 ID",
    "parentStructureId": "结构父级 ID，没有父级为 null",
    "structureName": "结构名称",
    "level": "层级，0 表示最顶级",
    "projectId": "项目 ID，项目类型必须有值",
    "remark": "备注",
    "sort": "层级内排序",
    "externalNo": "扩展字段一（用作外部编号）",
    "aliasCode": "节点 code",
    "aliasCodePath": "节点 codePath"
  }
]

已授权人员列表

功能描述

已授权人员列表。

接口地址

GET /v1.0/iot-02/building/access-auth-rules/actions/list-auth-person

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	body	项目 ID	是
name	String	body	名称	否
personCode	String	body	工号	否
page	int	body	页数	是
pageSize	int	body	页大小	是

返回参数

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

result 参数说明

{
  "total": "int",
  "list": [
    {
      "personId": "String //人员 ID",
      "name": "String //姓名",
      "personCode": "String //工号"
    }
  ],
  "hasMore": "boolean"
}

请求示例

{
  "name": "名称",
  "pageSize": "页大小",
  "page": "页数",
  "projectId": "项目 ID",
  "personCode": "工号"
}

响应示例

{
    "result": {
        "list": [
            {
                "name": "张重试",
                "person_code": "1123",
                "person_id": "1564855972651077***"
            },
            {
                "name": "涂鸦",
                "person_code": "",
                "person_id": "1563058569924837***"
            },
            {
                "name": "张三",
                "person_code": "0123",
                "person_id": "1534731015270957***"
            },
            {
                "name": "测试 11",
                "person_code": "121212234",
                "person_id": "1523932734794235***"
            }
        ],
        "total": 4
    },
    "success": true,
    "t": 1664195281135,
    "tid": "a91153243d9611ed84fd2237f0528b74"
}

按组织/人员/人员群组授权

功能描述

按组织/人员/人员群组授权。

接口地址

POST /v1.0/iot-02/building/access-auth-rules/actions/add-rules

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	body	项目 ID	是
authSourceType	String	body	授权来源。 1：按组织 2：按人员 3：按人员群组	是
authStartTime	long	body	授权起始时间	否
authEndTime	long	body	授权截止时间	否
accessAuthTimeRangeId	String	body	通行时间段。目前默认全天周传 1，后续传对应时间段规则 ID	否
authIds	String[]	body	选择的组织/人员/人员群组集合	否
groupIds	String[]	body	选择的出入口群组 ID 集合	否
channelIds	String[]	body	选择的出入口 ID 集合	是

返回参数

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

result 参数说明

String{}

请求示例

{
    "authStartTime":1661443200000,
    "authEndTime":2556115199000,
    "authIds":["1563057531880804***"],
    "groupIds":[],
    "authSourceType":"1",
    "channelIds":["1554305065534095***"],
    "accessAuthTimeRangeId":"1",
    "projectId":"1424615984265764***"
}

响应示例

{
    "result": "1574375617216917504",
    "success": true,
    "t": 1664195372302,
    "tid": "df6017e83d9611ed84fd2237f0528b74"
}

应用当前 authId 的规则

功能描述

应用当前 authId 的规则。

接口地址

POST /v1.0/iot-02/building/access-auth-rules/actions/generate-auth

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	body	项目 ID	是
authSourceType	String	body	授权来源。 1：按组织 2：按人员 3：按人员群组	是
authId	String	body	组织 ID 或人员 ID	是

返回参数

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

result 参数说明

String{}

请求示例

{
  "authSourceType": "授权来源：按组织：1，按人员：2，按人员群组：3",
  "projectId": "项目 ID",
  "authId": "组织 ID 或人员 ID"
}

响应示例

String{}

授权规则列表

功能描述

授权规则列表。

接口地址

POST /v1.0/iot-02/building/access-auth-rules/actions/query-rules

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	body	项目 ID	是
authId	String	body	组织 ID/人员 ID/群组 ID	否
relationType	int	body	搜索类型。 1：出入口群组 2：出入口	否
relationName	String	body	出入口组名称/出入口名称	否
page	int	body	页数	是
pageSize	int	body	页大小	是

返回参数

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

result 参数说明

{
  "total": "int",
  "list": [
    {
      "authRelationId": "String //授权主键 ID",
      "authId": "String //组织 ID/人员 ID/群组 ID",
      "relationType": "int //搜索类型 1：出入口群组，2：出入口",
      "relationId": "String //授权的出入口/出入口群组 ID",
      "relationName": "String //出入口组名称/出入口名称",
      "accessAuthTimeRangeId": "String //通行时间段：目前默认全天周",
      "accessAuthTimeRangeStr": "String //通行时间段：目前默认全天周",
      "authStartTime": "long //授权起始时间",
      "authEndTime": "long //授权截止时间"
    }
  ],
  "hasMore": "boolean"
}

请求示例

{
  "relationType": "搜索类型 1：出入口群组，2：出入口",
  "relationName": "出入口组名称/出入口名称",
  "pageSize": "页大小",
  "page": "页数",
  "projectId": "项目 ID",
  "authId": "组织 ID/人员 ID/群组 ID"
}

响应示例

{
  "total": "int",
  "list": [
    {
      "list": "授权截止时间"
    }
  ],
  "hasMore": "boolean"
}

按组织/人员 删除权限

功能描述

按组织/人员，删除权限。

接口地址

PUT /v1.0/iot-02/building/access-auth-rules/actions/delete-by-source

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	body	项目 ID	是
authSourceType	String	body	授权来源。 1：按组织 2：按人员 3：按人员群组	是
authId	String	body	组织 ID	是

返回参数

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

result 参数说明

String{}

请求示例

{
  "authSourceType": "授权来源：按组织：1，按人员：2，按人员群组：3",
  "projectId": "项目 ID",
  "authId": "组织 ID|人员 ID|人员群组 ID"
}

响应示例

String{}

按出入口编辑有效期

功能描述

按出入口编辑有效期。

接口地址

PUT /v1.0/iot-02/building/access-auth-rules/actions/edit-by-channels

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	body	项目 ID	是
authId	String	body	组织 ID/ 人员 ID	是
authSourceType	String	body	授权来源。 1：按组织 2：按人员 3：按人员群组	否
authRelationIds	String[]	body	授权规则 ID	否
authStartTime	long	body	授权起始时间	否
authEndTime	long	body	授权截止时间	否

返回参数

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

result 参数说明

String{}

请求示例

{
  "authEndTime": "授权截止时间",
  "authRelationIds": "授权规则 ID",
  "authStartTime": "授权起始时间",
  "authSourceType": "授权来源：按组织：1，按人员：2，按人员群组：3",
  "projectId": "项目 ID",
  "authId": "组织 ID/ 人员 ID"
}

响应示例

String{}

按出入口删除权限

功能描述

按出入口删除权限。

接口地址

PUT /v1.0/iot-02/building/access-auth-rules/actions/delete-by-channels

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	body	项目 ID	是
authId	String	body	组织 ID/ 人员 ID	是
authSourceType	String	body	授权来源。 1：按组织 2：按人员 3：按人员群组	否
authRelationIds	String[]	body	授权主键 ID	否

返回参数

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

result 参数说明

String{}

请求示例

{
  "authRelationIds": "授权主键 ID",
  "authSourceType": "授权来源：按组织：1，按人员：2，按人员群组：3",
  "projectId": "项目 ID",
  "authId": "组织 ID/ 人员 ID"
}

响应示例

String{}

出入口群组/出入口详情

功能描述

出入口群组/出入口详情。

接口地址

GET /v1.0/iot-02/building/access-auth-rules/actions/channel-detail

请求参数

参数名	类型	参数类型	说明	是否必需
projectId	String	body	项目 ID	是
authRelationId	String	body	授权主键 ID	否
page	int	body	页数	是
pageSize	int	body	页大小	是

返回参数

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

result 参数说明

{
  "accessAuthTimeRangeId": "String //通行时间段：目前默认全天周",
  "accessAuthTimeRangeStr": "String //通行时间段：目前默认全天周",
  "total": "int //总数",
  "channelListVOList": [
    {
      "relationId": "String //出入口 ID 或人员 ID",
      "accessControlChannelName": "String //出入口名称",
      "accessControlChannelNo": "String //出入口通道号",
      "accessChannelRoomId": "String //出入口安装空间 ID",
      "accessChannelPositionPath": "String //出入口安装空间名称",
      "businessDeviceId": "String //业务设备 ID",
      "businessDeviceName": "String //业务设备名称"
    }
  ]
}

请求示例

{
  "pageSize": "页大小",
  "page": "页数",
  "projectId": "项目 ID",
  "authRelationId": "授权主键 ID"
}

响应示例

{
  "accessAuthTimeRangeId": "通行时间段：目前默认全天周",
  "accessAuthTimeRangeStr": "通行时间段：目前默认全天周",
  "total": "总数",
  "channelListVOList": [
    {
      "channelListVOList": "业务设备名称"
    }
  ]
}

错误码

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

错误码	说明
500	系统错误