Extension 2 Elective data

Ext 2.1 Get courses

Call

liss.getCourses(auth)

Parameters

auth: See authentication

Returns

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

FieldTypeNotesExample
Codestring mandatoryA short identifier which uniquely identifies this course.11BIO
Namestring mandatoryA 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
YearLevelstringWhich 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
ColourstringThe colour associated with this course, in hexadecimal notation: RRGGBB, like the HTML colour format but without the '#' prefix.0000ff
Unitsinteger mandatoryWhat a 'unit' means depends on the school system. However, units must be 1 or more.2
Guidstring32 hexadecimal characters. They might be uppercase or lowercase, but we require that they do not contain punctuation.EF6E5950ED748E5A9D4997A8B7337099

Example

Send

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

Return

{
"result": [
{
"Code": "11BIO",
"Name": "Biology",
"YearLevel": "11",
"Colour": "0000FF",
"Units": 2,
"Guid": "EF6E5950ED748E5A9D4997A8B7337099"
}
],
"id": 0
}

Ext 2.2 Additional fields in Get teachers

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

FieldTypeNotesExample
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)

Ext 2.3 Get Student Subject Preferences

Call

liss.getCourses(auth, electiveForm)

Parameters

auth: See authentication

electiveForm: string.

Returns

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

FieldTypeNotesExample
StudentIdstring mandatoryThe student's identifier.ABB3321
Prefsstring mandatoryA 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
ReservesstringA 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

Example

Send

{
"method": "liss.getCourses",
"params": [
{
"School": "03014",
"UserName": "Jsmith",
"Password": "Password1",
"LissVersion": 10002,
"UserAgent": "Edval"
},
"11_Elecs"
],
"id": 0
}

Return

{
"result": [
{
"StudentId": "12345",
"Prefs": "11ENG,11MMA,11COM,11ENGEXT,11PHY,11ART",
"Reserves": "11LEG,11IST"
}
],
"id": 0
}