Git Product home page Git Product logo

oneroster.net's Introduction

OneRoster.NET

A simple client library for the OneRoster Spec, supporting versions 1.1 and 1.2. Only rostering calls are supported. Grade book has not been implemented.

Note: The OneRoster 1.2 specification has not yet been finalized. OneRoster.NET's implementation may change in the future to match the final spec once it's released.

Features

  • Auto deserialization to dto's
  • Synchronous calls
  • Asynchronous calls
  • Raw calls to view response content and headers (for troubleshooting or to deseralize using your own objects)
  • Intellisense comments

Installation

  • Nuget CLI Install-Package OneRoster.NET

  • Nuget GUI Package Manager Search for OneRoster

Usage

V1P1 - Replace baseUrl, consumerKey, and consumerSecret with appropriate values

using (var ora = new OneRosterApi().V1p1("baseUrl", "consumerKey", "consumerSecret"))
{
	//sync
	var students = ora.StudentsManagement.GetAllStudents();
	//async
	var studentsAsync = await ora.StudentsManagement.GetAllStudentsAsync();
	//raw
	var studentsRaw = ora.StudentsManagement.GetAllStudentsRaw();
}

V1P2 - Replace tokenUrl, baseUrl, clientId, and clientSecret with appropriate values

using (var ora = new OneRosterApi().V1p2("tokenUrl","baseUrl", "clientId", "clientSecret"))
{
	//sync
	var students = ora.StudentsManagement.GetAllStudents();
	//async
	var studentsAsync = await ora.StudentsManagement.GetAllStudentsAsync();
	//raw
	var studentsRaw = ora.StudentsManagement.GetAllStudentsRaw();
}

Parameters

var students = ora.StudentsManagement.GetAllStudents(new OneRoster.NET.v1p2.ApiParameters { Limit = 10, Offset = 100 });

View the offical spec for more details.

Available Managements

  • AcademicSessionsManagement
  • ClassesManagement
  • CoursesManagement
  • DemographicsManagement
  • EnrollmentsManagement
  • GradingPeriodsManagement
  • OrgsManagement
  • SchoolsManagement
  • StudentsManagement
  • TeachersManagement
  • TermsManagement
  • UsersManagement

oneroster.net's People

Contributors

jdolny avatar

Stargazers

Andy Hobbs avatar Isaiah Zupke avatar Matt McNabb avatar Patrick Palmer avatar Nic Bavetta avatar

Watchers

Tran Thanh Tung avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.