API文档
对方答复
API接口说明
- 接口说明Example中的参数都以GET的方式举例，实际都使用POST的传参方式
传参方式
键值对参数使用JSON序列化传输，放在Data中使用HTTP POST传输
返回结果格式说明
详细参考WebApi.doc
| 字段 | 说明 |
|---|---|
| Code | 返回结果的状态码 |
| Message | 当前异常相关的描述信息,若无异常则为空 |
| Data | 业务数据 |
| ServerTime | 服务器时间 |
常见错误字段说明
| Code | 说明 |
|---|---|
| 1002 | 表示数据库操作异常 |
| 3005 | 参数值超出允许范围 |
| 3002 | 缺少参数 |
本API文档阅读说明
本API文档主要分为以下几个Section
- URL
- Parameter
- Return Code
- Return Data
- Example Request
- Example Return Data
- Maintainer
Sections
URL
调用该API的目标地址
Parameter
API接受的业务参数，包括参数名和参数说明
- 本API默认必须加上的参数列表：
| Parameter | 说明 |
|---|---|
| accessToken | 校验Token，用于标志用户的省份，通过OAuth获取 |
以上参数在每个API中不再重复说明
- 其他调试参考暂不支持
Return Code
该API会返回的业务状态以及说明
Return Data
返回数据参数名以及该参数的说明
Example Request
调用本API URL示例
Example Return Data
该API正确情况下返回数据示例
Maintainer
维护者
类型为空返回值
- list为空 返回 null
- string为空 返回 空字符串或null
- int为空 返回 0
- float为空 返回 0
null不加引号 eg: {"namelist":null}