[关闭]
@xuduochoua 2017-08-21T10:50:18.000000Z 字数 6967 阅读 1574

分时租赁接口文档

分时租赁 云杉智慧

接口说明

1、返回数据的基本结构

  1. {
  2.     "errcode":"",//错误码    100-成功 300-失败
  3.     "errmsg":"",//错误描述
  4.     "state":"1",//状态 1-成功 0-失败
  5.     "data":Object//返回的数据
  6. }

2、修改接口时以APP具体调用为准

当前分时租赁后台接口版本较多，有一定的历史遗留问题，若需修改时以前端调用为准。

接口文档

获取公开公用充电站信息

接口说明

如标题

接口地址
POST /RentalLocation/GetChargingStations

所属对象
RentalLocationController.GetChargingStations

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 会员ID
Rows String Y 第几页
Page String Y 页码数据量
LastModifyTime Y String 最后修改时间（为空为第一次加载数据做缓存，日期为接收到的所有数据中最后修改时间最大的一个值）
AppID String Y AppID

响应结果

  1. {
  2.    //略
  3. }

获取网点下可用车辆数量,车辆总数量，可用车位数量

接口说明

如标题，此接口有多个版本，后续修改可参考app使用的具体接口

接口地址
POST /RentalLocation/GetRentalLocationEVCNum

所属对象
RentalLocationController.GetRentalLocationEVCNum

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 会员ID
AppID String Y AppID

响应结果

  1. {
  2.     //略
  3. }

上传用户信息

接口说明

如标题

接口地址
POST /CustomerManager/UpdateCustomerInfo

所属对象
CustomerManagerController.updateCustomerInfo

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 会员ID
AppID String Y AppID
Customer String Y 用户信息JSON对象
openId String N 默认空，第三方认证用的
authType String N 默认-0；0-更新会员附属信息 其他-更新三方认证表

响应结果

  1. {
  2.     //略
  3. }

获取APP版本

接口说明

检测更新

接口地址
POST /Common/GetAppVersion

所属对象
CommonController.getAppVersion

请求参数

参数 数据类型 是否必填 参数说明
AppID String Y AppID

响应结果

  1. {
  2.     //略
  3. }

获取手机APP配置信息

接口说明

获取手机APP配置信息以及一些H5的URL如广告

接口地址
POST /Common/GetAppConfig_V20

所属对象
CommonController.GetAppConfig_V20

请求参数

参数 数据类型 是否必填 参数说明
AppID String Y AppID
UserID String Y 会员ID

响应结果

  1. {
  2.     //略
  3. }

获取当前的用户的详细信息

接口说明

根据ID获取当前的用户的详细信息

接口地址
POST /CustomerManager/GetCustomerInfoByID

所属对象
CustomerManagerController.getCustomerInfoByID

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 会员ID
AppID String Y AppID
CusToken String Y 应是第三方登陆使用
openId String N 默认空，第三方认证用的
authType String N 默认-0；0-更新会员附属信息 其他-更新三方认证表

响应结果

  1. {
  2.     //略
  3. }

获取最近网点下的车辆（查找车辆）

接口说明

获取最近网点下的车辆（查找车辆）

接口地址
POST /VehicleManager/GetEVCInfoInNearestRentalLocation

所属对象
VehicleManagerController.getEVCInfoInNearestRentalLocation

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 会员ID
AppID String Y AppID
UserLo String Y 会员所在经度
UserLa String Y 会员所在纬度

响应结果

  1. {
  2.     //略
  3. }

获正在执行的订单

接口说明

如标题

接口地址
POST /EVCOrderBills/GetMyRunningOrder_V40

所属对象
EVCOrderBillsController.getMyRunningOrder_V40

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 会员ID
AppID String Y AppID

响应结果

  1. {
  2.     //略
  3. }

获正行程列表

接口说明

如标题

接口地址
POST EVCOrderBills/GetEVCOrder_V20

所属对象
EVCOrderBillsController.getEVCOrder_V20

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 会员ID
AppID String Y AppID
Rows String Y 第几页
Page String Y 页码数据量

响应结果

  1. {
  2.     //略
  3. }

获取收藏车辆的列表

接口说明

如标题

接口地址
POST /VehicleManagerController/GetCusEVCCollections

所属对象
VehicleManagerController.getCusEVCCollections

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 会员ID
AppID String Y AppID
Rows String Y 第几页
Page String Y 页码数据量

响应结果

  1. {
  2.     //略
  3. }

收藏车辆

接口说明

如标题

接口地址
POST /VehicleManager/EVCCollection

所属对象
VehicleManagerController.evcCollection

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 会员ID
AppID String Y AppID
EVCID String Y 车辆ID

响应结果

  1. {
  2.     //略
  3. }

取消收藏车辆

接口说明

如标题

接口地址
POST /VehicleManager/CancelEVCCollection

所属对象
VehicleManagerController.cancelEVCCollection

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 会员ID
AppID String Y AppID
EVCID String Y 车辆ID

响应结果

  1. {
  2.     //略
  3. }

代金券列表

接口说明

如标题

接口地址
POST /Preference/GetVouchersListByUserID

所属对象
PreferenceController.getVouchersListByUserID

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 会员ID
AppID String Y AppID
OrderID String Y 订单ID
Flag String Y 1-全部代金券 2-可用代金券
Rows String Y 第几页
Page String Y 页码数据量

响应结果

  1. {
  2.     //略
  3. }

代金券列表

接口说明

如标题

接口地址
POST /Preference/GetVouchersListByUserID

所属对象
PreferenceController.getVouchersListByUserID

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 会员ID
AppID String Y AppID
OrderID String Y 订单ID
Flag String Y 1-全部代金券 2-可用代金券
Rows String Y 第几页
Page String Y 页码数据量

响应结果

  1. {
  2.     //略
  3. }

激活代金券

接口说明

如标题

接口地址
POST /Vouchers/updateUseBind

所属对象
VouchersController.updateUseBind

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 会员ID
CheckCode String Y 校验码

响应结果

  1. {
  2.     //略
  3. }

获取用户的认证信息

接口说明

如标题

接口地址

POST CustomerManager/GetIdentityAuthByUserID_V20

所属对象

CustomerManagerController.getIdentityAuthByUserID

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 会员ID
AppID String Y AppID

响应结果

  1. {
  2.    //略
  3. }

认证信息提交接口

接口说明

如标题

接口地址
POST CustomerManager/CustomerCertification

所属对象

CustomerManagerController.customerCertification

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 会员ID
AppID String Y AppID
IdentityAuth String Y 用户提交的认证信息(IdentityAuth类对应的JSON字符串)

响应结果

  1. {
  2.    //略
  3. }

意见反馈保存接口

接口说明

如标题

接口地址
POST Feedback/CustomerFeedback_V20

所属对象

FeedbackController.customerFeedback

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 会员ID
AppID String Y AppID
CF_TEL String Y 联系电话
CF_Content String y 反馈内容

响应结果

  1. {
  2.    //略
  3. }

费用预估接口

接口说明

如标题

接口地址
POST EVCOrderBills/GetEstimatePrice_V20

所属对象

EVCOrderBillsController.getEstimatePrice

请求参数

参数 数据类型 参数必填 参数说明
UserID String Y 会员ID
AppID String Y AppID
EVCID String Y 车辆id
BeginDatetime String y 租车开始时间
EndDatetime String Y 租车结束时间
PolicyType String Y 预租类型(为空字符串)

响应结果

  1. {
  2.    //略
  3. }

获取网点下的车辆信息接口

接口说明

如标题

接口地址
POST VehicleManager/GetEVCInfoByRLID_V20

所属对象

VehicleManagerController.getEVCInfoByRLID_V20

请求参数

参数 数据类型 参数必填 参数说明
UserID String Y 会员ID
RLID String Y 租赁网点id

响应结果

  1. {
  2.    //略
  3. }

获取押金和余额接口

接口说明

如标题

接口地址
POST Payment/GetMyAccount

所属对象

PaymentController.getMyAccount

请求参数

参数 数据类型 参数必填 参数说明
UserID String Y 会员ID
AppID String Y APPID

响应结果

  1. {
  2.    //略
  3. }

充值和付款接口

接口说明

如标题

接口地址
POST PaymentPayment/Recharge_V20

所属对象

PaymentController.recharge_V20

请求参数

参数 数据类型 参数必填 参数说明
UserID String Y 会员ID
AppID String Y APPID
OrderID String Y 订单ID
PayInfo String Y 支付信息
BizType String Y 业务类型(01-充值；02-支付)
Payment String Y Payment实体类(支付详细信息实体类)

响应结果

  1. {
  2.    //略
  3. }

租车相关接口

1. 立即用车(下订单) ##

接口说明

如标题

接口地址

POST EVCOrderBills/InsertEVCOrderBill_V40

所属对象

EVCOrderBillsController.insertEVCOrderBill_V40

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 会员ID
AppID String Y AppID
EVCENo String Y 车辆设备号
OperType String Y 车辆运营类型（1：开放[暂时只用这个]，2：私用）
EVCOrderBill String Y EVCOrderBills实体类对应的json
Apart String Y ap用户离车的距离

响应结果

  1. {
  2.    //略
  3. }

2. 开始用车

接口说明

如标题

接口地址

POST EVCOrderBills/StartUseEVC

所属对象

EVCOrderBillsController.startUseEVC

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 会员ID
AppID String Y AppID
EVCID String Y 车辆Id
OrderID String Y 订单ID

响应结果

  1. {
  2.    //略
  3. }

## 3. 获取正在运行的订单

接口说明

如标题

接口地址

POST EVCOrderBills/GetMyRunningOrder_V40

所属对象

EVCOrderBillsController.getMyRunningOrder_V40

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 会员ID
AppID String Y AppID

响应结果

  1. {
  2.    //略
  3. }

4. 获取正在运行订单的费用信息

接口说明

如标题

接口地址

POST EVCOrderBills/CurrentAmount

所属对象

EVCOrderBillsController.currentAmount

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 会员ID
AppID String Y AppID
EVCID String Y 车辆id
OrderID String Y 订单id
StartTime String Y 订单开始用车的时间

响应结果

  1. {
  2.    //略
  3. }

5. 获取可还车的网店组列表供APP端显示

接口说明

如标题

接口地址

POST RentalLocation/GetReturnRentalLocation

所属对象

RentalLocationController.getReturnRentalLocation

请求参数

参数 数据类型 是否必填 参数说明
RLID String Y 租车网点的ID
EVCID String Y 车辆ID
UserLo String Y app用户的经度
UserLa String Y app用户的纬度

响应结果

  1. {
  2.    //略
  3. }

6. 还车接口

接口说明

如标题

接口地址

POST EVCOrderBills/ReturnEVC_V50

所属对象

EVCOrderBillsController.ReturnEVC_V50

请求参数

参数 数据类型 是否必填 参数说明
AppID String Y appID
UserID String Y 用户id
OrderID String Y 订单id
EVCENo String Y 车辆设备号
ReturnType String Y 还车类型(暂时只支持直接还车)
Mobile String Y 用户手机号码
PileCode String Y (充电桩编号，暂时不需要)
source String N (充电桩相关，暂时不需要)
CarLicense String Y 车牌号
UserLo String Y app用户的纬度
UserLa String Y app用户的纬度

响应结果

  1. {
  2.    //略
  3. }

7. 租车过程中的车辆控制接口

接口说明

如标题

接口地址

POST VehicleManager/EVCControl_V20

所属对象

VehicleManagerController.evcControl

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 用户id
Order String Y 控制命令（OPEN-开门，CLOSE-关门，WHISTLE-鸣笛，FLASHERS-双闪）
EVCENo String Y 车辆设备号
Token String Y 控制车辆的唯一标志（判断当前的用户有没有权力执行对车的操作）
UserLo String Y app用户的纬度
UserLa String Y app用户的纬度

响应结果

  1. {
  2.    //略
  3. }

8. 获取用户的找车时间接口

接口说明

如果用户多次取消用车，会存在惩罚时间。并且惩罚时间过后，用车后立即开始计费，没有找车时间

接口地址

POST VehicleManager/GetTimeToFindCar

所属对象

VehicleManagerController.getTimeToFindCar

请求参数

参数 数据类型 是否必填 参数说明
UserID String Y 用户id
APPID String Y 用户id

响应结果

  1. {
  2.    //略
  3. }
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注