Get rooms

Call

liss.getRooms(auth)

Parameters

auth: See authentication

Returns

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

FieldTypeNotesExample
RoomIdstring (primary key, i.e. mandatory)A unique alphanumeric identifier for the room. Maximum 20 chars.46217
RoomCodestring mandatoryA unique mnemonic identifier for the room. This is important because the liss.publishTimetable call uses RoomCode’s rather than RoomId’s.
Maximum 20 chars.
C3
NamestringThe room’s name. Usually identical to RoomCode. If it is identical to RoomCode then RoomName can be omitted.C3
CapacityintegerThe capacity of the room – the number of students able to be seated .29
CampusstringCremmorne
CommentstringA free-text comment about the room.Hearing loop enabled

Semantics

  • Both RoomId and RoomCode must be unique.
  • RoomId is the primary key – that is, it is mandatory and unique. If a record arrives where the RoomId matches a record in the satellite system but the RoomCode is different, then the RoomCode will be updated in the satellite system to the value given in this call.
  • Each call to liss.getTeachers() will return the full database of teachers employed by the school at the requested date. Therefore the satellite system should delete from its database any teacher which is not found in the returned array.
  • Timetabling system vendors should consider whether they should disable the creation or deletion of rooms in their own screens in installations which are using LISS.

Example

Send

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

Return

{
"result": [
{
"RoomId": "46217",
"RoomCode": "C3",
"Name": "C3",
"Capacity": 29,
"Campus": "Cremmorne",
"Comment": "Hearing loop enabled"
}
],
"id": 0
}