API: Classes endpoints¶
/classes¶
GET¶
Info
List owned and managed classes.
Input:
Output:
- list
- string code: class identification string
- string name: title of the class
/class¶
GET¶
Info
Get/check class.
Input:
- [!] string class: class identification string
Output:
- string class: class identification string
- string name: title of the class
- datetime/null start: start date and time (if set)
- datetime/null end: end date and time (if set)
/class:members¶
GET¶
Info
List all members in a class.
Input:
- [!] string class: class identification string
Output:
- list
- string code: user identification string
- string name: name of the member
- boolean active: active membership (approved and not expired)
POST¶
Info
Assign user(s) to a class. Updates memberships if already member of the class.
Input:
- [!] string class: class identification string
- [!] string users: comma-separated list of user identification strings
- integer/datetime expires: expiry in days or
YYYY-MM-DD HH:ii:ss
DELETE¶
Info
Remove user(s) from a class.
Input:
- [!] string class: class identification string
- [!] string users: comma-separated list of user identification strings
/classes:members¶
POST¶
Info
Assign user(s) to class(es). Updates memberships if already member of a class.
Input:
- [!] string classes: comma-separated list of class identification strings
- [!] string users: comma-separated list of user identification strings
- integer/datetime expires: expiry in days or
YYYY-MM-DD HH:ii:ss
/user:classes¶
GET¶
Info
List all classes a user is member of.
Input:
- [!] string user: user identification string
Output:
- list
- string code: class identification string
- string name: title of the class
- boolean active: active membership (approved and not expired)
POST¶
Info
Assign user to class(es). Updates membership if already member of a class.
Input:
- [!] string user: user identification string
- [!] string classes: comma-separated list of class identification strings
- integer/datetime expires: expiry in days or
YYYY-MM-DD HH:ii:ss
DELETE¶
Info
Remove user from class(es).
Input:
- [!] string user: user identification string
- [!] string classes: comma-separated list of class identification strings
Last update: October 30, 2020