Module: OneRoster

Defined in:: lib/one_roster.rb,
lib/types/base.rb,
lib/types/term.rb,
lib/types/admin.rb,
lib/types/class.rb,
lib/types/course.rb,
lib/types/student.rb,
lib/types/teacher.rb,
lib/types/classroom.rb,
lib/types/enrollment.rb,
lib/one_roster/client.rb,
lib/types/application.rb,
lib/one_roster/version.rb,
lib/one_roster/response.rb,
lib/one_roster/paginator.rb,
lib/one_roster/connection.rb

Defined Under Namespace

Modules: Types Classes: Client, Connection, ConnectionError, DistrictNotFound, Paginator, Response

Constant Summary collapse

STUDENTS_ENDPOINT =

'ims/oneroster/v1p1/students'

TEACHERS_ENDPOINT =

'ims/oneroster/v1p1/teachers'

ADMINS_ENDPOINT =

"ims/oneroster/v1p1/users?filter=role='administrator'"

COURSES_ENDPOINT =

'ims/oneroster/v1p1/courses'

CLASSES_ENDPOINT =

'ims/oneroster/v1p1/classes'

ENROLLMENTS_ENDPOINT =

'ims/oneroster/v1p1/enrollments'

ACADEMIC_SESSIONS_ENDPOINT =

'ims/oneroster/v1p1/academicSessions'

RESPONSE_TYPE_MAP =

{
  'users'            => 'users',
  'teachers'         => 'users',
  'students'         => 'users',
  'academicSessions' => 'academicSessions',
  'courses'          => 'courses',
  'classes'          => 'classes',
  'enrollments'      => 'enrollments'
}.freeze

VERSION =

'2.3.14'

PAGE_LIMIT =

5_000