Project

aeries-api

0.0
No commit activity in last 3 years
No release in over 3 years
aeries-apiderekpovah/aeries-apiHomepageDocumentationSource CodeBug TrackerWiki
A simple REST client for the Aeries SIS API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
10,294
Stars
0
Forks
1
Watchers
1
 Releases
Current version
1.1.0
Total releases
4
First release
2019-12-05
Latest release
2021-08-11
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2020-04-22
Reverse Dependencies
0

 Dependencies

Development

bundler
>= 0
pry
>= 0
rake
~> 12.3.3
rspec
~> 3.0
sinatra
>= 0
webmock
>= 0

Runtime

activesupport
>= 0
hashie
>= 0
httparty
>= 0
 Project Readme

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.