Data format for importing as a school

Please include the following files, each a CSV file with the columns as described (in that order). The files should be in one folder that is zipped.

When dealing with data for a single school, the school_id values across all these files should be a preset constant value that has been communicated with Edusight for setup before a sync is attempted. Any data in these files that does not have a school_id matching the expected value will be filtered out before syncing begins to guarantee compatibility with systems that can potentially export multiple schools' worth of data.

schools.csv

This should contain only a single row for your school

CSV Columns: name, id_number

name: String # required
id_number: String # required, unique
semester_id: string #required, sets the current semester for the school

students.csv

CSV Columns: first_name, last_name, nick_name, school_id_number, email, id_number, grade_level, gender

first_name: String # required
last_name: String # required
nick_name: String # optional
school_id_number: String # required
email: String # optional
id_number: String # required, unique
student_id: String # optional, can be specified if the student's ID number differs from the unique ID number above
grade_level: String # optional, currently unused
gender: String # optional, currently only used for Trillium export purposes
date_of_birth: String # optional, currently only used for Trillium export purposes
trillium_id_number: String # optional, currently only used for Trillium export purposes

teachers.csv

CSV Columns: first_name, last_name, title, nick_name, school_id_number, email, id_number

first_name: String # required
last_name: String # required
title: String # optional (ex. "Mr", "Miss")
nick_name: String # optional
school_id_number: String # required
email: String # required, this is required because teachers will need accounts to access Edusight
id_number: String # required, unique
role: One of: ['teacher', 'teacher_open', 'teacher_super', 'admin_s'] # optional, defines whether this is a teacher or an administrator; defaults to 'teacher' if not set

semesters.csv

CSV columns: id_number,school_id_number,start,end,description

id_number: String # required
school_id_number: String # required, joined with schools.csv
start: String
end: String
description: String

classrooms.csv

CSV Columns: name, id_number, course, section, description, school_id_number

name: String # required
id_number: String # required, unique
course: String # optional
section: String # optional
description: String # optional
school_id_number: String # required, joined with schools.csv
semester_id: String # required, joined with semesters.csv
type: One of: ['ktca','sbg'] # optional, defines the classroom type; defaults to 'ktca' if not set
grade_level: String # optional, currently unused

For a more thorough explanation of the classroom types, see Classroom Types for details.

enrolments.csv

CSV Columns: student_id, classroom_id

This is effectively a join table between students and classrooms

student_id: String # required
classroom_id: String # required

teachers_classrooms.csv

CSV Columns: teacher_id, classroom_id

This is effective a join table between teachers and classrooms

teacher_id: String # required
classroom_id: String # required
permission: One of: ['read','write', 'teacher'] # optional, defaults to "teacher" if not set

Specific permissions can be set up to reflect one of three modes of access to a classroom: 'read', 'write', and 'teacher.' The different permission levels are explained in greater detail here.

azure_logins.csv (optional)

CSV columns: azure_object_id,id_number,school_id_number

This file allows the management of Azure logins by linking a student or teacher account by ID with an Azure object ID. Each row should contain an Azure ID, an account ID number correlating with either of teachers.csv or students.csv, and the school that record exists within.

azure_object_id: String # required
id_number: String # required
school_id_number: String # required

terms.csv (optional)

Describes reporting terms that should be set up in this district.

id_number: String # required, uniquely identifies a term within a school
start: String (yyyy-mm-dd) # required, identifies the start date for this reporting term
end: String (yyyy-mm-dd) # required, identifies the end date for this reporting term
description: String # optional, a friendly name for this reporting period ("Final Reporting", "Interim Report", etc
semester_id_number: String : # required, identifies the semester this term is a part

parents.csv (optional)

Attaches parent information to student records

school_id: String # required, identifies the school this student is in
student_id: String # required, identifies the student for this parent
parent_email: String # required, defines the parent's contact e-mail
parent_first_name: String # optional, defines the parent's first name
parent_last_name: String # optional, defines the parent's last name

results matching ""

    No results matching ""