Get a classroom | Sample - GitHub REST API

1 parameter

classroom_idintegerrequired

The unique integer identifier of the classroom.

1 status code

410Returned when the operation is no longer available after the Classroom service sunset.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 410 is returned because this operation is closing down and is no longer available. classroom_id must be an integer identifying the classroom.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.classrooms.get({ classroomId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" });

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

Request

Response

Errors