Skip to main content
Edmentum Support

API v2 Extended Commands

 

User Management

        PLE Plato Courseware
Description URI Method Parameters Returns Notes    
Create a User /v2/User POST User User Instructors and learners only X X
Deactivate a User /v2/User/{UserId} DELETE UserId --   X X
Get a User by UserId /v2/User/{UserId} GET UserId User   X X
Update a User /v2/User/{UserId} PUT UserId & User --   X X
Get a list of valid Roles /v2/Role GET -- List of Role   X X
Get a list of valid Grade Levels  /v2/GradeLevel GET -- List of GradeLevel   X X
               
Location Management         PLE Plato Courseware
Description URI Method Parameters Returns Notes    
Get a list of Locations /v2/Location GET -- List of Location   X X
Get a list of Users in a Location /v2/Location/{LocationId}/User GET LocationId List of User   X X
Get a list of Users in a Location /v2/Location/{LocationId}/User/?activeUsersOnly={bool} GET LocationId & True/False for ActiveUsersOnly List of User   X X
Get a list of Classes in a Location /v2/Location/{LocationId}/Class GET LocationId List of Classrooms for PLE   X  
Get a list of Classes in a Location /v2/Class/GetAll GET -- List of Classrooms for Plato Courseware     X
Gets a single location /v2/Location/{locationId} GET -- Location   X X
               
Class Management         PLE Plato Courseware
Description URI Method Parameters Returns Notes    
Create a Class /v2/Class POST Classroom Classroom   X X
Delete (Deactivate) a Class /v2/Class/{ClassId} DELETE ClassId --   X X
Get a Class by ClassId /v2/Class/{ClassId} GET ClassId Classroom   X X
Update Class details /v2/Class/{ClassId} PUT ClassId --   X X
Get a list of learners for a Class /v2/Class/{ClassId}/Learners/?activeUsersOnly={bool} GET LocationId & True/False for ActiveUsersOnly List of User   X X
Get a list of instructors for a Class /v2/Class/{ClassId}/Instructors/?activeUsersOnly={bool} GET LocationId & True/False for ActiveUsersOnly List of User   X X
Enroll an Existing User in a Class, by UserId /v2/Class/{ClassId}/User/{UserId} POST ClassId & UserID --   X X
Un-Enrolls a Learner from a Class /v2/Class/{ClassId}/User/{UserId} DELETE ClassId & UserID --   X X
Get a User from a Class by UserId /v2/Class/{ClassId}/User/{UserId} GET ClassId & UserID User   X X
               
Assignment Management         PLE Plato Courseware
Description URI Method Parameters Returns Notes    
Get a list of valid CourseResources /v2/CourseResources GET -- List of Plato Courses   X X
Get a list of Custom Courses /v2/CourseResources?resourceType=CustomCourse GET -- List of Custom Courses   X X
Get a list of resource types  /v2/ResourceTypes Get -- List of resource types which can be called using "/v2/CourseResources"   X X
Gets list of Assignments for a Class /v2/Class/{classId}/Assignment GET ClassId List of Assignment Top level assignment, not details X X
Creates an Assignment for a Class /v2/Class/{classId}/Assignment POST ClassId & Assignment --   X X
               
Grade and Progress Data Management          PLE Plato Courseware
Description URI Method Parameters Returns Notes    
Gets the current average grade for a course section that is calculated in PLE currently, as well as the number of completed activities. /v2/Class/{classId}/StudentProgress GET ClassID list of StudentProgress   X X
Gets the static gradebook info for a section. /v2/Class/{classId}/GradebookInfo GET ClassID list of GradebookInfo returnAll - If true will return activities from all gradebookpages, False: only first X X
Gets the scores from PLE  /v2/Class/{classId}/GradebookScores GET ClassID list of GradebookScores returnAll - If true will return activities from all gradebookpages, False: only first X X
Gets account Gradebooks /v2/Account/Gradebooks GET startDate list of GradebookClass nullable datetime (defaults to seven days) X X
Gets account Gradebook Items /v2/Account/GradebookItems GET startDate list of GradebookInfo nullable datetime (defaults to seven days) X X
Gets account Gradebook scores /v2/Account/GradebookScores GET startDate list of AccountGradebookScore nullable datetime (defaults to seven days) X X
  • Was this article helpful?