How to Add Users and Schedule Classes for the User Quickly

Basic API Integration Solution: It enables you to synchronize data of users and classrooms from your system to the ClassIn. This session introduces APIs you are going to call from your system's backend when a student registers and joins in a class in your platform.

Note: This solution can solve to synchronize data through APIs and to finish the integration quickly. In order to better integrate your platform to ClassIn, it is necessary to integrate other functions such as modifying and deleting relevant data

About Data Synchronization

  • In API integration, data is synchronized in a single direction, from your system to ClassIn, which means operations in the School Dashboard and the ClassIn app will not be synchronized back to your system. Currently, we do not support the GET method. To avoid data conflict between the two systems, you should:

    • 1. Store data related to users and their courses/lessons in your database for your future reference.
    • 2. Do not permit sub-accounts to operate Teaching tab in the School Dashboard unless it is necessary.
    • 3. When creating a course, do not set the head teacher(course advisor) unnecessarily.

1. Add Users

  • Before scheduling classes for teachers and students, you need to map the users' accounts in the two systems, the EEO and your own system. The overall steps are to register a ClassIn account for the user and get the user's UID in the ClassIn, and then add the user to your ClassIn school account. UID is the unique identifier of the user in ClassIn. One UID can have multiple identities in a school, such as school teacher, student, or sub-account in the School Dashboard, etc

1.1 Steps

  • To obtain the user's UID, you can call user registration interface. Please refer to Register User for detailed information. Make sure to pass the addToSchoolMember parameter to add the user with the desired identity.
  • Alternatively, you can add users to the school by calling the Add Teacher or Add School Student interfaces. However, it is recommended to use the register user interface to complete the registration process and add the teacher or student identities.

1.2 Notes

  • 1. When the user account is already registered in ClassIn, by passing addToSchoolMember, the user will still be added to the school's admin dashboard and assigned the corresponding identity. However, the account password, avatar, and nickname will not be reset.
  • 2. The data returned by the interfaces of adding school teachers and students is the relationship ID between the user and the school. This parameter should not be used during class scheduling. You need to use the UID returned by the interface of registration.

2. Schedule Classes

2.1 Mode A: School's Admin Staff Arranges Classes For Students

  • The admin staff or teachers in your school need to create courses first, and add students to courses, and create lessons on your platform in advance. For students, they only need to attend the virtual classroom when lessons start.

Notes：You need to add users to your school first. Let the user has a valid identity in your school. Then can you arrange courses and lessons for the school teachers and students successfully.

2.2 Mode B：Students Book Classes Direclty

  • Notes：You need to add users to your school first. Let the user has a valid identity in your school. Then can the student book classes successfully on your platform.

results matching ""

    No results matching ""