Get timetable

It is more common that the client calls liss.publishTimetable() than liss.getTimetable(). liss.getTimetable() enables an SIS to pull the timetable out of a web-based timetabling system, or enables a timetabling application to pull an existing timetable out of an SIS as part of an initial migration process.

Call

liss.getTimetable(auth, academicYearId, startDate, endDate)

Parameters

auth: See authentication

academicYear: integer. e.g. 2012. For northern hemisphere schools, the academic year will be encoded according to when it starts, e.g. 2012/13 will be encoded as 2012.

startDate: See get students

endDate: See get students

Returns

An array of structs, where each struct represents a single cyclical lesson. See liss.publishTimetable(), because the structs will share the exact same format as that call.

Example

Send

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

Return

{
    "result": [
        {
            "DayNumber": 10,
            "Period": "L2",
            "ClassCode": "7MAT 1",
            "TeacherId": "712611G",
            "RoomId": "651541",
            "RoomCode": "S19",
            "TtStructure": "2012Junior"
        }
    ],
    "id": 0
}