Documentation
¶
Index ¶
- type ApiConfig
- type AuthParams
- type AuthResponse
- type Class
- type ClassRegEvents
- type Department
- type Exam
- type GetExamsRequest
- type GetPersonIdRequest
- type GetSubstitutionsRequest
- type GetTimetableRequest
- type GetTimetableRequestElement
- type GetTimetableSimpleRequest
- type Holiday
- type IdObject
- type OriginalData
- type Period
- type PeriodWithAbsenceObject
- type RPCError
- type RPCRequest
- type RPCResponse
- type Room
- type SchoolYear
- type StartAndEndDate
- type StatusData
- type Student
- type Subject
- type Substitutions
- type Teacher
- type TimegridUnit
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthParams ¶
type AuthParams struct {
User string `json:"user"`
Password string `json:"password"`
Client string `json:"client"`
}
AuthParams represents the parameters for the authenticate method.
type AuthResponse ¶
type AuthResponse struct {
SessionID string `json:"sessionId"`
PersonType int `json:"personType"`
PersonID int `json:"personId"`
KlasseId int `json:"klasseId"`
}
AuthResponse represents the result of the authenticate method.
type ClassRegEvents ¶
type ClassRegEvents struct {
StudentId int `json:"studentid"`
Surname string `json:"surname"`
Forname string `json:"forname"`
Date int `json:"date"` // Date conversion (current format: int YYYYMMDD)
Subject string `json:"subject"`
Reason string `json:"reason"`
Text string `json:"text"`
CategoryId int `json:"categoryId"`
}
type Department ¶
type Exam ¶
type Exam struct {
Id int `json:"id"`
Classes []Class `json:"classes"`
Teachers []Teacher `json:"teachers"`
Students []Student `json:"students"`
Subject int `json:"subject"`
Date int `json:"date"` // Date conversion (current format: int YYYYMMDD)
StartTime int `json:"startTime"` // Date / Time conversion (current format: int HHMM)
EndTime int `json:"endTime"` // Date / Time conversion (current format: int HHMM)
}
type GetExamsRequest ¶
type GetPersonIdRequest ¶
type GetSubstitutionsRequest ¶
type GetTimetableRequest ¶
type GetTimetableRequest struct {
Element GetTimetableRequestElement `json:"element"`
StartDate int `json:"startDate,omitempty"` // number, format: YYYYMMDD, optional (default: current date)
EndDate int `json:"endDate,omitempty"` // number, format: YYYYMMDD, optional (default: current date)
OnlyBaseTimetable bool `json:"onlyBaseTimetable,omitempty"` // boolean, returns only the base timetable (without bookings etc.)(default:false)
ShowBooking bool `json:"showBooking,omitempty"` // returns the period's booking info if available (default: false)
ShowInfo bool `json:"showInfo,omitempty"` // returns the period information if available (default: false)
ShowSubstText bool `json:"showSubstText,omitempty"` // returns the Untis substitution text if available (default: false)
ShowLsText bool `json:"showLsText,omitempty"` // returns the text of the period's lesson (default: false)
ShowLsNumber bool `json:"showLsNumber,omitempty"` // returns the number of the period's lesson (default: false)
ShowStudentgroup bool `json:"showStudentgroup,omitempty"` // returns the name(s) of the studentgroup(s) (default: false)
KlasseFields []string `json:"klasseFields,omitempty"` // optional, values: „id“, „name“, „longname“, „externalkey“ //TODO: to enum
RoomFields []string `json:"roomFields,omitempty"` // optional, values: „id“, „name“, „longname“, „externalkey“//TODO: to enum
SubjectFields []string `json:"subjectFields,omitempty"` // optional, values: „id“, „name“, „longname“, „externalkey“//TODO: to enum
TeacherFields []string `json:"teacherFields,omitempty"` // optional, values: „id“, „name“, „longname“, „externalkey“//TODO: to enum
}
type GetTimetableRequestElement ¶ added in v1.0.6
type OriginalData ¶ added in v1.2.0
type OriginalData interface {
}
type Period ¶
type Period struct {
Id int `json:"id"`
Date int `json:"date"`
StartTime int `json:"startTime"`
EndTime int `json:"endTime"`
Classes []Class `json:"kl"`
Teachers []Teacher `json:"te"`
Subjects []Subject `json:"su"`
Rooms []Room `json:"ro"`
OriginalClasses []Class `json:"orgkl,omitempty"`
OriginalTeachers []Teacher `json:"orgte,omitempty"`
OriginalSubjects []Subject `json:"orgsu,omitempty"`
OriginalRooms []Room `json:"orgro,omitempty"`
LessonType string `json:"lstype,omitempty"` //„ls“ (lesson) | „oh“ (office hour) | „sb“ (standby) | „bs“ (break supervision) | „ex“(examination) omitted if lesson
Code string `json:"code,omitempty"` //„“ | „cancelled“ | „irregular“ omitted if empty
Info string `json:"info"` //Only in custom request
SubstitutionText string `json:"substText"` //Only in custom request
LessonText string `json:"lstext,omitempty"` //omitempty only in non-custom request
LessonNumber int `json:"lsnumber"` //Only in custom request
StatisticalFlags string `json:"statflags,omitempty"` //omitempty only in non-custom request
StudentGroup string `json:"sg"`
BookingRemark string `json:"bkRemark"`
BookingText string `json:"bkText"`
ActivityType string `json:"activityType,omitempty"`
}
type PeriodWithAbsenceObject ¶
type PeriodWithAbsenceObject struct {
}
type RPCRequest ¶
type RPCRequest struct {
ID string `json:"id"`
Method string `json:"method"`
Params interface{} `json:"params"`
JSONRPC string `json:"jsonrpc"`
}
RPCRequest represents a JSON-RPC request.
type RPCResponse ¶
type RPCResponse struct {
JSONRPC string `json:"jsonrpc"`
ID string `json:"id"`
Result json.RawMessage `json:"result"`
Error *RPCError `json:"error,omitempty"`
}
RPCResponse represents a JSON-RPC response.
type SchoolYear ¶
type StartAndEndDate ¶
type StatusData ¶
type StatusData struct {
Lstypes json.RawMessage `json:"lstypes"`
Codes json.RawMessage `json:"codes"`
}
type Substitutions ¶
type Substitutions struct {
Type string `json:"type"` //"cancel" -> cancellation | subst -> teacher substitution | add -> additional period | shift -> shifted period | rmchg -> room change | rmlk -> locked period | bs -> break supervision | oh -> office hour | sb -> standby | other -> foreign substitutions | free -> free periods | ac -> activity | holi -> holiday | stxt -> substitution text
LessonId int `json:"lsid"`
Date int `json:"date"` // Date conversion (current format: int YYYYMMDD)
StartTime int `json:"startTime"` // Date / Time conversion (current format: int HHMM)
EndTime int `json:"endTime"` // Date / Time conversion (current format: int HHMM)
Classes []IdObject `json:"kl"`
Teachers []IdObject `json:"te"`
Subjects []IdObject `json:"su"`
Rooms []IdObject `json:"ro"`
SubstitutionText string `json:"txt"`
Reschedule struct {
Date int `json:"date"` // Date conversion (current format: int YYYYMMDD)
StartTime int `json:"startTime"` // Date / Time conversion (current format: int HHMM)
EndTime int `json:"endTime"` // Date / Time conversion (current format: int HHMM)
} `json:"reschedule"`
}
type TimegridUnit ¶
Click to show internal directories.
Click to hide internal directories.