OrelStateUniversity.API 1.0.0

Orel State University schedule API

This class library provides a client .NET implementation for interacting with the Oryol State University schedule API.

This library is not official.

Features

• Getting a list of divisions for students;
• Getting a list of courses;
• Getting a list of groups;
• Getting the schedule for the current week.

Usage

To start working with the API, you need to create an instance of the ScheduleApiClient class.

For example, as follows:

IScheduleApiClient client = new ScheduleApiClient();

To get a list of divisions available to students, you need to use the GetStudentDivisionsAsync method.

For example, as follows:

IEnumerable<Division> divisions = await client.GetStudentDivisionsAsync();

To get a list of available courses for the specified division, use the GetCoursesAsync method.

For example, as follows:

Division division = divisions.FirstOrDefault();
IEnumerable<Course> courses = await client.GetCoursesAsync(division);

To get a list of all groups for the specified division on the specified course, use the GetGroupsAsync method.

For example, as follows:

Course course = courses.FirstOrDefault();
IEnumerable<Group> groups = await client.GetGroupsAsync(division, course);

To get a schedule for the specified group, use the GetScheduleAsync method.

For example, as follows:

Group group = groups.FirstOrDefault();
Schedule schedule = await client.GetScheduleAsync(group);

Lessons for the current week will be available in the Lessons property.

For example, as follows:

Lesson lesson = schedule.Lessons.FirstOrDefault();

// Process the information about the lesson.

Non-asynchronous call

You can use all of these methods in non-synchronous projects as follows:

Schedule schedule = client.GetScheduleAsync(group).Result;