Skip to content

Latest commit

 

History

History
85 lines (57 loc) · 2.57 KB

README.md

File metadata and controls

85 lines (57 loc) · 2.57 KB
Raw

aeries-api

This gem provides an interface to the Aeries SIS API.

I will implement endpoints as I need them, but will also consider pull requests that add support for additional endpoints. At the time of writing, this gem is designed to be used with version 3 of the Aeries API.

Installation

Add this line to your application's Gemfile:

gem 'aeries-api'

Usage

Setup

Initialize the client:

aeries = AeriesApi::Client.new(
  aeries_cert: '477abe9e7d27439681d62f4e0de1f5e1',
  base_uri: ' https://demo.aeries.net/aeries/api/v5'
)

The client can also be configured via the environment:

ENV['AERIES_CERT'] = '477abe9e7d27439681d62f4e0de1f5e1'
ENV['AERIES_BASE_URI'] = ' https://demo.aeries.net/aeries/api/v5'

aeries = AeriesApi::Client.new

Retrieving Data

Most endpoints require a school code so it should be passed as an argument. Keyword arguments are then used to pass additional data to the API. Example:

aeries.students(school_code: 99, grade_level: 4)

Available Methods:

# /api/v5/schools
schools # returns all schools

# /api/v5/schools/#{school_code}
school(school_code: school_code) # returns a single school

# /api/v5/schools/#{school_code}/StudentGroups
student_groups(school_code: school_code) # returns all student groups at a school

# /api/v5/schools/#{school_code}/students
students(school_code: school_code) # returns all students at a school

# /api/v5/schools/#{school_code}/students/grade/#{grade_level}
students(school_code: school_code, grade_level: grade_level) # returns students in a specific grade level

# /api/v5/schools/#{school_code}/students/#{student_id}
student(school_code: school_code, student_id: student_id) # returns a single student

# /api/v5/schools/#{school_code}/contacts/#{student_id}
contacts(school_code: school_code, student_id: student_id) # returns contacts for a student

# /api/v5/schools/#{school_code}/StudentPictures
student_picture(school_code: school_code) # returns all student pictures at a school

# /api/v5/schools/#{school_code}/StudentPictures/#{student_id}
student_pictures(school_code: school_code, student_id: student_id) # returns a single student's picture

# /api/v5/schools/#{school_code}/students/#{student_id}/programs
student_programs(school_code: school_code, student_id: student_id) # returns a single student's picture

License

The gem is available as open source under the terms of the MIT License.