Rostering

API

Studies Weekly can receive your district's roster data and information through an API connection that is compatible with OneRoster. If your student information system (SIS) is OneRoster compatible, Studies Weekly will provide a way for your district to send us your credentials to connect with us directly. 

ClassLink is OneRoster certified, which means we integrate well with ClassLink through API. ClassLink provides a launchpad for your users to access Studies Weekly while only having to login to one place to access your Studies Weekly publication(s). 

CSV Roster Sync Instructions

If sending us user data through an API is not an option for your district, Studies Weekly has CSV files that can be filled out and managed through your district admin account. The CSV data files you upload will allow you to more smoothly create and manage teacher and student accounts, as well as teacher classrooms.

  1. To synchronize your district’s roster data with Studies Weekly, export roster data from your SIS in the format defined in the example files.
  2. After these files are prepared, upload them to our SFTP server. We sync these files with our system each night. 
    To synchronize your district’s roster data with Studies Weekly, prepare the following five CSV files (the sixth being optional) containing information about schools, teachers, students, and classes. Example CSV files can be found below.
    After these files are prepared, upload them to our SFTP server using your district credentials. For information about the SFTP server or to request credentials, please contact our rostering support team.

 Important

  • The names of the CSV files you upload must match the following file names exactly.
  • The CSV files must be UTF-8 encoded.
Five CSV Files

 schools.csv

This file is used to provide us with each school in your district that will be using Studies Weekly. This file is required in order for your users to see the publications your district has purchased.

 teachers.csv

We will use the teacher's email address as their username and email them their login information. They can then change their password, but not their username.

 students.csv

This file will be used to set students’ usernames and passwords.

For Google SSO, this file will contain 4 columns: student name, student email, student ID and username. The google hosted email address must be assigned in the username column.

For custom usernames and/or passwords, this file will contain 5 columns: student name, student email, student ID, username, password.*

*Each password must be at least 5 characters and include a number. If no password is provided, please include the header in the file, and we will auto generate one for you.

 classes.csv

A class's main teacher is specified here. Additional teachers can be assigned to a class in the teacher_class.csv file. In order for your teachers to have a classroom online, a classroom needs to be declared in this file.

 student_class.csv

Use this file to assign a student to a class here. If you find that one of your teachers is missing a student, you can check this file to ensure they are assigned to their teacher accordingly. 

 teacher_class.csv (optional)

If a class has multiple teachers, specify the other teachers here. The main teacher will be assigned in the classes.csv file. 

Every evening Studies Weekly will retrieve the files on the server and process them, updating your teacher and student accounts on Studies Weekly with the most recent information. The files will not be deleted after they are processed. However, the latest files will reflect on SWO as you may expect.

If you have any questions, please contact our rostering support team.

 

Support

  1. For information about the SFTP server, to request SFTP credentials, or to request district admin credentials, please contact our rostering support team at rostering@studiesweekly.com
  2. If anything is not working as expected, please contact our rostering support team at rostering@studiesweekly.com

 

Third-Party Integrations

  • ClassLink solves single sign-on and class roster challenges by providing identity authentication, single sign-on through OAuth connections, and OneRoster API services. Studies Weekly can import your school's roster directly from ClassLink to synchronize your schools' user accounts each night. ClassLink will also provide a central login portal for students from which they can jump to different learning material content providers, such as Studies Weekly.
  • Clever also solves single sign-on and class roster challenges by providing identity authentication, single sign-on through API connections. Studies Weekly can view your school's roster directly on Clever to ensure the data is coming over as expected. Clever will also provide a central login portal for students from which they can jump to different learning material content providers, such as Studies Weekly.

 Note

To qualify for third-party integration, your order must average $2,000 per school, each year.

If teachers and students have been rostered, the teacher will need to add the publication to the classroom.