For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

DreamClass API

DreamClass API Curriculum

GetSchoolPeriods

||View as Markdown|

GET

/dreamclassapi/v1/curriculum/schoolperiods/list

GET

/dreamclassapi/v1/curriculum/schoolperiods/list

1 curl https://https//https/dreamclassapi/v1/curriculum/schoolperiods/list \
2      -H "tenant: {{tenant}}" \
3      -H "schoolCode: {{schoolCode}}"

200Curriculum_GetSchoolPeriods_example

1 "[\r\n    {\r\n        \"id\": 1,\r\n        \"name\": \"Dec 2023 - Oct 2024\",\r\n        \"schoolyear\": \"\",\r\n        \"shortName\": \"Y1,\r\n        \"startDate\": \"2023-12-11\",\r\n        \"endDate\": \"2024-10-11\",\r\n        \"duration\": 11.0\r\n    },\r\n    {\r\n        \"id\": 2,\r\n        \"name\": \"2024-2025\",\r\n        \"schoolyear\": null,\r\n        \"shortName\": \"Y2\",\r\n        \"startDate\": \"2024-03-28\",\r\n        \"endDate\": \"2024-04-30\",\r\n        \"duration\": null\r\n    }\r\n]"

Get a list of Schools Periods

Headers

tenantstringOptional

schoolCodestringOptional

Response

OK

Was this page helpful?

GetSchoolCourses

GetPeriodClasses