About EEO System
The EEO provides online teaching solutions, including virtual classrooms and other teaching administration services. The system consists of two parts.
- An application: The ClassIn. The desktop client supports Windows, Mac OS and Chromebooks, and mobile applications for iOS and Android.
- A web-based school dashboard: classin.com.
About ClassIn
You need to install the ClassIn application to use the virtual classrooms and access various virtual teaching and learning functions, such as the IM system, Assignments&Grading, and Learning Reports.
About classin.com
classin.com, the EEO School Dashboard, allows administrators on the account to view information ranging from overall usage to live class data.
If you are a school, you can use the School Dashboard to:
Create courses and lessons, and manage teachers, students, and auditors.
Use the EEO School Drive to store and manage schools’ resources, such as courseware, recordings, course commodities, etc in the cloud.
View data of web-live classes and web playback, and data of events in the classroom, and manage tasks and tests.
Monitor online classes and perform other administrative-related duties.
In addition, the EEO School Dashboard supports API integration with your systems where you can customize the features to suit your needs.
About EEO API
General Concepts
Role Management(Student, Teacher, Administrator, Master Account, Sub-Account, Auditor)
The EEO uses accounts to identify different users and their data. Thus, you must sign up for an account to access the EEO services.
You need to log in to the ClassIn app or School Dashboard to access various services provided by the EEO.
If you are a school, you need to sign up as an Administrator on classin.com to access school administrative services for School Account. You need to submit the required materials to validate your school identity. After verification, your school account can become effective. Only school accounts can apply for API Plan and have the privileges to add teachers, create courses and assign sub-accounts, etc.
Master Account, the owner of the School Account, can assign multiple sub-accounts with different sets of role permissions. Sub-accounts can access the EEO School Dashboard. Granting sub-accounts permission is operated in classin.com, not via API.
The sub-account with permission to monitor classes can launch the ClassIn app through a web link and attend any lessons in the role of the auditor.
To add users to courses/lessons as teachers or students successfully, you need to add users to your school as teachers or students first.
The role of teacher/student/auditor is set by course/lesson. You can be a teacher in a lesson and other roles in other courses or lessons.
The auditor is a role only set for courses, not lessons.
A user can only have one role in a lesson. If you are already a teacher/co-teacher in a lesson, then you can not join the same lesson as a student. Once your role is the course teacher, then you cannot be a student in the same course, and vice versa.
Virtual Classroom(Course and Lesson)
In the EEO system, classrooms are organized into two levels, course and lesson. A course can consist of one or multiple lessons. Virtual classrooms are created with lessons.
For School Accounts, there is no limit on the number of courses.
One course can consist of multiple lessons. The time slots of the lessons should be different to avoid time conflicts for students attending those lessons.
Schools that do not have courses can create a course for each lesson to match the course-lesson structure in the EEO. For example, create a course from the perspective of the teacher or student, depending on your teaching scenario.
EEO Drive
- The EEO provides a cloud storage service, EEO Drive, for each user to store and manage their resources.
The EEO Drive is in a directory structure. Each directory can consist of multiple directories and files. The maximum number of directories is 5000 and 15 level of directories is supported.
You can store various types of courseware such as PPT, Word, PDF, audio, video, and other file types in the EEO Drive.
You can open and view the courseware uploaded in the EEO Drive in virtual classrooms in the ClassIn app.
If you are a teacher, you can open any courseware that ClassIn supports from your personal EEO Drive, My Drive, in the classroom during the class.
If you have signed up as School Account, you can access the service of School Drive in the School Dashboard to manage the school’s courseware, cloud recordings, and commodities.
Schools can specify a directory in the School Drive for a certain course or lesson. During the class, a teacher can open the materials from the directory authorized. The type of materials should be compatible with the ClassIn.
API Concepts
User: Each user must have an account in the EEO. The EEO uses accounts to identify different users and the data happening in their accounts. All users must log in first to access the information about their courses and other functions provided by the EEO.
Course/Lesson: A course comprises one or multiple lessons. You cannot only create an independent lesson without creating a course to contain the lessons. Therefore, you need to create a course first, and then add lessons to the course.
Class Group: When you create a standard course, you automatically create a class group in ClassIn.
About Courses
- Course Name: It displays on the ClassIn application. It is recommended to carefully design the course naming rule to facilitate daily administration.
- Course Cover: The avatar of the Class Group displayed in the ClassIn app. You can edit the Course Cover afterward.
- Course Valid Period: The date of automatically closing the course. Once the course is expired, you cannot edit the course or add more lessons. If the Course Valid Period is not set, the standard course is permanently valid by default and will not be closed automatically. If the Course Valid Period is set, after adding lessons to the course, the Course Valid Period will be extended by 90 days according to the date of the last lesson.
- Course Drive: You can set up a directory to contain the course resources in the School Drive. The instructor can access all the courseware in this directory during the online classes. If you set a directory for a specific lesson, then the instructor can only access the resources in the directory set for the lesson.
- Course Student: Course Students can attend all the lessons in the course, including the lessons created afterward. The total number of the course students is Class Capacity.
- Course Auditors: Auditing students can attend all the lessons in the course, including the lessons created afterward. Teachers and students are completely unaware of the existence of auditing students. You can use the role of Auditors to monitor online classes.
- About Lessons
- Lesson Name: It displays on the ClassIn application. It is recommended to carefully design the lesson naming rule to facilitate daily administration.
- Lesson Start Time: You need to set correct Lesson Start Time and Duration to create a virtual classroom successfully. Teachers can enter the classrooms 20 minutes before the lesson starts, and students/auditors can enter the classrooms 10 minutes before the lesson starts. 20 minutes after the lesson's End Time, teachers and students will force-quit the classroom by the system. The Lesson Start Time must be later than the current time.
- People On-Stage: The maximum number of people On-Stage in the classroom. 1v6 means that up to 1 teacher and 6 students can be on stage.
- Lesson Students: Normally, course students can attend each lesson in the course, however, there are occasions when different students participate in different lessons. In this case, you can use the role of Transfer Student and Dropout Student. If you don’t want a course student to attend certain lessons, you can remove the student and set him/her as a Dropout Student. If you want a student outside of the course to attend a certain lesson in the course, you can add the student to the lesson as a Transfer Student. The identity of Transfer/Dropout Students is set by lessons.
Note: If you want to increase the limits of the number of people on stage, course students (i.e. class capacity), and course auditors, please contact our customer manager.
API Integration
Note: To provide better products and services, the system will carry out routine maintenance in the early morning of the third Tuesday (Beijing time) in the last month of each quarter. Please visit the following link for specific maintenance times.
https://docs.eeo.cn/product/zh-hans/function/System/Maintainance.html#system-maintenance-description
Please make sure that the lesson time does not coincide with the system maintenance time. All API requests during system maintenance will return an error code 901. If the lesson time coincides with the maintenance time, the error code 454 will be returned.
Sync Users
Schools must use users’ real mobile phone numbers or emails to register accounts for users in the EEO (You are welcome to contact us for another account format.).
Before scheduling classes for teachers, you need to add them to your school account as school teachers first. (Via API or operate manually in the School Dashboard).
Use AIPs to create users, modify passwords, edit users, etc.
Create a Course
Use APIs to create, edit and end a course.
Add students and auditors to the course (Optional).
Assign teaching resources stored in the School Cloud Drive for the course (Optional).
Add Lessons to the Course
Use APIs to create, edit and delete a lesson.
Assign the instructing teacher, students (optional), and other users for the lesson.
Website Live Broadcast and Webpage Replay
Use APIs to enable classroom recording, website live broadcast, and webpage replay. To enable website live broadcast and webpage replay, you need to enable classroom recording first. The instructor of the lesson controls the class recording.
You can embed the web-live and replay page into your platform via iframe, and broadcast the live class to a larger scale and attract more potential audiences.
A URL to Launch ClassIn Client from Your Website(Optional)
There are two ways to create the URL.
A. Generate URL according to the rule introduced in the API doc.
B. Call API to get the URL directly
Manage Resources in Cloud Drive (Optional)
- Use APIs to manage files and folders in the School Drive, such as upload, rename and delete files and folders.