C# Class SchooxSharp.Api.Clients.Courses

Inheritance: SchooxApiBase

ファイルを表示 Open project: jamesbar2/SchooxSharp Class Usage Examples

Public Methods

Method	Description
Courses ( ) : System.Collections.Generic
Courses ( ISchooxService schooxService ) : System.Collections.Generic
GetCouponsInCourse ( int courseId, int userId = null ) : SchooxResponse>	Returns a list of generated coupons for a specific course.
GetCourseInvitations ( int courseId, int userId = null ) : SchooxResponse	You can either assign a course to a user or invite the user to enroll in a course. If you assign the course the user will automatically be enrolled in and the course in considered to be required. If you send an invitation the user will have the option to enroll optionally. This request returns a list of all invitations that have been sent for a particular course.
GetDetailsForCourse ( int courseId, int userId = null ) : SchooxResponse	Returns extended details of a specific course. A user's progress percentage, time spent and enrollment date can be retrieved by his/her schooX ID.
GetExamsInCourse ( int courseId, int userId = null ) : SchooxResponse>	Returns a list of a course's exams. You can retrieve the date of his or her last attempt, total score and points as well as the passing or failure status for each exam by his/her schooX ID.
GetLecturesInCourse ( int courseId, int userId = null ) : SchooxResponse>	Returns a list of a course's lectures. You can retrieve a user's progress percentage, time spent and number of views for each lecture by his/her schooX ID.
GetListOfCourses ( int start = null, int limit = null ) : SchooxResponse>	Returns a list of all courses with extended details.
GetListOfUserCourses ( int userId, string tab = null, int start = null, int limit = null ) : SchooxResponse>	Returns a list of a user's enrolled & created courses with extended details by his/her schooX ID.
GetUsersEnrolledInCourse ( int courseId, int userId = null, int start = null, int limit = null ) : SchooxResponse>	Returns a list of a course's enrolled users with each user's enrolled date, progress percentage and time spent.
GetUsersUsingCourseCoupon ( int courseId, int couponId, int userId = null ) : SchooxResponse>	Returns a list of a course's enrolled users for a specific coupon with each user's enrolled date, progress percentage and time spent.

Method Details

Courses() public method

public Courses ( ) : System.Collections.Generic
return	System.Collections.Generic

Courses() public method

public Courses ( ISchooxService schooxService ) : System.Collections.Generic
schooxService	ISchooxService
return	System.Collections.Generic

GetCouponsInCourse() public method

Returns a list of generated coupons for a specific course.

public GetCouponsInCourse ( int courseId, int userId = null ) : SchooxResponse>
courseId	int	Course ID
userId	int	User's ID you want to retrieve his/her course list view
return	SchooxResponse>

GetCourseInvitations() public method

You can either assign a course to a user or invite the user to enroll in a course. If you assign the course the user will automatically be enrolled in and the course in considered to be required. If you send an invitation the user will have the option to enroll optionally. This request returns a list of all invitations that have been sent for a particular course.

public GetCourseInvitations ( int courseId, int userId = null ) : SchooxResponse
courseId	int	Course ID
userId	int	User's ID you want to retrieve his/her course list view
return	SchooxResponse

GetDetailsForCourse() public method

Returns extended details of a specific course. A user's progress percentage, time spent and enrollment date can be retrieved by his/her schooX ID.

public GetDetailsForCourse ( int courseId, int userId = null ) : SchooxResponse
courseId	int	Course ID for details.
userId	int	User's ID you want to retrieve his/her course list view
return	SchooxResponse

GetExamsInCourse() public method

Returns a list of a course's exams. You can retrieve the date of his or her last attempt, total score and points as well as the passing or failure status for each exam by his/her schooX ID.

public GetExamsInCourse ( int courseId, int userId = null ) : SchooxResponse>
courseId	int	Course ID
userId	int	User's ID you want to retrieve his/her course list view
return	SchooxResponse>

GetLecturesInCourse() public method

Returns a list of a course's lectures. You can retrieve a user's progress percentage, time spent and number of views for each lecture by his/her schooX ID.

public GetLecturesInCourse ( int courseId, int userId = null ) : SchooxResponse>
courseId	int	Course ID
userId	int	User's ID you want to retrieve his/her course list view
return	SchooxResponse>

GetListOfCourses() public method

Returns a list of all courses with extended details.

public GetListOfCourses ( int start = null, int limit = null ) : SchooxResponse>
start	int	Starting position
limit	int	Max size of retrieved courses
return	SchooxResponse>

GetListOfUserCourses() public method

Returns a list of a user's enrolled & created courses with extended details by his/her schooX ID.

public GetListOfUserCourses ( int userId, string tab = null, int start = null, int limit = null ) : SchooxResponse>
userId	int	User ID of courses to retrieve.
tab	string
start	int	Starting position
limit	int	Max size of retrieved courses
return	SchooxResponse>

GetUsersEnrolledInCourse() public method

Returns a list of a course's enrolled users with each user's enrolled date, progress percentage and time spent.

public GetUsersEnrolledInCourse ( int courseId, int userId = null, int start = null, int limit = null ) : SchooxResponse>
courseId	int	Course ID
userId	int	User's ID you want to retrieve his/her course list view
start	int	Starting position
limit	int	Max size of retrieved courses
return	SchooxResponse>

GetUsersUsingCourseCoupon() public method

Returns a list of a course's enrolled users for a specific coupon with each user's enrolled date, progress percentage and time spent.

public GetUsersUsingCourseCoupon ( int courseId, int couponId, int userId = null ) : SchooxResponse>
courseId	int	Course ID
couponId	int	Coupon ID
userId	int	User's ID you want to retrieve his/her course list view
return	SchooxResponse>