车辆新增

接口说明

新增车辆信息

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-brm/1.0.0/car/add

请求Method

POST

数据提交格式

application/json

请求参数

参数名必选类型说明
carCodefalseString车辆编号 若子系统同步到brm则由子系统生成,管理端新增则由brm生成uuid
carNumtrueString车牌号码
carNumColorfalseString车牌颜色
carTypefalseString汽车类型
carBrandfalseString汽车品牌
carColorfalseString车身颜色
departmentIdtrueLong部门ID
departmentNamefalseString部门名称
ownerIdfalseLong车主ID
servicefalseString子系统服务名,默认evo-thirdParty
fieldExtfalseArray自定义字段 自定义字段信息 
+businessTypefalsestring业务类型,其中5为车辆
+useFieldNamesfalseobject自定义字段信息 key:value格式的数据

请求参数示例

{
	"departmentId": 10012,
	"carNum": "浙C112",
	"carNumColor": 0,
	"carType": 1,
	"carColor": 1,
	"carBrand": 1,
	"departmentName": "三级部门",
	"ownerId": 4,
	"fieldExt": {
		"businessType": "5",
		"useFieldNames": {
			"key1": "value1",
			"key2": "value2"
		}
	}
}

返回参数

名称类型说明
successboolean接口返回是否成功
codestring错误码:0-为无错误,非0-为具体错误码
errMsgstring错误消息
dataobject返回数据对象

返回参数示例(成功)

{
    "success": true,
    "data": {},
    "code": "0",
    "errMsg": ""
}

返回参数示例(失败)

{
    "success": false,
    "data": {},
    "code": "28150000",
    "errMsg": "28150000"
}
车辆更新

接口说明

更新车辆信息

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-brm/1.0.0/car/update

请求Method

PUT

数据提交格式

application/json

请求参数

参数名必选类型说明
carCodetrueString车辆编号 可调用车辆分页查询查询,不支持修改
carNumtrueString车牌号码,不支持修改
carNumColorfalseString车牌颜色
carTypefalseString汽车类型
carBrandfalseString汽车品牌
carColorfalseString汽车颜色
departmentIdtrueLong部门ID,车辆未绑定人员支持修改,车辆已绑定人员则车辆和人员所属部门相同,不支持修改
ownerIdfalseLong车主ID
fieldExtfalseArray自定义字段 自定义字段信息 
+businessTypefalsestring业务类型
+useFieldNamesfalseobject自定义字段信息 key:value格式的数据

请求参数示例

{
	"departmentId": 10012,
	"carCode": "565b525d-13e1-4737-8d9d-00088d1a6141",
	"carNum": "浙C112",
	"carNumColor": 1,
	"carType": 1,
	"carColor": 1,
	"carBrand": 1,
	"departmentName": "三级部门",
	"ownerId": 4,
	"fieldExt": {
		"businessType": "5",
		"useFieldNames": {
			"key1": "value1",
			"key2": "value2"
		}
	}
}

返回参数

名称类型说明
successboolean接口返回是否成功
codestring错误码:0-为无错误,非0-为具体错误码
errMsgstring错误消息
dataobject返回数据对象

返回参数示例(成功)

{
    "success": true,
    "data": {},
    "code": "0",
    "errMsg": ""
}

返回参数示例(失败)

{
    "success": false,
    "data": {},
    "code": "28150001",
    "errMsg": "车牌不存在"
}
车辆删除

接口说明

删除车辆信息

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-brm/1.0.0/car/delete

请求Method

POST

数据提交格式

application/json

请求参数

参数名必选类型说明
carCodeListtruearray车辆编号数组
carNumListtruearray车牌号数组
servicefalseString子系统服务名,默认evo-thirdParty

请求参数示例

{
	"carCodeList": ["123456", "234567"],
	"carNumList": ["浙A23434"],
	"service": "evo-thirdParty"
}

返回参数

名称类型说明
successboolean接口返回是否成功
codestring错误码:0-为无错误,非0-为具体错误码
errMsgstring错误消息
dataobject返回数据对象

返回参数示例(成功)

{
    "success": true,
    "data": {},
    "code": "0",
    "errMsg": ""
}

返回参数示例(失败)

{
    "success": false,
    "data": {},
    "code": "28150002",
    "errMsg": "车牌号不能为空"
}
车辆详情查询

接口说明

查询车辆信息

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-brm/1.0.0/car/detail?carCode={0}&domainId={1}

请求Method

GET

数据提交格式

application/json

请求参数

参数名必选类型说明
carCodetrueString车辆编码
domainIdfalseString域id

请求参数示例

/evo-apigw/evo-brm/1.0.0/car/detail?carCode=浙A234343&domainId=

返回参数

名称类型说明
successboolean接口返回是否成功
codestring错误码:0-为无错误,非0-为具体错误码
errMsgstring错误消息
dataobject返回数据对象
carCodestring车辆编号
carNumstring车牌号码
carNumColorstring车牌颜色
carTypeString汽车类型
carBrandstring汽车品牌
carColorstring汽车颜色
ownerIdlong车主id
ownerNamestring车主姓名
ownerPhonestring车主电话
departmentIdlong部门id
departmentNamestring部门名称
listTypeint车辆黑白名单
fieldExtobject自定义字段信息
+businessTypestring业务类型
+useFieldNamesobject自定义字段信息 key:value格式的数据

返回参数示例(成功)

{
	"success": true,
	"data": {
		"id": 354,
		"carCode": "f99c78a2-fb6b-41d0-8d2f-e40e4a224be2",
		"carNum": "浙AB7850",
		"carNumColor": "0",
		"carType": "1",
		"carBrand": "1",
		"carColor": "1",
		"ownerId": 691852,
		"ownerName": "门禁测试人员",
		"ownerPhone": "135****5612",
		"departmentId": 1,
		"departmentName": "根部门",
		"departmentNameExt": "根部门",
		"listType": 0,
		"createTime": 1638934111000,
		"createUser": 1,
		"updateTime": 1638934111000,
		"fieldExt": {
			"businessType": "5"
		}
	},
	"code": "0",
	"errMsg": ""
}

返回参数示例(失败)

{
    "success": false,
    "data": {},
    "code": "28150002",
    "errMsg": "车牌号不能为空"
}
车辆批量新增

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.0.0

接口URL

/evo-apigw/evo-brm/1.0.0/car/add-batch

请求Method

POST

数据提交格式

application/json

请求参数

参数名必选类型说明
servicetrueString子系统服务名,默认evo-thirdParty
carListtruearray车辆集合
+carCodefalseString车辆编号 若子系统同步到brm则由子系统生成,管理端新增则由brm生成uuid
+carNumtrueString车牌号码
+carNumColorfalseString车牌颜色
+carTypefalseString汽车类型
+carBrandfalseString汽车品牌
+carColorfalseString汽车颜色
+departmentIdtrueLong部门ID
+departmentNamefalseString部门名称
+ownerIdfalseLong车主ID
+servicefalseString子系统服务名,默认evo-thirdParty
+fieldExtfalseArray自定义字段 自定义字段信息 
++businessTypefalsestring业务类型
++useFieldNamesfalseobject自定义字段信息 key:value格式的数据

请求参数示例

{
	"carList": [{
			"departmentId": 10012,
			"carNum": "浙C112",
			"carNumColor": 0,
			"carType": 1,
			"carColor": 1,
			"carBrand": 1,
			"departmentName": "三级部门",
			"ownerId": 4,
			"fieldExt": {
				"businessType": "5",
				"useFieldNames": {
					"key1": "value1",
					"key2": "value2"
				}
			}
		},
		{
			"departmentId": 10013,
			"carNum": "浙C113",
			"carNumColor": 0,
			"carType": 1,
			"carColor": 1,
			"carBrand": 1,
			"departmentName": "三级部门",
			"ownerId": 4,
			"fieldExt": {
				"businessType": "5",
				"useFieldNames": {
					"key1": "value1",
					"key2": "value2"
				}
			}
		}
	],
	"service": "evo-thirdParty"
}

返回参数

名称类型说明
successboolean接口返回是否成功
codestring错误码:0-为无错误,非0-为具体错误码
errMsgstring错误消息
dataobject返回数据对象

返回参数示例(成功)

{
    "success": true,
    "data": {},
    "code": "0",
    "errMsg": ""
}

返回参数示例(失败)

{
    "success": false,
    "data": {},
    "code": "28150000",
    "errMsg": "车牌号码已存在"
}
车辆分页查询

接口说明

分页查询车辆信息

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.2.0

接口URL

/evo-apigw/evo-brm/1.2.0/car/subsystem/page

请求Method

POST

数据提交格式

application/json

请求参数

参数名必选类型说明
pageNumfalseint当前页, 默认1
pageSizefalseint每页记录数, 默认10
sortfalsestring排序字段 排序字段(参数描述参考返回列表):id(默认、createTime、updateTime、carNum、carNumColor、carCode、carType、carBrand、carColor、carStatus、ownerId、departmentId
sortTypefalsestring排序规则 排序规则:正序-ASC 倒序-DESC(默认)
carNumListfalsearray车牌列表 列表最大支持500
carNumColorListfalsearray车牌颜色列表 列表最大支持500
carCodeListfalsearray车辆编号列表 列表最大支持500
ownerIdListfalsearray车辆归属车主ID列表 列表最大支持500
carColorListfalsearray汽车颜色列表 列表最大支持500
carTypeListfalsearray汽车类型列表 列表最大支持500
carBrandListfalsearray汽车品牌列表 列表最大支持500
departmentIdfalselong车辆归属主部门id
includeSubDepartmentFlagfalseboolean是否查询主部门所有下级部门车辆 车辆归属主部门id存在时生效,默认false
ownerIdExistfalseint是否绑定人的车辆 0:查询未绑定人的车辆,1:查询已绑定人的车辆

请求参数示例

{
	"pageNum": 1,
	"pageSize": 1,
	"sortType": "ASC",
	"sort": "departmentId",
	"carNumList": ["1", "2", "3"],
	"carNumColorList": ["0", "99"],
	"carCodeList": ["43144c5a-a3cf-4c5f-beb4-04bbfa4f69e3", "da835f35-f6d1-432c-b8de-6e4822956673"],
	"ownerIdList": [1, 2, 3],
	"carColorList": ["0", "99"],
	"carTypeList": ["0", "1", "2"],
	"carBrandList": ["0", "1", "2"],
	"departmentId": 1,
	"includeSubDepartmentFlag": true,
	"ownerIdExist": 1
}

返回参数

名称类型说明
successboolean接口返回是否成功
codestring错误码:0-为无错误,非0-为具体错误码
errMsgstring错误消息
dataPageVO分页数据

PageVO

名称类型说明
currentPageint当前页码
totalPageint总页数
pageSizeint每页记录数
totalRowsint总数
pageDataList<CarInfoVO>数据列表

CarInfoVO

名称类型说明
id车辆IDLong
carCodestring车辆唯一标识uuid
carNumstring车牌号码
carNumColorstring车牌颜色
carTypeString汽车类型
carBrandstring汽车品牌
carColorstring汽车颜色
carMarkstring车标
carStatusstring车辆使用状态
carPicstring汽车照片
ownerIdLong车主id
departmentIdLong部门id
memostring备注
parkTypestring停车状态
listTypestring车辆黑白名单
createTimedata创建时间
createUserlong创建人ID
updateTimedate更新时间
updateUserlong更新人ID
pageFieldExtobject自定义字段信息 key:value格式的数据

返回参数示例(成功)

{
	"success": true,
	"data": {
		"pageData": [{
			"id": 14,
			"carCode": "da835f35-f6d1-432c-b8de-6e4822956673",
			"carNum": "1",
			"carNumColor": "99",
			"carType": "0",
			"carBrand": "0",
			"carColor": "99",
			"carMark": "1",
			"carStatus": "2",
			"carPic": "1",
			"ownerId": 3,
			"departmentId": 1,
			"memo": "1",
			"parkType": 1,
			"listType": 0,
			"createTime": 1598940460000,
			"createUser": 4,
			"updateTime": 1598945973000,
			"updateUser": 4,
			"pageFieldExt": {
				"key1": "value1",
				"key2": "value2"
			}
		}],
		"currentPage": 1,
		"totalPage": 2,
		"pageSize": 1,
		"totalRows": 2
	},
	"code": "0",
	"errMsg": ""
}
车辆全量数据同步

接口说明

同步全量的车辆数据

接口配套版本信息

智能物联综合管理平台iConnection Center V5.0.6及以上版本

接口版本

1.2.0

接口URL

/evo-apigw/evo-brm/1.2.0/car/page

请求Method

POST

数据提交格式

application/json

请求参数

参数名必选类型说明
pageNumfalseint当前页, 默认1
pageSizefalseint每页记录数, 默认10

请求参数示例

{
	"pageNum": 1,
	"pageSize": 10
}

返回参数

名称类型说明
successboolean接口返回是否成功
codestring错误码:0-为无错误,非0-为具体错误码
errMsgstring错误消息
dataPageVO分页数据

PageVO

名称类型说明
currentPageint当前页码
totalPageint总页数
pageSizeint每页记录数
totalRowsint总数
pageDataList<CarInfoVO>数据列表

CarInfoVO

名称类型说明
carCodestring车辆唯一标识uuid
carNumstring车牌号码
carNumColorstring车牌颜色
carTypeString汽车类型
carBrandstring汽车品牌
carColorstring汽车颜色
ownerIdint车主id
ownerNamestring车主姓名
ownerPhonestring车主电话
departmentIdint部门id
departmentNamestring部门名称
departmentNameExtstring部门名称(89系统一长度)
listTypeint车辆黑白名单
pageFieldExtobject自定义字段信息 key:value格式的数据

返回参数示例(成功)

{
	"success": true,
	"data": {
		"pageData": [{
				"carNum": "浙SB0001",
				"carNumColor": "0",
				"carType": "01",
				"carBrand": "1",
				"carColor": "1",
				"ownerId": 1,
				"ownerName": "崔俊",
				"ownerPhone": "176****8677",
				"departmentId": 1,
				"departmentName": "根部门",
				"listType": 0,
				"pageFieldExt": {
					"key1": "value1",
					"key2": "value2"
				}
			},
			{
				"carNum": "浙SB0002",
				"carNumColor": "3",
				"carType": "01",
				"carBrand": "2",
				"carColor": "2",
				"ownerId": 2,
				"ownerName": "邹瑶",
				"departmentId": 2,
				"listType": 0,
				"pageFieldExt": {
					"key1": "value1",
					"key2": "value2"
				}
			}
		],
		"currentPage": 1,
		"totalPage": 1,
		"pageSize": 10,
		"totalRows": 2
	},
	"code": "0",
	"errMsg": ""
}