个人编写的用于对接Java后台的部分功能的API文档。系Android端编写。
ChenH整理
序
- 此API文档主要为确定各个接口的JSON数据大间架结构
- 至于具体的JSON数据，可根据实际情况增删，增删后，互相拷贝JSON对应的JavaBean即可
- 新版APP的测试数据即是基于此接口模型编写
测试服务器
正式服务器
登录
-
接口地址
-
接口请求参数说明
参数 类型 说明 实例 备注 name String 账户名 李白 无 paw String 密码 123456 无 -
接口实例
http://URL:1041/URL?name=李白&Paw=123456
-
返回结果(JSON)
{ "resultCode": 1， "mMessage": "请求成功", "newTimestamp": 1514377402614, "dataSource":{ "UserID": 5, "UserName": "ChenH" } } -
返回结果说明
resultCode:请求状态:0:失败;1:成功; 2:服务器异常
mMessage:提示信息
newTimestamp:时间戳
dataSource:用户信息数据
userId:用户ID
userName:用户名
以上字段可根据具体需要增删
测试任务
根据用户ID拉取
-
接口地址
-
接口请求说明
参数 类型 说明 实例 备注 userId String 用户ID 12345 无 根据需要新增 根据需要新增 -
接口实例
http://URL:1041/URL?userId=李白&其余参数待补全
-
返回结果(JSON)
{ "mMessage": "请求成功", "newTimestamp": 1514377402614, "resultCode": 1, "dataSource": [ { "planId": 0, "testAddress": "XXX", "testDate": "2017-12-27 20:23:22", "testUser": "谵台浮萍" }, { "planId": 1, "testAddress": "XXX", "testDate": "2017-12-27 20:23:22", "testUser": "谵台浮萍" }, { "planId": 2, "testAddress": "XXX", "testDate": "2017-12-27 20:23:22", "testUser": "谵台浮萍" } ] } -
返回结果说明
resultCode:请求状态:0:失败;1:成功; 2:服务器异常
mMessage:提示信息
newTimestamp:时间戳
dataSource:测试任务数据，一个用户可以有多个测试任务
planId:测试任务ID
testAddress:测试地(每个基站都有地址，所以这个字段可以不要)
testDate:测试时间
testUser:测试人
以上字段可根据具体需要增删
获取基站
根据任务ID拉取
-
接口地址
-
接口参数说明
参数 类型 说明 实例 备注 planId String 测试任务ID 1001 无 根据需要新增 -
接口实例
http://URL/URL?planId=1001&其余参数待补全
-
返回结果(JSON)
{ "mMessage": "请求成功", "newTimestamp": 1514377609658, "resultCode": 1, "dataSource": [ { "mBaseStationAddress": "张爱玲故居", "mBaseStationDistance": "7.7km", "mBaseStationNumber": "777770", "mBaseStationType": "XXX", "mLatitude": "119.3232", "mLongitude": "78.4556", "mSector": "109", "mCommunityBeanList": [ { "mCommunityBeanName": "小区0", "mCommunityTestItemList": [ "RSRP", "SINR", "Ping" ], "mNodeBID": "61088", "mPci": "260", "mTac": "40960" }, { "mCommunityBeanName": "小区1", "mCommunityTestItemList": [ "RSRP", "SINR", "Ping", "接通时延", "PCI" ], "mNodeBID": "61088", "mPci": "261", "mTac": "40960" } ] }, { "mBaseStationAddress": "外滩十八号", "mBaseStationDistance": "7.7km", "mBaseStationNumber": "777770", "mBaseStationType": "XXX", "mLatitude": "119.3232", "mLongitude": "78.4556", "mSector": "109", "mCommunityBeanList": [ { "mCommunityBeanName": "小区0", "mCommunityTestItemList": [ "RSRP", "SINR", "Ping" ], "mNodeBID": "61088", "mPci": "260", "mTac": "40960" }, { "mCommunityBeanName": "小区1", "mCommunityTestItemList": [ "RSRP", "SINR", "Ping", "接通时延", "PCI" ], "mNodeBID": "61088", "mPci": "261", "mTac": "40960" } ] } ] } -
返回结果说明
resultCode:请求状态:0:失败;1:成功; 2:服务器异常
mMessage:提示信息
newTimestamp:时间戳
dataSource:测试基站数据，一个测试任务可以对应多个基站
mBaseStationAddress:基站地址
mBaseStationDistance:距离基站的距离
mLongitude:基站经度
mLatitude:基站纬度
mSector:扇区
mBaseStationType:基站类型
mBaseStationNumber:基站编号
mCommunityBeanList:每个基站对应的测试小区，一个基站可以对应多个测试小区
mCommunityBeanName:小区名或小区编号
mNodeBID:NodeBID
mPci:物理小区标识
mTac:跟踪区域码
mCommunityTestItemList:小区对应测试项，一个小区会有多个测试项
以上字段可根据具体需要增删
上传测试结果
上传测试好的结果值，是字符串
-
接口地址
-
接口参数说明
参数 类型 说明 实例 备注 userId String 用户ID 12345 无 planId String 测试任务ID 1001 无 up_RSRP String RSRP 90 无 up_SINR String SINR 8 无 up_PingDelay String ping时延 5000ms 无 up_PCI String PCI 261 无 up_RSSI String RSSI 56 无 up_CELLID String CELLID 2344 无 up_UplinkRate String XXX 13.5Kbps 无 up_DownstreamRate String XXX 9Kbps 无 具体上传字段根据每个小区的测试项来定，可增删 -
接口实例
-
返回结果(JSON)
{ "resultCode": 1， "mMessage": "上传成功", "newTimestamp": 1514377402614, "dataSource":null } -
返回结果说明
resultCode:请求状态:0:失败;1:成功; 2:服务器异常
mMessage:提示信息
newTimestamp:时间戳
dataSource:无
以上字段可根据具体需要增删
上传测试Log文件
此接口于主流程逻辑关联不大，可自行补充
- 接口地址
- 接口参数说明
- 接口实例
- 返回结果(JSON)
- 返回结果说明
跋
- 以上API仅提供JSON结构参考
- 只要JSON大结构不变，关于命名或字段的数目，可以自行修改
- 此API设计是针对新版APP的界面逻辑。如逻辑有纰漏，可一起商榷修正
- 具体需要展示的字段，根据用户需求做增删
- 包内提供JavaBean
由于对接工作紧迫，文档编写仓促，难免不足，共勉。
