车行服务
更新时间:2018-12-29 16:30:24
公共字段
以下参数通过登录信息中提取,不需要每次调用的时候传递
参数名称 |
参数 |
用户ID |
identityId |
租户ID |
tenantId |
登录用户租户ID |
identityTenantId |
appKey |
appKey |
资源隔离ID |
isolationId |
环境(开发,线上) |
env |
调用方Ip |
clientIp |
语言 |
language |
地理位置、ip |
locale |
通过智慧人居服务以下两个接口获取:* 房屋列表:/homelink/house/list |
* 房屋详情:/homelink/house/detail/get
| scopeId |
车行服务
1. 新增固定车
1.1. 定义描述
path |
版本 |
描述 |
是否需要登录 |
/campuslink/park/addOneCar |
1.0.2 |
新增固定车信息 |
是 |
1.2. 请求参数
参数字段名 |
类型 |
是否必须 |
参数说明 |
scopeId |
String |
是 |
园区ID,也就是rootSpaceId |
parkNo |
String |
否 |
停车场编号,园区下有多个停车场时必传 |
userId |
String |
否 |
家人用户Id,新增业主亲属车辆时必填 |
carNo |
String |
是 |
车牌号 |
businessType |
String |
是 |
业务类型,OWNER-业主 |
validTime |
Long |
否 |
起效时间 |
expireTime |
Long |
否 |
失效时间 |
carModel |
String |
否 |
车辆型号 |
1.3. 返回参数
1.4. 示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.0",
"iotToken": "token"
},
"params": {
"scopeId": "aaaaaaaaaa324bfa867bf5279cdc9976",
"parkNo": "test",
"userId": "BBBBBBBBBB81D649A3BD78D7963D439B67",
"carNo": "浙A88888",
"businessType": "1",
"validTime": 1517217645000,
"expireTime": 1517217645000,
"carModel": "BMW X3"
}
}
{
"code": 200,
"message": "success"
}
2. 修改固定车
2.1. 定义描述
path |
版本 |
描述 |
是否需要登录 |
/campuslink/park/updateOneCar |
1.0.2 |
修改固定车信息,只支持修改车辆型号 |
是 |
2.2. 请求参数
参数字段名 |
类型 |
是否必须 |
参数说明 |
scopeId |
String |
是 |
园区ID,也就是rootSpaceId |
parkNo |
String |
否 |
停车场编号,园区下有多个停车场时必传 |
userId |
String |
否 |
家人用户Id,修改业主亲属车辆时必填 |
carNo |
String |
是 |
车牌号 |
carModel |
String |
否 |
车辆型号 |
2.3. 返回参数
2.4. 示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.0",
"iotToken": "token"
},
"params": {
"scopeId": "aaaaaaaaaa324bfa867bf5279cdc9976",
"parkNo": "test",
"userId": "AAAAAAAAA1D649A3BD78D7963D439B67",
"carNo": "浙A88888",
"carModel": "BMW X5"
}
}
{
"code": 200,
"message": "success"
}
3. 查询固定车
3.1. 定义描述
path |
版本 |
描述 |
是否需要登录 |
/campuslink/park/queryCar |
1.0.2 |
查询固定车信息,既支持按人维度查,也支持按车牌号查 |
是 |
3.2. 请求参数
参数字段名 |
类型 |
是否必须 |
参数说明 |
scopeId |
String |
是 |
园区ID,也就是rootSpaceId |
parkNo |
String |
否 |
停车场编号,园区下有多个停车场时必传 |
userId |
String |
否 |
家人用户Id,查询业主亲属车辆时必填 |
carNo |
String |
否 |
车牌号 |
3.3. 返回参数
参数 |
类型 |
描述 |
cars |
Array |
车辆列表,按绑定时间降序 |
cars.businessType |
Long |
业务类型 |
cars.validTime |
String |
起效时间 |
cars.expireTime |
String |
失效时间 |
cars.carNo |
String |
车牌号 |
cars.carModel |
String |
车辆型号 |
3.4. 示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.0",
"iotToken": "token"
},
"params": {
"scopeId": "aaaaaaaaaa324bfa867bf5279cdc9976",
"parkNo": "test",
"userId": "AAAAAAAAA1D649A3BD78D7963D439B67"
}
}
{
"code": 200,
"message": "success",
"data": {
"cars": [{
"businessType": "1",
"validTime": 1517217645000,
"expireTime": 1517217645000,
"carNo": "浙A88888",
"carModel": "BMW X5"
}, {
"businessType": "1",
"validTime": 1517217645000,
"expireTime": 1517217645000,
"carNo": "浙A77777",
"carModel": "Tesla Model X"
}]
}
}
4 删除固定车
4.1. 定义描述
path |
版本 |
描述 |
是否需要登录 |
/campuslink/park/deleteOneCar |
1.0.2 |
删除固定车信息 |
是 |
4.2. 请求参数
参数字段名 |
类型 |
是否必须 |
参数说明 |
scopeId |
String |
是 |
园区ID,也就是rootSpaceId |
parkNo |
String |
否 |
停车场编号,园区下有多个停车场时必传 |
userId |
String |
否 |
家人用户Id,查询业主亲属车辆时必填 |
carNo |
String |
是 |
车牌号 |
4.3. 返回参数
4.4. 示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.0",
"iotToken": "token"
},
"params": {
"scopeId": "aaaaaaaaaa324bfa867bf5279cdc9976",
"parkNo": "test",
"userId": "BBBBBBBBBB1D649A3BD78D7963D439B67",
"carNo": "浙A88888"
}
}
{
"code": 200,
"message": "success"
}
5. 车辆入场
5.1. 定义描述
path |
版本 |
描述 |
是否需要登录 |
/campuslink/park/enterParkEvent |
1.0.4 |
车辆入场事件上报 |
否 |
5.2. 请求参数
参数字段名 |
类型 |
是否必须 |
参数说明 |
scopeId |
String |
是 |
园区ID,也就是rootSpaceId |
parkNo |
String |
是 |
停车场编号 |
recordId |
String |
是 |
入场记录ID |
carNo |
String |
是 |
车牌号 |
enterTime |
Long |
是 |
入场时间 |
operator |
String |
否 |
操作员 |
deviceId |
String |
否 |
设备ID |
deviceName |
String |
否 |
设备名称 |
deviceCode |
String |
否 |
设备代码 |
carType |
String |
否 |
车辆类型,1030新增,不填则无法参与数据中心统计 |
5.3. 返回参数
5.4. 示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.4",
"iotToken": "token"
},
"params": {
"scopeId": "aaaaaaaaaa324bfa867bf5279cdc9976",
"parkNo": "ccccccccc354667165597889d124f",
"recordId": "BBBBBBBBBB649A3BD78D7963D439B67",
"carNo": "浙A88888",
"carType": "OWNER",
"enterTime": 1517217645000,
"operator": "老王"
}
}
{
"code": 200,
"message": "success"
}
6. 车辆出场
6.1. 定义描述
path |
版本 |
描述 |
是否需要登录 |
/campuslink/park/exitParkEvent |
1.0.4 |
车辆出场事件上报 |
否 |
6.2. 请求参数
参数字段名 |
类型 |
是否必须 |
参数说明 |
scopeId |
String |
是 |
园区ID,也就是rootSpaceId |
parkNo |
String |
是 |
停车场编号 |
recordId |
String |
是 |
出场记录ID |
enterRecordId |
String |
是 |
该出场事件对应的入场记录ID |
carNo |
String |
是 |
车牌号 |
exitTime |
Long |
是 |
出场时间,毫秒级别的时间戳 |
operator |
String |
否 |
操作员 |
deviceId |
String |
否 |
设备ID |
deviceName |
String |
否 |
设备名称 |
deviceCode |
String |
否 |
设备代码 |
carType |
String |
否 |
车辆类型,1030新增,不填则无法参与数据中心统计 |
6.3. 返回参数
6.4. 示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.4",
"iotToken": "token"
},
"params": {
"scopeId": "aaaaaaaaaa324bfa867bf5279cdc9976",
"parkNo": "cccccccc5354667165597889d124f",
"recordId": "BBBBBBBBBD649A3BD78D7963D439B67",
"enterRecordId": "105A87654871D749A3BD78D7993D439B88",
"carNo": "浙A88888",
"carType": "OWNER",
"exitTime": 1517217848000,
"operator": "老王"
}
}
{
"code": 200,
"message": "success"
}