Extension 1 Daily deltas & excursions

• Teacher absences
• Covers for teacher absences
• Excursions
• publishRooms()

Ext 1.1 Publish daily deltas

This is like publishDailyData() except that it publishes just the delta's (i.e. additions and deletions) to the cyclical timetable.

Call

liss.publishDailyDeltas(auth, date1, date2, data)

Parameters

auth: See authentication

date1: timestamp. Any event or teacher absence overlapping one of these dates will be sent by the TS.

date2: timestamp.

data: An array of rows, where each row represents one activity. The rows are defined as in "liss.publishDailyData" with these exceptions:

Field	Type	Notes	Example
isCancelled	boolean	This is a cyclical event which won't run on this particular date.	true
CoverType	string	One of: inlieu, underload, extra or casual.	inlieu
WorkInstructions	string	A string of free text entered into the TS by the regular teacher, as a message to the replacing teacher.	Do chapter 7 of "Maths in Action"
Replacing	string	The teacherId of the regular teacher who can't make this lesson.	2412778
description	string	A description of the event as would make sense to a student.	Yr7 excursion to plywood factory
TeacherIds	string	In addition to normal teacherId(s), the TS can send one of the following strings: minimalSupervision <teacherId> merged <classCode>(no cover required because the class will go to the room and teacher of <classCode>.) no-cover(no cover required because e.g. it's a Yr11/12 class) go-to-library	no-cover

Returns

Nothing - an empty string "". If anything other than an error is returned it should be ignored. For error reporting see fault codes.

Example

Send

{
    "method": "liss.publishDailyDeltas",
    "params": [
        {
            "School": "03014",
            "UserName": "Jsmith",
            "Password": "Password1",
            "LissVersion": 10002,
            "UserAgent": "Edval"
        },
        "20201031T00:00:00",
        "20201214T00:00:00",
        [
            {
                "Date": "20120630T00:00:00",
                "Period": "6",
                "StartTime": "9:30",
                "EndTime": "10:30",
                "ClassCode": "7MAT 1",
                "ClassName": "Mathematics",
                "Type": "StaffMeeting",
                "TeacherIds": "go-to-library",
                "Rooms": "C3,LAB1",
                "Students": "652129,34611,24617,12172",
                "Guid": "34CBF4DCED74B20122414F16614D1253",
                "Details": "Students need to bring sun-block.",
                "Replacing": "54126677",
                "isCancelled": false,
                "CoverType": "inlieu",
                "WorkInstructions": "Do chapter 7 of \"Maths in Action\""
            }
        ]
    ],
    "id": 0
}

Return

{
    "result": "",
    "id": 0
}

Ext 1.2 Publish events and absences

This call allows a TS to send data about excursions and other events and teacher absences to an SIS.

Call

liss.publishEventsAndAbsences(auth, date1, date2, data)

Parameters

auth: See authentication

date1: timestamp. Any event or teacher absence overlapping one of these dates will be sent by the TS.

date2: timestamp.

data : An array of struct’s. Each struct is either an event or an absence, and you can distinguish between the two by seeing what fields appear.

Events are defined as follows:

Field	Type	Notes	Example
start	timestamp mandatory	When does the event begin?	20131004T9:00
finish	timestamp mandatory	When does the event finish?	20131004T15:30
name	string mandatory	An identifier, but it can contain spaces or other punctuation.	Yr7 Plywood factory
type	string mandatory	One of the following values: excursion, incursion, exam, event, supervision, bulletin, cancellation	excursion
description	string	A description of the event as would make sense to a student.	Yr7 excursion to plywood factory

Absences are defines as follows:

Field	Type	Notes	Example
start	timestamp mandatory	When does the absence begin?	20131004T9:00
finish	timestamp mandatory	When does the absence finish?	20131004T15:30
who	string mandatory	The teacher id of the teacher who is absent.	ARC
reasonCode	string mandatory	These codes can be alphanumeric and are expected to be short and elements of a small list of reason codes as configured by the school. The reason codes might include concepts such as: sick, leave, long service leave, maternity leave, personal development.	SK
text	string	A description or comment of the absence.	Attending timetabling workshop

Returns

Nothing - an empty string "". If anything other than an error is returned it should be ignored. For error reporting see fault codes.

Example

Send

{
    "method": "liss.publishEventsAndAbsences",
    "params": [
        {
            "School": "03014",
            "UserName": "Jsmith",
            "Password": "Password1",
            "LissVersion": 10002,
            "UserAgent": "Edval"
        },
        "20201031T00:00:00",
        "20201214T00:00:00",
        [
            {
                "start": "20131004T9:00",
                "finish": "20131004T15:30",
                "name": "Yr7 Plywood factory",
                "type": "excursion",
                "description": "Yr7 excursion to plywood factory"
            },
            {
                "start": "20131004T9:00",
                "finish": "20131004T15:30",
                "who": "ARC",
                "reasonCode": "SK",
                "text": "Attending timetabling workshop"
            }
        ]
    ],
    "id": 0
}

Return

{
    "result": "",
    "id": 0
}