数据返回结构.doc

数据返回结构 目的： 此文档用于前台手机端与后台系统的数据交互接口的规范。开发人员应严格遵守接口标准。 文档对象： 前台开发人员、后台开发人员 返回对象结构 ReturnResult对象，其结构包括三个属性：“success”、“message”、“object”。 “success”：本次操作是否成功，成功为true、失败为false。 “message”：本次操作返回结果提示信息，现在内容是中文提示，以后会是返回结果代码。 “object”：本次操作返回的结果集。如查询的结果列表、新建信息的id等。 以上三个属性会转换成json串的形式。 以用户注册为例，返回结果: {message:注册新用户成功,object:{_id:4dc74b78752d540fd0f2ee3b},success:true} message:：注册新用户成功——本次操作返回结果提示信息，以后可能是结果代码，如：CZCU001 success：true——本次操作是否成功，成功为true，不成功为false {XXXX对象的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.loginuser.loginName=xxxxuser.password=xxxxx 输入2：=xxxx.user.loginuser.email=xxxxuser.password=xxxxx 输出：返回对象结构，其中object:{“sessionId”:”xxxxxx”,”userId”:”xxxxxxx”} 例如：{message:登录成功, object:{sessionId:-86998193500343087504e015fb2a01a05de69e182c7, userId:4ddb7d7811afb3e7bfc1a69a},success:true} 或 {message:用户名或密码不正确,object:null,success:false} 2、用户注册xxxx.user. enroll 输入：=xxxx.user.enrolluser.loginName=xxxxuser.password=xxxxuser.email= xxxxxinsert.用户表字段…..=xxxxx 输出：{message:注册新用户成功,object:{_id:4dc74b78752d540fd0f2ee3b},success:true} 3、重置密码xxxx.user.resetPassword 输入：=xxxx.user.resetPassworduser.loginName=xxxxuser.password=xxxx 输出：{message:修改密码成功,object:null,success:true} 4、登录名是否被使用xxxx.user.checkLoginName 输入：=xxxx.user. checkLoginNameuser.loginName=xxxx 输出：{message:此登录名没有被使用,object:null,success:true} 5、查询用户信息xxxx.user.queryUserInfo 输入：=xxxx.user. queryUserInfo query.用户表字段…..=xxxx 输出：返回对象结构，其中object:{用户表的json字串} 6、修改用户基本信息xxxx.user.modifyUser 输入：=xxxx.user.modifyUserupdate.用户表字段…..=xxxx 输出：返回对象结构，其中object：{”user”: {User的json}} 7、查询用户所在的所有团队xxxx.user.collectionByUser 输入：=xxxx.user. collectionByUser 输出：返回对象结构，其中object：{”userCollection”: {UserCollection列表js