《云上城手机客户端接口规范v》精要.doc

文件编号：JHDZ/SJ密 级： 接口规范 （第一期） 项目名称：项目代号：版 本：V1.编制单位： 编制日期：20-08-06 编制 审核 批准 生效日期 版 本 变 更 记 录 版本/状态 作者 参与者 完成时间 变更内容 1.0/草稿 袁少 2014-08-06  目 录 1 文档概述 1 1.1 编写目的 1 1.2 术语定义 1 1.3 参考资料 1 1.4 使用对象 1 2 接口定义 1 2.1 通讯方式 1 2.2 协议说明 2 2.2.1 回应报文必填JSON属性项 2 2.2.2 result结果返回值定义 2 2.2.3 部分属性规格 2 2.2.4 JSON内容说明 3 2.2.5 接口添加与更改约定 3 2.3 通用接口定义 3 2.3.1 列表信息通用属性定义 3 2.4 首页 4 2.4.1 顶部Flash图片 4 2.4.2 中间服务列表 5 2.4.3 滚动分享信息 6 2.4.4 最新通知 7 2.4.5 推送服务信息列表 8 2.5 Flash详情 10 2.6 最新通知 10 2.6.1 列表 10 2.6.2 详情 11 2.7 快送服务 13 2.7.1 列表 13 2.7.2 详情 14 2.7.3 预约 15 2.8 服务预约 17 2.8.1 列表 17 2.8.2 详情 18 2.8.3 预约 19 2.9 维修服务 21 2.10 投诉建议 22 2.11 物业账单 23 2.11.1 列表 23 2.11.2 详情列表 25 2.12 房屋出租 26 2.12.1 小区列表 26 2.12.2 出租列表 27 2.12.3 详情 29 2.12.4 发布 31 2.13 甜甜圈 32 2.13.1 最新帖子 32 2.13.2 帖子详情 34 2.13.3 帖子评论 36 2.13.4 发表帖子 37 类别列表 37 发表帖子 38 2.13.5 所有评论 39 2.13.6 评论详情 41 2.13.7 评论 41 2.13.8 我的帖子 41 2.14 登录注册 41 2.14.1 小区列表信息 41 2.14.2 获取短信验证码 41 2.14.3 注册登录 41 2.15 个人中心 41 2.15.1 修改基本资料 41 文档概述 编写目的 本规范定义了手机客户端Android与IOS和服务器端之间的通讯的接口规范，明确协议参数及典型业务和数据流程。 术语定义 英文缩写 英文全称 中文翻译 参考资料 序号 参 考 文 献 来源 发行日期 使用对象 Android工程师、IOS工程师、JAVA工程师。 接口定义 通讯方式 采用HTTP/TCP方式通信，JSON承载数据。 协议说明 回应报文必填JSON属性项 属性名 类型 属性说明 备注 result int 结果返回值0：成功，其他失败 message String 结果描述 不成功时，此信息可能会直接提示给用户，因此必须友好、清晰、明了。 result结果返回值定义 错误码 描述 备注 0 成功 1 参数不对 包括类型不对，格式不对，参数不全 9 服务器异常 部分属性规格 接口属性命名遵守类属性命名规则，请看《平台运营部Java编码规范.doc》。 属性 规格 描述 时间 YYYY-MM-dd HH:mm:ss 默认时间格式 金额 单位：元 JSON内容说明 JSON数据，不能通过手工拼接，必须用JSON工具类生成，避免不必要的错误。 JSON内容，前后避免有空格出现。 JSON特殊字符需要转义。 接口添加与更改约定 接口添加，接口属性添加，接口的更改，接口属性的更改都必须先更新此文档，由相关负责人审核通过后，再通知相关人员实施。保证接口与代码一致性。 通用接口定义 列表信息通用属性定义 属性名 类型 属性说明 备注 titlePicPath String 标题图片路径 title String 标题 link String 详情链接 summary String 概要描述 实现建议：为减少代码量，相同属性抽取出来封装作为基类，其他类继承基类拓展个性属性。 首页 顶部Flash图片 接口说明 展示顶部flash 接口方向 手机客户端 - 服务器系统 接口地址 待定 接口参数 参数名 类型 参数说明 请求内容JSON格式 返回结果 JSON格式 {result:0, message:成功,list:[