数据返回结构.doc

数据返回结构目的： 此文档用于前台手机端与后台系统的数据交互接口的规范。开发人员应严格遵守接口标准。文档对象： 前台开发人员、后台开发人员返回对象结构ReturnResult对象，其结构包括三个属性：“success”、“message”、“object”。“success”：本次操作是否成功，成功为true、失败为false。“message”：本次操作返回结果提示信息，现在内容是中文提示，以后会是返回结果代码。“object”：本次操作返回的结果集。如查询的结果列表、新建信息的id等。以上三个属性会转换成json串的形式。以用户注册为例，返回结果:message:注册新用户成功,object:_id:4dc74b78752d540fd0f2ee3b,success:truemessage:：注册新用户成功本次操作返回结果提示信息，以后可能是结果代码，如：CZCU001success：true本次操作是否成功，成功为true，不成功为falseXXXX对象的json形式：是指这个对象的属性及其值以json的key:value形式给出。如：属性1:值1, 属性2:值2，属性3:值3。value可以是一个对象，则json就是嵌套结构。如果某个属性是boolean类型，名称是isXXXXX，则它的json的为XXXX（去掉前面的is）。参数格式约定1、 时间格式使用字符串形式传输，采用GTD+8（北京时间）计时。 格式：“2011-05-09 12:12:12”。2、 每次请求都要加上当前登录用户的sessionId（除登录后注册之外）。&user.sessionId=xxxxxxx。下面这两个不一定会列出来，但是都包含这个请求参数的。接口方法用户部分1、用户登录 xxxx.user.login输入1：=xxxx.user.login&user.loginName=xxxx&user.password=xxxxx输入2：=xxxx.user.login&user.email=xxxx&user.password=xxxxx输出：返回对象结构，其中object:“sessionId”:”xxxxxx”,”userId”:”xxxxxxx”例如：message:登录成功, object:sessionId:-86998193500343087504e015fb2a01a05de69e182c7, userId:4ddb7d7811afb3e7bfc1a69a,success:true或message:用户名或密码不正确,object:null,success:false2、用户注册xxxx.user. enroll输入：=xxxx.user.enroll&user.loginName=xxxx&user.password=xxxx&user.email= xxxxx&insert.用户表字段.=xxxxx输出：message:注册新用户成功,object:_id:4dc74b78752d540fd0f2ee3b,success:true3、重置密码xxxx.user.resetPassword输入：=xxxx.user.resetPassword&user.loginName=xxxx&user.password=xxxx输出：message:修改密码成功,object:null,success:true4、登录名是否被使用xxxx.user.checkLoginName输入：=xxxx.user. checkLoginName&user.loginName=xxxx输出：message:此登录名没有被使用,object:null,success:true5、查询用户信息xxxx.user.queryUserInfo输入：=xxxx.user. queryUserInfo &query.用户表字段.=xxxx输出：返回对象结构，其中object:用户表的json字串6、修改用户基本信息xxxx.user.modifyUser输入：=xxxx.user.modifyUser&update.用户表字段.=xxxx输出：返回对象结构，其中object：”user”: User的json7、查询用户所在的所有团队xxxx.user.collectionByUser输入：=xxxx.user. collectionByUser输出：返回对象结构，其中object：”userCollection”: UserCollection列表json8、查看用户下所有的业务xxxx.user.taskByUser查看当前登录用户下的所有业务：输入：=xxxx.user. taskByUser输出：返回对象结构，其中object:“task”:task列表json形式查看指定用户下的所有业务：输入：=xxxx.user. taskByUser&query._id=指定用户id输出：返回对象结构，其中object:“task”:task列表json形式9、人员关注未看信息数xxxx.user.followNumByUser输入：=xxxx.user. followNumByUser&query.author=xxx&query.lastTime=2011-05-18 19:43:00输出：返回对象结构，其中object:数10、获得指定数目的注册用户xxxx.user.queryEnrollUserInfo输入：=xxxx.user.queryEnrollUserInfo&query. excludeUserCollectionId =所要排除的团队Id &query.count=所要查找的注册用户数目说明：参数query. excludeUserCollectionId为可选项，如果传值，代表获得指定团队以外指定数目的注册用户，未传则认为无指定用户排除参数query.count为可选项，如果传值代表获取用户的指定数目，未传后台会默认把此值设定为100输出：返回对象结构，其中object: “userList”:user列表json形式11、邮箱是否被使用xxxx.user. checkEmail输入：=xxxx.user. checkEmail &user. email =xxxx输出：message:已经有用户使用此邮箱,object:null,success:false团队部分1、团队查看列表xxxx.collection.queryCollection输入：=xxxx.collection.queryCollection&query.member=xxxx输出：返回对象结构，其中object: userCollection, 团队列表的json形式2、增加团队xxxx.collection.addCollection输入：=xxxx.collection.addCollection&insert.parentUserCollection=父团队Id&insert.manager=团队管理者Id&insert.member=团队成员Id &insert.task=所要加入的业务Id&insert.团队表其他字段=xxx说明：当前要传insert.parentUserCollection，此值为标注当前用户在哪个父团队下发起的增加操作，如不传insert .parentUserCollection视为新增的团队独立存在。insert.parentUserCollection, insert.manager, insert.member, insert.task都是可选的，不传也可以输出：返回对象结构，其中object: 团队的json形式3、修改团队xxxx.collection.modifyCollection输入：=xxxx.collection.modifyCollection&update.团队表字段=xx输出：返回对象结构，其中object:团队的json形式4、删除团队xxxx.collection.deleteCollection输入：=xxxx.collection. deleteCollection&update._id=团队id输出：返回对象结构，其中object:“task”:业务列表json形式5、通过团队查业务xxxx.collection.queryTaskByCollection输入：=xxxx.collection.queryTaskByCollection&query.userCollectionId=团队id输出：返回对象结构，其中object:“task”:业务列表json形式6、团队下人员xxxx.collection.queryUserByCollection输入：=xxxx.collection.queryUserByCollection&query.userCollection=团队id& user.userId=xxx输出：返回对象结构，其中object: “member”:User列表json形式7、团队下动态信息列表xxxx.collection.queryActivityByCollection输入：=xxxx.collection.queryActivityByCollection&query._id=团队id输出：返回对象结构，其中object: feed : feed列表json8、删除团队下人员xxxx.collection.quitCollectionByUser输入：=xxxx.collection.quitCollectionByUser&update._id=团队id& update.member=userId_1& update.member=userId_2输出：返回对象结构9、增加团队人员xxxx.collection.enterCollectionByUser输入：=xxxx.collection.enterCollectionByUser&insert._id=团队id&insert.member=userId&insert.member=userId &insert.password=AN5V输出：返回对象结构，其中object:团队的json形式10、团队关注未看信息数xxxx.collection.followNumByCollection输入：=xxxx.collection.followNumByCollection&query.belongToId=xxxx& query.preTime=2011-05-17 12:38:22&query.userId=xxxx输出：返回对象结构，其中object:“count”:count11、获得指定团队xxxx.collection.getUserCollectionById输入：= xxxx.collection.getUserCollectionById&query._id=xxx输出：返回对象结构，其中object:团队json12、团队密码重置xxxx.collection.resetUserCollectionPassword输入：= xxxx.collection.resetUserCollectionPassword&update.userCollectionId=团队的ID输出：返回对象结构，其中object:password : “AN5V”13、获取服务器时间xxxx.search.getCurrentServerTime输入：= =xxxx.search.getCurrentServerTime输出：返回对象结构，其中object:currentTime:130698672768714、获取团队密码xxxx.collection.getUserCollectionPassword输入：= xxxx.collection.getUserCollectionPassword&query.userCollectionId=团队的ID输出：返回对象结构，其中object:password:QSNU15、根据密码获取团队xxxx.collection.getUserCollectionByPassword输入：=xxxx.collection.getUserCollectionByPassword &query.password=563Y输出：返回对象结构，其中object:团队json16、获取团队密码的时间(有效期、还有多久过期)xxxx.collection.getUserCollectionByPassword输入：=xxxx.collection.getUserCollectionPasswordTime&query.userCollectionId =团队的ID输出：返回对象结构，message:获取团队密码的时间成功,object:remainTime:6489609,periodTime:7200000,success:true17、获取团队密码的时间(有效期、还有多久过期)xxxx.collection.getUserCollectionByPassword输入：=xxxx.collection.getUserCollectionPasswordTime&query.password=563Y输出：返回对象结构，message:获取团队密码的时间成功,object:remainTime:6489609,periodTime:7200000,success:true注：返回值中remainTime(获取还有多少时间过期)，periodTime(获取时间的有效期)18、复制团队下业务xxxx.collection. copyTaskBySystemUserCollection输入：=xxxx.collection.copyTaskBySystemUserCollection&insert.userCollectionId=要复制业务的团队输出：返回对象结构，message:复制系统团队下业务成功,object:”,success:true注：19、获取系统团队xxxx.collection.querySystemUserCollection输入：=xxxx.collection.querySystemUserCollection输出：返回对象结构，其中object: UserCollection的json形式关注1、增加关注xxxx.follow.addFollow输入：=xxxx.follow.addFollow&insert.关注字段=xxx&user.userId=xxx输出：返回对象结构2、撤销关注xxxx.follow.cancelFollow输入：=xxxx.follow.cancelFollow&update.belongToId=xxx&update.userId=xxxx& user.userId=xxx输出：返回对象结构3、查询关注列表xxxx.follow.queryFollow输入：=xxxx.follow.queryFollow&query.userId=xxx&user.userId=xxx输出：返回对象结构，其中object:“follow”:所有关注列表json,”task”:业务关注列表json,”user”:人员关注列表json,”dept”:部门关注列表json业务1、查看动态（所有）xxxx.task.queryActivity输入：=xxxx.task.queryActivity&page.perPageSize=xxx&page.nextTime=xxx&page.preTime=xx&page.total=xxx输出：返回对象结构，其中object:nextData:DynamicInfo列表的json形式,”preDate”:DynamicInfo列表的json形式,”pageInfo”:PageInfo的json形式1a、查看动态（业务）xxxx.task.queryActivity输入：=xxxx.task.queryActivity&query.taskId=xxxxxxxxxxxxx&page.perPageSize=xxx&page.nextTime=xxx&page.preTime=xx&page.total=xxx输出：返回对象结构，其中object:nextData:DynamicInfo列表的json形式,”preDate”:DynamicInfo列表的json形式,”pageInfo”:PageInfo的json形式1b、查看动态（人员）xxxx.task.queryActivity输入：=xxxx.task.queryActivity&query.author=xxxxxxxxxxxxx&page.perPageSize=xxx&page.nextTime=xxx&page.preTime=xx&page.total=xxx输出：返回对象结构，其中object:nextData:DynamicInfo列表的json形式,”preDate”:DynamicInfo列表的json形式,”pageInfo”:PageInfo的json形式1b、查看动态（团队）xxxx.task.queryActivity输入：=xxxx.task.queryActivity&query. collectionId=xxxxxxxxxxxxx&page.perPageSize=xxx&page.nextTime=xxx&page.preTime=xx&page.total=xxx输出：返回对象结构，其中object:“taskId”：xxxx, “taskName”：xxxx, “data”： nextData:DynamicInfo列表的json形式,”preDate”:DynamicInfo列表的json形式,”pageInfo”:PageInfo的json形式2、发布动态xxxx.task.addActivity输入：=xxxx.task.addActivity&insert.taskId=xxx&insert.动态表字段.=xxx输出：message:提示信息,success:操作状态,object:_id:新动态id3、增加业务xxxx.task.addTask输入：=xxxx.task.addTask&insert.userCollectionId=团队id&insert.业务表字段=xxx 说明：insert.taskFormId值为taskForm的json形式；insert.taskTemplateId值为taskTemplate的json形式。输出：返回对象结构，其中object:Task的Json形式4、增加业务Field信息xxxx.task.addTaskField输入：=xxxx.task.addTaskField&insert.taskId=所要业务Field所属的业务id&insert. Field表字段=xxxx输出：返回对象结构，其中object:“taskField”:Field列表的json形式5、修改业务基本信息xxxx.task.modifyTaskBasic输入：=xxxx.task.modifyTaskBasic&update._id=所要修改的业务id&update.业务基本信息字段=xxx输出：返回对象结构，其中object:Task的json形式6、修改业务Field信息xxxx.task.modifyTaskField输入：=xxxx.task.modifyTaskField&update.taskId=所要修改的业务id&update.fieldName=所要修改的字段名称&update. Field表字段=xxxx输出：返回对象结构，其中object:“taskField”:Field列表的json形式7、修改业务结构信息xxxx.task.modifyTaskFrame输入：=xxxx.task.modifyTaskFrame&update.taskId=所要修改的业务id&update.task表字段=xxxxx输出：返回对象结构，其中object:“taskForm”: TaskForm的json形式,“taskTemplate”: Taskemplate的json形式,8、填写业务详细内容xxxx.task.addTaskDetail输入：= xxxx.task.addTaskDetail&insert.taskId=所要增加详细内容的业务id&insert.字段=xxx输出：返回对象结构，其中object:_id:4dc74b78752d540fd0f2ee3b9、更新业务详细内容xxxx.task.modifyTaskDetail输入：=xxxx.task.modifyTaskDetail&update.taskId=所要修改的业务id&update._id=所要修改的业务详细id&update.业务详细表字段=xxx输出：返回对象结构10、查看业务所属的团队xxxx.task.queryCollectionByTask输入：=xxxx.task.queryCollectionByTask&query.task=所要查看的业务id输出：返回对象结构，其中object:userCollection:UserCollection列表的json形式11、查看业务详细列表xxxx.task. xxxx.task.queryTaskDetail输入：=xxxx.task.queryTaskDetail&query.taskId=所要查看的业务id&page.perPageSize=xxx&page.nextTime=xxx&page.preTime=xxx&page.total=xxx输出：返回对象结构，其中object: acl:acl1列表的json形式,taskDetailList:taskDetail列表的json形式,”pageInfo”:pageInfo的json形式12、单业务关注未看信息数xxxx.task.followNumByTask输入：=xxxx.task.followNumByTask&query.taskId=所要查看的业务id& query.preTime=xxx输出：返回对象结构，其中object:count:单业务关注未看信息数13、删除业务xxxx.task.deleteTask输入：=xxxx.task.deleteTask&update._id=所要删除的业务id输出：返回对象结构14、删除团队下的业务xxxx.task.deleteTaskByCollection输入：=xxxx.task.deleteTaskByCollection&update._id=所要删除业务所在的团队id&update.task=所要删除的业务id输出：返回对象结构15、添加评论xxxx.task.addReviewByTaskDetail输入：=xxxx.task.addReviewByTaskDetail&update._id=所要添加评论详细业务id&update.taskId=所要添加评论的业务id&update.review=所要添加评论输出：返回对象结构，其中object:review:review列表的json形式16、通过业务id查看业务基本信息xxxx.task. xxxx.task. queryTaskBasic输入：=xxxx.task.queryTaskbasic&query._id=所要查看的业务id输出：返回对象结构，其中object:task的json形式17、通过taskFormId查看TaskForm内容xxxx.task. xxxx.task. queryTaskForm输入：=xxxx.task.queryTaskForm&query._id=所要查看的TaskFormId输出：返回对象结构，其中object: TaskForm的json形式18、通过taskTemplateId查看TaskTemlpate内容xxxx.task. xxxx.task. queryTaskTemplate输入：=xxxx.task.queryTaskTemplate&query._id=所要查看的TaskTemplateId输出：返回对象结构，其中object: TaskTemplate的json形式19、增加TaskForm内容xxxx.task.addTaskForm输入：= xxxx.task.addTaskForm&insert.taskForm=所要增加taskForm内容输出：返回对象结构，其中object: TaskForm的json形式20、增加TaskTemplate内容xxxx.task.addTaskTemplate输入：= xxxx.task.addTaskTemplate&insert.taskTemplate=所要增加taskTemplate内容输出：返回对象结构，其中object: TaskTemplate的json形式21、获取一个空的TaskTemlpate xxxx.task.queryTaskEmptyTemplate输入：= xxxx.task.queryTaskEmptyTemplate输出：返回对象结构，其中object: TaskTemplate的json形式22、修改动态内容xxxx.task.updateActivity输入：=xxxx.task.updateActivity&update._id=更改的动态的ID&ments=safsa:xcvfsd;输出：返回对象结构，其中object:Feed的json形式23、获取动态xxxx.task.getActivityById输入：=xxxx.task.getActivityById&query._id=动态ID;输出：返回对象结构，其中object: Feed的json形式24、增加业务关注xxxx.task.addFollowByTask&user输入：=xxxx.task.addFollowByTask&insert.follower.UserCollection=要关注的团队id&insert._id=被关注业务id&insert.follower.User=要关注的用户id;输出：返回对象结构24、撤消业务关注xxxx.task. cancelFollowByTask输入：=xxxx.task.cancelFollowByTask&update.follower.UserCollection=要关注的团队id &update._id=被关注业务id &update.follower.User=要关注的用户id;输出：返回对象结构搜索1、搜索xxxx.collection.search输入：=xxxx.collection.search&search.keyword=xxx&search.searchType=xxx&输出：返回对象结构，其中object: tasks: