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

    • 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 ...

    • Course Completion API

      core_completion_get_activities_completion_status Arguments courseid (Required)         Course ID General structure int   //Course ID REST (POST parameters) courseid= int userid (Required)         User ID General structure int   //User ID REST (POST ...

    • Enrollment API

      enrol_manual_enrol_users Arguments enrolments (Required) General structure list of (  object { roleid int   //Role to assign to the user userid int   //The user that is going to be enrolled courseid int   //The course to enrol the user role in ...

    • Grades API

      gradereport_overview_get_course_grades Arguments userid (Default to "0")         Get grades for this user (optional, default current) General structure int  Default to "0" //Get grades for this user (optional, default current) REST (POST parameters) ...

    • Calendar API

      core_calendar_create_calendar_events Arguments events (Required) General structure list of (    //event object { name string   //event name description string  Default to "null" //Description format int  Default to "1" //description format (1 = HTML, ...