Method | Description | |
---|---|---|
Dashboard ( ) : System | ||
Dashboard ( ISchooxService service ) : System | ||
GetCourses ( string role ) : SchooxResponse
|
Returns a list of all courses with title, short description and image. NOTE: NOT ALL PROPERTIES ARE RETURNED WITH THIS RESPONSE.
|
|
GetCurriculumProgressForUser ( int curriculumId, int userId, string externalId = null ) : SchooxResponse
|
Curriculum's can consist of one or more courses. This request returns detailed information about a user’s progress on a curriculum for every single course of it (e.g. course name, image, time spent and total progress).
|
|
GetCurriculums ( string role ) : SchooxResponse
|
Returns a list of all curriculums with title, short description, image and number of courses.
|
|
GetDetailedCourseProgressForUser ( int courseId, int userId, string externalId = null ) : SchooxResponse |
Courses can consist of one or more lectures and exams. This request returns detailed information about a user's progress on a course for every single lecture and exam of it (e.g. lecture name, progress, time spent, number of attempts, name of exam, score, date of last attempt).
|
|
GetEnrolledUsersInCourse ( int courseId, string role, int regionId = null, int locationId = null, int jobId = null, string letter = null, int start = null, int limit = 100, string sort = null ) : SchooxResponse
|
Returns a list of enrolled users in a course with a summary of information for every user (e.g. enrollment date, user’s region and location, total time spent on course and total progress).
|
|
GetEnrolledUsersInCurriculum ( int curriculumId, string role, int regionId = null, int locationId = null, int jobId = null, string letter = null, int start = null, int limit = null, string sort = null ) : SchooxResponse
|
Returns a list of enrolled users in a curriculum with a summary of information for every user (e.g. enrollment date, total time spent on the curriculum and total progress).
|
|
GetEnrolledUsersInExam ( int examId, string role, int regionId = null, int locationId = null, int jobId = null, string letter = null, int start = null, int limit = null, string sort = null ) : SchooxResponse
|
This returns a list of all users for an exam with detailed information about every user's performance (e.g. user’s name, number of attempts, date of last attempt, starting date, ending date, score, points and status: passed / failed).
|
|
GetExams ( string role ) : SchooxResponse
|
Returns a list of all exams with title, image and publishing date.
|
|
GetUserCourses ( int userId, string externalId = null ) : SchooxResponse
|
Returns a list of all courses a user is enrolled in with a summary of his or her total training and training information by course (e.g. enrollment/assignment date, due date, total time spent on the course and progress). By default only the first 100 people are returned.
|
|
GetUserCurriculums ( int userId, string externalId = null ) : SchooxResponse
|
Returns a list of all curriculums a user is enrolled in with a summary of his or her total training and training information by curriculum (e.g. enrollment/assignment date, due date, total time spent on the curriculum and progress). By default only the first 100 people are returned.
|
|
GetUserExams ( int userId, string externalId = null ) : SchooxResponse
|
Returns a list of all exams a user has taken so far with information about his or her performance on every exam (e.g. number of attempts, date of last attempt, score, points, passing score). By default only the first 100 people are returned.
|
|
GetUsers ( string role, int userId = null, string externalId = null, int aboveId = null, int unitId = null, int jobId = null, int start = null, int limit = 100, string sort = null ) : SchooxResponse
|
Returns a list of current users in your organization with a summary of their training performance (e.g. total training hours, courses and exams). By default only the first 100 people are returned. The list can be filtered on letter, role, region and location and paged using the optional paging parameters.
|
public Dashboard ( ISchooxService service ) : System | ||
service | ISchooxService | |
return | System |
public GetCourses ( string role ) : SchooxResponse
|
||
role | string | User's role. |
return | SchooxResponse
|
public GetCurriculumProgressForUser ( int curriculumId, int userId, string externalId = null ) : SchooxResponse
|
||
curriculumId | int | Curriculum identifier. |
userId | int | User identifier. |
externalId | string | Sets whether the id given is the external_id of the User. /// By default, the value is "false" |
return | SchooxResponse
|
public GetCurriculums ( string role ) : SchooxResponse
|
||
role | string | Users' role |
return | SchooxResponse
|
public GetDetailedCourseProgressForUser ( int courseId, int userId, string externalId = null ) : SchooxResponse |
||
courseId | int | Course identifier. |
userId | int | User identifier. |
externalId | string | Sets whether the id given is the external_id of the User. /// By default, the value is "false" |
return | SchooxResponse |
public GetEnrolledUsersInCourse ( int courseId, string role, int regionId = null, int locationId = null, int jobId = null, string letter = null, int start = null, int limit = 100, string sort = null ) : SchooxResponse
|
||
courseId | int | Course identifier. |
role | string | User's role |
regionId | int | Region identifier. |
locationId | int | Location identifier. |
jobId | int | Job identifier. |
letter | string | Lastname's starting letter |
start | int | List's starting position |
limit | int | Number of users to return per request, up to maximum of 1,000. Default to 100 |
sort | string | Sorting criteria |
return | SchooxResponse
|
public GetEnrolledUsersInCurriculum ( int curriculumId, string role, int regionId = null, int locationId = null, int jobId = null, string letter = null, int start = null, int limit = null, string sort = null ) : SchooxResponse
|
||
curriculumId | int | Curriculum identifier. |
role | string | User's role |
regionId | int | Region identifier. |
locationId | int | Location identifier. |
jobId | int | Job identifier. |
letter | string | Lastname's starting letter |
start | int | List's starting position |
limit | int | Number of users to return per request, up to maximum of 1,000. Default to 100 |
sort | string | Sorting criteria |
return | SchooxResponse
|
public GetEnrolledUsersInExam ( int examId, string role, int regionId = null, int locationId = null, int jobId = null, string letter = null, int start = null, int limit = null, string sort = null ) : SchooxResponse
|
||
examId | int | Exam identifier. |
role | string | User's role |
regionId | int | Region identifier. |
locationId | int | Location identifier. |
jobId | int | Job identifier. |
letter | string | Lastname's starting letter |
start | int | List's starting position |
limit | int | Number of users to return per request, up to maximum of 1,000. Default to 100 |
sort | string | Sorting criteria |
return | SchooxResponse
|
public GetExams ( string role ) : SchooxResponse
|
||
role | string | User's role |
return | SchooxResponse
|
public GetUserCourses ( int userId, string externalId = null ) : SchooxResponse
|
||
userId | int | User identifier. |
externalId | string | Sets whether the id given is the external_id of the User. By default, the value is "false" |
return | SchooxResponse
|
public GetUserCurriculums ( int userId, string externalId = null ) : SchooxResponse
|
||
userId | int | User identifier. |
externalId | string | Sets whether the id given is the external_id of the User. /// By default, the value is "false" |
return | SchooxResponse
|
public GetUserExams ( int userId, string externalId = null ) : SchooxResponse
|
||
userId | int | User identifier. |
externalId | string | Sets whether the id given is the external_id of the User. /// By default, the value is "false" |
return | SchooxResponse
|
public GetUsers ( string role, int userId = null, string externalId = null, int aboveId = null, int unitId = null, int jobId = null, int start = null, int limit = 100, string sort = null ) : SchooxResponse
|
||
role | string | Users' role |
userId | int | User Id to be simulated as logged in user |
externalId | string | Sets whether the id given is the external_id of the User. By default, the value is "false" |
aboveId | int | Above Unit's ID |
unitId | int | Unit's ID |
jobId | int | Job's ID |
start | int | List's starting position |
limit | int | Number of users to return per request, up to maximum of 1,000. Default to 100 |
sort | string | Sorting criteria |
return | SchooxResponse
|