1. 车辆基础信息

1.1. 车辆基础信息批量新增

基础信息

路径: /v1/api/vehicle/batchAdd

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
addVehicleBeans array 是 车辆批量新增请求体
  |─ object
    |─plateNumber string 是 车辆号码,车牌号码必须在1-16个字符内且只能包含数字、中英文
    |─plateType integer 否 车牌类型,1-标准民用车与军用车、2-006车、3-警车、4-军用车双行尾牌、5-使馆车、6-农用车、7-摩托车、8-新能源车
    |─plateColor integer 否 车牌颜色，1-蓝色、2-黄色、3-白色、4-黑色、5-绿色
    |─vehicleType integer 否 车辆类型,1-小型车、2-大型车、3-摩托车、4-其他车
    |─vehicleColor string 否 车辆颜色
    |─describe string 否 描述,车辆信息描述长度必须在0-255个中英文字符
    |─personUuId string 否 车主唯一uuid
    |─uniqueIdentify string 否 用户唯一标识,最大16位数字

Body示例:

{
    "addVehicleBeans": [
        {
            "plateNumber": "京B30003",
            "personUuId":"7ed2c46e4cc34b11a7ba9fbe8faf1feb",
            "plateType":1,
            "vehicleType":1,
            "plateColor":3,
            "vehicleColor":"黑",
            "describe":"test",
            "uniqueIdentify":"3003"

        },
        {
            "plateNumber": "京B50005",
            "plateType":1,
            "personUuId":"7ed2c46e4cc34b11a7ba9fbe8faf1feb"

        }
    ]
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─successVehicles array 批量新增车辆成功返回体
    |─ object
      |─vehicleUuId string 车辆新增返回唯一uuid
      |─plateNumber string 车辆号码
      |─plateType integer 车牌类型：1-标准民用车与军用车、2-006车、3-警车、4-军用车双行尾牌、5-使馆车、6-农用车、7-摩托车、8-新能源车
      |─plateColor integer 车牌颜色：1-蓝色、2-黄色、3-白色、4-黑色、5-绿色
      |─vehicleType integer 车辆类型：1-小型车、2-大型车、3-摩托车、4-其他车
      |─vehicleColor string 车辆颜色
      |─describe string 描述
      |─personUuId string 车主唯一uuId
      |─uniqueIdentify string 用户指定唯一标识
  |─failVehicles array 批量新增车辆失败返回体
    |─ object
      |─vehicleUuId string 车辆新增返回唯一uuid
      |─plateNumber string 车辆号码
      |─plateType integer 车牌类型：1-标准民用车与军用车、2-006车、3-警车、4-军用车双行尾牌、5-使馆车、6-农用车、7-摩托车、8-新能源车
      |─plateColor integer 车牌颜色：1-蓝色、2-黄色、3-白色、4-黑色、5-绿色
      |─vehicleType integer 车辆类型：1-小型车、2-大型车、3-摩托车、4-其他车
      |─vehicleColor string 车辆颜色
      |─describe string 描述
      |─personUuId string 车主唯一uuId
      |─personTelephone string 手机号码
      |─uniqueIdentify string 用户指定唯一标识
      |─msg string 异常原因
      |─code integer 异常码

响应示例:

{
    "code": 0,
    "data": {
        "failVehicles": [
            {
                "code": 202002,
                "describe": "test",
                "msg": "车牌已重复，请确认",
                "personUuId": "7ed2c46e4cc34b11a7ba9fbe8faf1feb",
                "plateColor": 3,
                "plateNumber": "京B30003",
                "plateType": 1,
                "uniqueIdentify": "3003",
                "vehicleColor": "黑",
                "vehicleType": 1
            }
        ],
        "successVehicles": [
            {
                "personUuId": "7ed2c46e4cc34b11a7ba9fbe8faf1feb",
                "plateNumber": "京B50005",
                "plateType": 1,
                "vehicleUuId": "c118bb3b90af45d499abcea4e88344e5"
            }
        ]
    },
    "msg": "成功"
}

1.2. 车辆基础信息更新

基础信息

路径: /v1/api/vehicle/update

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
vehicleUuId string 是 车辆唯一uuid
plateNumber string 是 车辆号码,车牌号码必须在1-16个字符内且只能包含数字、中英文
plateType integer 否 车牌类型,1-标准民用车与军用车、2-006车、3-警车、4-军用车双行尾牌、5-使馆车、6-农用车、7-摩托车、8-新能源车
plateColor integer 否 车牌颜色，1-蓝色、2-黄色、3-白色、4-黑色、5-绿色
vehicleType integer 否 车辆类型,1-小型车、2-大型车、3-摩托车、4-其他车
vehicleColor string 否 车辆颜色,车辆颜色长度必须在0-8个字符且仅支持汉字
describe string 否 描述,车辆信息描述长度必须在0-255个中英文字符
personUuId string 否 车主唯一uuid
uniqueIdentify string 否 用户指定唯一标识,最大16位数字

Body示例:

{
    "plateNumber": "鄂AFB2345",
    "vehicleUuId": "589856faaa4345b3baf62f77d1ac6ab4",
    "personUuId":"3e32740717524c48a12faaeebf827ad1",
    "plateType": 1,
    "plateColor": 3,
    "vehicleType": 1,
    "vehicleColor": "蓝",
    "describe": "测试",
    "uniqueIdentify": "123456789"
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值

响应示例:

{
  "code": 0,
  "msg": "成功"
}

1.3. 车辆基础详情信息

基础信息

路径: /v1/api/vehicle/query

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
vehicleUuId string 是 车辆唯一uuid

Body示例:

{
  "vehicleUuId": "c118bb3b90af45d499abcea4e88344e5"
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─vehicleUuId string 车辆唯一uuId
  |─plateNumber string 车辆号码
  |─plateType integer 车牌类型,1-标准民用车与军用车、2-006车、3-警车、4-军用车双行尾牌、5-使馆车、6-农用车、7-摩托车、8-新能源车
  |─plateTypeMsg string 车牌类型信息
  |─plateColor integer 车牌颜色枚举
  |─plateColorMsg string 车牌颜色信息
  |─vehicleType integer 车辆类型,1-小型车、2-大型车、3-摩托车、4-其他车
  |─vehicleTypeMsg string 车辆类型信息
  |─vehicleColor string 车辆颜色
  |─describe string 描述
  |─personUuId string 车主唯一uuid
  |─personType integer 车主身份,1-基础人员、2-访客、3-关注人员
  |─personTypeMsg string 车主身份信息
  |─personName string 车主姓名
  |─uniqueIdentify string 唯一标识

响应示例:

{
    "code": 0,
    "data": {
        "describe": "test",
        "personName": "auto员工",
        "personType": 1,
        "personTypeMsg": "基础人员",
        "personUuId": "7ed2c46e4cc34b11a7ba9fbe8faf1feb",
        "plateColor": 3,
        "plateColorMsg": "白色",
        "plateNumber": "京A10001",
        "plateType": 1,
        "plateTypeMsg": "标准民用车与军用车",
        "uniqueIdentify": "1001",
        "vehicleColor": "黑",
        "vehicleType": 1,
        "vehicleTypeMsg": "小型车",
        "vehicleUuId": "c4d04a7470fe4afa9ab4cc69e7a9b9b6"
    },
    "msg": "成功"
}

1.4. 车辆基础信息列表

基础信息

路径: /v1/api/vehicle/list

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
plateNumber string 否 车辆号码
plateType integer 否 车牌类型,1-标准民用车与军用车、2-006车、3-警车、4-军用车双行尾牌、5-使馆车、6-农用车、7-摩托车、8-新能源车
vehicleType integer 否 车辆类型,1-小型车、2-大型车、3-摩托车、4-其他车
personUuId string 否 车主唯一uuId
pageNum integer 否 1 查询页码,默认第1页
pageSize integer 否 10 页面大小,默认每页大小10

Body示例:

{
    "pageNum": 1,
    "pageSize": 10,
    "personUuId": "7ed2c46e4cc34b11a7ba9fbe8faf1feb"
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─pageNum integer 页码，从1开始
当前页码
  |─pageSize integer 页面大小
分页大小
  |─total integer 总记录数
总数
  |─list array
    |─ object
      |─vehicleUuId string 车辆唯一uuId
      |─plateNumber string 车辆号码
      |─plateType integer 车牌类型枚举
      |─plateTypeMsg string 车牌类型信息
      |─plateColor integer 车牌颜色枚举
      |─plateColorMsg string 车牌颜色信息
      |─vehicleType integer 车辆类型枚举
      |─vehicleTypeMsg string 车辆类型信息
      |─vehicleColor string 车辆颜色
      |─describe string 描述
      |─personUuId string 车主唯一uuId
      |─personName string 车主姓名
      |─uniqueIdentify string 唯一标识
      |─personType integer 车主类型
      |─personTypeMsg string 车主类型描述

响应示例:

{
    "code": 0,
    "data": {
        "list": [
            {
                "personName": "auto员工",
                "personType": 1,
                "personTypeMsg": "基础人员",
                "personUuId": "7ed2c46e4cc34b11a7ba9fbe8faf1feb",
                "plateNumber": "京B50005",
                "plateType": 1,
                "plateTypeMsg": "标准民用车与军用车",
                "vehicleUuId": "c118bb3b90af45d499abcea4e88344e5"
            },
            {
                "describe": "test",
                "personName": "auto员工",
                "personType": 1,
                "personTypeMsg": "基础人员",
                "personUuId": "7ed2c46e4cc34b11a7ba9fbe8faf1feb",
                "plateColor": 3,
                "plateColorMsg": "白色",
                "plateNumber": "京B30003",
                "plateType": 1,
                "plateTypeMsg": "标准民用车与军用车",
                "uniqueIdentify": "3003",
                "vehicleColor": "黑",
                "vehicleType": 1,
                "vehicleTypeMsg": "小型车",
                "vehicleUuId": "9bb312c1e02c4150a1bf42d7c0a0566d"
            },
            {
                "personName": "auto员工",
                "personType": 1,
                "personTypeMsg": "基础人员",
                "personUuId": "7ed2c46e4cc34b11a7ba9fbe8faf1feb",
                "plateNumber": "京B40004",
                "plateType": 1,
                "plateTypeMsg": "标准民用车与军用车",
                "vehicleUuId": "643de7984df945ab96d7e2aeb1fe4c74"
            },
            {
                "personName": "auto员工",
                "personType": 1,
                "personTypeMsg": "基础人员",
                "personUuId": "7ed2c46e4cc34b11a7ba9fbe8faf1feb",
                "plateNumber": "京B20002",
                "plateType": 1,
                "plateTypeMsg": "标准民用车与军用车",
                "vehicleUuId": "88b8fc72dc5c4bc896138ee2b5df9c11"
            },
            {
                "describe": "test",
                "personName": "auto员工",
                "personType": 1,
                "personTypeMsg": "基础人员",
                "personUuId": "7ed2c46e4cc34b11a7ba9fbe8faf1feb",
                "plateColor": 3,
                "plateColorMsg": "白色",
                "plateNumber": "京A10001",
                "plateType": 1,
                "plateTypeMsg": "标准民用车与军用车",
                "uniqueIdentify": "1001",
                "vehicleColor": "黑",
                "vehicleType": 1,
                "vehicleTypeMsg": "小型车",
                "vehicleUuId": "c4d04a7470fe4afa9ab4cc69e7a9b9b6"
            },
            {
                "describe": "",
                "personName": "auto员工",
                "personType": 1,
                "personTypeMsg": "基础人员",
                "personUuId": "7ed2c46e4cc34b11a7ba9fbe8faf1feb",
                "plateColor": 1,
                "plateColorMsg": "蓝色",
                "plateNumber": "B89123",
                "plateType": 2,
                "plateTypeMsg": "006车",
                "uniqueIdentify": "",
                "vehicleType": 1,
                "vehicleTypeMsg": "小型车",
                "vehicleUuId": "ef78d605187543e495943811e98e64d1"
            }
        ],
        "pageNum": 1,
        "pageSize": 10,
        "total": 6
    },
    "msg": "成功"
}

1.5. 车辆基础信息批量删除

基础信息

路径: /v1/api/vehicle/batchDelete

请求方法: POST

请求参数

Headers:

名称 值 必须 备注
Content-Type application/json 是

Body:

名称 类型 必须 默认值 备注
vehicleUuIdList array 是 车辆基础信息uuid集合
  |─ string

Body示例:

{
    "vehicleUuIdList":[
        "c118bb3b90af45d499abcea4e88344e5",
        "69815069a32840368b06635038e4a7de"
    ]
}

返回数据

Headers:

名称 值 必须 备注
content-type application/json;charset=UTF-8 否

Body:

名称 类型 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─successVehicles array 批量删除车辆成功返回体
    |─ object
      |─vehicleUuId string 车辆唯一uuid
  |─failVehicles array 批量删除车辆失败返回体
    |─ object
      |─vehicleUuId string 车辆唯一uuid
      |─msg string 异常原因
      |─code integer 异常码

响应示例:

{
    "code": 0,
    "data": {
        "failVehicles": [
            {
                "code": 202003,
                "msg": "69815069a32840368b06635038e4a7de车辆不存在",
                "vehicleUuId": "69815069a32840368b06635038e4a7de"
            }
        ],
        "successVehicles": [
            {
                "vehicleUuId": "c118bb3b90af45d499abcea4e88344e5"
            }
        ]
    },
    "msg": "成功"
}

results matching ""

    No results matching ""