Skip to main content

Terms

Manage academic terms within sessions (First, Second, Third term).

All endpoints require Authorization: Bearer <token>. X-SCHOOL-ID is required for fetching terms.


Create Term

POST /terms

Create a new academic term within a session.

Request Body

FieldTypeRequiredDescription
session_iduuidYesAcademic session ID
termenumYesOne of: FIRST, SECOND, THIRD
display_namestringYesHuman-readable name (e.g., "First Term 2024")

Example

curl -X POST https://api.vanillatots.com/terms \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"session_id": "session-uuid",
"term": "FIRST",
"display_name": "First Term 2024"
}'

Response 200 OK

{
"id": "uuid",
"term": "FIRST",
"sessionId": "session-uuid",
"displayName": "First Term 2024"
}

Get Term

GET /terms/{termId}

Retrieve a single term by ID.

Path Parameters

ParameterTypeDescription
termIduuidTerm ID

Response 200 OK — Returns a TermResponse object.