camera_vendor.md 37 KB

文档

摄像头厂家管理 Controller

获取厂家列表(分页)

维护人:TG Live

URL

描述:获取厂家列表(分页)

ContentType:application/json

请求参数

Body Parameter
名称 类型 必填 最大长度 描述 示例值
page Integer - 页码 (从 1 开始) 1
size Integer - 每页条数 10
keyword String - 搜索关键词 (模糊匹配名称、ID 等) 摄像头
enabled Boolean - 启用状态过滤 (null=全部, true=启用, false=禁用) true
sortBy String - 排序字段 createdAt
sortDir String - 排序方向 (ASC/DESC) DESC

请求示例

{
    "page": 1,
    "size": 10,
    "keyword": "摄像头",
    "enabled": true,
    "sortBy": "createdAt",
    "sortDir": "DESC"
}

响应参数

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {
        "list": [
            {
                "id": 0,
                "code": "string",
                "name": "string",
                "description": "string",
                "logoUrl": "string",
                "supportOnvif": true,
                "supportPtz": true,
                "supportIsapi": true,
                "supportGb28181": true,
                "supportAudio": true,
                "resolution": "string",
                "defaultPort": 0,
                "defaultRtspPort": 0,
                "rtspUrlTemplate": "string",
                "enabled": true,
                "sortOrder": 0,
                "createdAt": "yyyy-MM-dd HH:mm:ss",
                "updatedAt": "yyyy-MM-dd HH:mm:ss"
            }
        ],
        "page": 1,
        "size": 10,
        "total": 100,
        "totalPages": 10,
        "hasNext": true,
        "hasPrevious": false
    }
}

错误码

获取所有启用的厂家(用于下拉选择)

维护人:TG Live

URL

描述:获取所有启用的厂家(用于下拉选择)

ContentType:application/x-www-form-urlencoded;charset=UTF-8

请求参数

响应参数

名称 类型 必填 最大长度 描述 示例值
success Boolean - 请求是否成功 true
errCode String - 错误码(失败时返回)
errMessage String - 错误信息(失败时返回)
data object 响应数据 (ActualType: PageResponse)
└ list List 数据列表 (ActualType: T)
└ id Long - 厂家 ID 0
└ code String - 厂家代码
└ name String - 厂家名称
└ description String - 厂家描述
└ logoUrl String - 厂家 Logo URL
└ supportOnvif Boolean - 是否支持 ONVIF 协议 true
└ supportPtz Boolean - 是否支持 PTZ 控制 true
└ supportIsapi Boolean - 是否支持 ISAPI 协议 true
└ supportGb28181 Boolean - 是否支持 GB28181 协议 true
└ supportAudio Boolean - 是否支持音频 true
└ resolution String - 默认分辨率
└ defaultPort Integer - 默认端口号 0
└ defaultRtspPort Integer - 默认 RTSP 端口号 0
└ rtspUrlTemplate String - RTSP URL 模板
└ enabled Boolean - 是否启用 true
└ sortOrder Integer - 排序号 0
└ createdAt LocalDateTime - 创建时间 yyyy-MM-dd HH:mm:ss
└ updatedAt LocalDateTime - 更新时间 yyyy-MM-dd HH:mm:ss
└ page Integer - 当前页码 (从 1 开始) 1
└ size Integer - 每页条数 10
└ total Long - 总记录数 100
└ totalPages Integer - 总页数 10
└ hasNext Boolean - 是否有下一页 true
└ hasPrevious Boolean - 是否有上一页 false
名称 类型 必填 最大长度 描述 示例值
success Boolean - 请求是否成功 true
errCode String - 错误码(失败时返回)
errMessage String - 错误信息(失败时返回)
data array 响应数据 (ActualType: List)
└ id Long - 厂家 ID 0
└ code String - 厂家代码
└ name String - 厂家名称
└ description String - 厂家描述
└ logoUrl String - 厂家 Logo URL
└ supportOnvif Boolean - 是否支持 ONVIF 协议 true
└ supportPtz Boolean - 是否支持 PTZ 控制 true
└ supportIsapi Boolean - 是否支持 ISAPI 协议 true
└ supportGb28181 Boolean - 是否支持 GB28181 协议 true
└ supportAudio Boolean - 是否支持音频 true
└ resolution String - 默认分辨率
└ defaultPort Integer - 默认端口号 0
└ defaultRtspPort Integer - 默认 RTSP 端口号 0
└ rtspUrlTemplate String - RTSP URL 模板
└ enabled Boolean - 是否启用 true
└ sortOrder Integer - 排序号 0
└ createdAt LocalDateTime - 创建时间 yyyy-MM-dd HH:mm:ss
└ updatedAt LocalDateTime - 更新时间 yyyy-MM-dd HH:mm:ss

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": [
        {
            "id": 0,
            "code": "string",
            "name": "string",
            "description": "string",
            "logoUrl": "string",
            "supportOnvif": true,
            "supportPtz": true,
            "supportIsapi": true,
            "supportGb28181": true,
            "supportAudio": true,
            "resolution": "string",
            "defaultPort": 0,
            "defaultRtspPort": 0,
            "rtspUrlTemplate": "string",
            "enabled": true,
            "sortOrder": 0,
            "createdAt": "yyyy-MM-dd HH:mm:ss",
            "updatedAt": "yyyy-MM-dd HH:mm:ss"
        }
    ]
}

错误码

获取所有厂家

维护人:TG Live

URL

描述:获取所有厂家

ContentType:application/x-www-form-urlencoded;charset=UTF-8

请求参数

响应参数

名称 类型 必填 最大长度 描述 示例值
success Boolean - 请求是否成功 true
errCode String - 错误码(失败时返回)
errMessage String - 错误信息(失败时返回)
data array 响应数据 (ActualType: List)
└ id Long - 厂家 ID 0
└ code String - 厂家代码
└ name String - 厂家名称
└ description String - 厂家描述
└ logoUrl String - 厂家 Logo URL
└ supportOnvif Boolean - 是否支持 ONVIF 协议 true
└ supportPtz Boolean - 是否支持 PTZ 控制 true
└ supportIsapi Boolean - 是否支持 ISAPI 协议 true
└ supportGb28181 Boolean - 是否支持 GB28181 协议 true
└ supportAudio Boolean - 是否支持音频 true
└ resolution String - 默认分辨率
└ defaultPort Integer - 默认端口号 0
└ defaultRtspPort Integer - 默认 RTSP 端口号 0
└ rtspUrlTemplate String - RTSP URL 模板
└ enabled Boolean - 是否启用 true
└ sortOrder Integer - 排序号 0
└ createdAt LocalDateTime - 创建时间 yyyy-MM-dd HH:mm:ss
└ updatedAt LocalDateTime - 更新时间 yyyy-MM-dd HH:mm:ss

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": [
        {
            "id": 0,
            "code": "string",
            "name": "string",
            "description": "string",
            "logoUrl": "string",
            "supportOnvif": true,
            "supportPtz": true,
            "supportIsapi": true,
            "supportGb28181": true,
            "supportAudio": true,
            "resolution": "string",
            "defaultPort": 0,
            "defaultRtspPort": 0,
            "rtspUrlTemplate": "string",
            "enabled": true,
            "sortOrder": 0,
            "createdAt": "yyyy-MM-dd HH:mm:ss",
            "updatedAt": "yyyy-MM-dd HH:mm:ss"
        }
    ]
}

错误码

获取厂家详情

维护人:TG Live

URL

描述:获取厂家详情

ContentType:application/x-www-form-urlencoded;charset=UTF-8

请求参数

Query Parameter
名称 类型 必填 最大长度 描述 示例值
id int64 - No comments found. 0

响应参数

名称 类型 必填 最大长度 描述 示例值
success Boolean - 请求是否成功 true
errCode String - 错误码(失败时返回)
errMessage String - 错误信息(失败时返回)
data object 响应数据 (ActualType: CameraVendorDTO)
└ id Long - 厂家 ID 0
└ code String - 厂家代码
└ name String - 厂家名称
└ description String - 厂家描述
└ logoUrl String - 厂家 Logo URL
└ supportOnvif Boolean - 是否支持 ONVIF 协议 true
└ supportPtz Boolean - 是否支持 PTZ 控制 true
└ supportIsapi Boolean - 是否支持 ISAPI 协议 true
└ supportGb28181 Boolean - 是否支持 GB28181 协议 true
└ supportAudio Boolean - 是否支持音频 true
└ resolution String - 默认分辨率
└ defaultPort Integer - 默认端口号 0
└ defaultRtspPort Integer - 默认 RTSP 端口号 0
└ rtspUrlTemplate String - RTSP URL 模板
└ enabled Boolean - 是否启用 true
└ sortOrder Integer - 排序号 0
└ createdAt LocalDateTime - 创建时间 yyyy-MM-dd HH:mm:ss
└ updatedAt LocalDateTime - 更新时间 yyyy-MM-dd HH:mm:ss

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {
        "id": 0,
        "code": "string",
        "name": "string",
        "description": "string",
        "logoUrl": "string",
        "supportOnvif": true,
        "supportPtz": true,
        "supportIsapi": true,
        "supportGb28181": true,
        "supportAudio": true,
        "resolution": "string",
        "defaultPort": 0,
        "defaultRtspPort": 0,
        "rtspUrlTemplate": "string",
        "enabled": true,
        "sortOrder": 0,
        "createdAt": "yyyy-MM-dd HH:mm:ss",
        "updatedAt": "yyyy-MM-dd HH:mm:ss"
    }
}

错误码

根据代码获取厂家

维护人:TG Live

URL

描述:根据代码获取厂家

ContentType:application/x-www-form-urlencoded;charset=UTF-8

请求参数

Query Parameter
名称 类型 必填 最大长度 描述 示例值
code string - No comments found.

响应参数

名称 类型 必填 最大长度 描述 示例值
success Boolean - 请求是否成功 true
errCode String - 错误码(失败时返回)
errMessage String - 错误信息(失败时返回)
data object 响应数据 (ActualType: CameraVendorDTO)
└ id Long - 厂家 ID 0
└ code String - 厂家代码
└ name String - 厂家名称
└ description String - 厂家描述
└ logoUrl String - 厂家 Logo URL
└ supportOnvif Boolean - 是否支持 ONVIF 协议 true
└ supportPtz Boolean - 是否支持 PTZ 控制 true
└ supportIsapi Boolean - 是否支持 ISAPI 协议 true
└ supportGb28181 Boolean - 是否支持 GB28181 协议 true
└ supportAudio Boolean - 是否支持音频 true
└ resolution String - 默认分辨率
└ defaultPort Integer - 默认端口号 0
└ defaultRtspPort Integer - 默认 RTSP 端口号 0
└ rtspUrlTemplate String - RTSP URL 模板
└ enabled Boolean - 是否启用 true
└ sortOrder Integer - 排序号 0
└ createdAt LocalDateTime - 创建时间 yyyy-MM-dd HH:mm:ss
└ updatedAt LocalDateTime - 更新时间 yyyy-MM-dd HH:mm:ss

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {
        "id": 0,
        "code": "string",
        "name": "string",
        "description": "string",
        "logoUrl": "string",
        "supportOnvif": true,
        "supportPtz": true,
        "supportIsapi": true,
        "supportGb28181": true,
        "supportAudio": true,
        "resolution": "string",
        "defaultPort": 0,
        "defaultRtspPort": 0,
        "rtspUrlTemplate": "string",
        "enabled": true,
        "sortOrder": 0,
        "createdAt": "yyyy-MM-dd HH:mm:ss",
        "updatedAt": "yyyy-MM-dd HH:mm:ss"
    }
}

错误码

创建厂家

维护人:TG Live

URL

描述:创建厂家

ContentType:application/json

请求参数

Body Parameter
名称 类型 必填 最大长度 描述 示例值
id Long - 厂家 ID (更新时必填) 0
code String 50 厂家代码
Validate[max: 50; ]
name String 100 厂家名称
Validate[max: 100; ]
description String 500 厂家描述
Validate[max: 500; ]
logoUrl String 500 厂家 Logo URL
Validate[max: 500; ]
supportOnvif Boolean - 是否支持 ONVIF 协议 true
supportPtz Boolean - 是否支持 PTZ 控制 true
supportIsapi Boolean - 是否支持 ISAPI 协议 true
supportGb28181 Boolean - 是否支持 GB28181 协议 true
supportAudio Boolean - 是否支持音频 true
resolution String 20 默认分辨率
Validate[max: 20; ]
defaultPort Integer - 默认端口号 0
defaultRtspPort Integer - 默认 RTSP 端口号 0
rtspUrlTemplate String 500 RTSP URL 模板
Validate[max: 500; ]
enabled Boolean - 是否启用 true
sortOrder Integer - 排序号 0

请求示例

{
    "id": 0,
    "code": "string",
    "name": "string",
    "description": "string",
    "logoUrl": "string",
    "supportOnvif": true,
    "supportPtz": true,
    "supportIsapi": true,
    "supportGb28181": true,
    "supportAudio": true,
    "resolution": "string",
    "defaultPort": 0,
    "defaultRtspPort": 0,
    "rtspUrlTemplate": "string",
    "enabled": true,
    "sortOrder": 0
}

响应参数

名称 类型 必填 最大长度 描述 示例值
success Boolean - 请求是否成功 true
errCode String - 错误码(失败时返回)
errMessage String - 错误信息(失败时返回)
data object 响应数据 (ActualType: CameraVendorDTO)
└ id Long - 厂家 ID 0
└ code String - 厂家代码
└ name String - 厂家名称
└ description String - 厂家描述
└ logoUrl String - 厂家 Logo URL
└ supportOnvif Boolean - 是否支持 ONVIF 协议 true
└ supportPtz Boolean - 是否支持 PTZ 控制 true
└ supportIsapi Boolean - 是否支持 ISAPI 协议 true
└ supportGb28181 Boolean - 是否支持 GB28181 协议 true
└ supportAudio Boolean - 是否支持音频 true
└ resolution String - 默认分辨率
└ defaultPort Integer - 默认端口号 0
└ defaultRtspPort Integer - 默认 RTSP 端口号 0
└ rtspUrlTemplate String - RTSP URL 模板
└ enabled Boolean - 是否启用 true
└ sortOrder Integer - 排序号 0
└ createdAt LocalDateTime - 创建时间 yyyy-MM-dd HH:mm:ss
└ updatedAt LocalDateTime - 更新时间 yyyy-MM-dd HH:mm:ss

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {
        "id": 0,
        "code": "string",
        "name": "string",
        "description": "string",
        "logoUrl": "string",
        "supportOnvif": true,
        "supportPtz": true,
        "supportIsapi": true,
        "supportGb28181": true,
        "supportAudio": true,
        "resolution": "string",
        "defaultPort": 0,
        "defaultRtspPort": 0,
        "rtspUrlTemplate": "string",
        "enabled": true,
        "sortOrder": 0,
        "createdAt": "yyyy-MM-dd HH:mm:ss",
        "updatedAt": "yyyy-MM-dd HH:mm:ss"
    }
}

错误码

更新厂家

维护人:TG Live

URL

描述:更新厂家

ContentType:application/json

请求参数

Body Parameter
名称 类型 必填 最大长度 描述 示例值
id Long - 厂家 ID (更新时必填) 0
code String 50 厂家代码
Validate[max: 50; ]
name String 100 厂家名称
Validate[max: 100; ]
description String 500 厂家描述
Validate[max: 500; ]
logoUrl String 500 厂家 Logo URL
Validate[max: 500; ]
supportOnvif Boolean - 是否支持 ONVIF 协议 true
supportPtz Boolean - 是否支持 PTZ 控制 true
supportIsapi Boolean - 是否支持 ISAPI 协议 true
supportGb28181 Boolean - 是否支持 GB28181 协议 true
supportAudio Boolean - 是否支持音频 true
resolution String 20 默认分辨率
Validate[max: 20; ]
defaultPort Integer - 默认端口号 0
defaultRtspPort Integer - 默认 RTSP 端口号 0
rtspUrlTemplate String 500 RTSP URL 模板
Validate[max: 500; ]
enabled Boolean - 是否启用 true
sortOrder Integer - 排序号 0

请求示例

{
    "id": 0,
    "code": "string",
    "name": "string",
    "description": "string",
    "logoUrl": "string",
    "supportOnvif": true,
    "supportPtz": true,
    "supportIsapi": true,
    "supportGb28181": true,
    "supportAudio": true,
    "resolution": "string",
    "defaultPort": 0,
    "defaultRtspPort": 0,
    "rtspUrlTemplate": "string",
    "enabled": true,
    "sortOrder": 0
}

响应参数

名称 类型 必填 最大长度 描述 示例值
success Boolean - 请求是否成功 true
errCode String - 错误码(失败时返回)
errMessage String - 错误信息(失败时返回)
data object 响应数据 (ActualType: CameraVendorDTO)
└ id Long - 厂家 ID 0
└ code String - 厂家代码
└ name String - 厂家名称
└ description String - 厂家描述
└ logoUrl String - 厂家 Logo URL
└ supportOnvif Boolean - 是否支持 ONVIF 协议 true
└ supportPtz Boolean - 是否支持 PTZ 控制 true
└ supportIsapi Boolean - 是否支持 ISAPI 协议 true
└ supportGb28181 Boolean - 是否支持 GB28181 协议 true
└ supportAudio Boolean - 是否支持音频 true
└ resolution String - 默认分辨率
└ defaultPort Integer - 默认端口号 0
└ defaultRtspPort Integer - 默认 RTSP 端口号 0
└ rtspUrlTemplate String - RTSP URL 模板
└ enabled Boolean - 是否启用 true
└ sortOrder Integer - 排序号 0
└ createdAt LocalDateTime - 创建时间 yyyy-MM-dd HH:mm:ss
└ updatedAt LocalDateTime - 更新时间 yyyy-MM-dd HH:mm:ss

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {
        "id": 0,
        "code": "string",
        "name": "string",
        "description": "string",
        "logoUrl": "string",
        "supportOnvif": true,
        "supportPtz": true,
        "supportIsapi": true,
        "supportGb28181": true,
        "supportAudio": true,
        "resolution": "string",
        "defaultPort": 0,
        "defaultRtspPort": 0,
        "rtspUrlTemplate": "string",
        "enabled": true,
        "sortOrder": 0,
        "createdAt": "yyyy-MM-dd HH:mm:ss",
        "updatedAt": "yyyy-MM-dd HH:mm:ss"
    }
}

错误码

删除厂家

维护人:TG Live

URL

描述:删除厂家

ContentType:application/x-www-form-urlencoded;charset=UTF-8

请求参数

Query Parameter
名称 类型 必填 最大长度 描述 示例值
id int64 - No comments found. 0

响应参数

名称 类型 必填 最大长度 描述 示例值
success Boolean - 请求是否成功 true
errCode String - 错误码(失败时返回)
errMessage String - 错误信息(失败时返回)
data object - 响应数据 (ActualType: Void)

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {}
}

错误码

初始化默认厂家数据

维护人:TG Live

URL

描述:初始化默认厂家数据

ContentType:application/x-www-form-urlencoded;charset=UTF-8

请求参数

响应参数

名称 类型 必填 最大长度 描述 示例值
success Boolean - 请求是否成功 true
errCode String - 错误码(失败时返回)
errMessage String - 错误信息(失败时返回)
data object - 响应数据 (ActualType: Void)

响应示例

{
    "success": true,
    "errCode": "string",
    "errMessage": "string",
    "data": {}
}

错误码