예제 #1
0
 /// <summary>
 /// To read, get, a collection of courses i.e. all courses for the current school year. Refers to campus courses.
 /// Properties that are not supported: schoolYear, grades, resources. status is always active
 /// </summary>
 /// <param name="p"></param>
 /// <returns></returns>
 public Courses GetAllCourses(ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/courses/";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.Execute <Courses>(_request, p));
 }
예제 #2
0
 /// <summary>
 /// To read, get, a collection of students i.e. all students enrolled for the current school year.
 /// Properties that are not supported: userProfiles, userIds, identifier, username is not valid for login.
 /// Filtering by grades is not supported.
 /// </summary>
 /// <param name="p"></param>
 /// <returns></returns>
 public Users GetAllStudents(ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/students/";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.Execute <Users>(_request, p));
 }
예제 #3
0
 /// <summary>
 /// To read, get, a collection of orgs, district and schools. Refers to campus districts and schools. status is always active.
 /// </summary>
 /// <param name="p"></param>
 /// <returns></returns>
 public Orgs GetAllOrgs(ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/orgs/";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.Execute <Orgs>(_request, p));
 }
예제 #4
0
 /// <summary>
 /// To read, get, a collection of demographic data. Demographics information is taken from the Common Educational Data Standards (CEDS)
 /// from the US government. sourcedId refers to person GUID. publicSchoolResidenceStatus is not supported.
 /// </summary>
 /// <param name="p"></param>
 /// <returns></returns>
 public Demographicss GetAllDemographics(ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/demographics/";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.Execute <Demographicss>(_request, p));
 }
 /// <summary>
 /// To read, get, a collection of grading periods i.e. all grading periods for the current school year.
 /// Refers to campus terms and schedule sets by term GUID and structure GUID.
 /// </summary>
 /// <param name="p"></param>
 /// <returns></returns>
 public AcademicSessions GetAllGradingPeriods(ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/gradingPeriods/";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.Execute <AcademicSessions>(_request, p));
 }
예제 #6
0
 /// <summary>
 /// To read, get, a collection of enrollment data. An enrollment is the name given to an individual taking part in a class.
 /// Users will be students learning or teachers teaching in a class. sourcedId refers to roster ID for students and history ID for
 /// teachers. role only supports students and teachers.
 /// </summary>
 /// <param name="p"></param>
 /// <returns></returns>
 public Enrollments GetAllEnrollments(ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/enrollments/";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.Execute <Enrollments>(_request, p));
 }