智慧社区项目手机app后台与接口说明v0.167

1、智慧物流系统App 接口说明书文件状态： 草稿 正式发布 正在修改文件标识：Interface当前版本：0.1作者：刘学完成日期：2014 年 8 月 5 日版 本 历 史版本/状态作者参与者起止日期备注0.1 Daft刘学接口文档目 录1.文档介绍41.1. 文档目的41.2. 文档范围41.3. 读者对象41.4. 参考文献41.5. 术语与缩写解释41.6. 问题42.接口分类5提供服务给2.1.SCS_BS........4.2.

2、.2.APP. 5我要取件-OUTPUT5取件详情-OUTPUT6取件详情-关注-INPUT7取件详情-获取-OUTPUT8取件详情-快速取件-INPUT8我要寄件-INPUT9我要寄件-收件人历史我要寄件-寄件人历史-OUTPUT11-OUTPUT12我要寄件-快递公司选择-OUTPUT13我要寄件-所有订单-OUTPUT14快递-OUTPUT15麦宝-OUTPUT18麦宝-详情-OUTPUT19麦包-租用提交-INPUT20麦包-箱子租用-支付成功-INPUT22个人中心-地址-OUTPU

3、T22个人中心-地址登记-INPUT23个人中心-地址删除或添加默认-INPUT25快递员信息-OUTPUT27-INPUT28消息-获取消息-OUTPUT28消息-状态修改-INPUT30提供服务给 SCS_BS2.2. 552.2.1 消息-推送552.2.2 快速取件561. 文档介绍1.1. 文档目的通过本文档，详细说明了智慧物流项目 SCS_BS与App的通口，包括App 向 SCS_BS获取信息，SCS_BS 向App 推送信息。在整个业务流程中涉及到的数据交互，在此文档中做详细定义，包括的参数，返回的类型等，第公司或是本公司开发，参照此文档做具体业务开发。1.2. 文档范围本文定

4、义了智慧物流项目中 SCS_BS和App 交互的接口规范。1.3. 读者对象开发系统设计师1.4. 参考文献1.5. 术语与缩写解释1.6. 问题NO时间描述人状态缩写、术语解 释2. 接口分类2.1. SCS_BS提供服务给通信方式:HTTP+JSON接口主要说明：此处主要说明术支持等。App 和 SCS_BS 通信方式，实现正确通信需要什么样的技2.1.1.我要取件-OUTPUT接口详细说明：用户登录之后，在首页上选择“我要取件”，显示出全部取件信息、未取信息、已取信息，并标记出取件柜子与用户之间距离。请求说明:http 请求方式: POST请求参数：请求示例：“userCode “：“2

5、312323“返回说明：正确的 Json 返回结果:名称数据类型长度说明codeString500000 成功00001 取件信息msgString100msgList用户取件的物流信息，放到一个 list 中panyCode:快递公司编号名称是否必须数据类型长度说明userCode是String30用户号Json 返回示例:"code":00000,"msg":"成功！"," msgList ":MsgList2.1.2.取件详情-OUTPUT接口详细说明：用户登录之后，在首页上选择“我要取件”，显示出全部取件信

6、息、未取信息、已取信息，并标记出取件柜子与用户之间距离。未取信息，选择其中一条，进入取件详情。请求说明:http 请求方式: POST请求参数：请求示例：“expressNo “：“2312323232“返回说明：正确的 Json 返回结果:名称数据类型长度说明codeString500000 成功00001 失败msgString100名称是否必须数据类型长度说明expressNo是String20快递单号userCode是String30用户号panyName:快递公司名称expressNo:快递单号boxCode:柜子编号boxName:柜子名称boxCoordinate:柜子坐标box

7、Address:柜子详细地址inspectFlag:物流状态1:未取2：已取Json 返回示例:"code":00000,"msg":"成功！"2.1.3.取件详情-关注-INPUT接口详细说明：点击“未取信息”，选择其中一条，进入取件详情。如果，该柜子没有关注， 点击“关注”进行关注。请求说明:http 请求方式: POST请求参数：请求示例：“boxCode “：“2312323232“, “boxAtteFlag “：“2“返回说明：正确的 Json 返回结果:名称数据类型长度说明codeString500000 成功名称是否必

8、须数据类型长度说明userCode是String20用户编号boxCode是String20柜子编号boxAtteFlag是String1修改成关注状态 2locationFlag否String11 ：家附近 2：公司附近 3：其他boxCodeString20柜子编号boxNameString50柜子名称boxCoordinateString50柜子坐标boxAddressString100柜子详细地址boxAtteFlagString1关注标示smsCheckCodeString6dimCodeString50Json 返回示例:"code":00000,"m

9、sg":"成功！"2.1.4.取件详情-获取-OUTPUT接口详细说明：点击“未取信息”，选择其中一条，进入取件详情。如果，需要再次获取验证码，点击“重新获取”，再次获取。请求说明:http 请求方式: POST请求参数：请求示例：“expressNo “：“2312323232“返回说明：正确的 Json 返回结果:Json 返回示例:"code":00000,"msg":"成功！"2.1.5.取件详情-快速取件-INPUT接口详细说明：点击“未取信息”，选择其中一条，进入取件详情。点击快速取件按钮进行

10、快速取件操作。请求说明:名称数据类型长度说明codeString500000 成功00001 失败msgString100smsCheckCodeString6名称是否必须数据类型长度说明expressNo是String20快递单号userCode是String30用户号00001 失败msgString100http 请求方式: POST请求参数：请求示例：“expressNo “：“2312323232“返回说明：正确的 Json 返回结果:Json 返回示例:"code":00000,"msg":"成功！"2.1.6.我要寄件-

11、INPUT接口详细说明：点击“我要寄件”，打开寄件信息登记画面。请求说明:http 请求方式: POST参数：名称是否必须数据类型长度说明userCode是String30用户编号panyCode是String30快递公司编号receiverName是String10收件人名称数据类型长度说明codeString500000 成功00001 失败msgString100boxCodeString50柜子名称subBoxCodeString20小格子编号pickupTimedate取件时间名称是否必须数据类型长度说明expressNo是String20快递单号userCode是String30用

12、户号请求示例：“receiverName “：“张三“，.返回说明：正确的 Json 返回结果:Json 返回示例:"code":00000,"msg":"成功！"名称数据类型长度说明codeString500000 成功00001 失败msgString100dimCodeString100信息receiverPhone是String11收件人号receiverAreaCode是String6收件人所在地区编号receiverAddress是String100收件人详细地址senderName是String10寄件人senderPh

13、one是String11寄件人号senderAreaCode是String6寄件人所在地区senderAddress是String100寄件人详细地址totalWeight是long6重量subBoxCode是String10X 代表超大柜、L 代表大柜、M 代表中柜、S 代表小柜remark否String100备注2.1.7.我要寄件-收件人历史-OUTPUT接口详细说明：点击“我要寄件”，打开寄件信息登记画面。收件人信息填写中，选择“历史”。请求说明:http 请求方式: POST参数：请求示例：“userCode “：“张三“，.返回说明：正确的 Json 返回结果:名称是否必须数据类型

14、说明codeString500000 成功00001 失败msgString100receiverList用户收件人信息，放到一个 list中ID：唯一标识receiverName:收件人名称receiverPhone:收件人receiverAreaCode:收件人地区编号receiverAddress:收件人详细地址名称是否必须数据类型长度说明userCode是String15用户编号Json 返回示例:"code":00000,"msg":"成功！"2.1.8.我要寄件-寄件人历史-OUTPUT接口详细说明：点击“我要寄件”，打开

15、寄件信息登记画面。寄件人信息填写中，选择“历史”。请求说明:http 请求方式: POST参数：请求示例：“userCode “：“张三“，.返回说明：正确的 Json 返回结果:名称数据类型长度说明codeString500000 成功00001 失败msgString100sendList用户收件人信息，放到一个 list中ID：唯一标识senderName:寄件人名称名称是否必须数据类型长度说明userCode是String15用户编号defaultFlag: 1：默认地址 2：普通地址Json 返回示例:"code":00000,"msg":&q

16、uot;成功！"2.1.9.我要寄件-快递公司选择-OUTPUT接口详细说明：点击“我要寄件”，打开寄件信息登记画面。选择“请选择快递公司”。请求说明:http 请求方式: POST参数： 无请求示例： 无返回说明：正确的 Json 返回结果:名称数据类型长度说明codeString500000 成功00001 失败msgString100expressList快递公司信息，放到一个 list 中panyCode:快递公司编号panyNam e:快递公司名称senderPhone:寄件人sendAreaCode:寄件人地区编号senderAddress:寄件人详细地址defaultF

17、lag: 1：默认地址 2：普通地址Json 返回示例:"code":00000,"msg":"成功！"2.1.10.我要寄件-所有订单-OUTPUT接口详细说明：点击“我要寄件”，查看所有订单，包括正在进行中、已完成订单。请求说明:http 请求方式: POST参数：请求示例：“userCode “：“张三“，.返回说明：正确的 Json 返回结果:名称数据类型长度说明codeString500000 成功00001 失败msgString100orderList订单信息，放到一个 list中panyCode:快递公司编号panyN

18、ame:快递公司名称expressNo:快递单号名称是否必须数据类型长度说明userCode是String15用户编号Json 返回示例:"code":00000,"msg":"成功！"2.1.11.快递-模糊-OUTPUT接口详细说明：点击“快递请求说明:http 请求方式: POST”，扫描或输入快递单号。请求参数：请求示例：“expressNo “：”1323100023“，.返回说明：正确的 Json 返回结果:名称数据类型长度说明名称是否必须数据类型长度说明expressNo是String20快递单号userCode是Str

19、ing30用户号senderAddress:寄件地址receiverAddress:收件地址sendername:寄件人receiverName:收件人orderDate:订单日期orderState：1：进行中2：已完成dimCode：Json 返回示例:"code":00000,"msg":"成功！"2.1.12.快递-精确-OUTPUT接口详细说明：点击“快递”，扫描或输入快递单号。codeString500000 成功00001 失败msgString100typeString11:返回公司列表 2：返回快递信息express

20、Listtype 为 1 的情况快递公司信息，放到一个 list 中panyCode:快递公司编号panyName:快递公司名称statusString1type 为 2 的情况0 表示失败，1 正常，2 派送中，3 已签收，4 退回,5 其他问题expTextNameString20type 为 2 的情况快递公司名称datatype 为 2 的情况快递运行痕迹，存放到 list 中time: 2014.5.24 12:23context:【科技园分点】的派件员王 XX正在派件。请求说明:http 请求方式: POST请求参数：请求示例：“expressNo “：”1323100023“，.

21、返回说明：正确的 Json 返回结果:名称数据类型长度说明codeString500000 成功00001 失败msgString100statusString10 表示失败，1 正常，2 派送中，3 已签收，4 退回,5 其他问题expTextNameString20快递公司名称data快递运行痕迹，存放到 list 中time: 2014.5.24 12:23context:【科技园分点】的派件员王 XX正在派件。名称是否必须数据类型长度说明expressNo是String20快递单号panyCode是String30快递公司编号userCode是String30用户号Json 返回示例:

22、"code":00000,"msg":"成功！"麦宝-OUTPUT2.1.13.接口详细说明：登录App，点击“ 请求说明:http 请求方式: POST麦宝”，进入麦宝界面。请求参数：请求示例：“userCode “：“232323“，.返回说明：正确的 Json 返回结果:名称数据类型长度说明codeString500000 成功00001 失败msgString100expressNotCountint2未取包裹数量distanceString10附近距离定义boxCoordinateList柜子坐标，多个柜子，存放到 list

23、中boxCode：物流柜编号boxName:柜子名称boxCoordinate:柜子坐标名称是否必须数据类型长度说明userCode是String15用户号Json 返回示例:"code":00000,"msg":"成功！"麦宝-详情-OUTPUT2.1.14.接口详细说明：登录App，点击“ 请求说明:http 请求方式: POST麦宝”，进入麦宝界面，进入柜子详情。参数：请求示例：“boxCode “：“232323“， “userCode”: “22654555”,.返回说明：正确的 Json 返回结果:名称数据类型长度说明co

24、deString500000 成功00001 失败msgString100boxCodeString15柜子编号名称是否必须数据类型长度说明boxCode是String15柜子编号userCode是String15用户编号boxFocusFlag: 1： 未关注 2：已关注locationFlag：1 ：家附近 2：公司附近 3：其他Json 返回示例:"code":00000,"msg":"成功！"麦包-租用提交-INPUT2.1.15.接口详细说明：登录App，点击“麦宝”，进入麦宝界面，进入柜子详情，进入租用柜子,选择小柜子后点

25、击租用。请求说明:http 请求方式: POST参数：名称是否必须数据类型长度说明boxCode是String15柜子编号userCode是String20用户编号boxNameString50柜子名称boxCoordinateString50柜子坐标subBoxList物流柜子小柜子信息，存放list 中subBoxCode:0000001 subBoxStandard: X 代表超大柜、L 代表大柜、M 代表中柜、S 代表小柜subBoxStatus: 1 未租用 2已租用rentList物流柜子该用户租用小柜子信息，存放 list 中subBoxCode:0000001 subBoxSt

26、andard: X 代表超大柜、L 代表大柜、M 代表中柜、S 代表小柜rentTotal: 总共租用天数rentSurplus: 剩余天数“boxCode “：“232323“，返回说明：正确的 Json 返回结果:Json 返回示例:"code":00000,"msg":"成功！"名称数据类型长度说明codeString500000 成功00001 失败msgString100orderNOString20订单编号subBoxType是String15X 代表超大柜、L 代表大柜、M 代表中柜、S代表小柜rentPeriod是in

27、t51:一天2：两天3：三天7：一周phoneDate是String前台信息提交时间yyyy-mm-d dhh:mm:ss麦包-箱子租用-支付成功-INPUT2.1.16.接口详细说明：登录App，点击“麦宝”，进入麦宝界面，进入柜子详情，进入租用柜子,选择小柜子后点击租用。请求说明:http 请求方式: POST参数：请求示例： 请求示例：“orderNO “：“232323“，返回说明：正确的 Json 返回结果:Json 返回示例:"code":00000,"msg":"成功！"2.1.17.个人中心-地址-OUTPUT接口详细

28、说明：登录App，进入个人中心，进行认证。请求说明:http 请求方式: POST请求参数：名称数据类型长度说明codeString500000 成功00001 失败msgString100名称是否必须数据类型长度说明orderNO是String20订单编号userCode是String30用户号请求示例：“userCode “：“232323“，.返回说明：正确的 Json 返回结果:Json 返回示例:"code":00000,"msg":"成功！"2.1.18.个人中心-地址登记-INPUT接口详细说明：登录App，进入个人中心

29、，地址填写。请求说明:http 请求方式: POST名称数据类型长度说明codeString500000 成功00001 失败msgString100addressList详细地址,存放 list ID: 地址唯一标示name : 收货或发货phone: 收货或发货area:地区编号address:详细地址default：1 未设置默认 2 设置默认flag ： 1:收货地址2：发货地址名称是否必须数据类型长度说明userCode是String15用户号参数：请求示例：“name“：“姓名“，.返回说明：正确的 Json 返回结果:Json 返回示例:"code":0000

30、0,"msg":"成功！"名称数据类型长度说明codeString500000 成功00001 失败msgString100名称是否必须数据类型长度说明userCode是String20用户编号name是String15phone是String11area是String6所在地区编号addressDetail是String100详细地址phoneDate是String前台信息提交时间yyyy-mm-ddhh:mm:sstype是String11：收件 2：寄件2.1.19.个人中心-地址删除或添加默认-INPUT接口详细说明：登录请求说明:App，进入个

31、人中心，地址删除。http 请求方式:POST参数：请求示例：“userCode “：“121212“，.返回说明：正确的 Json 返回结果:Json 返回示例:"code":00000,"msg":"成功！"名称数据类型长度说明codeString500000 成功00001 失败msgString100名称是否必须数据类型长度说明userCode是String15用户编号ID是String64唯一标示地址 IDdeleteFlag是String1删除标示 1 删除 0正常defaultFlag是String1设置默认标示 1：默

32、认地址 2: 非默认地址2.1.20.个人中心-地址修改-INPUT接口详细说明：登录请求说明:App，进入个人中心，地址修改。http 请求方式:POST参数：请求示例：“id “：“121212“，.返回说明：正确的 Json 返回结果:Json 返回示例:"code":00000,"msg":"成功！"名称数据类型长度说明codeString500000 成功00001 失败msgString100名称是否必须数据类型长度说明ID是String64唯一标示地址 IDuserCode是String20用户编号name是String

33、15phone是String11area是String6所在地区编号addressDetail是String100详细地址phoneDate是String前台信息提交时间yyyy-mm-dd hh:mm:ss2.1.21.快递员信息-OUTPUT接口详细说明：查看快递员信息。请求说明:http 请求方式: POST请求参数：请求示例：“expressNO “：“232323“，.返回说明：正确的 Json 返回结果:Json 返回示例:"code":00000,"msg":"成功！"名称数据类型长度说明codeString500000

34、 成功00001 失败msgString100expressNameString100快递公司名称courierNameString50快递员workNOString30工号phoneString11号码serviceString1服务指数 1:一颗星 2： 两颗星 。civilizationString1文明指数 1:一颗星 2： 两颗星 。vitalityString1活力指数 1:一颗星 2： 两颗星 。名称是否必须数据类型长度说明expressNO是String15快递单号userCode是String30用户号2.1.22.-INPUT接口详细说明：用户请求说明:http 请求方式:

35、 POST时候，向用户。请求参数：请求示例：“phoneNO “：“232323“，.返回说明：正确的 Json 返回结果:Json 返回示例:"code":00000,"msg":"成功！"2.1.23.消息-获取快递消息-OUTPUT接口详细说明：用户点击消息的时候，获取快递消息。请求说明:http 请求方式: POST请求参数：名称是否必须数据类型长度说明userCode是String20用户编号名称数据类型长度说明codeString500000 成功00001 失败msgString100名称是否必须数据类型长度说明phon

36、eNO是String11号请求示例：“userCode “：“232323“，.返回说明：正确的 Json 返回结果:Json 返回示例:"code":00000,"msg":"成功！"2.1.24.消息-获取聚盒消息-OUTPUT接口详细说明：用户点击消息的时候，获取聚盒消息。请求说明:http 请求方式: POST请求参数：名称是否必须数据类型长度说明userCode是String20用户编号名称数据类型长度说明codeString500000 成功00001 失败msgString100msgListid:message:消息描

37、述msgDate:消息时间expressNO：但是快递消息的时候，有快递单号panyCode:快递公司编号panyName:快递公司名称status:1：未读 2：已读请求示例：“userCode “：“232323“，.返回说明：正确的 Json 返回结果:Json 返回示例:"code":00000,"msg":"成功！"2.1.25.消息-状态修改-INPUT接口详细说明：用户点击消息的时候，获取快递消息或麦宝消息，查看后消息改为已查看状态。请求说明:http 请求方式: POST请求参数：名称是否必须数据类型长度说明id是St

38、ring64消息 idstatus是String1修改成 2userCode是String30用户号名称数据类型长度说明codeString500000 成功00001 失败msgString100msgListid:message:消息描述msgDate: 消息时间status:1：未读 2：已读请求示例：“id “：“232323“，.返回说明：正确的 Json 返回结果:Json 返回示例:"code":00000,"msg":"成功！"2.1.26.消息-删除-INPUT接口详细说明：用户点击消息的时候，获取快递消息或麦宝消息

39、，删除消息。请求说明:http 请求方式: POST请求参数：请求示例：“id “：“232323“，.返回说明：名称是否必须数据类型长度说明id是String64消息 iduserCode是String30用户号名称数据类型长度说明codeString500000 成功00001 失败msgString100正确的 Json 返回结果:Json 返回示例:"code":00000,"msg":"成功！"2.1.27.消息-获取消息个数-OUTPUT接口详细说明：用户点击消息的时候，获取消息个数。请求说明:http 请求方式: POS

40、T请求参数：请求示例：“userCode “：“232323“，.返回说明：正确的 Json 返回结果:Json 返回示例:"code":00000,"msg":"成功！"名称数据类型长度说明codeString500000 成功00001 失败msgString100countString20未读消息个数，包括物流和聚盒名称是否必须数据类型长度说明userCode是String20用户编号名称数据类型长度说明codeString500000 成功00001 失败msgString1002.1.28.个人中心-关于我们-意见反馈-IN

41、PUT接口详细说明：登录App，进入个人中心，关于我们，意见反馈。请求说明:http 请求方式: POST参数：请求示例：“userCode “：“appuser“，返回说明：正确的 Json 返回结果:Json 返回示例:"code":00000,"msg":"成功！"2.1.29.个人中心-关于我们-（-OUTPUT、系统通知、用户帮助）接口详细说明：登录App，进入个人中心，关于我们(请求说明:http 请求方式: POST、系统通知、用户帮助)。参数：名称是否必须数据类型长度说明infoType是String1信息类型（系统通

42、知：名称数据类型长度说明codeString500000 成功00001 失败msgString100名称是否必须数据类型长度说明userCode是String20用户编号content是String500反馈意见信息请求示例：“id “：“121212“，.返回说明：正确的 Json 返回结果:Json 返回示例:"code":00000,"msg":"成功！"2.1.30.个人中心-管理-获取登陆码-OUTPUT接口详细说明：登录App，进入个人中心，进入请求说明:http 请求方式: POST管理。参数：请求示例：“id “：“

43、121212“，名称是否必须数据类型长度说明userCode是String30用户编号名称数据类型长度说明codeString500000 成功00001 失败msgString100InfoListListtitleContent:标题内容;detailContent:明细内容1：用户帮助；2：版权；3：系统通知）userCode是String20用户编号.返回说明：正确的 Json 返回结果:Json 返回示例:"code":00000,"msg":"成功！"2.1.31.个人中心-管理-OUTPUT接口详细说明：登录请求说明:A

44、pp，进入个人中心，进入管理，。http 请求方式:POST参数：请求示例：“id “：“121212“，.返回说明：正确的 Json 返回结果:名称数据类型长度说明名称是否必须数据类型长度说明userCode是String30用户编号名称数据类型长度说明codeString500000 成功00001 失败msgString100loginCodeString10登陆码Json 返回示例:"code":00000,"msg":"成功！"2.1.32.个人中心-管理-删除-OUTPUT接口详细说明：登录请求说明:App，进入个人中心，进入管理，删除。http 请求方式:POST参数：请求示例：“id “：“121212“，.返回说明：正确的 Json 返回结果:名称是否必须数据类型长度说明userCode是Strin