Remind
Schools & Districts Higher Ed Teachers Families Partners
Log in
  1. Help Center
  2. Administering Remind Hub
  3. Rostering - Aeries

Aeries API

Avatar
Veronica D. Joseph
Customer Support

For Aeries administrators with Remind Hub.

SIS syncing with Remind is the fastest, most effective way to automatically create accounts and classes for your teachers, students, and parents using data from your organization's SIS. Once you've completed an SIS sync, you can expand your communication and drive the adoption of Remind across your organization.

You can transfer data from your SIS via Aeries API, especially if your district or school already uses Aeries. Typically, Aeries rostering will take 3-14 business days to complete if your organization's data is already syncing to Aeries. It will take 5-21 business days if your organization still needs to sync data with Aeries. 

Remind will mirror the Aeries data your organization wants to share with us exactly. This can sometimes include data errors. We highly recommend that you work with Aeries's Support team to make changes to the data before you share it with Remind.

This article contains the following sections:

  • Before you begin
  • Aeries API Setup
  • Troubleshooting

Before you begin

checkmark.png Make sure you're a district administrator. You should have access to your district's Aeries account and your Remind district's dashboard.

checkmark.png Do not share emergency contact information with Remind, if possible. Be sure you have access to filter and manage data within Aeries before you share your organization's data with Remind. 

checkmark.png You can only actively sync schools in your Remind Hub plan. 

checkmark.png You can use these instructions to add administrators if you need to provide others admin access to Remind. 


Aeries API Setup

mceclip1.png

Step 1: Add Remind in Aeries

Resource - API Security Page 

  1. Log in to your district administrator account in Aeries.
  2. Go to the Security node of Aerie's navigation menu to access API Security.
  3. Click the Add button to create a record for Remind.
  4. Enter Remind as the Product Name.     mceclip2.png
  5. Check the OneRoster box.
  6. Click Insert to save the Remind record.mceclip4.png

Step 2: Share data with Remind via Aeries

Set sharing permissions for Remind to let Aeries know what data you want to transfer. Your organization's data will be shared with Remind in the OneRoster file format. You can see how we will receive the information by looking at the OneRoster file format in this article.

We recommend sharing data by the district if your full district purchased, or you can share by the school. Include the following data points:

student full name guardian full name  teacher full name  class name 
student ID  guardian mobile number or email teacher email class teacher
student DOB guardian_preferred_language preferred_language class list of students 
student grade      
       preferred_language      

All data points are required except for preferred_language. However, we highly recommend you provide the language preference for all your teachers, students, and parents so you can easily send them auto-translated district and school-wide messages.

If you choose not to share preferred language data with Remind, the preferred language for all accounts will be blank and default to English. Users can add a preferred language to their account at any time.

Please keep the following in mind when sharing data via Aeries:

    1. An account will be created for every parent/guardian contact shared with Remind. Before initiating a data share via Aeries, we strongly recommend filtering out emergency contacts and any individuals prohibited from contacting students.
    2. You must enable Student Data, Schools, Teacher Data, Classes, and Master Schedule Read permissions to complete an SIS sync. Aeries.png
    3. Remind classes will be created for every section shared with Remind, so set up sharing rules to omit unnecessary or inactive classes. 
    4. If a student, teacher, parent, or administrator changes their preferred language, their setting will override the language preference data you've shared with Remind for them.
    5. The only values we accept for preferred_language and guardian_preferred_language are any two-letter ISO-639-1 or BCP-47 code or three-letter ISO-639-2 or ISO-639-3 code you can get from this list here. 

You can see the data you share with Remind in the Aeries data browser. If necessary, please contact Aeries to adjust your sync settings.


Step 3: Connect and match your schools in Remind

  1. Sign in to your Remind account.
  2. Click on your district's name on the left navigation menu.
  3. Click on the SIS Sync tab, and select Start SIS sync setup. mceclip6.png
  4. Choose Aeries and click Continue.mceclip7.png
  5. Click Start Aeries setup on the right. mceclip8.png
  6. Copy and paste the OneRoster URL, Consumer ID, and Consumer Secret Key from Aeries into the Aeries setup page in Remind and click Continue.mceclip11.png
    • Troubleshooting

      If you get an error, it's usually because there are leading or trailing spaces. Remove them from your entries, and click Continue again.

  7. Match your schools and click Next. Once schools are mapped, they cannot be remapped.
  8. Confirm your schools are correct.

After you've matched the schools, Remind will automatically start to receive your organization's. You’ll receive an email once this initial data share is complete.

When you're ready to push your organization's data live, please reach out to our Implementation team. Your data will not be active in Remind until you communicate with our Implementation team. Remind will automatically pull new data every day at 9 PM PT once the data is enabled. 


Step 4: Send notifications

Once your data is live, you’ll need to notify teachers, students, and parents about their new accounts. Any district or school administrator can manually send notifications from each school’s SIS sync dashboard. You can learn more about the first teacher, student, and parent notifications here.


Step 5: Add student numbers (optional)

If you want students to receive school and class announcements via their phone, and your SIS doesn't have this contact information, they should link their cell phone number to their rostered account. Students can add mobile numbers to their SIS-linked Remind accounts in less than a minute. Learn more on how they can do that here.

Was this article helpful?
Yes No
0 out of 0 found this helpful

Why wasn’t this article helpful?

Loader

Related articles

  • CSV sync via SFTP Overview
  • Set up a rostered account
  • Setting up ClassLink within Remind
  • Formatting files for a CSV 2.0 sync
  • How do I add or remove administrators?

Related articles

  • CSV sync via SFTP Overview
  • Set up a rostered account
  • Setting up ClassLink within Remind
  • Formatting files for a CSV 2.0 sync
  • How do I add or remove administrators?

Can’t find what you’re looking for? Get in touch!

  1. Help Center
  2. Administering Remind Hub
  3. Rostering - Aeries

Aeries API

Avatar
Veronica D. Joseph
Customer Support

For Aeries administrators with Remind Hub.

SIS syncing with Remind is the fastest, most effective way to automatically create accounts and classes for your teachers, students, and parents using data from your organization's SIS. Once you've completed an SIS sync, you can expand your communication and drive the adoption of Remind across your organization.

You can transfer data from your SIS via Aeries API, especially if your district or school already uses Aeries. Typically, Aeries rostering will take 3-14 business days to complete if your organization's data is already syncing to Aeries. It will take 5-21 business days if your organization still needs to sync data with Aeries. 

Remind will mirror the Aeries data your organization wants to share with us exactly. This can sometimes include data errors. We highly recommend that you work with Aeries's Support team to make changes to the data before you share it with Remind.

This article contains the following sections:

  • Before you begin
  • Aeries API Setup
  • Troubleshooting

Before you begin

checkmark.png Make sure you're a district administrator. You should have access to your district's Aeries account and your Remind district's dashboard.

checkmark.png Do not share emergency contact information with Remind, if possible. Be sure you have access to filter and manage data within Aeries before you share your organization's data with Remind. 

checkmark.png You can only actively sync schools in your Remind Hub plan. 

checkmark.png You can use these instructions to add administrators if you need to provide others admin access to Remind. 


Aeries API Setup

mceclip1.png

Step 1: Add Remind in Aeries

Resource - API Security Page 

  1. Log in to your district administrator account in Aeries.
  2. Go to the Security node of Aerie's navigation menu to access API Security.
  3. Click the Add button to create a record for Remind.
  4. Enter Remind as the Product Name.     mceclip2.png
  5. Check the OneRoster box.
  6. Click Insert to save the Remind record.mceclip4.png

Step 2: Share data with Remind via Aeries

Set sharing permissions for Remind to let Aeries know what data you want to transfer. Your organization's data will be shared with Remind in the OneRoster file format. You can see how we will receive the information by looking at the OneRoster file format in this article.

We recommend sharing data by the district if your full district purchased, or you can share by the school. Include the following data points:

student full name guardian full name  teacher full name  class name 
student ID  guardian mobile number or email teacher email class teacher
student DOB guardian_preferred_language preferred_language class list of students 
student grade      
       preferred_language      

All data points are required except for preferred_language. However, we highly recommend you provide the language preference for all your teachers, students, and parents so you can easily send them auto-translated district and school-wide messages.

If you choose not to share preferred language data with Remind, the preferred language for all accounts will be blank and default to English. Users can add a preferred language to their account at any time.

Please keep the following in mind when sharing data via Aeries:

    1. An account will be created for every parent/guardian contact shared with Remind. Before initiating a data share via Aeries, we strongly recommend filtering out emergency contacts and any individuals prohibited from contacting students.
    2. You must enable Student Data, Schools, Teacher Data, Classes, and Master Schedule Read permissions to complete an SIS sync. Aeries.png
    3. Remind classes will be created for every section shared with Remind, so set up sharing rules to omit unnecessary or inactive classes. 
    4. If a student, teacher, parent, or administrator changes their preferred language, their setting will override the language preference data you've shared with Remind for them.
    5. The only values we accept for preferred_language and guardian_preferred_language are any two-letter ISO-639-1 or BCP-47 code or three-letter ISO-639-2 or ISO-639-3 code you can get from this list here. 

You can see the data you share with Remind in the Aeries data browser. If necessary, please contact Aeries to adjust your sync settings.


Step 3: Connect and match your schools in Remind

  1. Sign in to your Remind account.
  2. Click on your district's name on the left navigation menu.
  3. Click on the SIS Sync tab, and select Start SIS sync setup. mceclip6.png
  4. Choose Aeries and click Continue.mceclip7.png
  5. Click Start Aeries setup on the right. mceclip8.png
  6. Copy and paste the OneRoster URL, Consumer ID, and Consumer Secret Key from Aeries into the Aeries setup page in Remind and click Continue.mceclip11.png
    • Troubleshooting

      If you get an error, it's usually because there are leading or trailing spaces. Remove them from your entries, and click Continue again.

  7. Match your schools and click Next. Once schools are mapped, they cannot be remapped.
  8. Confirm your schools are correct.

After you've matched the schools, Remind will automatically start to receive your organization's. You’ll receive an email once this initial data share is complete.

When you're ready to push your organization's data live, please reach out to our Implementation team. Your data will not be active in Remind until you communicate with our Implementation team. Remind will automatically pull new data every day at 9 PM PT once the data is enabled. 


Step 4: Send notifications

Once your data is live, you’ll need to notify teachers, students, and parents about their new accounts. Any district or school administrator can manually send notifications from each school’s SIS sync dashboard. You can learn more about the first teacher, student, and parent notifications here.


Step 5: Add student numbers (optional)

If you want students to receive school and class announcements via their phone, and your SIS doesn't have this contact information, they should link their cell phone number to their rostered account. Students can add mobile numbers to their SIS-linked Remind accounts in less than a minute. Learn more on how they can do that here.

Was this article helpful?
Yes No
0 out of 0 found this helpful

Why wasn’t this article helpful?

Loader

Related articles

  • CSV sync via SFTP Overview
  • Set up a rostered account
  • Setting up ClassLink within Remind
  • Formatting files for a CSV 2.0 sync
  • How do I add or remove administrators?

Can’t find what you’re looking for? Get in touch!

Reach out to us directly

Still can’t find what you’re looking for? Send us a message and
we’ll get back to you as soon as possible.

Contact us
Terms & Policies

Product

  • Schools & Districts
  • Higher Education
  • Teachers
  • Families
  • Partners

Company

  • About Us
  • Careers
  • Press
  • Resources

Community

  • Connected Educators
  • Trust & Safety
  • Help Center
  • Blog
Terms & Policies