内容发布更新时间 : 2024/11/8 14:11:17星期一 下面是文章的全部内容请认真阅读。

APP接口规范文档 v.1.0.0

{ 北京天晴APP接口规范文档 }

手机客户端接口文档

文件状态： [ ] 草稿 [√] 正式发布 [ ] 正在修改

文件标识： 当前版本： 作 者： 完成日期： 1.0 北京天晴

APP接口规范文档 v.1.0.0

版 本 历 史

版本/状态 V1.0/草稿 作者 韩磊 参与者 移动小组 起止日期 备注 APP接口规范文档 v.1.0.0

目录

一、概述........................................................................................................................................... 1

1.1 有关接口 ............................................................................................................................ 1

1.1.1接口是纯数据的交互 .............................................................................................. 1 1.2 接口的分类 ........................................................................................................................ 1

1.2.1查询类接口 .............................................................................................................. 1 1.2.2 操作类接口 ............................................................................................................. 1 1.2.3上传下载类接口 ...................................................................................................... 1 1.2.4推送类接口 .............................................................................................................. 1

二、查询类接口格式规范 ............................................................................................................... 1

2.1获取单条对象信息 ............................................................................................................. 1

2.1.1 请求格式 ................................................................................................................. 1 2.1.2参数说明 .................................................................................................................. 2 2.1.3正常返回结果 .......................................................................................................... 2 2.2获取列表对象信息 ............................................................................................................. 3

2.2.1 请求格式 ................................................................................................................. 3 2.2.2参数说明 .................................................................................................................. 3 2.2.3正常返回结果 .......................................................................................................... 3

三、操作类接口 ............................................................................................................................... 4

3.1 新增操作 ............................................................................................................................ 4

3.1.1接口说明 .................................................................................................................. 4 3.1.2参数说明 .................................................................................................................. 4 3.1.3正常返回结果 .......................................................................................................... 4 3.1.4错误返回列表 .......................................................................................................... 5 3.2 修改操作 ............................................................................................................................ 5

3.2.1接口说明 .................................................................................................................. 5 3.2.2参数说明 .................................................................................................................. 5 3.2.3正常返回结果 .......................................................................................................... 5 3.2.4错误返回列表 .......................................................................................................... 5 3.3 删除操作 ............................................................................................................................ 6

3.3.1接口说明 .................................................................................................................. 6 3.3.2参数说明 .................................................................................................................. 6 3.3.3正常返回结果 .......................................................................................................... 6 3.3.4错误返回列表 .......................................................................................................... 6

四、上传下载类 ............................................................................................................................... 7

4.1 上传文件 ............................................................................................................................ 7

4.1.1接口说明 .................................................................................................................. 7 4.1.2参数说明 .................................................................................................................. 7 4.1.3正常返回结果 .......................................................................................................... 7 4.1.4错误返回列表 .......................................................................................................... 7 4.2 下载文件 ............................................................................................................................ 7

4.2.1接口说明 .................................................................................................................. 7