資源描述:
《數(shù)據(jù)返回結(jié)構(gòu)》由會(huì)員上傳分享,免費(fèi)在線閱讀,更多相關(guān)內(nèi)容在應(yīng)用文檔-天天文庫(kù)。
1、數(shù)據(jù)返回結(jié)構(gòu)目的:此文檔用于前臺(tái)手機(jī)端與后臺(tái)系統(tǒng)的數(shù)據(jù)交互接口的規(guī)范。開(kāi)發(fā)人員應(yīng)嚴(yán)格遵守接口標(biāo)準(zhǔn)。文檔對(duì)象:前臺(tái)開(kāi)發(fā)人員、后臺(tái)開(kāi)發(fā)人員返回對(duì)象結(jié)構(gòu)ReturnResult對(duì)象,其結(jié)構(gòu)包括三個(gè)屬性:“success”、“message”、“object”?!皊uccess”:本次操作是否成功,成功為true、失敗為false。“message”:本次操作返回結(jié)果提示信息,現(xiàn)在內(nèi)容是中文提示,以后會(huì)是返回結(jié)果代碼?!皁bject”:本次操作返回的結(jié)果集。如查詢的結(jié)果列表、新建信息的id等。以上三個(gè)屬性會(huì)轉(zhuǎn)換成json串的形式。以用戶注冊(cè)為例,
2、返回結(jié)果:{"message":"注冊(cè)新用戶成功","object":{"_id":"4dc74b78752d540fd0f2ee3b"},"success":true}"message"::"注冊(cè)新用戶成功"——本次操作返回結(jié)果提示信息,以后可能是結(jié)果代碼,如:CZCU001"success":true——本次操作是否成功,成功為true,不成功為false{XXXX對(duì)象的json形式}:是指這個(gè)對(duì)象的屬性及其值以json的{key:value}形式給出。如:{屬性1:值1,屬性2:值2,屬性3:值3}。value可以是一個(gè)對(duì)象,則js
3、on就是嵌套結(jié)構(gòu)。如果某個(gè)屬性是boolean類型,名稱是isXXXXX,則它的json的為XXXX(去掉前面的is)。參數(shù)格式約定1、時(shí)間格式使用字符串形式傳輸,采用GTD+8(北京時(shí)間)計(jì)時(shí)。格式:“2011-05-0912:12:12”。2、每次請(qǐng)求都要加上當(dāng)前登錄用戶的sessionId(除登錄后注冊(cè)之外)。&user.sessionId=xxxxxxx。下面這兩個(gè)不一定會(huì)列出來(lái),但是都包含這個(gè)請(qǐng)求參數(shù)的。接口方法用戶部分1、用戶登錄xxxx.user.login輸入1:method.name=xxxx.user.login&us
4、er.loginName=xxxx&user.password=xxxxx輸入2:method.name=xxxx.user.login&user.email=xxxx&user.password=xxxxx輸出:返回對(duì)象結(jié)構(gòu),其中object:{“sessionId”:”xxxxxx”,”userId”:”xxxxxxx”}例如:{"message":"登錄成功","object":{"sessionId":"-86998193500343087504e015fb2a01a05de69e182c7","userId":"4ddb7d78
5、11afb3e7bfc1a69a"},"success":true}或{"message":"用戶名或密碼不正確","object":null,"success":false}2、用戶注冊(cè)xxxx.user.enroll輸入:method.name=xxxx.user.enroll&user.loginName=xxxx&user.password=xxxx&user.email=xxxxx&insert.用戶表字段…..=xxxxx輸出:{"message":"注冊(cè)新用戶成功","object":{"_id":"4dc74b78752d
6、540fd0f2ee3b"},"success":true}3、重置密碼xxxx.user.resetPassword輸入:method.name=xxxx.user.resetPassword&user.loginName=xxxx&user.password=xxxx輸出:{"message":"修改密碼成功","object":null,"success":true}4、登錄名是否被使用xxxx.user.checkLoginName輸入:method.name=xxxx.user.checkLoginName&user.login
7、Name=xxxx輸出:{"message":"此登錄名沒(méi)有被使用","object":null,"success":true}5、查詢用戶信息xxxx.user.queryUserInfo輸入:method.name=xxxx.user.queryUserInfo&query.用戶表字段…..=xxxx輸出:返回對(duì)象結(jié)構(gòu),其中object:{用戶表的json字串}6、修改用戶基本信息xxxx.user.modifyUser輸入:method.name=xxxx.user.modifyUser&update.用戶表字段…..=xxxx輸出
8、:返回對(duì)象結(jié)構(gòu),其中object:{”user”:{User的json}}7、查詢用戶所在的所有團(tuán)隊(duì)xxxx.user.collectionByUser輸入:method.name=xxxx.