# info.description
List of APIs related to Account Management, User and Group

# paths./Resource/{ResourceID}/Student.get.description
To get a list of users who only have read access (students) for the module.

Only ID and Name is returned for read access. Managerial access can view all fields.

# paths./Resource/{ResourceID}/Student.get.parameters[].description
StudentRoster = To return only students from the Student Roster; GuestRoster = To return students from Guest Roster. Else return all students.

# paths./Resource/{ResourceID}/Student.get.parameters[].description
Accepted populate entities: groupIDs, photo, isInClassRoster, isInGuestRoster, isAudit.

isAudit indicates whether the student is auditing the module.

# paths./Resource/{ResourceID}/Student.get.responses.403.description
Login user not authorized to perform this action

# paths./Group/{ID}.get.parameters[].description
Accepted populate entities: user, photo, siblingGroupIDs, studentCount.
            
            "siblingGroupIDs" is only applicable for class groups, excluding root class groups. Root class groups will return null.

# paths./Group/{ID}.get.responses.403.description
Login user not authorized to perform this action

# paths./Group/{ID}.delete.description
Delete a guest group or class group only.

For class group, this will delete the sub-groups under the main group too.

# paths./Group/{ID}.delete.responses.403.description
Login user not authorized to perform this action

# paths./Group/{ID}/User.get.parameters[].description
Accepted populate entities: groupIDs, isInClassRoster, isInGuestRoster, photo, isAudit. 
            isInClassRoster is not applicable for Student Roster.
            
            isAudit is only applicable for Student Roster. It indicates whether the student is auditing the module.

# paths./Group/{ID}/User.get.responses.403.description
Login user not authorized to perform this action

# paths./Group/Descendant.get.description
To get the immediate level descendant groups under the parent class group.

Applicable only to class groups.

Returns only the next level of descendant groups under the given main/parent class group.

# paths./Group/Descendant.get.parameters[].description
Accepted populate entities: students, photo, groupIDs, studentCount, groupAccess, parentGroupID.

Can only populate photo and/or groupIDs if populate students.

# paths./Group/Descendant.get.responses.403.description
Login user not authorized to perform this action

# paths./Resource/{ResourceID}/ClassGroup.get.description
Get a list of class groups for the module.

# paths./Resource/{ResourceID}/ClassGroup.get.parameters[].description
Accepted populate entities: students, photo, groupIDs, studentCount, groupAccess, parentGroupID.

Can only populate photo and/or groupIDs if populate students.

# paths./Resource/{ResourceID}/ClassGroup.get.responses.403.description
Login user not authorized to perform this action

# paths./Resource/{ResourceID}/GuestGroup.get.description
Get a list of guest groups for the module.

# paths./Resource/{ResourceID}/GuestGroup.get.parameters[].description
Accepted populate entities: students, photo, groupIDs, studentCount, groupAccess, parentGroupID.

Can only populate photo and/or groupIDs if populate students.

# paths./Resource/{ResourceID}/GuestGroup.get.responses.403.description
Login user not authorized to perform this action

# paths./ClassGroup.put.responses.403.description
Login user not authorized to perform this action

# paths./ClassGroup.post.description
Add Class Group(s), without users.

Can only create up to 100 class groups at one go.

# paths./ClassGroup.post.responses.403.description
Login user not authorized to perform this action

# paths./ClassGroup.delete.description
Remove user(s) from all the class groups of the module.

One can only remove self from the module's class groups if and only if self is no longer in the rosters.
If facilitator remove user(s) from the module's class groups, no check on whether user(s) is/are in the rosters.

# paths./ClassGroup.delete.responses.403.description
Login user not authorized to perform this action

# paths./GuestGroup.put.responses.403.description
Login user not authorized to perform this action

# paths./GuestGroup.post.description
Add guest group, without users.

Sub-group creation is not allowed.

# paths./GuestGroup.post.responses.403.description
Login user not authorized to perform this action

# paths./Group/User.post.description
Add User to non-EduRec groups.

Not applicable to class roster and oracle groups.

For Class Group: This function is mainly for self-enrollment. If AllowMultipleSignUp option is false, disallow adding the user to the class group if already belongs to a existing class group under the same main/parent group.

# paths./Group/User.post.responses.403.description
Login user not authorized to perform this action

# paths./Group.put.description
Update a list of users in the group.

1. Mainly for batch import.

2. Not applicable to class roster and oracle groups.

3. For class group, if AllowMultiple option is false, prevent adding user to class group if user already in other class group under the same main/parent group.

# paths./Group.put.responses.403.description
Login user not authorized to perform this action

# paths./Group.delete.description
Delete guest groups or class groups only.

For class groups, this will delete the sub-groups under the main groups too.

# paths./Group.delete.responses.403.description
Login user not authorized to perform this action

# paths./Groups.put.description
Update users to the list of groups.

1. The list of groups must be of the same main/parent group.

2. No sub-groups under the list of groups.

3. Mainly for batch import.

4. Not applicable to class roster and oracle groups.

5. For class group, if AllowMultipleSignUp option is false, prevent adding user to class group if user already in other class group under the same main/parent group.

# paths./Groups.put.responses.403.description
Login user not authorized to perform this action

# paths./.delete.description
Remove a list of users from a group.

Not applicable to class roster and oracle groups.

# paths./.delete.responses.403.description
Login user not authorized to perform this action

# paths./Groups/Email.post.description
Send email to students in the selected student groups.

# paths./Groups/Email.post.responses.200.description
List of students which email was sent to

# paths./Groups/Email.post.responses.403.description
Login user not authorized to perform this action

# paths./Group/ImportByExcel.post.description
Batch import users into a group from excel sheet. Not for self-enrolment.

1. Mainly for batch import.

2. Not applicable to class roster and oracle groups.

3. For class group, if AllowMultiple option is false, prevent adding user to class group if user already in other class group under the same main/parent group.

4. Error messages are returned as concatenated string, with "\n" as the delimiter.

# paths./Group/ImportByExcel.post.responses.403.description
Login user not authorized to perform this action

# paths./Group/DeleteByExcel.post.description
Remove a list of users from a group by excel sheet.

1. Applicable for guest roster groups and class groups.

2. Error messages are returned as concatenated string, with "\n" as the delimiter.

# paths./Group/DeleteByExcel.post.responses.403.description
Login user not authorized to perform this action

# paths./Groups/{ResourceID}/Excel.post.description
Export groups and its students to excel, with given parameters.

Export main groups as sheets respectively, and Sub-groups within the sheet instead.

# paths./Groups/{ResourceID}/Excel.post.parameters[].description
Format - uuid. Resource ID, i.e. the Module ID

# paths./Groups/{ResourceID}/Excel.post.requestBody.description
The information of the Grade Item Scores to be exported based on the parameters

# paths./Groups/{ResourceID}/Excel.post.responses.403.description
Login user not authorized to perform this action

# paths./SyncModule.post.description
To sync one's enrolment (modules and EduRec groups).

1. For users with student role only.
2. Get the officially enrolled modules and EduRec groups from the EduRec web service for the current term to sync to LumiNUS.

# paths./SyncModule.post.responses.403.description
Login user not authorized to perform this action

# paths./Auth/UserInRole/{RoleName}.get.responses.401.description
Login user not authorized to perform this action

# paths./Profile.get.parameters[].description
Accepted populate entities: friendlyEmail, photo, groupId, userRole, acadCareer, matricYear, CurrentYearOfStudy, programme, careerProgramList.
            matricYear is the matriculation year of the student.
            CurrentYearOfStudy indicates in which year the student is in.
            careerProgramList is a list of programmes, careers the student is admitted.

# paths./Profile.get.responses.403.description
Login user not authorized to perform this action

# paths./Module/{ResourceID}/Guest/{ID}.get.description
Get guest accounts for the module.

Only facilitators can access.

# paths./Module/{ResourceID}/Guest/{ID}.get.responses.403.description
Login user not authorized to perform this action

# paths./Role.get.description
Get a list of roles types.

1. Only Super Admin role has the access to retrieve list of roles.

2. Library Super Admin has the access to retrieve only lib admin role.

# paths./Role.get.responses.403.description
Login user not authorized to perform this action

# paths./Role.put.description
Update roles types of user.

1. Only Super Admin role has the access to update user roles.

2. Library Super Admin has the access to update only lib admin role for users.

# paths./Role.put.responses.403.description
Login user not authorized to perform this action

# paths./Role.post.description
Add roles of user.

1. Only Super Admin role has the access to add user roles.

2. Library Super Admin has the access to only add lib admin role.

# paths./Role.post.responses.403.description
Login user not authorized to perform this action

# paths./{ID}/Role.get.description
Get roles of a user.

1. Only Super Admin role has the access to get the roles of users.

2. Library Super Admin has the access to retrieve only lib admin role of users. Other non lib admin roles of users will not be returned.

# paths./{ID}/Role.get.responses.403.description
Login user not authorized to perform this action

# paths./Profile/Staff.put.description
To update profile of staff or visitor (external).

# paths./Profile/Staff.put.requestBody.description
The information of the staff/visitor profile to be edited

# paths./Profile/Staff.put.responses.403.description
Login user not authorized to perform this action

# paths./Profile/Staff.patch.description
To update profile of staff or visitor (external). (patch)

# paths./Profile/Staff.patch.requestBody.description
The information of the staff/visitor profile to be edited

# paths./Profile/Staff.patch.responses.403.description
Login user not authorized to perform this action

# paths./Profile/Student.put.requestBody.description
The information of the student profile to be edited

# paths./Profile/Student.put.responses.403.description
Login user not authorized to perform this action

# paths./Profile/Student.patch.requestBody.description
The information of the student profile to be edited

# paths./Profile/Student.patch.responses.403.description
Login user not authorized to perform this action

# paths./Profile/Guest.put.requestBody.description
The information of the guest profile to be edited

# paths./Profile/Guest.put.responses.403.description
Login user not authorized to perform this action

# paths./Profile/Guest.patch.requestBody.description
The information of the guest profile to be edited

# paths./Profile/Guest.patch.responses.403.description
Login user not authorized to perform this action

# paths./Module/Guest.put.description
Update guest (gst) account for the module.

Users who are the owner or the facilitators of the module can update the guest (gst) account for the module.

# paths./Module/Guest.put.requestBody.description
The information of the guest account in the module to be edited

# paths./Module/Guest.put.responses.403.description
Login user not authorized to perform this action

# paths./PasswordResetToken.post.description
Send out an email containing a reset password link for guest account (of the given userid).

This is for guest account (gst) users only.

# paths./PasswordResetTokenValidity.post.description
Check validity when loading the password reset form.

# paths./{UserGuid}/Role/{RoleID}.delete.description
1. Only Super Admin role has the access to delete user roles.

2. Only Library Super Admin has the access to delete Library Admin role of user.

# paths./{UserGuid}/Role/{RoleID}.delete.responses.403.description
Login user not authorized to perform this action

# paths./Module/{ResourceID}/Groups/Search.get.description
To search for groups or students based on the filter.

Only facilitators of the module permitted.

# paths./Module/{ResourceID}/Groups/Search.get.parameters[].description
Format - uuid. ResourceID, i.e. Module ID

# paths./Module/{ResourceID}/Groups/Search.get.parameters[].description
Format - uuid. ID of Main/Parent Group. Applies to Class Groups only.

# paths./Module/{ResourceID}/Groups/Search.get.parameters[].description
Format - int32. Group Type to filter. Pass in -1 if search for students not within the group.
            Class Group = 1, Student Roster = 2, Guest Group = 10, Lecture Group = 21, Tutorial Group = 22, Laboratory Group = 23, Sectional Group = 24, Ensemble Group = 25, Independent Group = 26, Others Group = 27, Mini Project Group = 28, Recitation Group = 29,Seminar Group = 30, SupervisionGroup = 31, Workshop Group = 32

# paths./Module/{ResourceID}/Groups/Search.get.responses.200.description
Returns a list of groups and/or students

# paths./Module/{ResourceID}/Groups/Search.get.responses.403.description
Login user not authorized to perform this action

# paths./Resource/{ResourceID}/Group.get.description
To get a list of student groups in the module which the user belongs to.

# paths./Resource/{ResourceID}/Group.get.responses.200.description
Returns a list of [contract.User.Models.Groups]

# paths./Resource/{ResourceID}/Group.get.responses.403.description
Login user not authorized to perform this action

# paths./Module/{ResourceID}/Group.get.description
To get a list of student groups for the module.

# paths./Module/{ResourceID}/Group.get.parameters[].description
Accepted populate entities: students, photo, groupIDs, studentCount, groupAccess, parentGroupID.

Can only populate photo and/or groupIDs if populate students.

# paths./Module/{ResourceID}/Group.get.responses.403.description
Login user not authorized to perform this action

# paths./Resource/{ResourceID}/ClassRosterGroup.get.description
Get a list of student roster groups for the module.

# paths./Resource/{ResourceID}/ClassRosterGroup.get.parameters[].description
Accepted populate entities: students, photo, groupIDs, studentCount, groupAccess.

Can only populate photo and/or groupIDs if populate students.

# paths./Resource/{ResourceID}/ClassRosterGroup.get.responses.403.description
Login user not authorized to perform this action

# paths./Resource/{ResourceID}/OracleGroup.get.description
Get a list of EduRec groups for the module.

# paths./Resource/{ResourceID}/OracleGroup.get.parameters[].description
Accepted populate entities: students, photo, groupIDs, studentCount, groupAccess, parentGroupID, classLecturer, moduleTimeTable.

Can only populate photo and/or groupIDs if populate students.

classLecturer indicates the object class of teaching staff or the TA who teaches the group.

# paths./Resource/{ResourceID}/OracleGroup.get.responses.403.description
Login user not authorized to perform this action

# paths./ClassGroupFromOfficial.post.summary
Import class group(s) from EduRec groups

# paths./ClassGroupFromOfficial.post.description
Import Class Group(s) with users from EduRec groups

# paths./ClassGroupFromOfficial.post.responses.403.description
Login user not authorized to perform this action

# paths./Groups/Randomise.post.description
Randomise users to the list of class groups, with the option to save it.

1. The list of groups must be of the same main/parent group.

2. No sub-groups under the list of groups.

3. Mainly for batch import.

4. Applicable for class groups only.

5. If the user already in existing class group for the under the same main/parent group, it will be over-written by the new grouping.

# paths./Groups/Randomise.post.responses.403.description
Login user not authorized to perform this action

# paths./Search.post.description
Search for the list of users based on the search criteria.

Results :

1. Only up to 20 records will be returned.

2. Only users with Staff or TA roles are permitted to search.

# paths./Search.post.responses.200.description
Returns a list of [API_User.API.Users] subset

# paths./Search.post.responses.403.description
Login user not authorized to perform this action

# paths./Guest.get.description
Get a list of guest accounts created by requestor.

The "isInModule" populate indicates whether the guest account is being added into module. Can be added as a manager or student of the module.

# paths./Guest.get.responses.200.description
Returns a list of [API_User.API.Users] object

# paths./Guest.get.responses.403.description
Login user not authorized to perform this action

# paths./Guest.put.description
Update guest (gst) account created by the Login User.

Only to be used in the User Management

# paths./Guest.put.responses.403.description
Login user not authorized to perform this action

# paths./Guest.patch.description
Update guest (gst) account created by the Login User. (patch).

Only to be used in the User Management

# paths./Guest.patch.requestBody.description
The information of the User to be edited

# paths./Guest.patch.responses.403.description
Login user not authorized to perform this action

# paths./Guest/{ID}.get.description
Get details of a guest account.

Only creator of the guest account have the permission.

# paths./Guest/{ID}.get.parameters[].description
Accepted populate entities: modules.

The "modules" populate indicates whether the guest account is being added into module. Can be added as a manager or student of the module. Disregard the check for active flags.

# paths./Guest/{ID}.get.responses.403.description
Login user not authorized to perform this action

# paths./Guest/{ID}.delete.responses.403.description
Login user not authorized to perform this action

# paths./Guests.get.description
Get a list of guest accounts under the email address.

# paths./Module/{ResourceID}/User/{ID}.get.description
Get a list of users for the module.

Only facilitators allowed.

# paths./Module/{ResourceID}/User/{ID}.get.parameters[].description
Accepted populate entities: groupIDs, isAudit.
            
            isAudit applies to students only. It indicates whether the student is auditing the module.

# paths./Module/{ResourceID}/User/{ID}.get.responses.403.description
Login user not authorized to perform this action

# paths./Guest/ImportByExcel.post.description
Batch import guest accounts from excel sheet.

1. If new users, will create guest accounts, and add into the guest group (if guest group is provided).

---> Only "create guest account" role allowed to create guest (gst) accounts.
---> This will also add guest user role for the guest (gst) accounts.

2. If existing, will not create new accounts, but simply add into the guest group.

3. If group is provided, only guest group allowed.

4. Error messages are returned as concatenated string, with "\n" as the delimiter.

# paths./Guest/ImportByExcel.post.responses.201.description
the added guest accounts and/or existing users records

# paths./Guest/ImportByExcel.post.responses.403.description
Login user not authorized to perform this action

# paths./Group/Users.post.description
Add list of users to non-EduRec groups. Only applicable to Guest Group.

Only facilitators of the module allowed.

# paths./Group/Users.post.responses.403.description
Login user not authorized to perform this action

# paths./Group/ImportMultipleGroupsByExcel.post.description
Import groups (main/parent and sub/child groups) and users by creating new class groups and import users into these new groups from excel sheet.

1. Mainly for batch import.

2. Applicable for class group only.

3. Error messages are returned as concatenated string, with "\n" as the delimiter.

4. Ability to create new main/parent class groups and new sub class groups under the new main/parent class groups.

# paths./Group/ImportMultipleGroupsByExcel.post.responses.200.description
Returns the main/parent class groups records created

# paths./Group/ImportMultipleGroupsByExcel.post.responses.403.description
Login user not authorized to perform this action

# paths./Group/UsersByNumber.post.description
Add list of users to non-EduRec groups (by user number). Only applicable to Guest Group.

Only facilitators of the module allowed.

# paths./Group/UsersByNumber.post.responses.403.description
Login user not authorized to perform this action

# paths./Group/UsersByNumber.delete.description
Remove a list of users from a group (by user numbers).

Applicable for guest groups only.

# paths./Group/UsersByNumber.delete.responses.403.description
Login user not authorized to perform this action

# paths./GuestMapping/{ResourceID}.get.parameters[].description
Accepted populate entities: creator, group.

# paths./GuestMapping/{ResourceID}.get.responses.403.description
Login user not authorized to perform this action

# paths./NonNUSUser.post.description
Add non-NUS user to a guest group. ==> Add guest mapping.

Only user with "GUESTACCOUNTCREATION" role is allowed to add a non-NUS user.

Only non-NUS email domain is allowed.

This will only add the mapping of the guest and the module's guest group. The user record is not created. User record will only be created after user first login into LumiNUS.

# paths./NonNUSUser.post.responses.403.description
Login user not authorized to perform this action

# paths./Simulate/{userId}.post.description
To simulate a given user.

One need to have Super Admin and Simulate roles to simulate user.

# paths./Simulate/{userId}.post.responses.200.description
Returns the simulated information when success

# paths./Simulate/{userId}.post.responses.403.description
Login user not authorized to perform this action

# paths./GuestMapping.delete.description
To delete non-NUS user from the guest group of non-NUS users whom have yet login into LumiNUS.

# paths./GuestMapping.delete.responses.403.description
Login user not authorized to perform this action

# paths./GuestMappingMultiple.delete.description
To delete list of non-NUS users whom have yet login into LumiNUS from the guest group(s).

# paths./GuestMappingMultiple.delete.responses.403.description
Login user not authorized to perform this action

# paths./Simulate.post.description
To simulate a given user.

One need to have Super Admin and Simulate roles to simulate user.

# paths./Simulate.post.responses.200.description
Returns the simulated information when success

# paths./Simulate.post.responses.403.description
Login user not authorized to perform this action

# paths./GuestMapping/EmailActivation.post.description
Send email to remind unactivated guest account to activate.

# paths./GuestMapping/EmailActivation.post.responses.403.description
Login user not authorized to perform this action

# paths./{ResourceID}/accessReport/{ID}.get.summary
Get access report of a user against a top level resource

# paths./{ResourceID}/accessReport/{ID}.get.description
display the access rights of a user against a top level resource, the sub-resources which he can access and the sub-resources which he cannot access

# paths./ClassGroupBasedOnRoster.post.description
Create main class group with users added in from selected rosters, together with sub-groups creation.

Can only create up to 100 sub-groups at one go.

# paths./ClassGroupBasedOnRoster.post.responses.201.description
Returns the main class group record created

# paths./ClassGroupBasedOnRoster.post.responses.403.description
Login user not authorized to perform this action

# paths./ClassGroupBasedOnEduRecGroup.post.summary
Add class group(s) based on EduRec groups

# paths./ClassGroupBasedOnEduRecGroup.post.description
Create main class groups based on selected EduRec groups (of the same group type) with users added in, together with sub-groups creation.

Can only create up to 100 sub-groups at one go.

# paths./ClassGroupBasedOnEduRecGroup.post.responses.403.description
Login user not authorized to perform this action

# paths./NUSUser.post.description
Add new NUS user from AD.

Only user with "STAFF" role is allowed to add a new NUS user into the Users table.

# paths./NUSUser.post.responses.403.description
Login user not authorized to perform this action

# paths./NUSUsers.post.description
Add new NUS users from AD.

Only user with "STAFF" role is allowed to add a new NUS user into the Users table.

# paths./NUSUsers.post.responses.403.description
Login user not authorized to perform this action

# components.schemas.API_User.API.Grouping.Groups.properties.parentGroupID.description
Parent Group ID for the group. Applicable only for sub-groups in class groups.

# components.schemas.API_User.API.Grouping.Groups.properties.groupAccess.description
group access for viewing and managing the group

# components.schemas.API_User.API.Grouping.Groups.description
base group model, can have multiple variations with additional properties

# components.schemas.API_User.API.InputClassGroup.properties.maxUser.description
Enrollment limit. Zero means no limit. Applicable only if SelfEnrol is true.

# components.schemas.API_User.API.InputClassGroup.properties.selfEnrolOpenDate.description
Enrollment Opening Date. Applicable only if SelfEnrol is true.

# components.schemas.API_User.API.InputClassGroup.properties.selfEnrolCloseDate.description
Enrollment Closing Date. Applicable only if SelfEnrol is true.

# components.schemas.API_User.API.InputClassGroupsForCreate.properties.parentGroupID.description
Parent Group ID for the new group to be created. Applicable only for sub-group creation.

# components.schemas.API_User.API.InputClassGroupsForCreate.description
HTTP Post Input class when creating multiple class groups

# components.schemas.API_User.API.InputClassGroupForUpdate.properties.maxUser.description
Enrollment limit. Zero means no limit. Applicable only if SelfEnrol is true.

# components.schemas.API_User.API.InputClassGroupForUpdate.properties.selfEnrolOpenDate.description
Enrollment Opening Date. Applicable only if SelfEnrol is true.

# components.schemas.API_User.API.InputClassGroupForUpdate.properties.selfEnrolCloseDate.description
Enrollment Closing Date. Applicable only if SelfEnrol is true.

# components.schemas.API_User.API.InputClassGroupForUpdate.properties.allowMultiple.description
True to allow user to belong to more than one sub-group under the main/parent group. This is only applicable for sub-groups in Class Group.

# components.schemas.API_User.API.InputClassGroupForUpdate.description
HTTP Post Input class when updating class group

# components.schemas.API_User.API.InputClassGroupUserForDelete.properties.userGuids.description
IDs of the Users to be removed from all the class groups of the module. Not applicable if one is removing self.

# components.schemas.API_User.API.InputClassGroupUserForDelete.description
HTTP Post Input class for removing user from module's class groups

# components.schemas.API_User.API.InputClassGroupsForCreate_BasedOnRosters.properties.groupIDs.description
Group IDs of the rosters. Students from the roster groups will be added into the main group.

# components.schemas.API_User.API.InputClassGroupsForCreate_BasedOnRosters.description
HTTP Post Input class when creating main class group based on rosters, together with sub-groups creation.

# components.schemas.API_User.API.InputClassGroupsForCreate_BasedOnEduRecGroups.properties.groupIDs.description
Group IDs of the EduRec groups, which must be of the same group type. These will be created as main groups, with students in there.

# components.schemas.API_User.API.InputClassGroupsForCreate_BasedOnEduRecGroups.description
HTTP Post Input class when creating main class groups based on EduRec groups, together with sub-groups creation.

# components.schemas.API_User.API.InputClassGroupsFromOfficialGroupsForCreate.properties.parentGroupID.description
Parent Group ID for the new group(s) to be created.

# components.schemas.API_User.API.InputClassGroupsFromOfficialGroupsForCreate.description
HTTP Post Input class when creating class groups from official groups

# components.schemas.API_User.API.InputGuestGroupForCreate.description
HTTP Post Input class when creating guest group

# components.schemas.API_User.API.InputGuestGroupForUpdate.description
HTTP Post Input class when updating guest group

# components.schemas.API_User.API.InputGroupUserForCreate.properties.allowMultiple.description
True to allow user to belong to more than one sub-groups inside a main/parent group. This is only applicable for sub-groups in Class Group. This is not applicable for student doing self-enrolment.

# components.schemas.API_User.API.InputGroupUserForCreate.description
HTTP Post Input class when add user to group

# components.schemas.API_User.API.InputGroupUsersForCreate.description
HTTP Post Input class when add users (by userguids) to guest group

# components.schemas.API_User.API.InputGroupUsersForCreate_UserNumber.description
HTTP Post Input class when add users (by user numbers) to guest group

# components.schemas.API_User.API.InputGroupUsersForDelete_UserNumber.description
HTTP Post Input class when deleting list of users from guest group (by user numbers)

# components.schemas.API_User.API.InputGroupUsersForUpdate.properties.userGuids.description
GUIDs of users to be added into the group

# components.schemas.API_User.API.InputGroupUsersForUpdate.properties.allowMultiple.description
True to allow user to belong to more than one sub-group under this main/parent group. This is only applicable to sub-groups in Class Group.

# components.schemas.API_User.API.InputGroupUsersForUpdate.description
HTTP Post Input class when updating users to group

# components.schemas.API_User.API.InputGroupsUsersForUpdate.properties.iDs_UserGuids.description
List of groups and its respective users in each of the groups.

# components.schemas.API_User.API.InputGroupsUsersForUpdate.properties.allowMultiple.description
True to allow user to belong to more than one sub-groups in a main group for the module. This is only applicable for sub-groups in Class Group.

# components.schemas.API_User.API.InputGroupsUsersForUpdate.description
HTTP Post Input class when updating users to groups

# components.schemas.API_User.API.InputGroupUsersForDelete.properties.deleteFromClassGroup.description
True to remove user from all class group(s) for the module. This is only applicable when trying to remove user from a guest group of the module.

# components.schemas.API_User.API.InputGroupUsersForDelete.properties.deleteFromGuestGroup.description
True to remove user from all guest group(s) for the module. This is only applicable when trying to remove user from a guest group of the module.

# components.schemas.API_User.API.InputGroupUsersForDelete.description
HTTP Post Input class when deleting list of users from group

# components.schemas.API_User.API.InputGroupsForExportExcel.properties.includeName.description
True to export the names of the students

# components.schemas.API_User.API.InputGroupsForExportExcel.properties.includeUserID.description
True to export the userids of the students

# components.schemas.API_User.API.InputGroupsForExportExcel.properties.includeStudentNumber.description
True to export the student numbers of the students

# components.schemas.API_User.API.InputGroupsForExportExcel.properties.includeEmail.description
True to export the emails of the students

# components.schemas.API_User.API.InputGroupsForExportExcel.properties.includeFriendlyEmail.description
True to export the friendly emails of the students

# components.schemas.API_User.API.InputGroupsForExportExcel.properties.includeFaculty.description
True to export the faculties of the students

# components.schemas.API_User.API.InputGroupsForExportExcel.properties.includeDepartment.description
True to export the departments of the students

# components.schemas.API_User.API.InputGroupsForExportExcel.properties.includeMatricYear.description
True to export the matriculation year of the students

# components.schemas.API_User.API.InputGroupsForExportExcel.properties.includeProgramme.description
True to export the programmes of the students

# components.schemas.API_User.API.InputGroupsForExportExcel.properties.includeAcadCareer.description
True to export the academic career of the students

# components.schemas.API_User.API.InputGroupsForExportExcel.properties.includeAudit.description
True to export the audit indication of the students for the module

# components.schemas.API_User.API.InputGroupsForExportExcel.properties.weeks.description
Optional. If specified, it will generate attendance list with the indicated number of weeks

# components.schemas.API_User.API.InputGroupsForExportExcel.description
HTTP Post Input class for exporting groups and its students to excel

# components.schemas.API_User.API.InputGroupsUsersForUpdateRandomise.properties.parentGroupID.description
Parent Group ID. If empty, means it is the root level.

# components.schemas.API_User.API.InputGroupsUsersForUpdateRandomise.properties.toUpdate.description
False to randomise only without saving it. True to randomise and update the list of users to the groups.

# components.schemas.API_User.API.InputGroupsUsersForUpdateRandomise.properties.excludeGuestStudent.description
True to exclude students from the module's guest roster. False to include simply the students from the student roster.

# components.schemas.API_User.API.InputGroupsUsersForUpdateRandomise.description
HTTP Post Input class when randomise users to groups

# components.schemas.API_User.API.InputUsersForSearch.properties.roles.description
Types of User Roles - Staff, Student, Guest

# components.schemas.API_User.API.InputUsersForSearch.properties.listOperations.description
Optional parameters for Sorting, paging and filtering

# components.schemas.API_User.API.InputUsersForSearch.description
HTTP Post Input class for Users when search

# components.schemas.API_User.API.Users.properties.userNameOriginal.description
Original name of the user. Sync from Oracle

# components.schemas.API_User.API.Users.properties.position.description
Position of the user. Applicable for staff only.

# components.schemas.API_User.API.Users.properties.title.description
Title of the user. Applicable for staff and Guest (gst) only.

# components.schemas.API_User.API.Users.properties.matricYear.description
Year which the student matriculated. Applicable for student only.

# components.schemas.API_User.API.Users.properties.displayPhoto.description
True to display the photo. Applicable for students only. Staff will display the photo by default. Guest has no photos.

# components.schemas.API_User.API.Users.properties.studentType.description
Applicable only for students only. Student Type: P = Postgrad students, U = Undergrad students, X = Exchange students

# components.schemas.API_User.API.InputGuestForUpdate.description
HTTP Post Input class when updating guest account

# components.schemas.API_User.API.GuestMapping.properties.email.description
Email address of the non-NUS user who have yet login into LumiNUS

# components.schemas.API_User.API.GuestMapping.properties.creatorID.description
Guid of the creator who creates the mapping

# components.schemas.contract.ACL.Models.Access_Result.properties.access_Full.description
all accesses on the resource and its contents

# components.schemas.contract.ACL.Models.Access_Result.properties.access_Settings_Read.description
read-only access on the resource setting

# components.schemas.contract.Resource.Models.Resource.properties.startDate.description
the date which this resource is open to students.

# components.schemas.contract.Resource.Models.Resource.properties.endDate.description
the date which this resource is closed from students.

# components.schemas.contract.Resource.Models.Resource.properties.rootID.description
the root ID if any. For those resources which do not have a parent, the parent ID value will be the same as the ID.

# components.schemas.contract.Resource.Models.Resource.properties.creatorID.description
the ID of the user who created this record

# components.schemas.contract.Resource.Models.Resource.properties.lastUpdatedDate.description
the date this record is edited last time

# components.schemas.contract.Resource.Models.Resource.properties.lastUpdatedBy.description
the ID of the user who edited this record last time

# components.schemas.contract.Resource.Models.Resource.properties.lastDeletedDate.description
the date this record is deleted if the value is not null

# components.schemas.contract.Resource.Models.Resource.properties.lastDeletedBy.description
the ID of the user who deleted this record if the value is not null

# components.schemas.contract.Resource.Models.Resource.properties.publish.description
the publish flag which determin whether the record is published to students.

# components.schemas.contract.Resource.Models.Resource.properties.properties.description
the serialized string for the rest content properites.

# components.schemas.API_User.API.AccessReport.properties.rootAccess.description
the access of the user against the top level resource

# components.schemas.API_User.API.AccessReport.properties.groups.description
list of related access groups which the specific user belongs to.

# components.schemas.API_User.API.AccessReport.properties.accessibleResource.description
list of resources which user can see and can access, applies only if user has access to the root resource

# components.schemas.API_User.API.AccessReport.properties.inaccessibleResource.description
list of resources which user see but cannot access, applies only if user has access to the root resource

# components.schemas.API_User.API.AccessReport.properties.invisibleResources.description
list of resources which user cannot see, applies only if user has access to the root resource

# components.schemas.API_User.API.AccessReport.description
the report of a user can access a list of resources

# components.schemas.API_User.API.InputUserRoleForUpdate.properties.roleIDs.description
Role ID. Get list of Roles type from GetRoleTypes API. Note that this is case sensitive.

# components.schemas.API_User.API.InputUserRoleForUpdate.description
HTTP Post Input class when updating user roles

# components.schemas.API_User.API.InputLDAPForCreateMultiple.description
Input class when creating multiple NUS users

# components.schemas.API_User.API.InputNonNUSForCreate.properties.groupID.description
Group ID of the guest group to add non-NUS user

# components.schemas.API_User.API.InputStaffProfileForUpdate.properties.nickName.description
Nick name to be displayed on certain tools, example, Forum

# components.schemas.API_User.API.InputStaffProfileForUpdate.description
HTTP Post Input class when updating staff profile

# components.schemas.API_User.API.InputStudentProfileForUpdate.properties.nickName.description
Nick name to be displayed on certain tools, example, Forum

# components.schemas.API_User.API.InputStudentProfileForUpdate.description
HTTP Post Input class when updating staff profile

# components.schemas.API_User.API.InputGuestProfileForUpdate.properties.nickName.description
Nick name to be displayed on certain tools, example, Forum

# components.schemas.API_User.API.InputGuestProfileForUpdate.description
HTTP Post Input class when updating guest profile

# components.schemas.API_User.API.InputModuleGuestForUpdate.description
HTTP Post Input class when updating guest account in the module

# components.schemas.API_User.API.InputUsersForPasswordResetToken.description
HTTP Post Input class for Users when reset password

# components.schemas.API_User.API.InputUsersForPasswordResetTokenValidity.description
HTTP Post Input class for Users when reset password with the token

# components.schemas.API_User.API.InputGuestMappingForDelete.description
HTTP Delete Input class for GuestMapping

# components.schemas.API_User.API.InputGuestMappingForDeleteMultiple.description
HTTP Delete Input class for GuestMapping