Specifications‎ > ‎

Extension 2

1. liss.getCourses()

Call:

liss.getCourses(auth : authenticationObject)

Parameters:

auth : See section 3.3

Returns:

An array of structs.  Each struct is defined as follows:

 Field Type Notes Example
 Code string (mandatory)A short identifier which uniquely identifies this course.

11BIO 
 Namestring (mandatory) A human-understandable description of the subject. Typically the year-level would not be included because this would be displayed automatically (see 'YearLevel') or inferred from the context. Biology
 YearLevel string Which year-level the course is associated with. Note - it is still possible for students in other year-levels to attend classes of this course. 11
 Colour stringThe colour associated with this course, in hexadecimal notation: RRGGBB, like the HTML colour format but without the '#' prefix. 0000ff
 Units integer (mandatory) What a 'unit' means depends on the school system. However, units must be 1 or more. 2
 Guid string32 hexadecimal characters. They might be uppercase or lowercase, but we require that they do not contain punctuation. EF6E5950ED748E5A9D4997A8B7337099

2. Additional fields in liss.getTeachers():

See the main specifications for the 'liss.getTeachers()' call.  We propose to add:

 Field Type Notes Example
 CoursesstringA comma-separated list of course codes (as defined above) representing the courses this teacher is qualified for.  If a teacher prefers not to take a particular course but is qualified for it, then this can be put in brackets.  If a teacher can take a particular course if there is no alternative, "if desperate", then the course should be enclosed in double brackets.

11BIO,12BIO,(11PHY),((12PHY)),10SCI,9SCI,8SCI,7SCI,(7MAT)
 



3. liss.getStudentSubjectPreferences()

Call:

liss.getCourses(auth : authenticationObject, electiveForm : string)

Parameters:

auth : See section 3.3

Returns:

An XmlRpc array of XmlRpc struct’s.  Each struct is defined as follows:

 Field Type Notes Example
 StudentId    string (primary key, i.e. mandatory)The student's identifier

ABB3321
 Prefsstring (mandatory) A comma-separated string of course codes. These should be in preference order, i.e. the most desired course specified first.  In the most optimistic case, the student will be granted all courses.  The number of units the student wishes to take can be computed by summing the number of units of each of these courses. 11ENG,11MMA,11COM,11ENGEXT,11PHY,11ART
 Reserves string A comma-separated string of course codes representing the student's fallback preferences, i.e. what courses to take if they can't get granted the preferred courses. 11LEG,11IST