汽车信息娱乐系统通信协议规范.doc

项目名称： 北京汽车信息娱乐系统通信协议规范-TSP平台与DVDVer1.1北京汽车股份有限公司2011年07月目 录1文档简介11.1协议说明11.2数据类型11.3编码说明11.4注释说明11.5符号说明11.6加密11.7度量单位12协议框架22.1协议概述22.2协议说明22.2.1协议请求头22.2.2应答请求头33DVD接口协议说明43.1消息服务43.1.1消息分类获取应答结果.1数据结构.2应答示例53.1.2消息列表获取应答结果.1数据结构.2应答示例73.1.3消息详情获取消息详情获取获取.1请求参数.2应答结果.2.1数据结构.2.2应答示例下载附件.1请求参数.2应答结果.2.1数据结构.2.2应答示例153.2保养服务163.2.1保养记录查询请求参数应答结果163.2.2查询当次保养状态请求参数应答结果183.2.3取消当次保养提醒请求参数应答结果193.3一键导航203.3.1获取设定位置请求参数应答结果213.4网络检索243.4.1关键字检索请求参数应答结果253.4.2POI分类检索2请求参数2应答结果283.4.3交叉路检索30请求参数30应答结果313.4.4周边POI检索3请求参数3应答结果333.5新闻353.5.1新闻分类查询3请求参数3应答结果353.5.2新闻订阅3请求参数3应答结果373.5.3新闻取消订阅3请求参数3应答结果383.5.4新闻获取3请求参数3应答结果393.6天气预报413.6.1行政区划元数据检索4请求参数4应答结果413.6.2天气查询4请求参数4应答结果433.7车队组队453.7.1车队列表查询4请求参数4应答结果4数据结构4应答示例473.7.2车队队员检索4请求参数4应答结果4数据结构4应答示例493.7.3位置上报5请求参数5应答结果5数据结构5应答示例523.7.4加入/退出车队申请5请求参数5应答结果543.8消息检测543.8.1消息检测请求543.8.2消息应答结果554附录564.1服务类型说明564.2返回码564.3消息分类57前 言本规范由北京汽车股份有限公司提出并归口。本规范起草单位：北京汽车股份有限公司本规范解释单位：北京汽车股份有限公司1 文档简介1.1 协议说明本文中内容对北京汽车信息娱乐系统平台（TSP平台）与DVD之间的HTTP通讯协议进行定义和说明。1.2 数据类型本文中标记 C显示Character型。C 后面连接的数字显示Character数。如：C4 表示 Character型，4 Character。1.3 编码说明DVD与TSP平台间请求、应答协议编码方式默认采用GBK。1.4 注释说明本文采用如下注释关键词：注意提醒读者关注此处。1.5 符号说明1) 必填项。2) (空)非必填项。1.6 加密本协议中涉及到的DID需要进行加密，加密算法由DVD供应商和TSP平台进行共同商定。1.7 度量单位本协议中涉及到的度量单位信息，如无特殊说明，均按照下列处理：编号名称长度单位说明1经度C101/1000秒10进制2纬度C101/1000秒10进制3方向C3度10进制, 与正北方向夹角:0 3604速度C50.1公里每小时10进制2 协议框架2.1 协议概述本通讯协议的承载协议为HTTP/1.1(参见RFC2626)。服务采用HTTP网络传输协议，客户端以GET的形式发送请求数据到服务器端。本公开协议由一个安全协议规范和业务协议规范构成，安全对协议的结构和控制标识进行约定，业务协议对具体的业务功能进行规范。安全和业务协议有各自的版本号。2.2 协议说明2.2.1 协议请求头序号参数说明长度示例必填1Device-id终端设备DVD的信息C16Device-id= SD2010072600001 2Device-vin用于标识车辆的唯一码C17Protocol-version协议的版本号。发起方请求时，必须标明使用的版本号，主要用于版本升级。版本号的组成：xxxx 版本号(主版本号.次版本号)C40100Encoding用于标识请求编码方式，支持UTF-8或者GBK，默认是GBK。C5Test-flag该字段用于终端是否为测试请求TSP处理业务，0为非测试，1为测试,默认为0C16BID厂商业务标识类型, 标识接入的厂商业务C3参见“厂商业务标识类型表”7SID终端请求服务的请求码。请求码系统统一定义。C4详细参见附录4.1厂商业务标识类型(BID)如下：标识含义100C60F101C70G DVD 102C70G CD103C80K104C50E2.2.2 应答请求头序号参数说明长度示例必填1Result_code应答状态C4Result_code: 02002SID终端请求服务的请求码C4参见附录4.1应答状态参见附录4.2中定义3 DVD接口协议说明DVD和TSP平台之间的，请求的URL统一为：/baicTSP/SafeDVDServlet。请求方式为/baicTSP/SafeDVDServlet?param.3.1 消息服务3.1.1 消息分类获取车载终端使用该接口获取消息分类信息。示例：GET /baicTSP/SafeDVDServlet HTTP/1.1Host: ip:portDevice-vin:20110705-BJ10234Device-id: SD2010072600001Protocol-version: 1.0Encoding: gbkTest-flag: 0BID: 100SID: 200 应答结果.1 数据结构序号元素名称英文名称相关解释长度示例必填1符合条件总记录数sumnumber所有的记录C32消息mesgtypes消息分类体3分类IDmesgtype_id消息ID最长C114分类标题mesgtype_title消息标题最长C645分类类型mesgtype_type大分类：0小分类：为该小分类的父类型ID最长C.2 应答示例HTTP/1.1 200 OKContent-Length: 72Date: Mon, 14 Mar 2011 07:50:37 GMTResult_code: 0200SID: 2002sumnumber: 2,mesgtypes:mesgtype_id: 10,mesgtype_title: 终端,mesgtype_type: 0,/表示大分类,mesgtype_id: 1001,mesgtype _title: 广告,mesgtype_type: 10/非“0”即为小分类，值为父类型的“mesgtype_id”3.1.2 消息列表获取车载终端使用该接口获取消息列表信息。序号元素名称英文名称相关解释长度示例必填1消息大类别mesgType参见附录4.3C22消息详细类别typeDetail参见附录4.3C43结果开始位置pos取得检索结果集的开始位置最长C44结果集的件数cnt取得检索结果集的件数最长C4示例：GET /baicTSP/SafeDVDServlet?mesgType=10&typeDetail=1001&pos=0&cnt=10 HTTP/1.1Host: ip:portDevice-vin:20110705-BJ10234Device-id: SD2010072600001Protocol-version: 1.0Encoding: gbkTest-flag: 0BID: 100SID: 200 应答结果.1 数据结构序号元素名称英文名称相关解释长度示例必填1符合条件总记录数sumnumber所有的记录C32消息messages消息体3消息IDmessage_id消息ID最长C114消息标题message_title消息标题最长C645消息大类型message_type消息大类型C46消息详细类型message_type_detail消息详细类型C47消息来源message_from消息来源最长C328消息发布时间publish_time格式：yyyy-mm-dd hh:mm:ssC.2 应答示例HTTP/1.1 200 OKContent-Length: 72Date: Mon, 14 Mar 2011 07:50:37 GMTResult_code: 0200SID: 2003sumnumber: 2,messages:message_id:message_title: 终端版本需要升级,message_type: 11,message_type_detial:1101message_from: 系统,publish_time:2010-03-25 14:39:01,message_id:message_title: 送您洗车大礼包,message_type: 14,message_type_detial:1402message_from: 系统,publish_time:2010-03-25 14:39:013.1.3 消息详情获取终端使用该接口获取消息详情，支持同时获取多条消息详情。 消息详情获取获取.1 请求参数序号元素名称英文名称相关解释长度示例必填1消息的IDmsgId如果想要获取即时消息的ID，并且想要同时获取多条消息的ID，则使用”,”分割最长C11msgId=1001, 10022获取方式obtainType1：BASE64方式，一次性获取全部消息。2：URL方式，先获取文字部分，在逐个获取附件。C1obtainType=1obtainType=2示例：GET /baicTSP/SafeDVDServlet?msgId=1001,1002&obtainType=1 HTTP/1.1Host: ip:portDevice-vin:20110705-BJ10234Device-id: SD2010072600001 Protocol-version: 1.0Encoding: gbkTest-flag: 0BID: 100SID: 200.2 应答结果.2.1 数据结构序号元素名称英文名称相关解释长度示例必填1符合条件总记录数sumnumber符合条件总记录数最长C32消息messages消息体3消息IDmessage_id消息ID最长C114消息标题message_title消息标题最长C1005消息来源message_from消息来源最长C206消息发布时间publish_time格式：yyyy-mm-dd hh:mm:ssC197消息大类型message_type消息大类型C48消息详细类型message_type_detial消息详细类型C49消息体message_body消息体最长C20010获取方式obtainType1：BASE64方式，一次性获取全部消息。2：URL方式，先获取文字部分，在逐个获取附件。11附件体message_ multimedia _body附件体12附件编号message_ multimedia_id附件编号C113附件类型message_ multimedia_type1：图片；2：声音C114附件大小message_ multimedia_length附件大小C815附件message_ multimedia附件.2.2 应答示例说明1：用BASE64方式获取全部消息HTTP/1.1 200 OKContent-Length: 72Date: Mon, 14 Mar 2011 07:50:37 GMTResult_code: 0200SID: 2004sumnumber: 2,messages:message_id: 1001,message_title: 送您洗车大礼包,message_from: 系统,publish_time:”2010-03-25 14:39:01”,message_type: 14,message_type_detial:”1402,message_body:从即日起至10月1日，到中街4S店洗车享受半价优惠，快快行动吧,obtainType:1,message_ multimedia _body: message_ multimedia_id:1,message_ multimedia_type:1, message_ multimedia_length:120, message_ multimedia:asdfadfasdfasdfasdf” ,message_ multimedia_id:2,message_ multimedia_type:2, message_ multimedia_length:150, message_ multimedia:asdfadfasdfasdfasdf” ,message_id: 1002,message_title: 分享信息,message_from: 好友,publish_time:”2010-03-25 14:39:01”,message_type: 13,message_type_detial:”1303”,message_body:东大门口有活动，obtainType:1,message_ multimedia _body: message_ multimedia_id:2,message_ multimedia_type:2, message_ multimedia_length:180, message_ multimedia:asdfadfasdfasdfasdf” 说明2：以URL方式获取文字信息，再用BASE64方式逐个获取附件。HTTP/1.1 200 OKContent-Length: 72Date: Mon, 14 Mar 2011 07:50:37 GMTResult_code: 0200SID: 2004sumnumber: 2,getnumber: 2,messages:message_id: 1001,message_title: 送您洗车大礼包,message_from: 系统,publish_time:”2010-03-25 14:39:01”,message_type: 14,message_type_detial:”1402,message_body:从即日起至10月1日，到中街4S店洗车享受半价优惠，快快行动吧,obtainType:2,message_ multimedia _body: message_ multimedia_id:1,message_ multimedia_type:, message_ multimedia_length:, message_ multimedia: message_ multimedia _body: message_ multimedia_id:2,message_ multimedia_type:, message_ multimedia_length:, message_ multimedia: ,message_id: 1002,message_title: 分享信息,message_from: 好友,publish_time:”2010-03-25 14:39:01”,message_type: 13,message_type_detial:”1303”message_body:东大门口有活动,obtainType:1,message_ multimedia _body: message_ multimedia_id:2,message_ multimedia_type:, message_ multimedia_length:, message_ multimedia: 说明3 ：无附件信息的消息。HTTP/1.1 200 OKContent-Length: 72Date: Mon, 14 Mar 2011 07:50:37 GMTResult_code: 0200SID: 2004sumnumber: 1,getnumber: 1,messages:message_id: 1001,message_title: 送您洗车大礼包,message_from: 系统,publish_time:2010-03-25 14:39:01,message_type: 14,message_type_detial:”1402,message_body:从即日起至10月1日，到中街4S店洗车享受半价优惠，快快行动吧,obtainType:2,message_ multimedia _body: 下载附件.1 请求参数序号元素名称英文名称相关解释长度示例必填1消息IDmessageId消息ID最长C112附件编号message_ multimedia_id附件编号C11示例：GET /baicTSP/SafeDVDServlet?messageId=1001&message_ multimedia_id=1 HTTP/1.1Host: ip:portDevice-vin:20110705-BJ10234Device-id: SD2010072600001 Protocol-version: 1.0Encoding: gbkTest-flag: 0BID: 100SID: 200.2 应答结果.2.1 数据结构序号元素名称英文名称相关解释长度示例必填1消息IDmessage_id消息ID最长C112附件体message_ multimedia _body附件体3附件编号message_ multimedia_id附件编号C114附件类型message_ multimedia_type1：图片；2：声音C15附件大小message_ multimedia_length附件大小C86附件message_ multimedia附件.2.2 应答示例HTTP/1.1 200 OKContent-Length: 72Date: Mon, 14 Mar 2011 07:50:37 GMTResult_code: 0200SID: 2005message_id:message_ multimedia _body: message_ multimedia_id:1,message_ multimedia_type:1, message_ multimedia_length:120, message_ multimedia:asdfadfasdfasdfasdf” 3.2 保养服务3.2.1 保养记录查询 请求参数序号元素名称英文名称相关解释长度示例必填1结果开始位置pos取得检索结果集的开始位置最长C42结果集的件数cnt取得检索结果集的件数最长C4示例：GET /baicTSP/SafeDVDServlet?pos=0&cnt=10 HTTP/1.1Host: ip:portDevice-vin:20110705-BJ10234Device-id: SD2010072600001Protocol-version: 1.0Encoding: gbkTest-flag: 0BID: 100SID: 700 应答结果序号元素名称英文名称相关解释长度示例必填1符合条件总记录数sumnumber总记录数最长C42记录体maintainRecords3主键标识id主键标识最长C114保养日期maintain_date保养日期C205保养公里数maintain_km保养公里数最长C57保养4s店dealer_name保养4s店最长C648保养费用check_cost保养费用最长C89保养状态check_status保养状态最长C810保养内容check_content11保养项content_key保养项最长C2012保养操作content_value保养操作最长C2013保养费用content_cost保养费用最长C8示例：HTTP/1.1 200 OKContent-Length: 72Date: Mon, 14 Mar 2011 07:50:37 GMTResult_code: 0200SID: 7001sumnumber:2,maintainRecords: id:1001,maintain_date:20110505, maintain_km:120, dealer_name:北京4s店” check_cost:4000” check_status:已完成”,check_content:content_key:发动机,content_value:换机油content_cost:230.99，content_key:轮胎,content _value:补齐content_cost:03.2.2 查询当次保养状态 请求参数示例：GET /baicTSP/SafeDVDServlet?type=1 HTTP/1.1Host: ip:portContent-Length: 91Device-vin:20110705-BJ10234Device-id: SD2010072600001Protocol-version: 1.0Encoding: gbkTest-flag: 0BID: 100SID: 7002注意：请求URL中type是查询的类型，包含保养提醒、车辆信息、4S店服务、广告等，暂定只有查询当次保养状态，即type=1。 应答结果序号元素名称英文名称相关解释长度示例必填1保养状态结果result保养状态结果0：保养状态已取消1：保养状态未取消最长C1HTTP/1.1 200 OKContent-Length: 72Date: Mon, 14 Mar 2011 07:50:37 GMTResult_code: 0200SID: 7002result:1 /0：保养状态已取消 1：保养状态未取消3.2.3 取消当次保养提醒 请求参数示例：GET /baicTSP/SafeDVDServlet?type=1 HTTP/1.1Host: ip:portDevice-vin:20110705-BJ10234Device-id: SD2010072600001Protocol-version: 1.0Encoding: gbkTest-flag: 0BID: 100SID: 7003注意：请求URL中type是取消的类型，包含保养提醒、车辆信息、4S店服务、广告等，暂定只有取消当次保养提醒，即type=1。 应答结果示例(取消成功)：HTTP/1.1 200 OKContent-Length: 72Date: Mon, 14 Mar 2011 07:50:37 GMTResult_code: 0200SID: 7003示例(取消失败)：HTTP/1.1 200 OKContent-Length: 72Date: Mon, 14 Mar 2011 07:50:37 GMTResult_code:0401SID: 70033.3 一键导航3.3.1 获取设定位置一键导航是把用户要求的位置,发送给TSP平台,DVD从TSP平台下载位置信息。 请求参数序号元素名称英文名称相关解释长度示例必填1包含历史记录has_history是否包含历史记录，默认为0最长C1has_history=0，has_history=1注：has_history为0 就是不包含历史记录，如果没有最新的导航记录，返回无导航记录；has_history为1就是包含历史记录，如果没有最新的导航记录，返回最后一次的导航记录。示例：GET /baicTSP/SafeDVDServlet?has_history=0 HTTP/1.1Host: ip:portDevice-vin:20110705-BJ10234Device-id: SD2010072600001 Protocol-version: 1.0Encoding: gbkTest-flag: 0BID: 100SID: 300 应答结果序号元素名称英文名称相关解释长度示例必填1结果Result2导航条件navicondition0: 推荐优先；1：高速优先；2：距离优先；3：时间优先；4：采用导航本地的设置。默认值为4C13目的地destination目的地4位置名pname位置名最长C505经度lon经度C106纬度lat 纬度C107电话tel电话C158地址address地址最长C1289途经地vias最多3个途径地10途经地序号viaid途径地的顺序号C111途经地信息poiinfo途径地信息12位置名pname位置名最长C6413经度lon经度C1014纬度lat 纬度C1015电话tel电话最长C1516地址address地址最长C100示例(单一目的地成功)：HTTP/1.1 200 OKContent-Length: 72Date: Mon, 14 Mar 2011 07:50:37 GMTResult_code: 0200SID: 3001Result:navicondition：1， destination : pname:万豪酒店,lon:222222222,lat:1111111111,tel:65478915,address:北京市朝阳区劲松南路145号,vias: viaid:1,poiinfo:pname:万豪酒店,“lon”: 222222222,“lat:1111111111,“tel:65478915，address:北京市朝阳区劲松南路145号,viaid:2,poiinfo:lon :222222222,lat :1111111111，tel:65478915，address:北京市朝阳区劲松南路145号示例(多目的地成功)：HTTP/1.1 200 OKContent-Length: 72Date: Mon, 14 Mar 2011 07:50:37 GMTResult_code: 0200SID: 3001Result: “destination : pname:万豪酒店,lon:222222222,lat:1111111111，tel:65478915，address:北京市朝阳区劲松南路145号,pname:大厦1,lon:222222222,lat:1111111111,tel:65478915，address:北京市朝阳区劲松南路145号示例(失败)：HTTP/1.1 200 OKContent-Length: 72Date: Mon, 14 Mar 2011 07:50:37 GMTResult_code: 0403SID: 30013.4 网络检索3.4.1 关键字检索 请求参数序号元素名称英文名称相关解释长度示例必填1省名称prov_name省级行政区域的中文名称最长C40prov_name=辽宁省2市名称city_name市级行政区域的中文名称最长C40city_name=沈阳市高德GIS必须且只要城市代码3县名称county_name县、区级行政区域的中文名称最长C40county_name =沈河区4关键字keyword检索关键字最长C100keyword=万豪酒店关键字与首字母二选一5首字母first_letters关键字拼音首字母最长C50first_letters=whjd6排序字段sort_cri排序字段：设定是否使用分类排序字段。最长C20sort_cri=keyowrd7结果集的开始位置pos取得结果集的开始位置最长C4pos=208结果集件数cnt取得结果集的件数最长C4cnt=30 【注】1) pos 值为正整数，cnt值为正整数。2) 请求参数中的省市信息都为国标码。3) 关键字和首字母字段，不能同时为空4) 排序字段,默认值为 keyword ，示例：GET /baicTSP/SafeDVDServlet?prov_name=辽宁省&city_name=沈阳市& county_name=沈河区&keyword=万豪酒店&sort_cri=keyword&pos=20&cnt=30 HTTP/1.1或GET /baicTSP/SafeDVDServlet? prov_name=辽宁省&city_name=沈阳市& county_name=沈河区& first_letters=whjd&sort_cri=keyword&pos=20&cnt=30 HTTP/1.1Host: ip:portDevice-vin:20110705-BJ10234Device-id: SD2010072600001 Protocol-version: 1.0Encoding: gbkTest-flag: 0BID: 100SID: 400 应答结果序号元素名称英文名称相关解释长度必填1符合条件总记录数sumnumber总记录数最长C42结果result3主键id主键最长C204POI名称keywordPOI名称最长C1005电话tel电话最长C156地址address地址最长C1007经度lon经度C108纬度lat纬度C10示例：HTTP/1.1 200 OKContent-Length: 72Date: Mon, 14 Mar 2011 07:50:37 GMTResult-code: 0200SID: 4001sumnumber:2,result:id:1001,keyword :万豪酒店,tel:14687311,address:沈阳市青年大街100号,lon:1201111,lat:4312354，id:1002,keyword :新万豪酒店,tel:25258899,address:沈阳市奉天大街77号,lon:1201222,lat:43125313.4.2 POI分类检索 请求参数序号元素名称英文名称相关解释长度示例必填1POI分类代码type_codePOI分类代码最长C11type_code=1902012省级行政区prov_name省级行政区域的中文名称最长C40prov_name=辽宁省3市级行政区city_name市级行政区域的中文名称最长C40city_name=沈阳市城市改为必填，高德GIS检索需要该参数4县、区级行政区county_name县、区级行政区域的中文名称最长C40county_name =沈河区5POI名称poi_namePOI名称最长C100poi_name=万豪酒店与首字母二选一6POI名称的拼音首字母first_lettersPOI名称的拼音首字母最长C50first_letters=whjd7排序字段sort_cri排序字段：poi_name（拼音排序），type（类型排序）。默认为poi_nameC20sort_cri= poi_name8结果集开始位置pos取得检索结果集的开始位置最长C4pos=209结果集的件数cnt取得检索结果集的件数最长C4cnt=30【注】1) pos 值为正整数，cnt值为正整数。2) 请求参数中的省市信息都为国标码。3) POI名称和首字母字段，不能同时为空4) 排序字段,默认值为 poi_name，示例：GET /baicTSP/SafeDVDServlet?type_code=190201&prov_name=辽宁省&city_name=沈阳市& county_name=沈河区&poi