IVLE LAPI
This is the Learning API for the Integrated Virtual Learning Environment (IVLE) used by the National University of Singapore. With this API, you will be able to access your course information on any platform that has internet access. Usage of this API is governed by the NUS Acceptable Use Policy found at https://inetapps.nus.edu.sg/AUP/aup.htm
IVLE LAPI endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET |
Modules /Modules |
Shows the latest changes to the information or tools tied to the Modules within the last [Duration] minutes, set to 0 to show all. |
| GET |
Timetable_Student /Timetable_Student |
Gets the related student timetable information for the academic semester year. |
| POST |
CommunityForum_ReplyPost /CommunityForum_ReplyPost |
Replies to a posting |
| GET |
Project_SelfEnrolGroups /Project_SelfEnrolGroups |
Gets self-enrol groups for a project. |
| GET |
Webcasts /Webcasts |
Gets the related Webcast for the Module ID for the past [Duration] mins, set 0 to show all |
| GET |
Timetable_ModuleExam /Timetable_ModuleExam |
Gets the related module timetable information. |
| GET |
NUScastEvents_Year /NUScastEvents_Year |
Gets the academic years and semesters to display for NUScast Events |
| POST |
Community_CreateTask_JSON /Community_CreateTask_JSON |
Create a Task for the community |
| POST |
MyOrganizer_AddPersonalEvent_JSON /MyOrganizer_AddPersonalEvent_JSON |
Create a new Personal Event, returns the new event id (Json format) |
| POST |
StudentEvent_PostNewEvent_JSON /StudentEvent_PostNewEvent_JSON |
Post a new student event, returns the new event id (Json format) |
| POST |
Forum_PostNewThread_JSON /Forum_PostNewThread_JSON |
Post a new thread, returns the new thread id (Json format) |
| POST |
MyOrganizer_DeletePersonalEvent_JSON /MyOrganizer_DeletePersonalEvent_JSON |
Delete the Personal Event, returns a bool (Json format) |
| POST |
StudentEvents_PostNewEvent /StudentEvents_PostNewEvent |
Post a new event, returns the new event id (XML format) |
| GET |
Modules_Taken /Modules_Taken |
Gets the list of modules taken for the student |
| POST |
Forum_Thread_AddLog_JSON /Forum_Thread_AddLog_JSON |
Add log when user clicks to read the forum thread. (Json format) |
| POST |
Poll_SubmitVote_JSON /Poll_SubmitVote_JSON |
Submit vote result. return error message if any. (Json format) |
| GET |
Community_GetSubTask /Community_GetSubTask |
Gets sub task for taskID |
| POST |
RealTime_Subscription_JSON /RealTime_Subscription_JSON |
Add subscription for real time notification, returns the new thread id (JSON format) |
| GET |
CommunityWeblinks /CommunityWeblinks |
Gets details of community weblinks |
| POST |
CommunityForum_ReplyPost_JSON /CommunityForum_ReplyPost_JSON |
Replies to a posting - JSON |
| GET |
Advertisement /Advertisement |
Get advertisement details |
| POST |
Community_UpdateMember_JSON /Community_UpdateMember_JSON |
Updates a member for the community - JSON |
| GET |
NUScastPublicEvents_Departments /NUScastPublicEvents_Departments |
Gets the list of departments with nuscast events |
| GET |
Poll_GetVotedUser /Poll_GetVotedUser |
Get details (ID, name and email) of the users who voted the option.[For 'Others' Option, please use the API Method 'Poll_GetVotedUser_Other()' instead.] |
| POST |
Announcement_AddLog /Announcement_AddLog |
Adds log when user clicks to read announcement |
| GET |
Module_Weblinks /Module_Weblinks |
Gets the related weblinks for the Module ID, set to 0 to show all |
| POST |
Community_Quit_JSON /Community_Quit_JSON |
Quits a community - JSON |
| GET |
ConsultationSlots /ConsultationSlots |
Gets consultation slots created by module facilitator [LecID] for a module. |
| GET |
WhatsNew /WhatsNew |
Gets what's new for the current user |
| POST |
Login_XML /Login_XML |
Attempts to login a user using the specified [domain], [userid] and [password], use 'Validate' to renew the token if neccessary. |
| GET |
Module_ReadingsFormatted_Coop /Module_ReadingsFormatted_Coop |
Gets the related formatted text and readings for the Module ID, set to 0 to show all. [This function is used only by COOP only.] |
| POST |
Forum_PostNewThread /Forum_PostNewThread |
Post a new thread, returns the new thread id (XML format) |
| GET |
Timetable_Student_Module /Timetable_Student_Module |
Gets the related module timetable information for the student. |
| GET |
ProjectGroupUsers /ProjectGroupUsers |
Gets details of project group users. |
| POST |
ProjectGroup_SignUp /ProjectGroup_SignUp |
Signs up for a project group |
| POST |
Announcement_AddLog_JSON /Announcement_AddLog_JSON |
Adds log when user clicks to read announcement - JSON |
| GET |
UserID_Get /UserID_Get |
Returns the user ID of the logged in user |
| GET |
CommunityTags /CommunityTags |
Gets tags for all or active communities |
| GET |
Validate /Validate |
Validates [token] and ensure that it is valid, returns a new token if the original token is expiring in one day. |
| POST |
Community_UpdateComment /Community_UpdateComment |
Update a Comment for the community Task |
| GET |
Modules_Student /Modules_Student |
Shows the latest changes to the information or tools tied to the Student Modules within the last [Duration] minutes, set to 0 to show all.Student Modules refers to modules which… |
| GET |
UserEmail_Get /UserEmail_Get |
Returns the email of the logged in user |
| GET |
GetFileInfo /GetFileInfo |
Gets the file detailed information based on the File ID. |
| GET |
Poll_GetVotedUser_Other /Poll_GetVotedUser_Other |
Get details (ID, name and email) of the users who voted the 'Others' option. |
| GET |
Consultation_ModuleFacilitatorsWithSlots /Consultation_ModuleFacilitatorsWithSlots |
Gets module facilitators with consultation slots for a module. |
| POST |
MyOrganizer_AddPersonalEvent /MyOrganizer_AddPersonalEvent |
Create a new Personal Event, returns the new event id (XML format) |
| GET |
GenerateException /GenerateException |
|
| GET |
Login /Login |
|
| POST |
Community_Create /Community_Create |
Creates a community |
| POST |
ClassGroupSignUp /ClassGroupSignUp |
Sign Up Class Group |
IVLE LAPI pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|