[[TOC]]

= 摩登学院1.0.0接口文档 =
>mrobot代理环境说明： 
     192.168.10.198：1080(192.168.74.80)[[BR]] 
     192.168.10.199 端口为 1080 连的是dev40的开发环境（192.168.75.40）[[BR]] 
     ps1:未到qa阶段，连开发环境调试（若仅做代理，mrobot不存在真正的处理文件，只作转发的功能） [[BR]] 
     ps2:common_session_id都是在cookies中添加此参数，测试环境为common_session_id1 [[BR]]

     [http://192.168.33.102/CAT/index.html "框架"][[BR]]
     [http://192.168.50.171/2015/2015-12-02/index.html "设计稿地址"][[BR]]
     [http://rdtrac.pc.com.cn/iphone/wiki/pclady_modern1.0.0终端协议 "终端协议"][[BR]]

==  1.公用接口 ==
----------

=== 1.1新增用户 ===

开发环境：http://dev15.pclady.com.cn/app/addUser.jsp  [[BR]]
线上环境：http://modern.pclady.com.cn/app/addUser.jsp [[BR]]

**说明**

>初次登录后，通知平台添加用户

**缓存时间**

>0

**提交方式**

>POST

**是否登录**

>是

**数据来源**

> passport

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||

**返回**

{{{#!java
{
  status:0,
  msg:”请求成功”
}

}}}

**返回参数说明**
||= 参数名 =||= 参数含义 =||
||= status =||= 0:成功，-1：已存在，-2：用户被禁用 ,-3：其它原因=||


=== 2.2启动上报 ===
开发环境：http://dev15.pclady.com.cn/app/reportStartUp.jsp  [[BR]]
线上环境：http://modern.pclady.com.cn/app/reportStartUp.jsp [[BR]]

**说明**

> 当天用户第一次启动时，需要上报一次。便于判断活跃度，以后发送通知时会用到

**缓存时间**

>0

**提交方式**

> POST

**是否登录**

> 是

**数据来源**

>魔方token

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||==||
||= type =||= 客户端类型 =||= int =||= "" =||= 否 =||= 1:IOS,2:Android =||
||= token =||= 魔方推送apns token =||= String =||= "" =||= 否 =||= IOS为魔方的token,安卓为deviceid =||

**返回**

{{{#!java
{
  "status":0,
  "msg":"请求成功"
}

}}}
**返回参数说明**
||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||

----------

== 2.首页 ==

=== 2.1首页 ===
开发环境：http://dev15.pclady.com.cn:8004/app/index.jsp [[BR]]
线上环境：http://modern.pclady.com.cn/app/index.jsp [[BR]]
mrobot地址：http://mrobot.pclady.com.cn/x-300/modern/app/index.jsp

**说明**

> 根据需求文档返回对应的节点[[BR]]
> 由于需要查询正在直播的视频，先不考虑缓存[[BR]]

**缓存时间**

>0

**提交方式**

> GET

**是否登录**

> 否

**数据来源**

>摩登后台

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||=说明=||

**返回**

{{{#!java
{
    "status": 0,
    "msg": "请求成功",
    "focus": [
        {
            "typeName": "焦点图类型",
            "imageUrl": "http://img.pconline.com.cn/7.jpg",
            "url": "外链url",
            "contentId": "14324"
        }
    ],
    "recommend": [
        {
            "contentId": 1111,
            "typeName": "推荐类型,类型同焦点图",
            "imageUrl": "http://img.pconline.com.cn/7.jpg",
            "url": "外链url",
            "recommendId": "14324",
            "title": "标题",
            "desc": "推荐描述"
        }
    ],
    "liveVideo": [
        {
            "courseId": 11,
            "liveType": 1,
            "imageUrl": "http://img.pconline.com.cn/7.jpg",
            "techId": 1111,
            "techJobName": "××御用化妆师",
            "techNickName": "老师姓名",
            "techIconUrl": "http://img.pconline.com.cn/7.jpg",
            "techType": 1,
            "title": "课程标题",
            "startTime": "MM.dd hh:mm",
            "watchTotal": 100
        }
    ],
    "teacher": [
        {
            "techId": 111,
            "techJobName": "××御用化妆师",
            "techNickName": "老师姓名",
            "techIconUrl": "http://img.pconline.com.cn/7.jpg",
            "techType": 1
        }
    ],
    "chosenVideo": [
        {
            "courseId": 11,
            "liveTime": "6'33''",
            "imageUrl": "http://img.pconline.com.cn/7.jpg",
            "techId": 1111,
            "techJobName": "××御用化妆师",
            "techNickName": "老师姓名",
            "techIconUrl": "http://img.pconline.com.cn/7.jpg",
            "techType": 1,
            "title": "课程标题",
            "watchTotal": 100,
            "tag": [
            {
                "tagId": 11,
                "tagName": "标签"
            }
        ]
        }
    ],
    "hotVideo": [
        {
            "courseId": 11,
            "liveTime": "6'33''",
            "imageUrl": "http://img.pconline.com.cn/7.jpg",
            "techId": 1111,
            "techJobName": "××御用化妆师",
            "techNickName": "老师姓名",
            "techIconUrl": "http://img.pconline.com.cn/7.jpg",
            "techType": 1,
            "title": "课程标题",
            "watchTotal": 100
        }
    ]
}

}}}
**返回参数说明**
||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
||= typeName =||= 直接课:liveCourse，视频课程:videoCourse，一对一课程:lesson，老师:teach，标签:tagInfo，外接:webview =||= focus =||= 焦点图节点，返回5张焦点图 =||
||= recommend =||= 推荐节点，返回三条 =||=liveVideo =||= 直播视频节点，3条 =||
||= liveType =||= 1:直播,2:预告 =||=imageUrl =||= liveVideo节点中为封面图 =||
||= techID =||= 老师ID =||=techJobName =||= 头衔 =||
||= startTime =||= 如果为预告，要返回开始时间 =||=watchTotal =||= 如果是直播，返回观看人数 =||
||= techIconUrl =||= 老师等级icon =||=techType =||= 老师类型，1：老师，2：达人 =||
||= teacher =||= 老师推荐节点，7条 =||=chosenVideo =||= 精选直播课节点，3条 =||
||= liveTime =||= 视频时长 =||=tag =||= 标签，最多三个 =||
||= hotVideo =||= 热点视频节点，6个 =||=tag =||= 标签，最多三个 =||
[[BR]]


----------
== 3.公开课 ==

=== 3.1获取公开课列表 === 
开发环境：http://dev15.pclady.com.cn/app/courseList.jsp  [[BR]]
线上环境：http://modern.pclady.com.cn/app/courseList.jsp [[BR]]
mrobot地址：http://mrobot.pclady.com.cn/x/modern/app/courseList.jsp

**说明**

>获取公开课列表,默认加载10条[[BR]]
>显示顺序：正在直播和预告优先显示。其余按回顾直播课的开始时间、视频教程的启用时间，新到旧排列[[BR]]
> 由于需要查询正在直播的视频，先不考虑缓存[[BR]]

**缓存时间**

>0分钟

**提交方式**

>GET


**是否登录**

> 否

**数据来源**

> 后台

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||pageNo||页数||int||1||是||
||pageSize||页面大小||int||10||是||

**返回**

{{{#!java
{
    "status": 0,
    "msg": "请求成功",
    "pageNo": 1,
    "pageSize": 20,
    "total": 100,
    "data": [
        {
            "courseId": 11,
            "liveType": 1,
            "liveTime": "6'33''",
            "startTime": "MM.dd hh:mm",
            "imageUrl": "http://img.pconline.com.cn/7.jpg",
            "techId": 1111,
            "techJobName": "××御用化妆师",
            "techNickName": "老师姓名",
            "techIconUrl": "http://img.pconline.com.cn/7.jpg",
            "techType": 1,
            "title": "课程标题",
            "watchTotal": 100,
            "tag": [
            {
                "tagId": 11,
                "tagName": "标签"
            }
        ]
        }
    ]
}

}}}

**返回参数说明**
||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
||= liveType =||= 1:直播,2:预告,3:视频教程 =||= liveTime =||= 视频时长 =||
||= imageUrl =||= 封面图 =||=watchTotal =||= 如果是直播，返回观看人数 =||
||= techID =||= 老师ID =||=techJobName =||= 头衔 =||
||= startTime =||= 如果为预告，要返回开始时间 =||=tag =||= 标签，最多三个 =||
||= techIconUrl =||= 老师等级icon =||=techType =||= 老师类型，1：老师，2：达人 =||
[[BR]]


=== 3.2直播课终端页 === 
开发环境：http://dev15.pclady.com.cn/app/liveCourseInfo.jsp  [[BR]]
线上环境：http://modern.pclady.com.cn/app/liveCourseInfo.jsp [[BR]]
mrobot地址：http://mrobot.pclady.com.cn/x/modern/app/liveCourseInfo.jsp

**说明**

>直播课和预告终端页[[BR]]

**缓存时间**

>0分钟

**是否登录**

> 是

**提交方式**

>GET

**数据来源**

> 后台

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||pageNo||页数||int||1||是||
||pageSize||页面大小||int||10||是||

**返回**

{{{#!java
{
    "status": 0,
    "msg": "请求成功",
    "data": {
        "courseId": 11,
        "liveType": 1,
        "title": "课程标题",
        "courseUrl": "http://view.mp4",
        "timeCount": "120",
        "startTime": "YYYY-MM-dd hh:mm",
        "shareUrl": "http://wap.pclady.com.cn/111.html",
        "isSignUp": 1,
        "isCollect": 1,
        "type": 1,
        "oldPrice": 100,
        "price": 50,
        "signUpTotal": 100,
        "techId": 1111,
        "techJobName": "××御用化妆师",
        "techNickName": "老师姓名",
        "techIconUrl": "http://img.pconline.com.cn/7.jpg",
        "techType": 1,
        "techDesc": "老师描述",
        "isFollow": 1,
        "isGood": 1,
        "tag": [
            {
                "tagId": 11,
                "tagName": "标签"
            }
        ],
        "courseDesc": "课程描述",
        "courseList": [
            {
                "courseId": 11,
                "liveType": 1,
                "liveTime": "6'33''",
                "startTime": "MM.dd hh:mm",
                "imageUrl": "http://img.pconline.com.cn/7.jpg",
                "title": "课程标题"
            }
        ],
        "watchIng": [
            "11",
            "222"
        ]
    }
}

}}}

**返回参数说明**
||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
||= liveType =||= 1:直播,2:预告 =||= courseUrl =||= 视频地址 =||
||= startTime =||= 开始时间，预告需要返回 =||=timeCount =||= 倒计时，单位为秒，预告需要返回 =||
||= shareUrl =||= 分享的wap地址 =||=isSignUp =||= 是否报名，1：是，0：否 =||
||= title =||= 课程标题 =||=isSignUp =||= 是否收藏，1：是，0：否 =||
||= type =||= 上课方式，1:直播课,2:一对一 =||=price =||= 价格 =||
||= oldPrice =||= 原价 =||=signUpTotal =||= 报名人数 =||
||= techID =||= 老师ID =||=techJobName =||= 头衔 =||
||= techIconUrl =||= 老师等级icon =||=techType =||= 老师类型，1：老师，2：达人 =||
||= isFollow =||= 是否关注老师，1：是，0：否 =||=tag =||= 标签，最多三个 =||
||= isGood =||= 是否点赞，1：是，0：否 =||=courseList =||= 相关课程，两条 =||
||= watchIng =||= 正在看的用户ID，最多6条，直播需要返回=||= =||=  =||
[[BR]]


=== 3.3直播课终端页问答列表 === 
开发环境：http://dev15.pclady.com.cn/app/requestList.jsp  [[BR]]
线上环境：http://modern.pclady.com.cn/app/requestList.jsp [[BR]]
mrobot地址：http://mrobot.pclady.com.cn/x/modern/app/requestList.jsp

**说明**

>问答列表[[BR]]

**缓存时间**

>0分钟

**是否登录**

> 是

**提交方式**

>GET

**数据来源**

> 后台

**参数**

||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||
||pageNo||页数||int||1||是||
||pageSize||页面大小||int||10||是||

**返回**

{{{#!java
{
    "status": 0,
    "msg": "请求成功",
    "data": [
        {
            "requestId": 11,
            "userId": 111,
            "nickName": "昵称",
            "message": "问题内容",
            "techIconUrl": "http://img.pconline.com.cn/7.jpg",
            "imageUrl": "http://img.pconline.com.cn/7.jpg",
            "createTime": "MM-dd hh:mm",
            "supportTotal": 10,
            "replyList": [
                {
                    "replyId": 11,
                    "message": "回复内容",
                    "createTime": "MM-dd hh:mm",
                    "nickName": "昵称",
                    "userId": 111
                }
            ]
        }
    ]
}

}}}

**返回参数说明**
||= 参数名 =||= 参数含义 =||=参数名=||=参数含意=||
||=  =||= =||= =||=  =||
[[BR]]