/// <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)); }
/// <summary> /// To read, get, one course by sourcedId /// </summary> /// <param name="sourcedId"></param> /// <param name="p"></param> /// <returns></returns> public SingleCourse GetCourse(string sourcedId, ApiParameters p = null) { _request.Method = Method.GET; _request.Resource = $"/courses/{sourcedId}"; _oneRosterApi.AddRequestParameters(_request, p); return(_oneRosterApi.Execute <SingleCourse>(_request, p)); }
/// <summary> /// To read, get, classes for a course by sourcedId /// </summary> /// <param name="sourcedId"></param> /// <param name="p"></param> /// <returns></returns> public Classes GetClassesForCourse(string sourcedId, ApiParameters p = null) { _request.Method = Method.GET; _request.Resource = $"/courses/{sourcedId}/classes"; _oneRosterApi.AddRequestParameters(_request, p); return(_oneRosterApi.Execute <Classes>(_request, p)); }
public IRestResponse GetOrgRaw(string sourcedId, ApiParameters p = null) { _request.Method = Method.GET; _request.Resource = $"/orgs/{sourcedId}"; _oneRosterApi.AddRequestParameters(_request, p); return(_oneRosterApi.GetResponse(_request, p)); }
public IRestResponse GetAllCoursesRaw(ApiParameters p = null) { _request.Method = Method.GET; _request.Resource = $"/courses/"; _oneRosterApi.AddRequestParameters(_request, p); return(_oneRosterApi.GetResponse(_request, p)); }
/// <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, p)); }
/// <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)); }
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, p)); }
private string GenerateParamsString(ApiParameters p) { if (p == null) { return(null); } var paramBuilder = new System.Text.StringBuilder(); if (p.Filter != null) { paramBuilder.Append($"filter={p.Filter}&"); } if (p.Sort != null) { paramBuilder.Append($"sort={p.Sort}&"); } if (p.OrderBy != null) { paramBuilder.Append($"orderBy={p.OrderBy}&"); } if (p.Limit != null) { paramBuilder.Append($"limit={p.Limit}&"); } if (p.Offset != null) { paramBuilder.Append($"offset={p.Offset}&"); } if (p.Fields != null) { paramBuilder.Append($"fields={p.Fields}&"); } return(paramBuilder.ToString().TrimEnd('&')); }
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, p)); }
/// <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, p)); }
/// <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, one grading period by sourcedId /// </summary> /// <param name="sourcedId"></param> /// <param name="p"></param> /// <returns></returns> public SingleAcademicSession GetGradingPeriod(string sourcedId, ApiParameters p = null) { _request.Method = Method.GET; _request.Resource = $"/gradingPeriods/{sourcedId}"; _oneRosterApi.AddRequestParameters(_request, p); return(_oneRosterApi.Execute <SingleAcademicSession>(_request, p)); }
public async Task <AcademicSessions> GetAllGradingPeriodsAsync(ApiParameters p = null) { _request.Method = Method.GET; _request.Resource = $"/gradingPeriods/"; _oneRosterApi.AddRequestParameters(_request, p); return(await _oneRosterApi.ExecuteAsync <AcademicSessions>(_request, p)); }
public IRestResponse GetTermsForSchoolRaw(string sourcedId, ApiParameters p = null) { _request.Method = Method.GET; _request.Resource = $"/schools/{sourcedId}/terms"; _oneRosterApi.AddRequestParameters(_request, p); return(_oneRosterApi.GetResponse(_request, p)); }
/// <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)); }
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, p)); }
/// <summary> /// To read, get, one student by sourcedId /// </summary> /// <param name="sourcedId"></param> /// <param name="p"></param> /// <returns></returns> public SingleUser GetStudent(string sourcedId, ApiParameters p = null) { _request.Method = Method.GET; _request.Resource = $"/students/{sourcedId}"; _oneRosterApi.AddRequestParameters(_request, p); return(_oneRosterApi.Execute <SingleUser>(_request, p)); }
internal IRestResponse GetResponse(RestRequest request, ApiParameters p) { request.AddHeader("Authorization", new Oauth1(_consumerKey, _consumerSecret).GenerateAuthHeader(_restClient.BaseUrl + request.Resource, p)); var response = _restClient.Execute(request); return(response); }
public async Task <Courses> GetCoursesForSchoolAsync(string sourcedId, ApiParameters p = null) { _request.Method = Method.GET; _request.Resource = $"/schools/{sourcedId}/courses"; _oneRosterApi.AddRequestParameters(_request, p); return(await _oneRosterApi.ExecuteAsync <Courses>(_request, p)); }
/// <summary> /// To read, get, one organization, district or school by sourcedId /// </summary> /// <param name="sourcedId"></param> /// <param name="p"></param> /// <returns></returns> public SingleOrg GetOrg(string sourcedId, ApiParameters p = null) { _request.Method = Method.GET; _request.Resource = $"/orgs/{sourcedId}"; _oneRosterApi.AddRequestParameters(_request, p); return(_oneRosterApi.Execute <SingleOrg>(_request, p)); }
/// <summary> /// To read, get, enrollments for a school by sourcedId /// </summary> /// <param name="sourcedId"></param> /// <param name="p"></param> /// <returns></returns> public Enrollments GetEnrollmentsForSchool(string sourcedId, ApiParameters p = null) { _request.Method = Method.GET; _request.Resource = $"/schools/{sourcedId}/enrollments"; _oneRosterApi.AddRequestParameters(_request, p); return(_oneRosterApi.Execute <Enrollments>(_request, p)); }
/// <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)); }
/// <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, p)); }
public async Task <Courses> GetAllCoursesAsync(ApiParameters p = null) { _request.Method = Method.GET; _request.Resource = $"/courses/"; _oneRosterApi.AddRequestParameters(_request, p); return(await _oneRosterApi.ExecuteAsync <Courses>(_request, p)); }
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, p)); }
public async Task <SingleCourse> GetCourseAsync(string sourcedId, ApiParameters p = null) { _request.Method = Method.GET; _request.Resource = $"/courses/{sourcedId}"; _oneRosterApi.AddRequestParameters(_request, p); return(await _oneRosterApi.ExecuteAsync <SingleCourse>(_request, p)); }
/// <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, p)); }
public IRestResponse GetClassesForCourseRaw(string sourcedId, ApiParameters p = null) { _request.Method = Method.GET; _request.Resource = $"/courses/{sourcedId}/classes"; _oneRosterApi.AddRequestParameters(_request, p); return(_oneRosterApi.GetResponse(_request, p)); }
public async Task <Enrollments> GetAllEnrollmentsAsync(ApiParameters p = null) { _request.Method = Method.GET; _request.Resource = $"/enrollments/"; _oneRosterApi.AddRequestParameters(_request, p); return(await _oneRosterApi.ExecuteAsync <Enrollments>(_request, p)); }