Course Groups API

Course Groups API

core_group_add_group_members

Arguments
members (Required)

General structure
list of ( 
object {
groupid int   //group record id
userid int   //user id
)

REST (POST parameters)
members[0][groupid]= int
members[0][userid]= int


core_group_delete_group_members

Arguments
members (Required)

General structure
list of ( 
object {
groupid int   //group record id
userid int   //user id
)

REST (POST parameters)
members[0][groupid]= int
members[0][userid]= int


core_group_create_groups

Arguments
groups (Required)
        List of group object. A group has a courseid, a name, a description and an enrolment key.

General structure
  //List of group object. A group has a courseid, a name, a description and an enrolment key.
list of ( 
object {
courseid int   //id of course
name string   //multilang compatible name, course unique
description string   //group description text
descriptionformat int  Default to "1" //description format (1 = HTML, 2 = PLAIN or 4 = MARKDOWN)
enrolmentkey string  Optional //group enrol secret phrase
idnumber string  Optional //id number
)

REST (POST parameters)
groups[0][courseid]= int
groups[0][name]= string
groups[0][description]= string
groups[0][descriptionformat]= int
groups[0][enrolmentkey]= string
groups[0][idnumber]= string

core_group_delete_groups

Arguments
groupids (Required)

General structure
list of ( 
int   //Group ID
)
REST (POST parameters)
groupids[0]= int

    • Related Articles

    • Manually Create Course Groups

      OVERVIEW Course groups in Pluto LMS are a feature that allows for the organization and management of students or learners within a course. Overall, course groups in an LMS are a valuable feature for organizing and managing learners in a way that ...
    • Bulk Add Users to Course Groups

      OVERVIEW You can add a large number of existing users to course groups by uploading a text (.csv) file to perform a bulk action. In order to bulk upload users to course groups, these groups must already exist in the relevant course on your Pluto LMS. ...
    • Manually Add Users to Course Groups

      OVERVIEW You can manually add users to existing course groups. Note: In order to add users to course groups, the groups must already have been created in the relevant course. USE CASE EXAMPLE: Manually adding users to course groups in a Learning ...
    • Bulk Create Course Groups

      OVERVIEW If you need to create a large number of course groups in a specific course, you can use the "Import" function in that course to upload a text (.csv) file and create groups in bulk. USE CASE EXAMPLE: Bulk creating course groups in a Learning ...
    • Course API

      core_course_get_courses Arguments options (Default to "Array ( ) ")         options - operator OR is used General structure  Default to "Array ( ) " //options - operator OR is used object { ids  Optional //List of course id. If empty return all ...