Updated 在线授课接口定义 (markdown)

@@ -34,64 +34,78 @@ http://192.168.0.100:8098  新版链接 自动生成群id和chat_room_id,自动
 ...
 ...
 ```
 ```
 
 
-### 获取在线授课必备信息
-说明：授课客户端需要获取**在线授课必备消息**和**听课学生基本信息**
+#显示学生、课程等信息
+
+> 说明：授课客户端需要获取**在线授课必备消息**和**听课学生基本信息**
+> 
+> 显示学生信息，课程信息，饼图，柱状图
+> 
+> 返回值里的course_type_ratio(饼图) 信息还未确定，暂返回空
 
 
 接口地址：/teaching/student/info
 接口地址：/teaching/student/info
 
 
-Request Method： GET
+请求方式：GET
 
 
-Request Params：
+Request params：
 
 
-|参数名         |是否必须    |说明    |参数类型            |
-|--------------|-----------|--------|-------------------|
-|work_order_id |是         |工单id  |Long                |
-|student_id    |是         |测试时必填参数，此id应该根据work_order_id来获取|Long     |
-|teacher_id    |是         |测试时必填参数，此id应该根据work_order_id来获取|Long     |
 
 
-与工单中心对接后，则删除student_id 和 teacher_id 参数
+|参数名         |是否必须    |说明     |参数类型            |
+|--------------|-----------|--------|-------------------|
+|work_order_id |是         |工单id   |Long               |
+|student_id    |是         |学生id   |Long               |
+|lesson_id     |是         |课程id   |String             |
 
 
-**调完这个接口，老师和学生就已经加到返回的群里了**
 
 
-**腾讯云的用户identifier 为盒子鱼用户id的md5值**
+**腾讯云的用户identifier 为盒子鱼用户id的小写md5值**
 
 
 
 
 Response：
 Response：
 
 
 ```json
 ```json
 {
 {
+  "student_detail": {
     "student_info": {
     "student_info": {
-        "student_name": "孙尚香",
-        "student_id":12938,
-        "goal": "融入美国中学课堂",
-        "word_count": 2800,
-        "read_count": 23000,
-        "listen": "4小时43分",
-        "spoken": "3小时18分"
+      "real_name": "Mmm",
+      "figure_url": "http://avatars.boxfish.cn/user/12938/figure/1423708364.jpg",
+      "level": 6,
+      "level_name": "滔滔6级"
+    },
+    "lesson_info": {
+      "id": "L3NoYXJlL3N2bi8yMDE1MDkxMOa1i-ivleaooeadvy8wMTMu5qih5p2_5ZCI6ZuGLnhsc3g",
+      "name": "模板合集",
+      "lastModified": 1445001009175,
+      "cover": "10fb562cdc2b3c184a418c1c18d0d8b8"
+    },
+    "achievement_info": {
+      "read_word_count": 0,
+      "listening_time": 0,
+      "record_time": 0,
+      "word_count": 209
     },
     },
-    "group_name": "boxfish-class001",
-    "group_id": "@TGS#2AA4BQAEN",
-    "chat_room_id": "100001"
+    "course_type_ratio": {}
+  },
+  "group_room_info": {
+    "group_name": "BOXFiSH Online Teaching Group",
+    "group_id": "@TGS#2SMUBTAER",
+    "chat_room_id": 359755386104019
+  }
 }
 }
 ```
 ```
 
 
-### 通知学生开始上课
-说明：通知某次课程相应的学生准备上课，通过发送推送信息的方式通知给学生。推送的通知中应该包括**在线授课必备消息**和**授课教师的基本信息**
+# 发推送 - 通知学生开始上课
+> 说明：通知某次课程相应的学生准备上课，通过发送推送信息的方式通知给学生。推送的通知中应该包括**在线授课必备消息**和**授课教师的基本信息**
+> 
+
+接口地址：/teaching/student/push
 
 
-接口地址：/teaching/student/push  :连接云数据库
+请求方式：GET
 
 
-         /teaching/student/push_local  :连接本地数据库
+Request params：
 
 
-Request Method： GET
+|参数名           |是否必须   |说明     |参数类型     |
+|----------------|----------|--------|------------|
+|work_order_id   |是        |工单id   | Long       |
 
 
-|参数名    |是否必须   |说明     |参数类型     |
-|----------|----------|--------|-------------|
-|user_id   |否        |用户id，即JPush别名,默认为 12938    | Long   |
-|title     |否       |推送的title，默认为"boxfish_push_test"|String  |
-|production|否       |是否为正式环境，true为正式环境，false为测试环境 |boolean  |
-|group_name|否       |群名称，默认是 boxfish-class001|String   |
-|group_id  |否       |群id，默认是 @TGS#2AA4BQAEN  |String     |
-|chat_room_id|否    |默认是 100001     |Long      |
 
 
 推送json：
 推送json：
 
 
@@ -106,54 +120,90 @@ Request Method： GET
 }
 }
 ```
 ```
 
 
-###课程结束接口
+# 课程正常结束接口
 接口地址：/teaching/student/finish
 接口地址：/teaching/student/finish
 
 
-Request Method: POST
+请求方式： POST
+
+Request params：
+
+|参数名         |是否必须   |说明     |参数类型   |
+|--------------|----------|--------|----------|
+|work_order_id |是        |工单id   |Long      |
 
 
-|参数名    |是否必须   |说明     |参数类型   |
-|----------|----------|--------|-----------|
-|lesson_id |是        |课程id  |String     |
-|teacher_id|是        |老师id  |Long       |
-|group_id  |是        |群组id  |Long       |
 
 
 返回值：
 返回值：
 
 
 status code：200
 status code：200
 
 
-###课程结束评价接口
-接口地址：/teaching/evaluation
 
 
-Request Method: POST
 
 
-|参数名         |是否必须   |说明    |参数类型   |
-|--------------|----------|--------|-----------|
-|work_order_id |是        |工单id  |Long       |
-|score         |是        |评分    |int        |
-|evaluation    |否        |评价    |String      |
-|source_id     |是        |评价人id|Long        |
-|target_id     |是        |被评价人id|Long      |
 
 
 
 
+# 房间进入状态回调接口
 
 
-###房间进入状态回调接口
+> 说明：老师进入房间、学生进入房间各回调一次
 
 
 接口地址：/teaching/callback/chat_room
 接口地址：/teaching/callback/chat_room
 
 
 请求方式：POST
 请求方式：POST
 
 
-Request参数：
+Request body：
 
 
-|参数名         |是否必须   |说明    |参数类型   |
-|--------------|----------|--------|-----------|
-|work_order_id |是        |工单id  |Long       |
-|user_id       |是        |用户id  |Long        |
-|chat_room_id  |是        |房间号id|Long        |
-|type          |是        |用户类型 |STUDENT or TEACHER|
-|is_entered    |是        |进入状态 |boolean true or false |
+```
+{
+	"userId":12938,
+	"type":"TEACHER",
+	"workOrderId": 34,
+	"chatRoomId":12345
+}
+```
 
 
 Response
 Response
 
 
+status code: 200
+
+# 客户端断线重连获取课程状态
+> 说明：
+
+接口地址：/teaching/course/status
+
+请求方式：GET
+
+Request params：
+
+
+|参数名         |是否必须   |说明     |参数类型   |
+|--------------|----------|--------|----------|
+|work_order_id |是        |工单id   |Long      |
+
+Response：
+
+```
+{
+	"recover": true
+}
+```
+
+# 学生端未收到上课推送主动发起上课接口
+
+> 说明：
+
+接口地址：/teaching/student/enter_class
+
+请求方式：GET
+
+Request params：
+
+|参数名         |是否必须   |说明     |参数类型   |
+|--------------|----------|--------|----------|
+|work_order_id |是        |工单id   |Long      |
+
+Response:
+
 ```
 ```
-......
+
+{
+    ...
+}
 ```
 ```