Exemple #1
0
 public IRestResponse GetTeachersForSchoolRaw(string sourcedId, ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/schools/{sourcedId}/teachers";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.GetResponse(_request));
 }
Exemple #2
0
 public async Task <AcademicSessions> GetAllTermsAsync(ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/terms/";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(await _oneRosterApi.ExecuteAsync <AcademicSessions>(_request));
 }
Exemple #3
0
 /// <summary>
 /// To read, get, classes for a term by sourcedId
 /// </summary>
 /// <param name="sourcedId"></param>
 /// <param name="p"></param>
 /// <returns></returns>
 public Classes GetClassesForTerm(string sourcedId, ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/terms/{sourcedId}/classes";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.Execute <Classes>(_request));
 }
Exemple #4
0
 /// <summary>
 /// To read, get, grading periods for a term by sourcedId
 /// </summary>
 /// <param name="sourcedId"></param>
 /// <param name="p"></param>
 /// <returns></returns>
 public AcademicSessions GetGradingPeriodsForTerm(string sourcedId, ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/terms/{sourcedId}/gradingPeriods";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.Execute <AcademicSessions>(_request));
 }
Exemple #5
0
 /// <summary>
 /// To read, get, a collection of terms i.e. all terms for the current school year. Refers to campus terms by term ID. status is always active.
 /// </summary>
 /// <param name="p"></param>
 /// <returns></returns>
 public AcademicSessions GetAllTerms(ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/terms/";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.Execute <AcademicSessions>(_request));
 }
Exemple #6
0
 /// <summary>
 /// To read, get, a collection of teachers i.e. all teachers registered to teach for the current school year.
 /// Properties that are not supported: userProfiles, userIds, identifier, grades, username is not valid for login.
 /// </summary>
 /// <param name="p"></param>
 /// <returns></returns>
 public Users GetAllTeachers(ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/teachers/";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.Execute <Users>(_request));
 }
Exemple #7
0
 /// <summary>
 /// To read, get, one teacher by sourcedId
 /// </summary>
 /// <param name="sourcedId"></param>
 /// <param name="p"></param>
 /// <returns></returns>
 public SingleUser GetTeacher(string sourcedId, ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/teachers/{sourcedId}";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.Execute <SingleUser>(_request));
 }
 /// <summary>
 /// To read, get, a collection of classes i.e. all classes for the current school year.
 /// Properties that are not supported: resources, grades. Status is always active, classCode is section teacher display name.
 /// </summary>
 /// <param name="p"></param>
 /// <returns></returns>
 public Classes GetAllClasses(ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/classes/";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.Execute <Classes>(_request));
 }
 /// <summary>
 /// To read, get, one class by sourcedId
 /// </summary>
 /// <param name="sourcedId"></param>
 /// <param name="p"></param>
 /// <returns></returns>
 public SingleClass GetClass(string sourcedId, ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/classes/{sourcedId}";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.Execute <SingleClass>(_request));
 }
Exemple #10
0
 /// <summary>
 /// To read, get, one school by sourcedId
 /// </summary>
 /// <param name="sourcedId"></param>
 /// <param name="p"></param>
 /// <returns></returns>
 public SingleOrg GetSchool(string sourcedId, ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/schools/{sourcedId}";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.Execute <SingleOrg>(_request));
 }
 public async Task <Users> GetTeachersForClassAsync(string sourcedId, ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/classes/{sourcedId}/teachers";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(await _oneRosterApi.ExecuteAsync <Users>(_request));
 }
Exemple #12
0
 public async Task <Orgs> GetAllSchoolsAsync(ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/schools/";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(await _oneRosterApi.ExecuteAsync <Orgs>(_request));
 }
Exemple #13
0
 /// <summary>
 /// To read, get, terms for a school by sourcedId
 /// </summary>
 /// <param name="sourcedId"></param>
 /// <param name="p"></param>
 /// <returns></returns>
 public AcademicSessions GetTermsForSchool(string sourcedId, ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/schools/{sourcedId}/terms";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.Execute <AcademicSessions>(_request));
 }
Exemple #14
0
 public async Task <List <User> > GetTeachersForSchoolAsync(string sourcedId, ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/schools/{sourcedId}/teachers";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(await _oneRosterApi.ExecuteAsync <List <User> >(_request));
 }
Exemple #15
0
 public IRestResponse GetDemographicsRaw(string sourcedId, ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/demographics/{sourcedId}";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.GetResponse(_request));
 }
 /// <summary>
 /// To read, get, a collection of students i.e. all students for the current school year for a class.
 /// </summary>
 /// <param name="sourcedId"></param>
 /// <param name="p"></param>
 /// <returns></returns>
 public Users GetStudentsForClass(string sourcedId, ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/classes/{sourcedId}/students";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.Execute <Users>(_request));
 }
Exemple #17
0
 public async Task <SingleDemographic> GetDemographicsAsync(string sourcedId, ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/demographics/{sourcedId}";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(await _oneRosterApi.ExecuteAsync <SingleDemographic>(_request));
 }
Exemple #18
0
 public async Task <SingleUser> GetStudentAsync(string sourcedId, ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/students/{sourcedId}";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(await _oneRosterApi.ExecuteAsync <SingleUser>(_request));
 }
Exemple #19
0
 public async Task <Users> GetAllTeachersAsync(ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/teachers/";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(await _oneRosterApi.ExecuteAsync <Users>(_request));
 }
 /// <summary>
 /// To read, get, one academicSession by sourcedId
 /// </summary>
 /// <param name="sourcedId"></param>
 /// <param name="p"></param>
 /// <returns></returns>
 public SingleAcademicSession GetAcademicSession(string sourcedId, ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/academicSessions/{sourcedId}";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.Execute <SingleAcademicSession>(_request));
 }
Exemple #21
0
 public async Task <Classes> GetClassesForTermAsync(string sourcedId, ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/terms/{sourcedId}/classes";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(await _oneRosterApi.ExecuteAsync <Classes>(_request));
 }
 public IRestResponse GetAcademicSessionRaw(string sourcedId, ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/academicSessions/{sourcedId}";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.GetResponse(_request));
 }
Exemple #23
0
 public IRestResponse GetGradingPeriodsForTermRaw(string sourcedId, ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/terms/{sourcedId}/gradingPeriods";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.GetResponse(_request));
 }
Exemple #24
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));
 }
Exemple #25
0
 public IRestResponse GetAllTermsRaw(ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/terms/";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.GetResponse(_request));
 }
Exemple #26
0
 public async Task <Demographicss> GetAllDemographicsAsync(ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/demographics/";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(await _oneRosterApi.ExecuteAsync <Demographicss>(_request));
 }
Exemple #27
0
 public async Task <SingleAcademicSession> GetTermAsync(string sourcedId, ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/terms/{sourcedId}";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(await _oneRosterApi.ExecuteAsync <SingleAcademicSession>(_request));
 }
Exemple #28
0
 /// <summary>
 /// To read, get, one demographic by sourcedId
 /// </summary>
 /// <param name="sourcedId"></param>
 /// <param name="p"></param>
 /// <returns></returns>
 public SingleDemographic GetDemographics(string sourcedId, ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/demographics/{sourcedId}";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.Execute <SingleDemographic>(_request));
 }
Exemple #29
0
 public IRestResponse GetClassesForRaw(string sourcedId, ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/terms/{sourcedId}/classes";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.GetResponse(_request));
 }
Exemple #30
0
 /// <summary>
 /// To read, get, students for a school by sourcedId
 /// </summary>
 /// <param name="sourcedId"></param>
 /// <param name="p"></param>
 /// <returns></returns>
 //Todo: This is returning a list of user instead of the Users class, could be a bug in Campus implementation or error in spec
 public List <User> GetStudentsForSchool(string sourcedId, ApiParameters p = null)
 {
     _request.Method   = Method.GET;
     _request.Resource = $"/schools/{sourcedId}/students";
     _oneRosterApi.AddRequestParameters(_request, p);
     return(_oneRosterApi.Execute <List <User> >(_request));
 }