GetTimeTableData (Opus Funktion)
Beschreibung
Diese Funktion gibt den Stundenplan einer Person zurück.
Returns all timetable data for the specified entity over the given date range as a struct with parallel arrays. Each array element corresponds to one lesson row.
Argumente
Name | Typ | Beschreibung |
|---|---|---|
ID | ID des Datensatzes. Die gültigen Typen sind im nächsten Feld ersichtlich. Mit Version 2.4.0.31 kann hier auch [integer] angegeben werden, aber nur bei Typ "SSP_AddressID". Mehrere Adressen abzufragen ist effizienter als wiederholt eine einzelne Adresse abzufragen. | |
IDType | eines der folgenden Werte: "SSB_ClassID" "SSB_ClassGroupID" "SSB_TeacherID" "SSP_AddressID" "SSB_RoomID" "SSB_HouseID" “SSB_ClassSubjectID” Wird etwas anderes übergeben, ist das Resultat undefiniert resp. es werden alle geplanten Lektionen zurückgegeben. | |
PlanningPeriodID | (optional) Planungsperiode Die Planungsperiode muss bei SSB_ClassID und SSB_ClassGroupID nicht mitgegeben werden und wird in diesem Fall ignoriert. Es wird die Planungsperiode der Klasse resp. Klassengruppe genommen. In allen anderen Fällen ist diese Angabe notwendig. | |
StartDate | (optional) Erstes Datum Wird dieses Argument nicht mitgegeben, dann wird das erste Datum der Planungsperiode genommen. | |
EndDate | (optional) Letztes Datum Wird dieses Argument nicht mitgegeben, dann wird das letzte Datum der Planungsperiode genommen. | |
IgnorePublicHolidays | (optional) 0 = (Default) Lektionen an Feiertagen werden aus dem Stundenplan ausgenommen. 1 = Feiertage sollen ignoriert werden. Dies bedeutet, dass Lektionen an diesen Daten im Stundenplan bleiben sollen. | |
CombinationMode | (optional) Nur für die Type "SSB_ClassID" und "SSB_ClassGroupID". Für die anderen Typen hat dieses Argument keine Bedeutung. 0 = (Default) Es werden alle Lektionen ausgegeben, also auch Lektionen, welche mit einer anderen Hauptklasse/-gruppe zusammengelegt sind. 1 = Es werden nur Lektionen ausgegeben, für welche die Klasse oder Klassengruppe die Hauptklasse ist. 2 = Es werden nur Lektionen ausgegeben, für welche es eine andere Hauptklasse gibt. |
Rückgabewert
Es wird ein Objekt mit folgenden Arrays zurückgegeben. Alle Arrays sind gleich gross.
Name | Typ | Beschreibung |
|---|---|---|
AddressID | [integer] | ID der Adressen. |
LessonID | [integer] | ID der Lektionen |
ClassID | [integer] | ID der Klassen Mit GetClassFriendlyName (Opus Funktion) kann der Name der Klasse geholt werden. |
ClassGroupID | [integer] | ID der Klassengruppe. Mit GetClassGroupFriendlyName (Opus Funktion) oder GetClassGroupLongFriendlyName (Opus Funktion) kann der vollständige Name der Gruppe geholt werden |
StartTime | [integer] | Startzeit z.b. 900 für 9.00 Uhr |
EndTime | [integer] | Endzeit |
LessonTypeID | [integer] | ID des Lektionstyps Um die totale Bezeichnung des Faches zu erhalten, kann GetTotalSubjectName (Opus Funktion) verwendet werden |
TeacherID | [integer] | ID des Lehrers |
DayID | [integer] | ID des Tages (1 = Montag ... 7 = Sonntag) |
MainRoomID | [integer] | ID des Hauptraumes |
SubjectID | [integer] | ID des Faches Um die totale Bezeichnung des Faches zu erhalten, kann GetTotalSubjectName (Opus Funktion) verwendet werden |
ClassSubjectID | [integer] | i_SSB_ClassSubjectID |
WeekDate | [datetime] | Datum des Montags in der Woche der Lektion |
Date | [datetime] | Datum der Lektion |
DateID | [integer] |
|
ClassName | [string] | Name der Klasse |
PrintName | [string] | Druckname der Klasse |
ClassGroupList | [string] | Liste von Klassengruppen (ev. nicht vollständig) Mit Version 2.4.0.31 enthält dieses Feld nur noch den Text “ClassGroupList“. |
Beispiel
Lo_TimeTable = GetTimeTableData(Ai_AddressID, "SSP_AddressID",Ai_PlanningPeriodID);
Siehe auch
---