Skip to main content

Get class memberships

Call​

liss.getClassMemberships(auth, asAtDate)

Parameters​

auth: See authentication

asAtDate: See get students

Returns​

An array of struct’s as defined in publish class memberships.

Semantics​

  • Each call to liss.getClassMemberships() will return the full database of class memberships at the requested date. Therefore the satellite system should delete from its database any class membership which is not found in the returned array.
  • Some SIS’s and timetabling systems have a concept whereby class membership is defined at the level of a group of classes, e.g. 7HIS1 and 7GEO1 share the same class lists. This structure is not defined in LISS, and therefore in such cases, the class membership will be expanded so that the array contains entries for all classes.

Example​

Send

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

Return

{
    "result": [
        {
            "StudentId": "46217",
            "ClassCode": "C3",
            "StartDate": "C3",
            "EndDate": 29
        }
    ],
    "id": 0
}