ClassDetails.md

ClassDetails

A classroom

Properties

Name	Type
id	string
state	ClassState
name	string
section	string
description	string
organization	string
owner	string
creationDate	Date
modificationDate	Date
enrollmentCode	string
theme	string
assignmentsCount	number
studentsGroup	GroupDetails
teachersGroup	GroupDetails
issues	ClassDetailsIssues
googleClassroom	ClassDetailsGoogleClassroom
googleDrive	ClassDetailsGoogleDrive
microsoftGraph	ClassDetailsMicrosoftGraph
lti	ClassDetailsLti
canvas	ClassDetailsCanvas
mfc	ClassDetailsMfc
clever	ClassDetailsClever
level	ClassGradeLevel
skillsFocused	Array<string>
size	number

Example

import type { ClassDetails } from 'flat-api'

// TODO: Update the object below with actual values
const example = {
  "id": null,
  "state": null,
  "name": null,
  "section": null,
  "description": null,
  "organization": null,
  "owner": null,
  "creationDate": null,
  "modificationDate": null,
  "enrollmentCode": null,
  "theme": null,
  "assignmentsCount": null,
  "studentsGroup": null,
  "teachersGroup": null,
  "issues": null,
  "googleClassroom": null,
  "googleDrive": null,
  "microsoftGraph": null,
  "lti": null,
  "canvas": null,
  "mfc": null,
  "clever": null,
  "level": null,
  "skillsFocused": null,
  "size": null,
} satisfies ClassDetails

console.log(example)

// Convert the instance to a JSON string
const exampleJSON: string = JSON.stringify(example)
console.log(exampleJSON)

// Parse the JSON string back to an object
const exampleParsed = JSON.parse(exampleJSON) as ClassDetails
console.log(exampleParsed)

[Back to top] [Back to API list] [Back to Model list] [Back to README]