Mirror the partner's data including school branches, classrooms, students, and teachers. Completing this step is required before generating SSO links for teachers and students, enabling seamless access to experiments and classroom management.
{Tenant
endpoint}/api/v2/mirror-data/branches
Send the partner's school and branch data to our system. Includes branches,
classrooms,
students,and teachers.
Tenant endpoint example:
yoursubdomain.jusoorlabs.com
Note: Data synchronization may take time depending on size
as it uses queues.
| Name | Required | Type | Description |
|---|---|---|---|
| referer | YES | string | Provided by Jusoor Labs to identify your app (your website at jusoorlabs.com). |
| accept | YES | string | Set as application/json |
| token | YES | string | Your API token from Jusoor Labs. |
| Name | Required | Type | Description |
|---|---|---|---|
| branches | YES | Array | An array containing one or more school objects with nested classrooms, sections, subjects, teachers, and students. |
| branches.id | YES | Integer | Unique identifier for the school. |
| branches.name | YES | String | Name of the school. |
| branches.classes | YES | Array | Array of class objects associated with the school. |
| branches.classes.id | YES | Integer | Unique identifier for the class. |
| branches.classes.name | YES | String | Name of the class. |
| branches.classes.sections | YES | Array | Array of section objects within the class. |
| branches.classes.sections.name | YES | String | Unique identifier for the section. |
| branches.classes.sections.subjects | YES | Array | Array of subject objects taught in the section. |
| branches.classes.sections.subjects.id | YES | Integer | Unique identifier for the subject. |
| branches.classes.sections.subjects.name | YES | String | Name of the subject. |
| branches.classes.sections.subjects.teachers | YES | Array | Array of teacher objects associated with the subject. |
| branches.classes.sections.subjects.teachers.uuid | YES | String | Unique identifier for the teacher. |
| branches.classes.sections.subjects.teachers.name | YES | String | Name of the teacher. |
| branches.classes.sections.students | YES | Array | Array of student objects enrolled in the section. |
| branches.classes.sections.students.uuid | YES | String | Unique identifier for the student. |
| branches.classes.sections.students.name | YES | String | Name of the student. |