Get Class

GET /classes/{classId}

Api key

Get a Class

Path parameters

classId string(uuid) Required

Class UUID.

Responses

200 application/json

OK
Hide response attribute Show response attribute object
- class object Required
  
  Hide class attributes Show class attributes object
  
  classId string(uuid) Required
  
  Class UUID.
  
  name string Required
  
  The name of the class
  
  description string
  
  Optional class description
  
  academicYearId string(uuid) Required
  
  Academic Year UUID.
400

Invalid request.
401

Invalid authentication credentials
403

Not authorised to access this resource
404

Class not found.

GET /classes/{classId}

curl \
 --request GET 'https://connect.century.tech/api/v1/classes/c81fd38c-03f6-4b68-8720-84a7233e89de' \
 --header "x-api-key: $API_KEY"

Response examples (200)

{
  "class": {
    "name": "Algebra 101",
    "classId": "c81fd38c-03f6-4b68-8720-84a7233e89de",
    "description": "An introductory course to Algebra",
    "academicYearId": "dccd109a-08ca-4a18-a277-4653ba726316"
  }
}