app服務器接口文檔

1、人衛(wèi)BBS接口文檔北京澤元迅長軟件有限公司2016年06月文檔更新歷史序號文檔版本更新內容參與者更新日期11.0新增內容郭可攀2016-10-131. 圈子列表接口url參數示例json="UserName":"xxx","Source":"xxx","Type":"xxx","Theme":"xxx","PageSize":"10","PageIndex":"1&q

2、uot;"deviceinfo":"SiteID":"33","AppVersion":"1.0","TerminalType":"IOS","SysVersion":"IOS5.1","Mac":"0E-A5-98-22-33","NetType":"Wifi","TerminalModel":"Lenov

3、o A520","Resolution":"720*1280","AppType":"TCM"參數描述UserName(用戶名)可空Source(圈子來源)教學平臺/電子書城/增值服務Type(圈子類型) 交友/學習Theme(載體)可空PageSize 分頁大小PageIndex 第幾頁接口描述圈子列表接口用戶名為空查詢所有類型圈子返回值成功:"result":1, "data":"id":"1","Name&qu

4、ot;:"圈子名稱1",”Diescribe”:”圈子描述”,"logo":" courseLogo/123.jpg ",”Source”:”教學平臺”"type":"交友",MaxCount: "10",”Theme”:”111”,”IsTop”:”0”,"adduser":"jsptxxx",status: "0",addtime: "2016-06-29 09:03:20","co

5、unt":30失敗:"result":0, "message":"獲取圈子列表失敗"2. 新增圈子接口url參數示例json="UserName":"xxx","Name":"xxx","Diescribe":"xxx","Source":"xxx","Type":"xxx","MaxCount":"

6、;100","Theme":"xxx",”IsHidden:”0”,"FileBytes":"xxx","FileName":"xxx","Users":"zhangsan;lisi","deviceinfo":"SiteID":"33","AppVersion":"1.0","TerminalType":&

7、quot;IOS","SysVersion":"IOS5.1","Mac":"0E-A5-98-22-33","NetType":"Wifi","TerminalModel":"Lenovo A520","Resolution":"720*1280","AppType":"TCM"參數描述UserName(用戶名)Name(圈子名稱)Source(

8、來源 教學平臺/電子書城/增值服務。不限)Type(圈子類型 交友/學習。不限)Diescribe(圈子描述)可空MaxCount(人數最多限制)可空Theme(內容載體ID ，同來源應用保證唯一(授課ID或ISBN或空)可空IsHidden(是否開放 )FileBytes(文件流)可空FileName(文件名稱)可空Users(學生包括關聯老師名稱)可空接口描述注意：新增圈子TZT要屏蔽顯示(注：TZT代表通知/作業(yè)/討論，下同)如果是TZT傳入Users/TeacherName建立圈子的同時把學生/老師加入圈子返回值成功:"result":1, "messag

9、e":”新建圈子成功”失敗:"result":0, "message":"新建圈子失敗"3. 修改圈子接口url參數示例json="UserName":"xxx","ID":"xxx","Name":"xxx","Diescribe":"xxx","Status":"xxx","IsHidden":"

10、;xxx","MaxCount":"233","IsTop":"xxx","FileName":"xxx","FileBytes":"xxx","deviceinfo":"SiteID":"33","AppVersion":"1.0","TerminalType":"IOS","

11、SysVersion":"IOS5.1","Mac":"0E-A5-98-22-33","NetType":"Wifi","TerminalModel":"Lenovo A520","Resolution":"720*1280","AppType":"TCM"參數描述UserName(用戶名)ID(圈子ID)Name(圈子名稱)可空Diescribe(圈子描述)可空S

12、tatus(審核狀態(tài)(0:未審核 1:通過 2:未通過)可空IsHidden(是否顯示(0:否 1:是)可空MaxCount(人數最多限制)可空IsTop(是否置頂(0:否 1:是)可空FileBytes 文件流 可空FileName 文件名 可空接口描述修改圈子返回值成功:"result":1, "message":”修改圈子成功”失敗:"result":0, "message":"修改圈子失敗"4. 加入圈子接口url參數示例json="UserName":"x

13、xx","CircleID":"xxx","deviceinfo":"SiteID":"33","AppVersion":"1.0","TerminalType":"IOS","SysVersion":"IOS5.1","Mac":"0E-A5-98-22-33","NetType":"Wifi&q

14、uot;,"TerminalModel":"Lenovo A520","Resolution":"720*1280","AppType":"TCM"參數描述UserName（用戶名）CircleID(圈子ID)接口描述加入圈子返回值成功:"result":1, "message":加入圈子成功失敗:"result":0, "message":"加入圈子失敗"5. 發(fā)送帖子url

15、參數示例json="UserName":"xxx","ToUser":"zhangsan;lisi","CircleID":"12","Title":"xxx","Theme":"xxx","Content":"xxx","Type":"xxx",”Source”:”xxx”"deviceinfo"

16、:"SiteID":"33","AppVersion":"1.0","TerminalType":"IOS","SysVersion":"IOS5.1","Mac":"0E-A5-98-22-33","NetType":"Wifi","TerminalModel":"Lenovo A520","Resolut

17、ion":"720*1280","AppType":"TCM"參數描述UserName（用戶名）ToUser(收信人) 可空CircleID(圈子ID)Title(標題)Content(內容)Theme(內容載體(授課ID_課時ID或ISBN或空) 可空Type (類型(0:通知,1:討論,2:作業(yè),3:普通帖子)Source 平臺來源 (教學平臺/電子書城/增值服務。不限)接口描述返回值成功:"result":1, "message":"發(fā)送帖子成功"失敗:&qu

18、ot;result":0, "message":"發(fā)送帖子失敗"6. 刪除帖子url參數示例json="UserName":"xxx","CircleID":"xxx","ID":"xxx","deviceinfo":"SiteID":"33","AppVersion":"1.0","TerminalType"

19、;:"IOS","SysVersion":"IOS5.1","Mac":"0E-A5-98-22-33","NetType":"Wifi","TerminalModel":"Lenovo A520","Resolution":"720*1280","AppType":"TCM"參數描述UserName（用戶名）CircleID(圈子ID)

20、ID(帖子ID)接口描述刪除帖子返回值成功:"result":1, "message":”刪除帖子成功”失敗:"result":0, "message":"刪除帖子失敗"7. 回復帖子url參數示例json="UserName":"xxx","CircleID":"xxx","ID":"xxx","InfoID":"xxx","

21、Content":"xxx","ToUser":"xxx","Type":"xxx","deviceinfo":"SiteID":"33","AppVersion":"1.0","TerminalType":"IOS","SysVersion":"IOS5.1","Mac":"0

22、E-A5-98-22-33","NetType":"Wifi","TerminalModel":"Lenovo A520","Resolution":"720*1280","AppType":"TCM"參數描述UserName（用戶名）CircleID(圈子ID)InfoID(Info表ID) 可空ID(回復表帖子ID) 可空Content(回復內容)ToUser(收信人)可空 (發(fā)送作業(yè)時,需要指定收信人)Type 帖子類型

23、接口描述回復帖子(InfoID和ID不能同時為空)返回值成功:"result":1, "message":回復帖子成功失敗:"result":0, "message":"回復帖子失敗"8. 帖子列表接口url參數示例json="UserName":"xxx","CircleID":"12","Theme":"xxx","Source":"xxx&q

24、uot;,”Source”:xxx”,”PageSize”:”10”,”PageIndex”:”1”"deviceinfo":"SiteID":"36","AppVersion":"1.0","TerminalType":"IOS","SysVersion":"IOS5.1","Mac":"0E-A5-98-22-33","NetType":"Wi

25、fi","TerminalModel":"Lenovo A520","Resolution":"720*1280","AppType":"TCM"參數描述UserName(用戶名)CircleID(圈子ID)可空Theme(載體ID，話題綁定的載體)可空Source(來源)教學平臺/電子書城/增值服務PageSize 分頁大小PageIndex 第幾頁接口描述圈子顯示的時候需要傳入CircleID通知/討論/作業(yè)需要傳入Theme返回值成功:"result

26、":1, "data":"id":"1","Title":"xxx",”content:”:”xxx”,”FavoCount”:”1”,”IsTop":”1”,”ReadFlag”:”0”,adduser":"jsptxxx,addtime: "2016-06-29 09:03:20”,"count":30失敗:"result":0, "message":"獲取帖子列表失敗&q

27、uot;9. 帖子詳情接口url參數示例json="UserName":"xxx",”ID”:”xxx”"deviceinfo":"SiteID":"33","AppVersion":"1.0","TerminalType":"IOS","SysVersion":"IOS5.1","Mac":"0E-A5-98-22-33","

28、NetType":"Wifi","TerminalModel":"Lenovo A520","Resolution":"720*1280","AppType":"TCM"參數描述UserName（用戶名）ID(帖子ID)接口描述通知：系統(tǒng)通知，所有人只能看不能回復作業(yè)：學生(只能看到自己和老師的對話)，老師(所有收到作業(yè)的學生列表,點擊學生列表調用作業(yè)詳情接口)討論：任何人都能查看和回復返回值成功:"result":1, &q

29、uot;data":"id":"1","Title":"帖子標題",”content:”:”帖子內容”,”ParentID”:”1”,"adduser":"jsptxxx,addtime: "2016-06-29 09:03:20”,"count":30失敗:"result":0, "message":"獲取帖子詳情失敗"10. 收信人列表接口url參數示例json="User

30、Name":"xxx","CircleID":"xxx","deviceinfo":"SiteID":"33","AppVersion":"1.0","TerminalType":"IOS","SysVersion":"IOS5.1","Mac":"0E-A5-98-22-33","NetType&

31、quot;:"Wifi","TerminalModel":"Lenovo A520","Resolution":"720*1280","AppType":"TCM"參數描述UserName(用戶名)CircleID(圈子ID)接口描述查詢當前圈子下所有用戶返回值成功:"result":1, "data":"name":"zhangsan","realname"

32、;:"張三","type":"Common"失敗:"result":0, "message":"獲取收信人列表失敗"11. *作業(yè)詳情接口(教學平臺教師端作業(yè)使用）url參數示例json="UserName":"xxx","ID":"xxx",”StuName”:”lisi”"deviceinfo":"SiteID":"33","

33、;AppVersion":"1.0","TerminalType":"IOS","SysVersion":"IOS5.1","Mac":"0E-A5-98-22-33","NetType":"Wifi","TerminalModel":"Lenovo A520","Resolution":"720*1280","App

34、Type":"TCM"參數描述UserName（用戶名）ID(帖子ID)StuName(學生姓名)接口描述學生回復詳情返回值成功:"result":1, "data":"id":"1",”content:”:”帖子內容”,"adduser":"jsptxxx,addtime: "2016-06-29 09:03:20”,"count":30失敗:"result":0, "message":"獲取作業(yè)詳情失敗"12. 未讀提示數url參數示例json="UserName":"xxx","Theme":"xxx","deviceinfo":"SiteID":"33","AppVersion":&q