通用App接口定义文档规范

1阅读之前（必读*）：1.所有接口返回数据格式为{code:’0000’,msg:’’,data:{}}的形式其中code是响应码msg是响应消息默认正确响应无msg消息只有错误才有错误消息data为数据段.Java段对应返回数据bean为如下形式。2.响应码表对应codeStringSUCCESS=0000;StringSUCCESS_MSG=成功;StringERROR=0001;StringERROR_MSG=失败;StringPARAM_ERROR=0002;StringPARAM_ERROR_MSG=参数错误或者参数不完整;StringNO_PERMISSION=UP01;StringNO_PERMISSION_MSG=无接口访问权限;StringUE01=UE01;StringUE01_MSG=未知接口异常;测试服务器调试路径登录逻辑附件如下：2app登录流程.txt1.接口服务器验证接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/loginvalidate输入字段定义序号字段名称字段定义数据类型备注1手机号phoneNumber字符串2tokentoken字符串需要返回的数据{msg:“成功”,code:“0000”data:{token:’’role:’1’;//1superadmin2亲情号phoneNumber:’139080090’name:’王小二’sex:’’,//1男2女className:’’,birthday:’’,otherCards:[{imei:2313123name:小明}]}}1.1注销接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/logout输入字段定义序号字段名称字段定义数据类型备注31tokentoken字符串登录得到的token字符串1.2修改密码接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/setNewPassword输入字段定义序号字段名称字段定义数据类型备注1phoneNumber手机号字符串2老密码oldPassword字符串3新密码newPassword字符串4tokentoken字符串需要返回的数据{msg:“成功”,code:“0000”}2.宝贝信息设置接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/setStudentInfo输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串3学生姓名name字符串4性别sex字符串5班级名称className字符串6生日birthday字符串需要返回的数据{msg:“成功”,code:“0000”}43.学生卡主动定位接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/card/getCardLocation输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串需要返回的数据:{batteryValue:100,//电量data:{locationType:1,//定位类型GPS0,北斗1,基站2.coord:{latitude:22.566235,longitude:113.90045}},updateTime:15452154,//更新时间msg:“成功”,code:“0000”}4.围栏列表查询接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/card/getWeiLan输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串需要返回的数据:{count:3,data:[{“meter”:123123“name”:’学校’//围栏名称“gpsPointWeidu”:23.123123//中心纬度5“gpsPointJingdu”:132.23213123//中心经度}],code:0000“msg”:”成功”}5.设置围栏接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/card/setSafeCircles输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串2safeCircles围栏列表字符串围栏列表ListSafeCircleJSON字符串SafeCircle{meter//半径name//围栏名称gpsPointWeidu//中心纬度gpsPointJingdu//中心经度}输出数据格式{msg:“成功”,code:“0000”}6.历史轨迹查询接口6数据接口定义备注1、调用结果以json格式返回2、接口地址:/card/getHistoryLocation输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串2时间date字符串格式为2014-09-08需要返回的数据:{count:2,data:[{time:1419241868124,coord:{latitude:22.576584,longitude:113.87609},‘dingweiType’:1//0北斗1GPS2基站},{time:1419241914042,coord:{latitude:22.575483,longitude:113.873566}‘dingweiType’:1}//...等等等],updatetime:1419241920307,code:‘0000’‘msg’:’成功’}5．亲情号设置接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/card/setQinqinghao输入字段定义7序号字段名称字段定义数据类型备注1tokentoken字符串2亲情号码numbers字符串ListQH的Json字符串Qinqinghao{name:’妈妈’phoneNum:’138908872312’}需要返回的数据:{code:‘0000’‘msg’:’成功’}6.获取宝贝信息数据接口定义备注1、调用结果以json格式返回2、接口地址:/card/getStudentInfo输入字段定义序号字段名称字段定义数据类型备注1Imei号imeiLong需要返回的数据:{data:{childBirthday:123151351,childGrade:,childName:,childSex:1//1男2女}code:’0000’msg:’成功’}获取亲情号码数据接口定义备注1、调用结果以json格式返回82、接口地址:/card/getQinqinghao输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串需要返回的数据:{count:2data:[{name:妈妈phoneNum:1390943233},{name:爸爸phoneNum:1390943233}]code:’0000’msg:’成功’}7.获取上课隐身接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/card/getHide输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串需要返回的数据:{count:4,data:[{repeatCycleMode:012,timeEnd:19:00,timeStart:8:00,“openState”:0//表示是否启用字符串1表示启用，0表示不启用}//等等],code:‘0000’‘msg’:’成功’}9/**TimeEndStringTimeStartStringRepeatCycleModeStringRepeatCycleMode:如果是没有重复的话-1,周一0,周二1,周三2,周四3,周五4,周六5,周日6,例如:重复周期为星期三星期四的话就为23**/8.设置上课隐身接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/card/setHide输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串2上课隐身对象ListhideTimes字符串ListHideTimejson字符串HideTime{/***开始小时*/privateintstartHour;/***开始分钟*/privateintstartMinute;/***结束小时*/privateintendHour;/**10*结束分钟*/privateintendMinute;/***模式，参考本类静态变量*/privateintmode;privateStringenabled;表示是否启用字符串1表示启用，0表示不启用}9.获取闹钟接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/card/getClock输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串需要返回的数据:{count:2,data:[{alarmsName:起床,openState:true,repeatCycleMode:012,time:9:00},{alarmsName:午休,openState:false,repeatCycleMode:234,time:10:00}],code:200msg:成功}1110.设置闹钟接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/card/setClock输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串2闹钟身对象Listclocks字符串ListClockjson字符串Clock{alarmsName:起床,openState:true,repeatCycleMode:012,time:9:00}11.获取一键拨号接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/card/getOneKey输入字段定义序号字段名称字段定义数据类型备注1Imei号imeiLong需要返回的数据:{data:[‘13909123212’,’121212123232’,’’,’’]//一键拨号注意下标对应按键。code:‘0000’msg:成功}12.设置一键拨号接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/card/setOneKey12输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串2一键拨号onekeys字符串4位的电话号码数字没有的填0例如:0,18224096426,0,13909089789代笔#1为空#218224096426#3为空#41390908978913.设置休眠接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/card/setSleep输入字段定义序号字段名称字段定义数据类型备注1Imei号imeiLong2是否休眠isSleepBoolean是否休眠需要返回的数据:{code:‘0000’msg:成功}14.发起远程监听接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/card/getRemoteMonitoring输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串2类型typeString1代表录音2代表电话回拨3电话号码phoneNumberString回拨的电话号码需要返回的数据:{code:‘0000’msg:成功13}15.远程关机接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/card/remoteClose输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串2phoneNumber手机号字符串需要返回的数据:{code:‘0000’msg:成功}16.意见反馈接口数据接口定义备注1、调用结果以json格式返回2、接口地址:/suggest输入字段定义序号字段名称字段定义数据类型备注1tokentoken字符串可选2phoneNumber手机号字符串必填3content内容字符串长度大于10个字(必填)4imgFile图片二进制数据可选需要返回的数据:{code:‘0000’msg:成功}1417.学生卡解