Skip to content

Commit

Permalink
docs: call out learner report vs. enrollment report
Browse files Browse the repository at this point in the history
  • Loading branch information
brianreichtcs committed May 29, 2024
1 parent 5564117 commit 79780db
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
3 changes: 3 additions & 0 deletions src/Client.php
Original file line number Diff line number Diff line change
Expand Up @@ -989,6 +989,9 @@ public function revokePermissions(
/**
* Make a GetLearnerReport query to the SmarterU API.
*
* Note: SmarterU has begun calling this an Enrollment Report, but the API
* method and XML request/response still refer to it as a learner Report.
*
* @param GetLearnerReportQuery $query The query by which to filter the
* results of the Learner Report.
* @return LearnerReport[] A list of all LearnerReports matching the query.
Expand Down
5 changes: 4 additions & 1 deletion src/DataTypes/LearnerReport.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@
* A Learner Report, also known as an Enrollment Report, enables course
* managers to view the progress of Users who have been assigned to the
* course. Please refer to the SmarterU documentation for further information:
* https://support.smarteru.com/v1/docs/enrollment-report
* https://support.smarteru.com/v1/docs/enrollment-report.
*
* Note: SmarterU has begun calling this an Enrollment Report, but the API
* method and XML request/response still refer to it as a learner Report.
*/
class LearnerReport {
/**
Expand Down

0 comments on commit 79780db

Please sign in to comment.