zervo/GoSkola24API
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Expand godoc

Browse source
This commit is contained in:
zervo 2024-12-10 12:06:08 +01:00
parent aa7c403e60
commit 9b6da62bb1
2 changed files with 8 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
goskola24api.go
View file

@ -33,30 +33,37 @@ type Skola24API struct {
Host string
}
// Get all available terms (aka semesters) from the active host/domain
func (api Skola24API) GetTerms() (_result pubtypes.Terms, _error error) {
return requests.GetTerms(api.Host)
}
// Get all available schools from the active host/domain
func (api Skola24API) GetSchools() (_result []pubtypes.School, _error error) {
return requests.GetSchools(api.Host)
}
// Get all available rooms from a school
func (api Skola24API) GetRooms(school pubtypes.School, checkAvailability bool) (_result []pubtypes.Room, _error error) {
return requests.GetRooms(school, checkAvailability)
}
// Get all available teachers from a school
func (api Skola24API) GetTeachers(school pubtypes.School, checkAvailability bool) (_result []pubtypes.Teacher, _error error) {
return requests.GetTeachers(school, checkAvailability)
}
// Get all available students from a school (EXPERIMENTAL)
func (api Skola24API) GetStudents(school pubtypes.School, checkAvailability bool) (_result any, _error error) {
return requests.GetStudents(school, checkAvailability)
}
// Get all available classes from a school
func (api Skola24API) GetClasses(school pubtypes.School, checkAvailability bool) (_result []pubtypes.Class, _error error) {
return requests.GetClasses(school, checkAvailability)
}
// Get a week schedule for the provided date, school, term and class
func (api Skola24API) GetWeekSchedule(year int, week int, school pubtypes.School, term pubtypes.SchoolTerm, class pubtypes.Class) (_result any, _error error) {
return requests.GetSchedule(year, week, 0, school, term, class)
}

2
types/schedules.go
View file

@ -32,5 +32,5 @@ type Lesson struct {
DayOfWeek int `json:"dayOfWeek"` // Day of the week where lesson occurs (monday=1)
Start time.Time `json:"start"` // Time when the lesson starts
End time.Time `json:"end"` // Time when the lesson ends
Texts []string `json:"texts"` // Extra texts that may be displayed on timetable
Texts []string `json:"texts"` // Extra texts that may be displayed on a timetable
}