1. 访客类型配置信息

API列表

编号 API名称 路径 版本
1.1 访客类型配置新增 /v1/iot/door/visitorSetting/add 1.0
1.2 访客类型配置修改 /v1/iot/door/visitorSetting/update 1.0
1.3 访客类型配置删除 /v1/iot/door/visitorSetting/delete 1.0
1.4 访客类型配置列表查询 /v1/iot/door/visitorSetting/query 1.0
1.5 访客类型配置详情查询 /v1/iot/door/visitorSetting/queryInfo 1.0
1.6 根据访客性质获取访客类型 /v1/iot/door/visitorSetting/queryByVisitorKind 1.0
1.7 访客性质数据集 /v1/iot/door/visitorSetting/queryVisitorKind 1.0

API调用

1.1: 访客类型配置新增

描述 访客类型配置新增

请求信息

HTTP协议:HTTP,HTTPS

uri:/v1/iot/door/visitorSetting/add

方法:POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
visitorTypeName body string y 访客类型名称
allowOpeningTimes body int y 授权次数
expiredHour body double n 授权时效(时)
visitorPeriod body string n 是否访问周期
visitorKindId body int y 访客性质id
projectId body string y 项目id

请求Body描述(非Form表单数据)

{
    "visitorTypeName":"测试访客",
    "allowedOpeningTimes": 1,
    "expiredHour": 1.5,
    "visitorKindId": 1,
    "visitorPeriod": "否",
    "projectId": "92"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 响应码标识
success 顶层 boolean 是否成功
data 顶层 boolean 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": true
}

1.2: 访客类型配置修改

描述

请求信息

HTTP协议:HTTP,HTTPS

uri: /v1/iot/door/visitorSetting/update

方法:POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
id body string y 主键id
visitorTypeName body string y 访客类型名称
allowOpeningTimes body int y 授权次数
expiredHour body double n 授权时效(时)
visitorPeriod body string n 是否访问周期
visitorKindId body int y 访客性质id
projectId body string y 项目id

请求Body描述(非Form表单数据)

{
    "id": 2,
    "visitorTypeName":"测试访客update",
    "allowedOpeningTimes": 1,
    "expiredHour": "1.5",
    "visitorKindId": 1,
    "visitorPeriod": "否",
    "projectId": "92"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING y 响应码标识
success 顶层 boolean y 是否成功
data 顶层 boolean y 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": true
}

1.3: 访客类型配置删除

描述 访客类型配置删除

请求信息

HTTP协议:HTTP,HTTPS

uri:/v1/iot/door/visitorSetting/delete

方法:POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
id body JSONARRAY y 访客类型配置id

请求Body描述(非Form表单数据)

{
  "id": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 响应码标识
message 顶层 STRING 响应消息文本
data 顶层 boolean 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": true
}

1.4: 访客类型配置列表查询

描述

请求信息

HTTP协议:HTTP,HTTPS

uri: /v1/iot/door/visitorSetting/query

方法:POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
projectId body int y 项目id

请求Body描述(非Form表单数据)

{
    "projectId": "92"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 响应码标识
message 顶层 STRING 响应消息文本
data 顶层 boolean 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": [
        {
            "id": 3,
            "createTime": "2021-01-08 10:45:17",
            "updateTime": "2021-01-08 10:45:17",
            "visitorTypeName": "测试访客", (访客类型明)
            "allowOpeningTimes": 1, (授权次数)
            "expiredHour": 1.5, (授权时效(单位时))
            "visitorPeriod": "否", (是否授权周期)
            "visitorKindId": 1, (访客性质id)
            "visitorKind": "普通访客", (访客性质)
            "projectId": "92" (项目id)
        }
    ]
}

1.5: 访客类型配置详情查询

描述 访客类型配置详情查询

请求信息

HTTP协议:HTTP,HTTPS

uri: /v1/iot/door/visitorSetting/queryInfo

方法:POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
id body string y 访客类型配置id

请求Body描述(非Form表单数据)

{
    "id": "3"
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 响应码标识
message 顶层 STRING 响应消息文本
data 顶层 boolean 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": {
        "id": 3,
        "createTime": "2021-01-08 10:45:17",
        "updateTime": "2021-01-08 10:45:17",
        "visitorTypeName": "测试访客", 
        "allowOpeningTimes": 1,
        "expiredHour": 1.5,
        "visitorPeriod": "否",
        "visitorKindId": 1,
        "visitorKind": "普通访客",
        "projectId": "92"
    }
}

1.6: 根据访客性质获取访客类型

描述 根据访客性质获取访客类型

请求信息

HTTP协议:HTTP,HTTPS

uri: /v1/iot/door/visitorSetting/queryByVisitorKind

方法:POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述
projectId body string y 项目id
visitorKindId body string y 访客性质id

请求Body描述(非Form表单数据)

{
    "projectId": "92",
    "visitorKindId": 1
}

返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 响应码标识
message 顶层 STRING 响应消息文本
data 顶层 boolean 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": [
        {
            "id": 3,
            "visitorTypeName": "测试访客"
        }
    ]
}

1.7: 访客性质数据集

描述 访客性质数据集

请求信息

HTTP协议:HTTP,HTTPS

uri: /v1/iot/door/visitorSetting/queryVisitorKind

方法:POST

名称 位置 类型 必填 描述

请求参数

名称 位置 类型 必填 描述

请求Body描述(非Form表单数据)



返回信息

返回参数类型

JSON

返回参数

名称 位置 类型 必填 描述
code 顶层 STRING 响应码标识
message 顶层 STRING 响应消息文本
data 顶层 boolean 响应数据对象
返回结果示例
{
    "code": "200",
    "success": true,
    "data": [
        {
            "typeName": "普通访客",
            "type": "1"
        },
        {
            "typeName": "短期特殊访客",
            "type": "2"
        },
        {
            "typeName": "长期特殊访客",
            "type": "3"
        }
    ]
}

results matching ""

    No results matching ""