C# Class SchooxSharp.Api.Clients.Curriculums

Inheritance: SchooxApiBase

Mostra file Open project: jamesbar2/SchooxSharp Class Usage Examples

Public Methods

Method	Description
Curriculums ( ) : System.Collections.Generic
Curriculums ( ISchooxService schooxService ) : System.Collections.Generic
GetCurriculums ( int userId = null, int start = null, int limit = null ) : SchooxResponse>	Returns a list of all curriculums with extended details.
GetDetailsForCurriculum ( int curriculumId, int userId = null ) : SchooxResponse	Returns extended details of a specific curriculum. A user's progress percentage, time spent and enrollment date can be retrieved by his/her schooX ID.
GetUsersCurriculums ( int userId, int start = null, int limit = null ) : SchooxResponse>	Returns a list of a user's enrolled & created curriculums with extended details by his/her schooX ID.

Method Details

Curriculums() public method

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

Curriculums() public method

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

GetCurriculums() public method

Returns a list of all curriculums with extended details.

public GetCurriculums ( int userId = null, int start = null, int limit = null ) : SchooxResponse>
userId	int	User's ID you want to retrieve his/her curriculum list view
start	int	Starting Position
limit	int	Max size of retrieved curriculums
return	SchooxResponse>

GetDetailsForCurriculum() public method

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

public GetDetailsForCurriculum ( int curriculumId, int userId = null ) : SchooxResponse
curriculumId	int	Curriculum ID
userId	int	User's ID you want to retrieve his/her curriculum list view
return	SchooxResponse

GetUsersCurriculums() public method

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

public GetUsersCurriculums ( int userId, int start = null, int limit = null ) : SchooxResponse>
userId	int	User's ID you want to retrieve his/her curriculum list view
start	int	Starting Position
limit	int	Max size of retrieved curriculums
return	SchooxResponse>