Get timetable structures

Some SIS’s and timetabling systems divide cyclical lessons into multiple data-sets called Timetable structures. For example, the K-6 school and the 7-12 school might be in different timetable structures, or the International Baccalaureate students might be in a different timetable structure to the other Yr11/12 students. These timetable structures are created for various reasons, for example because different bell times apply to different groups of students, or because the data-sets largely involve separate groups of teachers/rooms/students with just very minimal interaction between them.

This call pulls down the timetable structure as set up in the SIS. The satellite system needs to get these identifiers in order to attach to the cyclical lessons in liss.publishTimetable().

Call

getTimetableStructures(auth, asAtDate)

Parameters

auth: See authentication

asAtDate: See get students

Returns

An array of structs. Each struct has these members:

Field	Type	Notes	Example
TtStructure	string mandatory	Each cyclical lesson will have a TtStructure field, linking it to the object defined in this struct. Maximum 20 chars.	2012 2012T4 2012VCE
AcademicYear	integer	The year as a 4-digit number. In the case of Northern Hemisphere schools, 2011-2012 will be encoded as 2011.	2011
Terms	array of structs – see below	The set of terms comprising this timetable. The terms do not have id’s because we automatically refer to the first array element as term 1, and so on.

Term objects:

Field	Type	Notes	Example
SemesterId	integer mandatory	Which semester: in most schools this will be either 1 or 2, but in LISS it can be any integer >= 1.	2
Semester	string mandatory	The name of the semester.	Semester 1
TermId	integer mandatory	The term number, Can be any integer >= 1.	4
Term	string mandatory	Term name.	Term 4
StartDate	timestamp mandatory	The start date for the term.	20120201T00:00:00
EndDate	timestamp mandatory	The end date for the term?	20120629T23:59:00

Example

Send

{
    "method": "liss.getTimetableStructures",
    "params": [
        {
            "School": "03014",
            "UserName": "Jsmith",
            "Password": "Password1",
            "LissVersion": 10002,
            "UserAgent": "Edval"
        },
        "20201031T00:00:00"
    ],
    "id": 0
}

Return

{
    "result": [
        {
            "TtStructure": "2012VCE",
            "AcademicYear": 2011,
            "Terms": [
                {
                    "SemesterId": 2,
                    "Semester": "Semester 1",
                    "TermId": 4,
                    "Term": "Term 4",
                    "StartDate": "20120201T00:00:00",
                    "EndDate": "20120629T23:59:00"
                }
            ]
        }
    ],
    "id": 0
}