Publish class memberships
Call
liss.publishClassMemberships(auth, membership, asAtDate)
Parameters
auth
: See authentication
membership
: an array of structs defined as follows:
Field | Type | Notes | Example |
---|---|---|---|
StudentId | string mandatory | The alphanumeric student identifier (see liss.getStudents() . Maximum 20 chars. | 8722004A |
ClassCode | string mandatory | The class code. See Classes and courses . Maximum 20 chars. | 7MAT 1 |
StartDate | timestamp | The date/(time?) the class membership takes effect. This field and endDate are only needed if the class membership is a subset of the startDate/endDate date-range of the class. | 20130203T0:00:00 |
EndDate | timestamp | The date/(time?) the class membership terminates. | 20130614T23:59:00 |
asAtDate
: See get students
Returns
Nothing - an empty string ""
. If anything other than an error is returned it should be ignored. For error reporting see fault codes.
Semantics
- 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
and7GEO1
share the same class lists. This structure is not defined in LISS, and therefore in such cases, the class membership should be expanded so that the array contains entries for all classes.
Example
Send
{
"method": "liss.publishClassMemberships",
"params": [
{
"School": "03014",
"UserName": "Jsmith",
"Password": "Password1",
"LissVersion": 10002,
"UserAgent": "Edval"
},
[
{
"StudentId": "46217",
"ClassCode": "C3",
"StartDate": "C3",
"EndDate": 29
}
],
"20201031T00:00:00"
],
"id": 0
}
Return
{
"result": "",
"id": 0
}