create_course_group_in_category: create_course_group_in_category

Description Usage Arguments Value Examples

View source: R/simple_functions.R

Description

Creates a group in a predefined Canvas group category

Creates a group in a predefined Canvas group category

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
create_course_group_in_category(
  groupcat_id,
  name,
  description = NULL,
  is_public = NULL,
  join_level = NULL,
  storage_quota_mb = NULL,
  sis_group_id = NULL
)

create_course_group_in_category(
  groupcat_id,
  name,
  description = NULL,
  is_public = NULL,
  join_level = NULL,
  storage_quota_mb = NULL,
  sis_group_id = NULL
)

Arguments

groupcat_id

the canvas id of the group category (integer)

name

the name of the group(string/character)

description

a description of the group (string/character)

is_public

make the group public (boolean)

storage_quota_mb

storage quota of the group page in megabytes (integer)

sis_group_id

the sis id of the group (integer)

Value

server response. Either 200 status code if everything went correctly or a specific http status warning.

server response. Either 200 status code if everything went correctly or a specific http status warning.

Examples

1
2
3
4
5
create_course_group_in_category(6348, "Werkgroepen_1")
create_course_group_in_category(groupcat_id = 6348, name = "Werkgroepen_1", is_public = T, storage_quota_mb = 20)

create_course_group_in_category(6348, "Werkgroepen_1")
create_course_group_in_category(groupcat_id = 6348, name = "Werkgroepen_1", is_public = T, storage_quota_mb = 20)

ICTO-FMG/uvacanvas documentation built on Jan. 24, 2022, 5:16 a.m.