See the courses versus classes section above for an explanation of the difference between classes and courses.
liss.publishClasses(auth, academicYear, classes)
auth: See authentication
academicYear: a 4-digit year, e.g.
2012. A northern hemisphere school would use e.g.
2012 to refer to the 2012/2013 year.
classes is an array of structs defined as follows:
|string (primary key, i.e. mandatory)||The class |
Maximum 20 chars.
|string||The name of the course. Eg |
|string||The teacher id for the default teacher. The actual teacher assigned to each lesson in the cycle is specified in the |
Note that this field matches the
|string||One of the following strings:|
|string||This string has either 1 or 2 parts. The first element is a |
The next element is optional – if it exists, then a space is used to separate it from the
Maximum 20 chars.
|timestamp||The date the class first runs.|
|timestamp||The date the class runs on. Use |
|string||The colour assigned to the class by the satellite system, in hexadecimal notation: |
|string||The form (aka year-level) associated with the class. Some SIS's don't associate courses or classes with year-levels, in this case ignore this field.|
|string||The faculty (aka department) associated with the class.|
|integer (bit-vector)||A |
To interpret rotations, you will need the
|string||When a class is linked to another class as a composite, i.e. sharing the same teacher and same room, then this will point to the other class. Typically these classes come in pairs, in which case you make one 'Composite' point to the other, but the reverse link should not appear. 'Composite' links involving 3 or more classes are allowed, provided there are no cycles|
|integer||If a student is "invited" to 2 classes at the same time, this number indicates which one they should go to. |
A lower number means high priority. If the numbers are equal then both classes should be displayed on the student's timetable.
|string||Class guid, also known as UUID. 32 hexadecimal characters. They might be uppercase or lowercase, but we require that they do not contain punctuation.|
Nothing - an empty string
"". If anything other than an error is returned it should be ignored. For error reporting see fault codes.
- The SIS may choose to store class objects which do not represent classes managed by the satellite system. These objects typically represent extra-curricular activities such as “Choir”. Conversely the satellite system may store class objects which it does not publish to the SIS, e.g. “helper” classes designed to enforce the correct timetable structure. Each system must have a way to distinguish between classes which are shared versus internal class objects.
- Each call to
liss.publishClasses()will publish the full database of shared classes at the requested date. Therefore the SIS should (a) mark as inactive or (b) terminate the date-range of, or (c) delete from its database, any class which is not found in the returned array.
- There is no DefaultRoom field, because typically, rooms change from period to period.
"ClassCode": "7MAT 1",
"CourseName": "7 Mathematics",