收集客户端接口标准文档范例.doc

HAOXEE手机客户端APIHAOXEE客户端API第1章 接口地址接口地址:http:/服务器地址/haoqee/ServiceServlet服务器返回客户端报文约定http返回header信息code:信息码，0为成功message:信息http返回body信息data:结果集列表格式 records: id: 46, receivedTime: 2012-06-07 16:06:55, title: 今天是个好天气, sendUser: admin, isRead: 2 , id: 47, receivedTime: 2012-06-08 10:30:28, title: , sendUser: admin, isRead: 2 对象格式 userId: 1第2章 登陆包名: LoginAction方法名: login报文格式:json请求参数:属性类型说明party_idstring企业账号usernamestring登陆用户名passwordstring登陆密码imsistring手机sim卡号imeistring手机序列号mobiletypestring手机类型请求报文（参考） username : “admin”, password : 123,“party_id”:”saeat”,“imsi”:” 357947042763822”,“imei”:” 864931010328962”,“mobiletype”:” android”返回:属性类型说明userIdstring当前登陆者IDuserName当前登录者姓名locateStatusstring0 定位服务未开启1 定位服务开启authCode授权码serverVerson服务端版本号pushServerAddressstring推送服务器地址companyIdstring企业IDonWorkTimestring上班时间offWorkTimestring下班时间onWorkTimeQuantumstring签到时间段offWorkTimeQuantumstring签退时间段repeatsstring重复周期(Mon:星期一；Tue:星期二；Web:星期三；Thu:星期四；Fri:星期五；Sat:星期六；Sun:星期日)delaystring延迟时间 （分钟）codestring0 为成功，1为失败(请求头) 返回报文体(参考)userId: 1,“userName”:”chenbo”,“locateStatus”:”0”,“authCode”:” f8940619e570a58b5a07b9b0c02d47bc”,“serverVerson”:”1.4”,“companyId”:” 402882123875625d0138756482c70003”,“pushServerAddress”: “4”,“onWorkTime”:”09:00:00”,“offWorkTime”:”18:00:00”,“onWorkTimeQuantum”:”8:55-9:05”,“offWorkTimeQuantum”:”17:55-18:05”,“repeats”:”Mon,Tue”,“delay”:”5”,“code”:”0”第3章 注销包名: LoginAction方法名: loginOut报文格式:json请求参数:返回:属性类型说明codestring0 为成功，1为失败(请求头)第4章 内部消息收件箱包名: com.xguanjia.haoxee.client.action.InnerMsgAction方法名: getReceivedMsg报文格式:json请求参数:属性类型说明userIdstring当前登陆系统用户IDlastReceivedTimestring客户端最后收件时间格式(yyyy-MM-dd HH:mm:ss)请求报文（参考）userId: “1”,lastReceivedTime: 2012-06-02 18:16:47返回:属性类型说明idstringId为收件人的IDsendUserstring发送人titlestring消息标题receivedTime string收到时间hasAttachmentstring是否有附件 0:没有,1:有isReadstring阅读状态 2已读 3未读 返回报文(参考) records: id: 46, receivedTime: 2012-06-07 16:06:55, title: 今天是个好天气, sendUser: admin, isRead: 2 , id: 2, receivedTime: 2012-07-11 17:03:34, title: 测试内部消息保存, sendUser: 陈健, isRead: 2 详细信息包名: com.xguanjia.haoxee.client.action.InnerMsgAction方法名:getMsgContent报文格式:json请求参数:属性类型说明isReadIdstring之前收件箱给的ID请求报文（参考）isReadId: “2” 返回:属性类型说明groupNamestring部门userNamestring发送人titlestring消息标题receivedTimestring收到时间attachmentstring附件contentstring信息内容attachmentsarrayfileName:文件名称fileExt：文件类型fileUrl：文件相对路径,fileId:文件id 返回报文(参考) records: groupName : 46, userName : 2012-06-07 16:06:55, title: 今天是个好天气, sendTime : admin, content : 2 , id: 2, receivedTime: 2012-06-08 10:30:28, title: , sendUser: admin, isRead: 2,attachments: fileName: 16进制颜色代码对照(1).doc, fileExt: .doc, fileUrl: /uploadFiles/file/20120717/2012071714593341329.doc , fileName: PC端功能缺陷报表.xlsx, fileExt: .xlsx, fileUrl: /uploadFiles/file/20120717/2012071715000087459.xlsx , fileName: 16进制颜色代码对照(2).doc, fileExt: .doc, fileUrl: /uploadFiles/file/20120717/2012071715040986164.doc , , 发送包名: com.xguanjia.haoxee.client.action.InnerMsgAction方法名: sendMsg报文格式:json请求参数:属性类型说明titlestring信息标题contentstring内容userIdsString接收人(多个以,隔开)attachmentUrlString附件地址多个以”,”隔开orignalNameString附件名称多个以”,”隔开userIdString发送人(当前登录人)groupIdsString接收组多个以,隔开)forwardingIdString转发时上送的原信息IDexcludeAttachmentUrlstring转发时从原信息中需要去掉的附件地址，多个以”,”隔开请求报文（参考） content: 今天6:30去吃饭., title: 李小鹏test, userId: 2,userIds: 2，“groupIds”:”2,3”,“attachmentUrl”:”F: uploadFilesgps201211291106232343.png, D:uploadFilesgps201211291106232343.png”,“orignalName”:”aa.jpg,bb.png”,“forwardingId”:”2”,“excludeAttachmentUrl”:” uploadFilesgps201211291106232343.png”返回:属性类型说明codestring返回参数(0,成功1失败) 返回报文(参考) “code”:”1” 回复转发 接口和发送一样总经理信箱包名: com.xguanjia.haoxee.client.action.InnerMsgAction方法名: sendGeneralManagerMsg报文格式:json请求参数:无属性类型说明userIdstring当前登陆系统用户IDtitleString标题contentString内容sendTimeString创建时间返回属性类型说明codestring返回参数(0,成功1失败)第5章 公告通知公告列表包名: com.xguanjia.haoxee.client.action.AnnounceAction方法名: getAnnounceList报文格式:json请求参数:属性类型说明lastAnnounceTimeString客户端上传最新时间请求报文（参考）(如果是第一次请求,则给空) lastAnnounceTime: 2012-06-11 11:13:40返回:属性类型说明idString公告通知idtopStringtrue表示置顶topDateString置顶时间startTimeString开始时间releaseNameString发布人姓名titleString公告标题briefIntroductionString简介返回值参考: records: id: 21, startTime: 2012-06-11 11:13:49, releaseName: admin, title: 0 , id: 22, startTime: 2012-06-14 09:51:15, releaseName: admin, title: test1 公告详细包名: com.xguanjia.haoxee.client.action.AnnounceAction方法名: getAnnounceContent报文格式:json请求参数:属性类型说明announceIdString公告iduserIdString用户的userId请求报文（参考）(如果是第一次请求,则给空)返回:属性类型说明titleString新闻idreleaseNameString发布人startDateString生效日期briefIntroductionString简介detailsstring详细attachmentsarrayfileName:文件名称fileExt：文件类型fileUrl：文件相对路径，fileId：文件id返回值参考: data: startTime: 2012-08-29 20:21:49, title: 公告附件测试, details: 测试 , releaseName: 系统管理员, attachments: fileId: 115, fileName: jQuery_EasyUI教程.doc, fileExt: .doc, fileUrl: /uploadFiles/file/20120829/2012082920214484120.doc , fileId: 1, fileName: Chrysanthemum.jpg, fileExt: .jpg, fileUrl: /uploadFiles/file/20120702/2012070216415485015.jpg 第6章 消息盒子包名: com.xguanjia.client.action.MessageBoxAction方法名: getLastMessageBox报文格式:json请求参数:属性类型说明userIdstring当前登陆系统用户IDtimestring客户端最后收件时间格式(yyyy-MM-dd HH:mm:ss)请求报文（参考）userId: “1”,time: 2012-06-02 18:16:47返回:属性类型说明messageIdstring消息盒子的IDmessageAppTypestring应用类型messageObjstring消息对象messageCreateTime string创建时间messageReceiverstring接收者messageObjNamestring消息对象名称 返回报文(参考) records: id: 46, messageAppType: type, messageObj: messageobj, messageCreateTime: 2012-07-11 17:03:34, imessageReceiver: chenbo, “messageObjName”:”messageObjName” , id: 4, messageAppType: type, messageObj: messageobj, messageCreateTime: 2012-07-11 17:03:34, imessageReceiver: chenbo,“messageObjName”:”messageObjName” 第7章 意见反馈访问地址: 41/mobile!problemBack.action包名: MobileAction方法名: problemBack报文格式:json请求参数:属性类型说明titleString问题反馈标题contentString问题反馈内容companyIdString企业的idmobileTypeString手机型号systemTypeString手机系统版本clientVersionString客户端版本emailString邮箱mobileString电话productIdString产品编号请求报文（参考）返回:属性类型说明codeString成功标记0:成功/其他失败messageString返回信息 返回报文(参考) 第8章 手机考勤8.1 签到/签退包名: com.xguanjia.client.action. LbsAction方法名: getClientAddress报文格式:json请求参数:属性类型说明longitudestring经度latitudeString纬度userIdstring用户IDflagstring1:签到,2:签退actionNamestringcom.xguanjia.client.action.LbsAction$getClientAddress请求报文（参考） “longitude”:”2012-12-12 20:20:20”, latitude : 0,“flag”: “1”,“actionName”: “com.xguanjia.client.action.LbsAction$getClientAddress”返回报文（参考）：第9章 文件柜9.1 文件夹包名: com.xguanjia.client.action.FileCabinetAction方法名: getFolder报文格式:json请求参数:属性类型说明lastFolderTimestring根目录文件夹时间 (格式(yyyy-MM-dd HH:mm:ss )isPublicString公共或者个人的标识符(1 为公共 0 为个人)userIdstring需要请求个人的，则要提交当前登录人员id请求报文（参考） “lastFolderTime”:”2012-12-12 20:20:20”,isPublic: 0,“userId”: “1”属性类型说明idstring文件夹idNameString文件夹名称defstring是否缺省 0 否 1 是parentIdString父级iduserIdString请求个人，父级节点，有此值createDateString父级节点，有此值files数组fileName 文件名称fileId 文件idfileSize 文件大小fileUrl 文件相对路径releaseDate 文件创建时间返回报文（参考）： records: id: 8, files: fileSize: 1088, fileId: 44, releaseDate: 2012-07-17 16:18:11, fileName: 25会议记录25会议记录(1).txt, fileUrl: /uploadFiles/file/20120717/2012071716181178992.txt , parentId: 7, name: bbbbbb, “def”:”1” , id: 9, files: fileSize: 2407, fileId: 46, releaseDate: 2012-07-17 17:41:52, fileName: html1.htm, fileUrl: /uploadFiles/file/20120717/2012071717415272870.htm , fileSize: 1208, fileId: 47, releaseDate: 2012-07-17 17:42:10, fileName: common_field.js, fileUrl: /uploadFiles/file/20120717/2012071717421087590.js , fileSize: 708, fileId: 48, releaseDate: 2012-07-17 17:42:11, fileName: login.js, fileUrl: /uploadFiles/file/20120717/2012071717421184119.js , fileSize: 2407, fileId: 46, releaseDate: 2012-07-17 17:41:52, fileName: html1.htm, fileUrl: /uploadFiles/file/20120717/2012071717415272870.htm , fileSize: 1208, fileId: 47, releaseDate: 2012-07-17 17:42:10, fileName: common_field.js, fileUrl: /uploadFiles/file/20120717/2012071717421087590.js , fileSize: 708, fileId: 48, releaseDate: 2012-07-17 17:42:11, fileName: login.js, fileUrl: /uploadFiles/file/20120717/2012071717421184119.js , parentId: 7, name: cccccc, “def”:”1” , id: 10, parentId: 8, name: 第三级, “def”:”1” , id: 7, parentId: , name: 公共文件夹, createDate: 2012-07-24 17:48:38, “def”:”0” 9.2 文件详细（暂没用）包名: com.xguanjia.client.action.FileCabinetAction方法名: getFileContent报文格式:json请求参数:属性类型说明fileIdstring文件ID请求报文（参考） fileId: 42返回:属性类型说明 idstring文件idfileNamestring文件名称releaseDatestring文件创建时间fileContentstring文件内容attachmentExplainstring文件说明attachmentstring文件附件 返回报文(参考) records: fileContent: 多对多, attachment: , attachmentExplain: 多对多, releaseDate: 2012-06-06 16:58:41, fileName: 公共1, id: 42 9.3 新增文件夹包名: com.xguanjia.client.action.FileCabinetAction方法名: newFolder报文格式:json请求参数:属性类型说明namestring文件夹名称(必填)parentIdstring要在文件夹下建立文件的id(必填)userIdstring用户id请求报文（参考） parentId: 26,name: client“userId”:”11” 返回报文(参考)(0成功,-2 失败，-1 为名称重复)返回为0，folderId:25 folderId 为 新增文件夹的id9.4 删除文件夹和文件包名: com.xguanjia.client.action.FileCabinetAction方法名: deleteFolderAndFile报文格式:json请求参数:属性类型说明folderIdstring文件夹id，多个以”,”号隔开userIdstring用户idfileIdstring文件id，多个以”,”号隔开parentIdstring文件夹的父id请求报文（参考） folderId : 25,12, “userId”:”2”, “fileId”:”1,2”, “parentId”:”4”返回报文(参考)(0成功,1 失败，2 为参数错误)9.5 新增文件包名: com.xguanjia.client.action.FileCabinetAction方法名: newFile报文格式:json请求参数:属性类型说明parentIdstring要在文件夹下建立文件的id(必填)attachmentUrlString文件地址多个以”,”隔开orignalNameString文件名称多个以”,”隔开userIdstring用户id请求报文（参考） “parented”:”2”,“attachmentUrl”:”F: uploadFilesgps201211291106232343.png, D:uploadFilesgps201211291106232343.png”,“orignalName”:”aa.jpg,bb.png”,“userId”:”3”返回:属性类型说明codestring返回参数(0成功1失败2 分配的磁盘空间不足)idsstring附件id多个以”,”隔开urlsstring附件地址多个以”,”隔开fileNamesstring附件名称多个以”,”隔开createTimesstring生成时间多个以”,”隔开sizesstring附件大小多个以”,”隔开 返回报文(参考) “code”:”1”, “ids”:”1,3”, “urls”:” /uploadFiles/gps/201211291106232343.png, /uploadFiles/gps/201211291106232343.png”, “fileNames”:” 20121129_110623.png, 20121129_110623.jpg”, “createTimes”:” 2012-12-22 11:05:00, 2012-12-22 11:05:00”, “sizes”:”1234,2345” 9.6 分享文件包名: com.xguanjia.client.action.FileCabinetAction方法名: shareFile报文格式:json请求参数:属性类型说明fileIdstring分享文件的IDuserIdstring登陆者的IDshareUserIdsstring被分享的用户ID请求报文（参考）返回:报文(0,分享成功)9.7 同步分享文件包名: com.xguanjia.client.action.FileCabinetAction方法名: synchronousShareFile报文格式:json请求参数:属性类型说明userIdstring登陆者ID请求报文（参考）返回:属性类型说明idstring共享文件编号filemapfileId:文件编号filename:文件名称releaseDate:创建时间fileUrl:文件地址fileSize:文件尺寸shareTimeString分享时间shareUserNameString分享者姓名9.8 撤销分享文件包名: com.xguanjia.client.action.FileCabinetAction方法名: undoShareFile报文格式:json请求参数:属性类型说明fileIdstring分享文件的ID请求报文（参考）返回:报文(0,撤销分享成功)第10章 数据上报10.1 获得位置包名: com.xguanjia.client.action.DataReportAction方法名: getAddress报文格式:json请求参数:属性类型说明latitudestring纬度longitudestring经度请求报文（参考）latitude: 42,“longitude”:”123”返回:属性类型说明addressstring位置 返回报文(参考) records: address: “常州科技城”, , 10.2 上传数据上报包名: com.xguanjia.client.action.DataReportAction方法名: uploadDataReport报文格式:json请求参数:属性类型说明titleString数据上报名称attachmentUrlstring附件的urlcontentString上报内容userIdString用户IdaddressString位置请求报文（参考）title: 标题,“attachmentUrl”:” F: uploadFilesdatareport201211291106232343.png”,“content”:”内容”,“address”:”常州科技城”,“userId”:”2”返回:属性类型说明codestring返回参数(0,成功1失败) 返回报文(参考) “code”:”1” 10.3 获得列表（暂时不用）包名: com.xguanjia.client.action.DataReportAction方法名: getDataReportList报文格式:json请求参数:属性类型说明timeStampstring最近时间 (格式(yyyy-MM-dd HH:mm:ss )userIdstring当前登录人员id请求报文（参考） “timestamp”:”2012-12-12 20:20:20”, “userId”: “1”返回属性类型说明idstring数据上报idtitleString数据上报名称xystring上报坐标contentString上报内容uploadTimeString上报时间attachmentIdString附件id返回报文（参考）： records: id: 8, title: aaaa, xy: 127, content: bbbbbb, “uploadTime”:” 2012-07-17 17:41:52”, attachmentId: 2 , id: 9, title: aaaa, xy: 127, content: bbbbbb, “uploadTime”:” 2012-07-17 17:41:52”, attachmentId: 2 , id: 6, title: aaaa, xy: 127, content: bbbbbb, “uploadTime”:” 2012-07-17 17:41:52”, attachmentId: 2 , 10.4 详细（暂时不用）包名: com.xguanjia.client.action.DataReportAction方法名: getDa