PerlearnerApi class

Constructors

PerlearnerApi([ApiClient? apiClient])

Properties

apiClient → ApiClient
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
perlearnerOrgsUsersActivityRetrieve(String org, String userId, {String? format, int? groupId}) → Future<ActivityAPI?>
Provides information on user enrollments Params user_id e.g developer@ibleducation.com| developer
perlearnerOrgsUsersActivityRetrieveWithHttpInfo(String org, String userId, {String? format, int? groupId}) → Future<Response>
Provides information on user enrollments Params user_id e.g developer@ibleducation.com| developer
perlearnerOrgsUsersCoursesGradingCutoffsRetrieve(String courseId, String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<PerlearnerGradeWithCutOff?>
Provides about a learner current grade in a course with the course cut Kwargs 1. course_id e.g course-v1:Org+Course4+Run 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
perlearnerOrgsUsersCoursesGradingCutoffsRetrieveWithHttpInfo(String courseId, String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Provides about a learner current grade in a course with the course cut Kwargs 1. course_id e.g course-v1:Org+Course4+Run 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
perlearnerOrgsUsersCoursesGradingDetailRetrieve(String courseId, String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<DetailedGradeView?>
Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
perlearnerOrgsUsersCoursesGradingDetailRetrieveWithHttpInfo(String courseId, String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
perlearnerOrgsUsersCoursesGradingSummaryRetrieve(String courseId, String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<PerlearnerGradeSummary?>
Query Params 1. course_id e.g course-v1:Org+Course4+Run 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
perlearnerOrgsUsersCoursesGradingSummaryRetrieveWithHttpInfo(String courseId, String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Query Params 1. course_id e.g course-v1:Org+Course4+Run 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
perlearnerOrgsUsersCoursesOverviewEngagementIndexRetrieve(String courseId, String org, String userId) → Future<Value?>
Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days for a learner in a course
perlearnerOrgsUsersCoursesOverviewEngagementIndexRetrieveWithHttpInfo(String courseId, String org, String userId) → Future<Response>
Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days for a learner in a course
perlearnerOrgsUsersCoursesOverviewGradeRetrieve(String courseId, String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<PerlearnerGradeWithCutOff?>
Provides about a learner current grade in a course with the course cut Kwargs 1. course_id e.g course-v1:Org+Course4+Run 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
perlearnerOrgsUsersCoursesOverviewGradeRetrieveWithHttpInfo(String courseId, String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Provides about a learner current grade in a course with the course cut Kwargs 1. course_id e.g course-v1:Org+Course4+Run 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
perlearnerOrgsUsersCoursesOverviewPerformanceIndexRetrieve(String courseId, String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Value?>
Evaluates performance index for platform, per course, per user and per user-per course Query Params course_id
perlearnerOrgsUsersCoursesOverviewPerformanceIndexRetrieveWithHttpInfo(String courseId, String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Evaluates performance index for platform, per course, per user and per user-per course Query Params course_id
perlearnerOrgsUsersCoursesOverviewTimeOverTimeRetrieve(String courseId, String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Overtime?>
Time spent within a course in secs on a per-day basis Kwargs 1. course_id e.g course-v1:Org+Course4+Run 2. user_id e.g developer@ibleducation.com or dev123 (username|email) Query Params 3. start_date e.g 2020-10-01 4. end_date e.g 2020-10-10 Default result when no query param is added is last_7_days (today inclusive)
perlearnerOrgsUsersCoursesOverviewTimeOverTimeRetrieveWithHttpInfo(String courseId, String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Time spent within a course in secs on a per-day basis Kwargs 1. course_id e.g course-v1:Org+Course4+Run 2. user_id e.g developer@ibleducation.com or dev123 (username|email) Query Params 3. start_date e.g 2020-10-01 4. end_date e.g 2020-10-10 Default result when no query param is added is last_7_days (today inclusive)
perlearnerOrgsUsersCoursesVideosOverTimeRetrieve(String courseId, String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Overtime?>
Watched Videos count on a per-day basis Kwargs 1. course_id
perlearnerOrgsUsersCoursesVideosOverTimeRetrieveWithHttpInfo(String courseId, String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Watched Videos count on a per-day basis Kwargs 1. course_id
perlearnerOrgsUsersCoursesVideosRetrieve(String courseId, String org, String userId, {String? format, int? groupId}) → Future<PerLearnerCourseVideosWatched?>
List of videos within a course a learner has watched Kwargs 1. course_id e.g course-v1:Org+Course4+Run 2. user_id e.g developer@ibleducation.com or dev123 (username|email) Default result when no query param is added is [], 0
perlearnerOrgsUsersCoursesVideosRetrieveWithHttpInfo(String courseId, String org, String userId, {String? format, int? groupId}) → Future<Response>
List of videos within a course a learner has watched Kwargs 1. course_id e.g course-v1:Org+Course4+Run 2. user_id e.g developer@ibleducation.com or dev123 (username|email) Default result when no query param is added is [], 0
perlearnerOrgsUsersGradesPerCourseRetrieve(String org, String userId, {String? format, int? groupId}) → Future<PerlearnerGradingPerCourseAPI?>
Summary Grading Information for a learner on a per-enrollment basis Query Params 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
perlearnerOrgsUsersGradesPerCourseRetrieveWithHttpInfo(String org, String userId, {String? format, int? groupId}) → Future<Response>
Summary Grading Information for a learner on a per-enrollment basis Query Params 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
perlearnerOrgsUsersInfoRetrieve(String org, String userId, {String? format, int? groupId, String? meta, String? search}) → Future<LearnerInformationAPI?>
Returns dictionary of user PII
perlearnerOrgsUsersInfoRetrieveWithHttpInfo(String org, String userId, {String? format, int? groupId, String? meta, String? search}) → Future<Response>
Returns dictionary of user PII
perlearnerOrgsUsersLastAccessRetrieve(String org, String userId, {String? format, int? groupId}) → Future<PerLearnerLastAccess?>
Last course accessed by a learner, includes upto unit information as well
perlearnerOrgsUsersLastAccessRetrieveWithHttpInfo(String org, String userId, {String? format, int? groupId}) → Future<Response>
Last course accessed by a learner, includes upto unit information as well
perlearnerOrgsUsersOverviewEngagementIndexRetrieve(String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Value?>
Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days
perlearnerOrgsUsersOverviewEngagementIndexRetrieveWithHttpInfo(String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days
perlearnerOrgsUsersOverviewGradesAverageRetrieve(String org, String userId, {String? format, int? groupId}) → Future<Average?>
Average grade value for platform, course, or user. Query Params course_id
perlearnerOrgsUsersOverviewGradesAverageRetrieveWithHttpInfo(String org, String userId, {String? format, int? groupId}) → Future<Response>
Average grade value for platform, course, or user. Query Params course_id
perlearnerOrgsUsersOverviewPerformanceIndexRetrieve(String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Value?>
Evaluates performance index for platform, per course, per user and per user-per course Query Params course_id
perlearnerOrgsUsersOverviewPerformanceIndexRetrieveWithHttpInfo(String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Evaluates performance index for platform, per course, per user and per user-per course Query Params course_id
perlearnerOrgsUsersOverviewTimeOverTimeRetrieve(String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Overtime?>
Time spent in secs on a per-day basis Query Params 1. course_id
perlearnerOrgsUsersOverviewTimeOverTimeRetrieveWithHttpInfo(String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Time spent in secs on a per-day basis Query Params 1. course_id
perlearnerOrgsUsersRetrieve(String org, {String? format, int? groupId, int? length, int? page, String? search}) → Future<PerlearnerUserList?>
List of entire learners on the platform with aggregated enrollments, completions and time spent
perlearnerOrgsUsersRetrieveWithHttpInfo(String org, {String? format, int? groupId, int? length, int? page, String? search}) → Future<Response>
List of entire learners on the platform with aggregated enrollments, completions and time spent
perlearnerOrgsUsersVideosOverTimeRetrieve(String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Overtime?>
Watched Videos count on a per-day basis Kwargs 1. course_id
perlearnerOrgsUsersVideosOverTimeRetrieveWithHttpInfo(String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Watched Videos count on a per-day basis Kwargs 1. course_id
perlearnerOrgsUsersVideosPerCourseRetrieve(String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<PerlearnerEngagementVideosWatchedPerCourse?>
Summary Videos watched data for a learner per enrollment Query Params 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
perlearnerOrgsUsersVideosPerCourseRetrieveWithHttpInfo(String org, String userId, {String? endDate, String? format, int? groupId, String? startDate}) → Future<Response>
Summary Videos watched data for a learner per enrollment Query Params 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited