Get a classroom assignment | GitHub API (unofficial showcase)

1 parameter

assignment_idintegerrequired

The unique identifier of the classroom assignment.

1 status code

410Returned when this operation is no longer available.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 410 is returned because this operation is closing down. The assignment_id path parameter identifies the classroom assignment.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
});

const result = await client.assignments.get({ assignmentId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "message": "This is an example message.",
  "documentation_url": "https://example.com",
  "url": "https://example.com",
  "status": "active"
}

Request

Response

Errors