Specifications‎ > ‎

Extension 1: daily delta's and excursions


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

1. liss.publishDailyDeltas

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 : authenticationObject, date1 : timestamp, date2 : timestamp, data : array)

Parameters:

auth : See section 3.3

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

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
 isCancelledbooleanThis is a cyclical event which won't run on this particular datetrue
CoverTypestringOne of:  "inlieu", "underload", "extra" or "casual"inlieu
WorkInstructionsstringA 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 stringThe teacherId of the regular teacher who can't make this lesson.2412778
description stringA 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


2. liss.publishEventsAndAbsences

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

Call:

liss.publishEventsAndAbsences(auth : authenticationObject, date1 : timestamp, date2 : timestamp, data : array)

Parameters:

auth : See section 3.3

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

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
 starttimestamp (mandatory)When does the event begin?    

20131004T9:00
finishtimestamp (mandatory) When does the event finish?20131004T15:30
namestring (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, cancellationexcursion
description stringA 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
 starttimestamp (mandatory)When does the absence begin?    

20131004T9:00
finishtimestamp (mandatory) When does the absence finish?20131004T15:30
whostring (mandatory)The teacher id of the teacher who is absentARC
 reasonCodestring (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 stringA description or comment of the absence.Attending timetabling workshop