API数据服务接口开发指南Word下载.docx
- 文档编号:21507120
- 上传时间:2023-01-30
- 格式:DOCX
- 页数:22
- 大小:24.87KB
API数据服务接口开发指南Word下载.docx
《API数据服务接口开发指南Word下载.docx》由会员分享,可在线阅读,更多相关《API数据服务接口开发指南Word下载.docx(22页珍藏版)》请在冰豆网上搜索。
s,请参考API文档3错误:
参数s:
%s存在非法字符,请参考API文档例如:
“参数VIN:
123DFG9871SER23存在非法字符。
4错误参数s:
%s位数不正确,请参考API文档5错误结束时间小于开始时间,请参考API文档6错误开始时间大于当前时间,请参考API文档7错误参数s:
%s大于s,请参考API文档8错误参数s:
%s不存在,请参考API文档9错误序号%s中缺失必选参数:
s,请参考API文档10错误如:
序号%s中参数s:
%s存在非法字符,请参考API文档例“参数VIN:
11错误序号%s中参数%s:
%s位数不正确,请参考API文档12错误序号%s参数s:
%s大于%s,请参考API文档13错误序号%s参数s:
%s不存在,请参考API文档14错误序号%s中参数%s:
%s格式错误,请参考API文档15错误预计总数:
s,实际总数s,请检查16错误号码s为空号17错误号码%s无人接听18错误%s:
%s不存在19错误参数s:
%s格式错误,请参考API文档99超时3数据效劳接口数据效劳接口3.1importCustomerAndVHLData(FTPMonitor-TSS)接口名称importCustomerAndVHLData调用方FTP效劳方TSSMonitor接口描述监视器监控某个指定文件夹,如果有文件,那么读取文件,并调用该接口,将客户数据和对应的车辆数据存储到TSS数据库中URL/tss/importData/V1/importCustomerAndVHLData接口类型RESTFul内容格式JSON版本号V1请求方法POST输入参数参数代码参数名称数据类型必输参数说明total总数intY客户和车辆配对总计customerVHLDataList客户、车辆、效劳状态信息列表ListY数据类型参照输出参数参数代码参数名称数据类型必输参数说明responseCode返回码intY参照返回值说明errorMessage错误信息stringN当请求异常时,将返回error信息返回值说明序号responseCodeerrorMessage说明10无22错误:
count缺失count32错误:
customerVHLList缺失customerVHLList42错误:
NO缺失NO53错误:
参数NO%s存在非法字符,请参考API文档参数NO为全数字组成69错误:
序号%s中缺失必选参数:
customerInfo79错误:
customerNamecustomerInfo中的所有必输项相同,都有缺失必选项参数错误810错误:
序号%s中参数ownership:
%s存在非法字符,请参考API文档ownership范围如下:
1:
个人;
2:
公司910错误:
序号%s中参数IDType:
%s存在非法字符,请参考API文档IDType范围如下:
1:
身份证;
组织机构代码证;
3:
护照;
4:
军官证109错误:
VHLInfo119错误:
VINVHLInfo中的所有必输项相同,都有缺失必选项参数错误1210错误:
序号%s中参数VIN:
%s存在非法字符,请参考API文档参数VIN值由字母和数字组成1311错误:
%s位数不正确,请参考API文档定义长度为17位1413错误:
序号s参数OEM%s不存在,请参考API文档VHLInfo中Band、Series、Type、Color、dealerName与OEM相同,都有不存在错误1514错误:
序号%s中参数PurcaseDate:
%s格式错误,请参考API文档格式为YYYY/MM/DD169错误:
serviceStatus179错误:
isFreeServiceserviceStatus中的所有必输项相同,都有缺失必选项参数错误1810错误:
序号%s中参数isFreeService:
%s存在非法字符,请参考API文档参数isFreeService必须数字serviceStatus中所有int类型的数据都有此错误1914错误:
序号%s中参数remainingServiceDate:
%s格式错误,请参考API文档格式为YYYY/MM/DD2015错误:
预计总数:
total,实际总数:
customerVHLDataListsize(),请检杳例:
错误:
1000,实际总数:
990,请检杳2199超时超时3.2createLeads(TSS-TSM接口名称createLeads调用方TSS效劳方TSM接口描述TSS将最新的客户静态信息、车辆静态信息和车辆效劳状态信息导入到TSM,生成对应的LeadsURL/tsm/createLeads/V1/createLeads接口类型RESTFul内容格式JSON版本号V1请求方法POST输入参数参数代码参数名称数据类型必输参数说明total总数intY需要生成Leads的总数customerVHLList客户、车辆、效劳状态信息列表ListcustomerVHLDataY数据类型参照输出参数参数代码参数名称数据类型必输参数说明responseCode返回码intY参照返回值说明errorMessage错误信息stringN当请求异常时,将返回error信息total生成Leads总数intY右为异常,那么total为0leadsList对应的Leads信息ListN数据类型参照返回值说明序号responseCodeerrorMessage说明10无22错误:
参数NO%s存在非法字符,请参考API文档参数NO为全数字组成69错误:
customer79错误:
customerNamecustomer中的所有必输项相同,都有缺失必选项参数错误810错误:
%s存在非法字符,请参考API文档ownership范围如下:
%s存在非法字符,请参考API文档IDType范围如下:
%s存在非法字符,请参考API文档参数VIN值由字母和数字组成1311错误:
序号s参数OEM%s不存在,请参考API文档VHLInfo中Band、Series、Type、Color、dealerName与OEM相同,都有不存在错误1514错误:
%s存在非法字符,请参考API文档参数isFreeService必须数字serviceStatus中所有int类型的数据都有此错误1914错误:
990,请检杳2199超时超时3.3callTheCustomer(TSS-CCA)接口名称callTheCustomer调用方TSS效劳方CCA接口描述将TSS中的客户传输到CCA触发CCA拨打给客户URL/cca/cti/V1/callTheCustomer接口类型RESTFul内容格式JSON版本号V1请求方法POST输入参数参数代码参数名称数据类型必输参数说明VIN车架号stringYcallNumber号码stringY需要拨打的号码输出参数参数代码参数名称数据类型必输参数说明responseCode返回码intY参照返回值说明errorMessage错误信息stringN当请求异常时,将返回error信息返回值说明序号responseCodeerrorMessage说明10无22错误:
VIN缺失VIN32错误:
callNumber缺失callNumber43错误:
参数callNumber:
%s存在非法字符,请参考API文档号码存在!
凉&
()等非法字符516错误:
号码%s为空号617错误:
号码%s无人接听799超时超时3.4fishTheCall(CCA-TSS接口名称fishTheCall调用方CCA效劳方TSS接口描述销售与客户交流结束后,将通话开始时间、结束时间返回给TSSURL/tss/cti/V1/fishTheCall接口类型RESTFul内容格式JSON版本号V1请求方法POST输入参数参数代码参数名称数据类型必输参数说明VIN车架号stringYcallNumber号码stringY需要拨打的号码startDate通话开始时间datetimeYYYYY/MM/DDHH:
mm:
SSendDate通话开始结束时间datetimeYYYYY/MM/DDHH:
SS输出参数参数代码参数名称数据类型必输参数说明responseCode返回码intY参照返回值说明errorMessage错误信息stringN当请求异常时,将返回error信息返回值说明序号responseCodeerrorMessage说明10无22错误:
callNumber缺失callNumber42错误:
startDate缺失startDate52错误:
endDate缺失endDate618错误:
VIN:
%s不存在73错误:
()等非法字符819错误:
参数YYYY/MM/DDHH:
SSstartDate:
%s格式错误,请参考API文档919错误:
参数endDate:
%s格式错误,请参考API文档YYYY/MM/DDHH:
SS1099超时超时3.5searchPastPackage(TSS-ES接口名称searchPastPackage调用方TSS效劳方ES接口描述TSS通过VIN查询外部系统,获取到该VIN对应的历史套餐列表URL/es/vehicle/V1/searchPastPackage接口类型RESTFul内容格式JSON版本号V1请求方法POST输入参数参数代码参数名称数据类型必输参数说明VIN车架号stringY输出参数参数代码参数名称数据类型必输参数说明responseCode返回码intY参照返回值说明errorMessage错误信息stringN当请求异常时,将返回error信息packageList套餐列表listN参照当responseCode为0时,packageList不为空返回值说明序号responseCodeerrorMessage说明10无218错误:
%s不存在32错误:
packageList,请参考API文档499超时超时3.6searchServiceStatus(TSS-ES接口名称searchServiceStatus调用方TSS效劳方ES接口描述TSS通过VIN查询外部系统,获取到该VIN对应的当前效劳状态信息URL/es/vehicle/V1/searchServiceStatus接口类型RESTFul内容格式JSON版本号V1请求方法POST输入参数参数代码参数名称数据类型必输参数说明VIN车架号stringY输出参数参数代码参数名称数据类型必输参数说明responseCode返回码intY参照返回值说明errorMessage错误信息stringN当请求异常时,将返回error信息serviceStatus效劳状态servicestatusN参照当responseCode为0时,serviceStatus不为空返回值说明序号responseCodeerrorMessage说明10无218错误:
serviceStatus,请参考API文档499超时超时4附录附录4.1数据结构描述数据结构描述4.1.1customerVHLData列表名customerVHLData客户对应车辆和效劳状态信息集合No参数代码参数名称数据类型必选参数说明1NO序号intY2customerlnfo客户静态信息customerY参照3VHLInfo车辆静态信息VHLInfoY参照4serviceStatus车辆效劳状态信息serviceStatusY参照4.1.2customerlnfo列表名customerInfo客户静态信息No参数代码参数名称数据类型必选参数说明1customerID客户IDstringN/Y当在TSS中创立客户时为空,其他情况下,必须有唯一数值2customerName客户名称stringY3renewalTimes续约次数intN4mobileNumber联系stringY5IDType证件类型intN1:
组织机构代码证;
军官证6IDNumber证件号码stringN7gender客户性别intN1:
男;
女8ownership账号类型intY1:
公司9homeNumber家庭stringN10bacKUpNumber1备用1stringN11bacKUpNumber2备用2stringN12email邮箱stringN13emergencyContact紧急联系人stringN14emergencyContactNumber紧急联系人stringN15wechat微信号stringN16companyName公司名称stringN/Y当账号类型为公司时,该字段为必输字段17companyNumber公司stringN/Y当账号类型为公司时,该字段为必输字段18companyAddress公司地址stringN/Y当账号类型为公司时,该字段为必输字段4.1.3VHLInfo列表名VHLInfo车辆静态信息No参数代码参数名称数据类型必选参数说明1VIN车架号stringY2OEM厂商stringY3Band品牌stringY4Series车系stringY5Type车型stringY6Color颜色stringY7dealerName经销商名称stringY8dealerPhoneNumber经销商stringY9dealerAddress经销商地址stringY10License车牌号stringN11MDN车载stringN12PurcaseDate购置时间datetimeYYYYY/MM/DD4.1.4serviceStatus列表名serviceStatus车辆效劳状态信息No参数代码参数名称数据类型必选参数说明1isFreeService是否处于免费效劳期intY1:
在;
不在2remainingServiceDate效劳到期时间datetimeYYYYY/MM/DD3activeProduct当前套餐名称stringY4dataUsed当月花费流量intY单位:
GB5minutesUsed当月花费分钟数intY单位:
分钟6POISearchPOI搜索次数intY7remoteLockunlock远程解闭锁次数intY8autoAlert自动报警次数intY9roadsideAssistanee道路救援次数intY10emergencyAssistanee紧急救援次数intY11ACRAssistanee碰撞自动救援次数intY12destinationDownloads目的地下载次数intY13parkinglndication停车位置提示次数intY14remoteHorningFlashing闪灯鸣笛次数intY15SVT被盗车辆跟踪次数intY16travelConsultation旅游咨询次数intY17sendToCar发送到车次数intY4.1.5leadslnfo列表名leadsInfo对应leads信息No参数代码参数名称数据类型必选参数说明1leadsIDLeadsIDstringY2VINVINstringY3customerID客户IDstringY4leadsStatusLeads状态intY1:
待分配;
新建;
执行中;
关闭5renewalPossibility续约指数stringY6customerStatusLV1一级客户状态stringN7customerStatusLV2二级客户状态stringN8leadsOwnerLeads归属stringN用户ID4.1.6package列表名package套餐信息No参数代码参数名称数据类型必选参数说明1packageName套餐名称stringY2startDate
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- API 数据 服务 接口 开发 指南