Skip to main content
Edmentum Support

API extended commands

How To

The following list of commands are now available using the PLATO API. The following commands require the use of the ia.ple.platoweb.com URL.

NOTe: Normal API.PLE.PLATOWEB.COM commands will not function on the ia.ple.platoweb.com site

What's Next

List of commands

Below is the description of the action you wish to perform, followed by the URI, Method and Parameters. These are followed by what is returned by the API. These commands are compatible with both PLE 2.0 and Plato Courseware 3.5 where noted. No other commands are accessible via the API.

 

A new API is releasing for Plato Courseware and will be available prior to the end of 2015. The API will include an explorer application to browse and test all avaialble commands. You can see a demo of the explorer here: https://ed-api.ple.platoweb.com/help/index

 

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

 

 

 

 

 

 

 

 

 

 


How to get more help

Copyright Information

Virtual Workshops

Keep your implementation on track. As part of your Edmentum partnership, we provide ongoing training through our comprehensive collection of virtual workshops delivered on-demand. Whether you’re an advanced user who needs more detailed support to meet a specific need, or brand new to the Edmentum suite of services, we have a workshop for you.


Click here to register today for Edmentum Virtual Workshops!

  • Was this article helpful?