特殊车辆(黑白名单)管理

更新时间:2025-05-30 01:56:03下载pdf

API列表

请求方式 API 描述
POST /v1.0/iot-02/third/parking/special-cars 添加特殊车辆名单
DELETE /v1.0/iot-02/third/parking/special-cars/{special_car_id} 删除特殊车辆名单
GET /v1.0/iot-02/third/parking/special-cars 分页查询特殊车列表

添加特殊车辆名单

功能描述

添加特殊车辆名单

接口地址

POST /v1.0/iot-02/third/parking/special-cars

请求参数

参数名 类型 参数类型 说明 是否必需
gateway_id String body 网关 id true
plate_number String body 车牌号,不超过 64 个字符 true
list_type String body 类型:BLACK_LIST 黑名单,WHITE_LIST 白名单,不超过 64 个字符,(WHITE_LIST:白名单;BLACK_LIST:黑名单) true
remark String body 原因,不超过 2048 个字符 false

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result String 特殊车 id

请求示例

POST /v1.0/iot-02/third/parking/special-cars
{
  "gateway_id": "o2rH2t0TdE",
  "plate_number": "浙A12345",
  "list_type": "WHITE_LIST",
  "remark": "epOkCdIODK"
}

响应示例

{
  "success": true,
  "t": 1573441137,
  "result": "5bxW3ayXOO"
}

删除特殊车辆名单

功能描述

删除特殊车辆名单

接口地址

DELETE /v1.0/iot-02/third/parking/special-cars/{special_car_id}

请求参数

参数名 类型 参数类型 说明 是否必需
special_car_id String url 特殊车辆 id true
gateway_id String query 网关 id true

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result boolean 成功、失败

请求示例

DELETE /v1.0/iot-02/third/parking/special-cars/{special_car_id}?gateway_id=villBF7Zv2

响应示例

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

分页查询特殊车列表

功能描述

分页查询特殊车列表

接口地址

GET /v1.0/iot-02/third/parking/special-cars

请求参数

参数名 类型 参数类型 说明 是否必需
page_no int query 页码,最小值 1 false
page_size int query 页大小,最小值 1,最大值 1000 false
gateway_id String query 网关 id false
list_type String query 类型:BLACK_LIST 黑名单,WHITE_LIST 白名单,(WHITE_LIST:白名单;BLACK_LIST:黑名单) false

返回参数

参数名 类型 说明
code Integer 响应码(详情见错误码章节),成功时为空
success Boolean 是否成功:(true:成功,false:失败)
msg String 请求失败的信息,成功时为空
t Long 返回时间戳,13 位
result Object 特殊车信息分页列表

result 参数说明

参数名 类型 说明
total int 总数
data Object[] 当前页数据
- project_id String 项目 id
- creator String 创建者
- modifier String 修改者
- gmt_create long 创建时间(毫秒)
- gmt_modified long 修改时间(毫秒)
- special_car_id String 特殊车 id
- list_type String 类型:BLACK_LIST 黑名单,WHITE_LIST 白名单
- plate_number String 车牌号
- remark String 原因

请求示例

GET /v1.0/iot-02/third/parking/special-cars?page_no=1&page_size=100&gateway_id=CM2Phkmzpl&list_type=WHITE_LIST

响应示例

{
  "success": true,
  "t": 1573441137,
  "result": {
    "total": 1,
    "data": [
      {
        "project_id": "v5LZNK16Kj",
        "creator": "chgYW8nuwB",
        "modifier": "JTm3a0MGVQ",
        "gmt_create": 248599,
        "gmt_modified": 579625,
        "special_car_id": "7qa057NSKM",
        "list_type": "DFWZMGS78H",
        "plate_number": "gd5EgBCiSM",
        "remark": "dQuae39FAE"
      }
    ]
  }
}