updateAssignment: Update Assignment Details

View source: R/AssignmentFunctions.R

updateAssignmentR Documentation

Update Assignment Details

Description

This function modifies one or more attributes of an assignment.

Usage

updateAssignment(
  section_id,
  assignment_id,
  title = NULL,
  description = NULL,
  due = NULL,
  grading_scale = NULL,
  grading_category = NULL,
  max_points = NULL,
  factor = NULL,
  is_final = NULL,
  show_comments = NULL,
  grade_stats = NULL,
  allow_dropbox = NULL,
  allow_discussion = NULL,
  published = NULL,
  type = NULL,
  grade_item_id = NULL,
  dropbox_submissions = NULL,
  last_dropbox_submission = NULL,
  show_rubric = NULL,
  grading_period = NULL,
  assignees = NULL,
  grade_group_ids = NULL
)

Arguments

section_id

The id of the assignment section

assignment_id

The id of the assignment to update.

title

The assignment title

description

The assignment description

due

When the assignment is due

grading_scale

The ID of the grading scale for this assignment. For no grading scale, use "0". Course grading scales can be found on the course Grade Setup page.

grading_category

The grading category ID to which this assignment belongs

max_points

The maximum number of points for this assignment (excl. extra credit)

factor

The relative weight of this assignment

is_final

Mark this assignment as a midterm or final

show_comments

Show grade comments to students

grade_stats

0 - Hide statistics, 1 - Show statistics without bell curve

allow_dropbox

Allow students to post assignment submissions to a dropbox.

allow_discussion

Enable the assignment profile discussion board

published

Whether or not the assignment is published

type

Distinguishes different types of grade items (grade items being a broad term for anything that can have a grade).

grade_item_id

If this is of type assignment, this ID will point to the assignment object id attribute. If this is of type discussion, this ID will point to the discussion object ID.

dropbox_submissions

This field is only available to teachers and will only be returned if the ?with_dropbox_stats=TRUE argument is given. This is a snapshot of the number of submissions in this assignments dropbox

last_dropbox_submission

This field is only available to teachers and will only be returned if the ?with_dropbox_stats=TRUE argument is given. This is a timestamp representing when the last dropbox revision was submitted.

show_rubric

This field is true when the assignment is using a rubric and the teacher has enabled the option for students to see the rubric.

assignees

This field shows which enrollees are assigned a particular assignment. This field can be used in a POST or PUT operation. If an empty array is sent in, all assignees will be removed from the assignment

grading_group_ids

This field shows what grading groups are assigned a particular assignment. This field can be used in a POST or PUT operation. If an empty array is sent in, all grading groups will be removed from the assignment

Value

A dataframe of updated assignment details.

References

API Documentation


sterfa02/SchoologyAPI documentation built on Jan. 10, 2023, 11:27 p.m.