app服务器接口文档.doc

人卫BBS接口文档北京泽元迅长软件有限公司2016年06月文档更新历史序号文档版本更新内容参与者更新日期11.0新增内容郭可攀2016-10-131. 圈子列表接口urlhttp:/books123456789.ipmph.com/books/mobile.zaction?command=circleList参数示例json=UserName:xxx,Source:xxx,Type:xxx,Theme:xxx,PageSize:10,PageIndex:1deviceinfo:SiteID:33,AppVersion:1.0,TerminalType:IOS,SysVersion:IOS5.1,Mac:0E-A5-98-22-33,NetType:Wifi,TerminalModel:Lenovo A520,Resolution:720*1280,AppType:TCM参数描述UserName(用户名)可空Source(圈子来源)教学平台/电子书城/增值服务Type(圈子类型) 交友/学习Theme(载体)可空PageSize 分页大小PageIndex 第几页接口描述圈子列表接口用户名为空查询所有类型圈子返回值成功:result:1, data:id:1,Name:圈子名称1,”Diescribe”:”圈子描述”,logo:http:/books123456789.ipmph.com/books/ courseLogo/123.jpg ,”Source”:”教学平台”type:交友,MaxCount: 10,”Theme”:”111”,”IsTop”:”0”,adduser:jsptxxx,status: 0,addtime: 2016-06-29 09:03:20,count:30失败:result:0, message:获取圈子列表失败2. 新增圈子接口urlhttp:/books123456789.ipmph.com/books/mobile.zaction?command=addCircle参数示例json=UserName:xxx,Name:xxx,Diescribe:xxx,Source:xxx,Type:xxx,MaxCount:100,Theme:xxx,”IsHidden:”0”,FileBytes:xxx,FileName:xxx,Users:zhangsan;lisi,deviceinfo:SiteID:33,AppVersion:1.0,TerminalType:IOS,SysVersion:IOS5.1,Mac:0E-A5-98-22-33,NetType:Wifi,TerminalModel:Lenovo A520,Resolution:720*1280,AppType:TCM参数描述UserName(用户名)Name(圈子名称)Source(来源 教学平台/电子书城/增值服务。不限)Type(圈子类型 交友/学习。不限)Diescribe(圈子描述)可空MaxCount(人数最多限制)可空Theme(内容载体ID ，同来源应用保证唯一(授课ID或ISBN或空)可空IsHidden(是否开放 )FileBytes(文件流)可空FileName(文件名称)可空Users(学生包括关联老师名称)可空接口描述注意：新增圈子TZT要屏蔽显示(注：TZT代表通知/作业/讨论，下同)如果是TZT传入Users/TeacherName建立圈子的同时把学生/老师加入圈子返回值成功:result:1, message:”新建圈子成功”失败:result:0, message:新建圈子失败3. 修改圈子接口urlhttp:/books123456789.ipmph.com/books/mobile.zaction?command=editCircle参数示例json=UserName:xxx,ID:xxx,Name:xxx,Diescribe:xxx,Status:xxx,IsHidden:xxx,MaxCount:233,IsTop:xxx,FileName:xxx,FileBytes:xxx,deviceinfo:SiteID:33,AppVersion:1.0,TerminalType:IOS,SysVersion:IOS5.1,Mac:0E-A5-98-22-33,NetType:Wifi,TerminalModel:Lenovo A520,Resolution:720*1280,AppType:TCM参数描述UserName(用户名)ID(圈子ID)Name(圈子名称)可空Diescribe(圈子描述)可空Status(审核状态(0:未审核 1:通过 2:未通过)可空IsHidden(是否显示(0:否 1:是)可空MaxCount(人数最多限制)可空IsTop(是否置顶(0:否 1:是)可空FileBytes 文件流 可空FileName 文件名 可空接口描述修改圈子返回值成功:result:1, message:”修改圈子成功”失败:result:0, message:修改圈子失败4. 加入圈子接口urlhttp:/books123456789.ipmph.com/books/mobile.zaction?command=joinCircle参数示例json=UserName:xxx,CircleID:xxx,deviceinfo:SiteID:33,AppVersion:1.0,TerminalType:IOS,SysVersion:IOS5.1,Mac:0E-A5-98-22-33,NetType:Wifi,TerminalModel:Lenovo A520,Resolution:720*1280,AppType:TCM参数描述UserName（用户名）CircleID(圈子ID)接口描述加入圈子返回值成功:result:1, message:加入圈子成功失败:result:0, message:加入圈子失败5. 发送帖子urlhttp:/books123456789.ipmph.com/books/mobile.zaction?command=addPost参数示例json=UserName:xxx,ToUser:zhangsan;lisi,CircleID:12,Title:xxx,Theme:xxx,Content:xxx,Type:xxx,”Source”:”xxx”deviceinfo:SiteID:33,AppVersion:1.0,TerminalType:IOS,SysVersion:IOS5.1,Mac:0E-A5-98-22-33,NetType:Wifi,TerminalModel:Lenovo A520,Resolution:720*1280,AppType:TCM参数描述UserName（用户名）ToUser(收信人) 可空CircleID(圈子ID)Title(标题)Content(内容)Theme(内容载体(授课ID_课时ID或ISBN或空) 可空Type (类型(0:通知,1:讨论,2:作业,3:普通帖子)Source 平台来源 (教学平台/电子书城/增值服务。不限)接口描述返回值成功:result:1, message:发送帖子成功失败:result:0, message:发送帖子失败6. 删除帖子urlhttp:/books123456789.ipmph.com/books/mobile.zaction?command=delPost参数示例json=UserName:xxx,CircleID:xxx,ID:xxx,deviceinfo:SiteID:33,AppVersion:1.0,TerminalType:IOS,SysVersion:IOS5.1,Mac:0E-A5-98-22-33,NetType:Wifi,TerminalModel:Lenovo A520,Resolution:720*1280,AppType:TCM参数描述UserName（用户名）CircleID(圈子ID)ID(帖子ID)接口描述删除帖子返回值成功:result:1, message:”删除帖子成功”失败:result:0, message:删除帖子失败7. 回复帖子urlhttp:/books123456789.ipmph.com/books/mobile.zaction?command=replyPost参数示例json=UserName:xxx,CircleID:xxx,ID:xxx,InfoID:xxx,Content:xxx,ToUser:xxx,Type:xxx,deviceinfo:SiteID:33,AppVersion:1.0,TerminalType:IOS,SysVersion:IOS5.1,Mac:0E-A5-98-22-33,NetType:Wifi,TerminalModel:Lenovo A520,Resolution:720*1280,AppType:TCM参数描述UserName（用户名）CircleID(圈子ID)InfoID(Info表ID) 可空ID(回复表帖子ID) 可空Content(回复内容)ToUser(收信人)可空 (发送作业时,需要指定收信人)Type 帖子类型接口描述回复帖子(InfoID和ID不能同时为空)返回值成功:result:1, message:回复帖子成功失败:result:0, message:回复帖子失败8. 帖子列表接口urlhttp:/books123456789.ipmph.com/books/mobile.zaction?command=postList参数示例json=UserName:xxx,CircleID:12,Theme:xxx,Source:xxx,”Source”:xxx”,”PageSize”:”10”,”PageIndex”:”1”deviceinfo:SiteID:36,AppVersion:1.0,TerminalType:IOS,SysVersion:IOS5.1,Mac:0E-A5-98-22-33,NetType:Wifi,TerminalModel:Lenovo A520,Resolution:720*1280,AppType:TCM参数描述UserName(用户名)CircleID(圈子ID)可空Theme(载体ID，话题绑定的载体)可空Source(来源)教学平台/电子书城/增值服务PageSize 分页大小PageIndex 第几页接口描述圈子显示的时候需要传入CircleID通知/讨论/作业需要传入Theme返回值成功:result: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:获取帖子列表失败9. 帖子详情接口urlhttp:/books123456789.ipmph.com/books/mobile.zaction?command=postDetail参数示例json=UserName:xxx,”ID”:”xxx”deviceinfo:SiteID:33,AppVersion:1.0,TerminalType:IOS,SysVersion:IOS5.1,Mac:0E-A5-98-22-33,NetType:Wifi,TerminalModel:Lenovo A520,Resolution:720*1280,AppType:TCM参数描述UserName（用户名）ID(帖子ID)接口描述通知：系统通知，所有人只能看不能回复作业：学生(只能看到自己和老师的对话)，老师(所有收到作业的学生列表,点击学生列表调用作业详情接口)讨论：任何人都能查看和回复返回值成功:result:1, data:id:1,Title:帖子标题,”content:”:”帖子内容”,”ParentID”:”1”,adduser:jsptxxx,addtime: 2016-06-29 09:03:20”,count:30失败:result:0, message:获取帖子详情失败10. 收信人列表接口urlhttp:/books123456789.ipmph.com/books/mobile.zaction?command=userList参数示例json=UserName:xxx,CircleID:xxx,deviceinfo:SiteID:33,AppVersion:1.0,TerminalType:IOS,SysVersion:IOS5.1,Mac:0E-A5-98-22-33,NetType:Wifi,TerminalModel:Lenovo A520,Resolution:720*1280,AppType:TCM参数描述UserName(用户名)CircleID(圈子ID)接口描述查询当前圈子下所有用户返回值成功:result:1, data:name:zhangsan,realname:张三,type:Common失败:result:0, message:获取收信人列表失败11. *作业详情接口(教学平台教师端作业使用）urlhttp:/books123456789.ipmph.com/books/mobile.zaction?command=stuReplyDetail参数示例json=UserName:xxx,ID:xxx,”StuName”:”lisi”deviceinfo:SiteID:33,AppVersion:1.0,TerminalType:IOS,SysVersion:IOS5.1,Mac:0E-A5-98-22-33,NetType:Wifi,TerminalModel:Lenovo A520,Resolution:720*1280,AppType: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:获取作业详情失败12. 未读提示数urlhttp:/books123456789.ipmph.com/books/mobile.zaction?command=unreadCount参数示例json=UserName:xxx,Theme:xxx,deviceinfo:SiteID:33,AppVersion:1.0,TerminalType:IOS,SysVersion:IOS5.1,Mac:0E-A5-98-22-33,NetType:Wifi,TerminalModel:Lenovo A520,Resolution:720*1280,AppType:TCM参数描述UserName（用户名）Theme(载体，授课里面调接口时带参数Theme,外面圈子调用时不带参数) 可空接口描述获取个人未读提示数返回值成功:result:1, count:5失败:result:0, message:获取未读提示数失败13. 获取帖子类型urlhttp:/books123456789.ipmph.com/books/mobile.zaction?command=getPostType参数示例json=”Source”:”xxx”,deviceinfo:SiteID:33,AppVersion:1.0,TerminalType:IOS,SysVersion:IOS5.1,Mac:0E-A5-98-22-33,NetType:Wifi,TerminalModel:Lenovo A520,Resolution:720*1280,AppType:TCM参数描述Source 来源 (教学平台/电子书城/增值服务。不限)接口描述Type (类型(0:通知,1:讨论,2:作业,3:普通帖子)根据平台来源获取可选择的帖子类型返回值成功:result:1, PostTypeArray:“0”:”通知”,1”:”讨论”,”2”:”作业”,”3”:”普通帖子”失败:result:0, message:获取帖子类型失败