班主任.md 5.89 KB

env.url: https://api[api-online.test].boxfish.cn

notes:

  • 默认所有接口都要携带token access_token

班主任接口

今日学情接口

  • URL {env.url}/clazz/consultant/user/plan/learning
  • GET Method
  • path 参数:
  • request 参数:
  • response:

    变量名 类型 必填 说明 示例
    learning Object Y 学情
    unfinished List Y 未完成学生列表
    finished List Y 已完成学生列表
    • 学生列表:
    变量名 类型 必填 说明 示例
    user_id Long Y id
    user_real_name String Y 用户名字
    figure_url String Y 头像
    courses List N 已完成课程列表
    lesson String Y 课程ID
    course_type_group_type List Y 课程类型
    course_type_group_name List Y 课程类型显示名
    completion_grade List Y 成绩
    {
    "learning": {
        "unfinished": [{
            "user_id": 9200,
            "user_real_name": "吕寰",
            "figure_url": "https://avatars.boxfish.cn/user/9200/figure/1516946382.jpg"
        }],
        "finished": [{
            "user_id": 7566,
            "user_real_name": "low",
            "figure_url": "https://avatars.boxfish.cn/user/7566/figure/1563170627.jpg",
            "courses": [{
                    "lesson": "L3NoYXJlL3N2bi9MZXZlbCAzX0Z1bmN0aW9uMS8wMjgu5aaC5L2V6K-i6Zeu5LuK5aSp5piv5ZGo5Yeg77yfLnhsc3g",
                    "course_type_group_type": "KNOWLEDGE",
                    "course_type_group_name": "AI知识点拓展课",
                    "completion_grade": "C"
                },
                {
                    "lesson": "L3NoYXJlL3N2bi9MZXZlbCAyX-WNleivjeeUqOazlTIvMjEyLuWNleivjeeUqOazlV93ZWVrIOaYn-acn-Wbm-WIsOaYn-acn-aXpS54bHN4",
                    "course_type_group_type": "KNOWLEDGE",
                    "course_type_group_name": "AI知识点拓展课",
                    "completion_grade": "A_PLUS"
                }
            ]
        }]
    }
    }   
    

用户规划课程接口

  • URL {env.url}/clazz/consultant/user/{userId}/plan/course
  • GET Method
  • path 参数:

    变量名 类型 必填 说明 示例
    userId Long Y 学生id
  • request 参数:

  • response:

    变量名 类型 必填 说明 示例
    user_id Long Y id
    user_real_name String Y 用户名
    figure_url String Y 用户名
    user_with_mobile String Y 用户手机号
    plan_days String Y 规划的时间
    plan_course_count_info String Y 课程完成情况
    version String Y 用户名
    user_plan_course List Y 用户名
    {
    "user_id": 7566,
    "user_real_name": "low",
    "figure_url": "https://avatars.boxfish.cn/user/7566/figure/1563170627.jpg",
    "user_with_mobile": "13661354560",
    "plan_days": "每周二、三、四、五、六、七学习",
    "plan_course_count_info": "共37课,已完成6课",
    "version": "北京版二年级上",
    "user_plan_course": {
        "user_id": 7566,
        "plan_day": 14,
        "plan_goal": "天达到二年级上优秀",
        "plan": [{
            "title": "DAY 1",
            "date": "2020-07-28",
            "date_title": "7月28日 周二",
            "courses": [{
                    "id": "L3NoYXJlL3N2bi9MZXZlbCAzX0Z1bmN0aW9uMS8wMjgu5aaC5L2V6K-i6Zeu5LuK5aSp5piv5ZGo5Yeg77yfLnhsc3g",
                    "name": "如何询问今天是周几?",
                    "knowledge": "What day is today?",
                    "cover": "e35d7ee19e0b934c3893f0d030af12bb",
                    "level": "3",
                    "lastModified": 1573814347821,
                    "student": true,
                    "teacher": true,
                    "finished": true,
                    "sequence": 1240,
                    "free": true,
                    "locked": false,
                    "unit": "Unit1",
                    "knowledgeSystems": [{
                        "knowledgeSystemOne": "communication",
                        "knowledgeSystemTwo": "描述时间",
                        "knowledgeSystemThree": "日期"
                    }],
                    "planCoefficient": 15,
                    "knowledge_type": "功能对话",
                    "course_type": "FUNCTION",
                    "course_type_v2": "COMMUNICATION",
                    "completion_grade": "C",
                    "review_class": true,
                    "course_type_group": "知识点",
                    "is_paper": false,
                    "knowledge_count": "4",
                    "phrase_count": "1",
                    "opening_count": "18+",
                    "nationalKnowledge": [
                        "What day is it today?",
                        "what引导的特殊疑问句",
                        "日常生活-人际交往"
                    ],
                    "internationalKnowledge": [
                        "描述时间-日期"
                    ],
                    "basic_knowledge": true,
                    "basic_word": false,
                    "course_type_group_name": "AI知识点拓展课",
                    "course_type_group_type": "KNOWLEDGE"
                },
                {
                    "id": "L3NoYXJlL3N2bi9MZXZlbCAyX-WNleivjeeUqOazlTIvMjEyLuWNleivjeeUqOazlV93ZWVrIOaYn-acn-Wbm-WIsOaYn-acn-aXpS54bHN4",
                    "name": "单词用法_week 星期四到星期日",
                    "knowledge": "星期week: Thursday/Friday/Saturday/Sunday",
                    "cover": "267c51a8e5291f28119b0d520477417a",
                    "level": "2",
                    "lastModified": 1517217115584,
                    "student": true,
                    "teacher": true,
                    "finished": true,
                    "sequence": 1220,
                    "free": true,
                    "locked": false,
                    "unit": "Unit1",
                    "planCoefficient": 15,
                    "knowledge_type": "词汇组合与用法",
                    "course_type": "WORD",
                    "course_type_v2": "WORDS_EXPRESSIONS",
                    "completion_grade": "A_PLUS",
                    "review_class": true,
                    "course_type_group": "知识点",
                    "is_paper": false,
                    "knowledge_count": "1",
                    "phrase_count": "1",
                    "opening_count": "18+",
                    "nationalKnowledge": [
                        "星期week: Thursday/Friday/Saturday/Sunday"
                    ],
                    "basic_knowledge": true,
                    "basic_word": false,
                    "course_type_group_name": "AI知识点拓展课",
                    "course_type_group_type": "KNOWLEDGE"
                }
            ]
        }]
    }
    }