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