IVLE LAPI

FREE
By nuscit
Updated 4 months ago
Education
-/10
Popularity Score
-
Latency
-
Success Rate

IVLE LAPI API Documentation

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

View API Details
GETAcadYrSem_Current
GETAdvertisement
GETAnnouncement
POSTAnnouncement_Add
POSTAnnouncement_AddLog
POSTAnnouncement_AddLog_JSON
POSTAnnouncement_Add_JSON
GETAnnouncements
GETAnnouncements_Unread
GETBulletin_AcademicYearSemester
GETBulletin_Module_Search
GETBulletin_Modules
POSTClassGroupSignUp
POSTClassGroupSignUpRemove
POSTClassGroupSignUpRemove_JSON
POSTClassGroupSignUp_JSON
GETClass_Roster
GETCodeTable_WeekTypes
GETCommunities
GETCommunity
GETCommunityAnnouncements
GETCommunityCategories
GETCommunityForumHeadings
GETCommunityForumPosts
POSTCommunityForum_AddLogByPost
POSTCommunityForum_AddLogByPost_JSON
POSTCommunityForum_NewTopic
POSTCommunityForum_NewTopic_JSON
POSTCommunityForum_ReplyPost
POSTCommunityForum_ReplyPost_JSON
GETCommunityMembers
GETCommunityTags
GETCommunityWeblinks
GETCommunityWorkbinFiles
GETCommunityWorkbinFolders
POSTCommunity_AddMember
POSTCommunity_AddMember_JSON
POSTCommunity_Create
POSTCommunity_CreateComment
POSTCommunity_CreateComment_JSON
POSTCommunity_CreateTask
POSTCommunity_CreateTask_JSON
POSTCommunity_Create_JSON
POSTCommunity_DeleteComment
POSTCommunity_DeleteComment_JSON
POSTCommunity_DeleteMember
POSTCommunity_DeleteMember_JSON
POSTCommunity_DeleteTask
POSTCommunity_DeleteTask_JSON
GETCommunity_GetAllComments
GETCommunity_GetAllTasks
GETCommunity_GetComment
GETCommunity_GetSubTask
GETCommunity_GetTask
POSTCommunity_Join
POSTCommunity_Join_JSON
POSTCommunity_Quit
POSTCommunity_Quit_JSON
GETCommunity_Search
POSTCommunity_Update
POSTCommunity_UpdateComment
POSTCommunity_UpdateComment_JSON
POSTCommunity_UpdateMember
POSTCommunity_UpdateMember_JSON
POSTCommunity_UpdateTask
POSTCommunity_UpdateTask_JSON
POSTCommunity_Update_JSON
GETConsultationSlots
POSTConsultation_CancelSlot
POSTConsultation_CancelSlot_JSON
GETConsultation_ModuleFacilitatorsWithSlots
POSTConsultation_SignUp
POSTConsultation_SignUp_JSON
GETConsultation_SignedUpSlots
GETDelta_ModuleTimeTable
GETExceptionCrash
POSTExceptionCrash_Post
POSTExceptionCrash_Post_JSON
GETFaculties
GETForum
GETForum_HeadingMainThreads
GETForum_HeadingThreads
GETForum_Headings
POSTForum_PostNewThread
POSTForum_PostNewThread_JSON
POSTForum_ReplyThread
POSTForum_ReplyThread_JSON
GETForum_SaleOfUsedTextbooks
GETForum_StudentFeedback
GETForum_Thread
POSTForum_Thread_AddLog
POSTForum_Thread_AddLog_JSON
GETForum_Threads
GETForum_Threads_New
GETForums
GETGenerateException
GETGetFileInfo
GETGradebook_ViewItems
GETGroupProjectsByUser
GETGroupsByUser
GETGroupsByUserAndModule
GETGuest_Roster
GETLibEreserveFiles
GETLibEreserves
GETLogin
POSTLogin_JSON
POSTLogin_XML
GETModule
GETModule_ClassGroupUsers
GETModule_ClassGroups
GETModule_Information
GETModule_Lecturers
GETModule_OfficialGroupUsers
GETModule_Reading
GETModule_ReadingFormatted
GETModule_ReadingUnformatted
GETModule_ReadingsFormatted_Coop
GETModule_Weblinks
POSTModule_Weblinks_Add
POSTModule_Weblinks_Add_JSON
GETModules
GETModules_Search
GETModules_Staff
GETModules_Student
GETModules_Taken
GETMyOrganizer_AcadSemesterInfo
POSTMyOrganizer_AddPersonalEvent
POSTMyOrganizer_AddPersonalEvent_JSON
POSTMyOrganizer_DeletePersonalEvent
POSTMyOrganizer_DeletePersonalEvent_JSON
GETMyOrganizer_Events
GETMyOrganizer_IVLE
GETMyOrganizer_Personal
GETMyOrganizer_SpecialDays
POSTMyOrganizer_UpdatePersonalEvent
POSTMyOrganizer_UpdatePersonalEvent_JSON
POSTNUScastEvents_AddLog
POSTNUScastEvents_AddLog_JSON
GETNUScastEvents_Departments
GETNUScastEvents_Files
GETNUScastEvents_HitCount
POSTNUScastEvents_IncreaseHitCount
POSTNUScastEvents_IncreaseHitCount_JSON
GETNUScastEvents_TopEvents
GETNUScastEvents_Year
POSTNUScastPublicEvents_AddLog
POSTNUScastPublicEvents_AddLog_JSON
GETNUScastPublicEvents_Departments
GETNUScastPublicEvents_Files
GETNUScastPublicEvents_TopEvents
GETNUScastPublicEvents_Year
POSTOpenWebcast_AddLog
POSTOpenWebcast_AddLog_JSON
GETOpenWebcasts
GETPoll_GetVotedUser
GETPoll_GetVotedUser_Other
POSTPoll_SubmitVote
POSTPoll_SubmitVote_JSON
GETPolls
GETProfile_View
GETProjectGroupUsers
POSTProjectGroup_RemoveSignUp
POSTProjectGroup_RemoveSignUp_JSON
POSTProjectGroup_SignUp
POSTProjectGroup_SignUp_JSON
GETProject_EnrolledGroups
GETProject_SelfEnrolGroups
GETPublicNews
POSTRealTime_Subscription
POSTRealTime_SubscriptionRemove
POSTRealTime_SubscriptionRemove_Json
POSTRealTime_Subscription_JSON
GETRealTime_UserDevice
GETStaff_Search
POSTStudentEvent_PostNewEvent_JSON
GETStudentEvents
GETStudentEvents_Categories
GETStudentEvents_Category
GETStudentEvents_Committee
GETStudentEvents_Committees
POSTStudentEvents_PostNewEvent
GETTimetable_Module
GETTimetable_ModuleExam
GETTimetable_Student
GETTimetable_Student_Module
GETTimetable_iCal
GETTurnitin_OverallReport
GETTurnitin_UserReport
GETUserEmail_Get
GETUserID_Get
GETUserName_Get
GETValidate
POSTWebcast_AddLog
POSTWebcast_AddLog_JSON
GETWebcasts
GETWhatsNew
GETWorkbins
GETAcadYrSem_Current

Gets the current academic year and semester.

Authorization:

This will be the description of the authentication, like how to apply for it

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
APIKeyQUERY
REQUIREDThe pre-allocated API key
Code Snippet
unirest.get("https://nuscit-ivle-lapi2.p.rapidapi.com/AcadYrSem_Current")
.header("X-RapidAPI-Host", "nuscit-ivle-lapi2.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
Sample Response
General
Request URL: https://nuscit-ivle-lapi2.p.rapidapi.com/AcadYrSem_Current
Request Method: GET
Response Headers
Response Body

Install SDK for NodeJS

Installing

To utilize unirest for node.js install the the npm module:

$ npm install unirest

After installing the npm package you can now start simplifying requests like so:

var unirest = require('unirest');

Creating Request

unirest.get("https://nuscit-ivle-lapi2.p.rapidapi.com/AcadYrSem_Current")
.header("X-RapidAPI-Host", "nuscit-ivle-lapi2.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication