classroom_assignments

Creates, updates, deletes, gets or lists a classroom_assignments resource.

Overview

Name	classroom_assignments
Type	Resource
Id	github.classroom.classroom_assignments

Fields

The following fields are returned by SELECT queries:

list_assignments_for_a_classroom

Response

Name	Datatype	Description
id	integer	Unique identifier of the repository.
accepted	integer	The number of students that have accepted the assignment.
classroom	object	A GitHub Classroom classroom (title: Simple Classroom)
deadline	string (date-time)	The time at which the assignment is due. (example: 2011-01-26T19:06:43Z)
editor	string	The selected editor for the assignment. (example: codespaces)
feedback_pull_requests_enabled	boolean	Whether feedback pull request will be created on assignment acceptance.
invitations_enabled	boolean	Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.
invite_link	string	The link that a student can use to accept the assignment. (example: https://classroom.github.com/a/Lx7jiUgx)
language	string	The programming language used in the assignment. (example: elixir)
max_members	integer	The maximum allowable members per team.
max_teams	integer	The maximum allowable teams for the assignment.
passing	integer	The number of students that have passed the assignment.
public_repo	boolean	Whether an accepted assignment creates a public repository.
slug	string	Sluggified name of the assignment. (example: intro-to-binaries)
students_are_repo_admins	boolean	Whether students are admins on created repository on accepted assignment.
submitted	integer	The number of students that have submitted the assignment.
title	string	Assignment title. (example: Intro to Binaries)
type	string	Whether it's a Group Assignment or Individual Assignment. (individual, group) (example: individual)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_assignments_for_a_classroom	select	classroom_id	page, per_page	Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
classroom_id	integer	The unique identifier of the classroom.
page	integer	The page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_page	integer	The number of results per page (max 100). For more information, see "Using pagination in the REST API."

SELECT examples

list_assignments_for_a_classroom

Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.

SELECT
id,
accepted,
classroom,
deadline,
editor,
feedback_pull_requests_enabled,
invitations_enabled,
invite_link,
language,
max_members,
max_teams,
passing,
public_repo,
slug,
students_are_repo_admins,
submitted,
title,
type
FROM github.classroom.classroom_assignments
WHERE classroom_id = '{{ classroom_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;