Users must log in once before they can be added to wiki spaces.
Skip to end of metadata
Comment: Migrated to Confluence 4.0
Go to start of metadata

IVLE LAPI Integration Summary

The IVLE LAPI is available to developers who wish to integrate to the following tools on IVLE:

  1. Login
  2. Module List
  3. Module Search
  4. Module Description
  5. Module Text & Readings
  6. Module Weblinks
  7. Module Teaching Staff
  8. Consultation
  9. Class Roster
  10. Guest Roster
  11. Groups
  12. Announcement
  13. Discussion Forum
  14. Gradebook
  15. Webcast Lectures
  16. Poll
  17. Workbin
  18. Library E-Reserves
  19. MyOrganizer
  20. IVLE Community
  21. Open Webcast Lectures
  22. Student Events
  23. IVLE News
  24. Delta datasets

IVLE LAPI Reference provides detailed request and response information for each LAPI call.

JSON Functionality

All queries return JSON by default, there is also the capability to enable JSONP output by appending additional parameters

Parameter

Example

Function

callback

callback=aaa

returns a JSONP reply. Note that the callback property only accepts a-zA-Z0-9_. All other characters will be replaced with an underscore (_)

jsonindent

jsonindent=1

Returns a human friendly indented JSON or JSONP reply. Note this is NOT recommended for production use

XML Functionality

By default the queries return JSON, XML output is supported but not recommended.

Parameter

Example

Function

output

output=xml

returns data in xml format

XML

JSON

Validate

Validate

UserName_Get

UserName_Get

Modules

Modules

Modules_Staff

Modules_Staff

Modules_Student

Modules_Student

Module

Module

Modules_Search

Modules_Search

Module_Lecturers

Module_Lecturers

Module_Information

Module_Information

Module_Weblinks

Module_Weblinks

Module_ReadingFormatted

Module_ReadingFormatted

Module_ReadingUnformatted

Module_ReadingUnformatted

Module_ReadingsFormatted_Coop

Module_ReadingsFormatted_Coop

Module_Reading

Module_Reading

Consultation_ModuleFacilitatorsWithSlots

Consultation_ModuleFacilitatorsWithSlots

ConsultationSlots

ConsultationSlots

Consultation_SignedUpSlots

Consultation_SignedUpSlots

Consultation_SignUp

Consultation_SignUp_JSON

Consultation_CancelSlot

Consultation_CancelSlot_JSON

Class_Roster

Class_Roster

Guest_Roster

Guest_Roster

GroupsByUserAndModule

GroupsByUserAndModule

GroupsByUser

GroupsByUser

Module_ClassGroups

Module_ClassGroups

ClassGroupSignUp

ClassGroupSignUp_JSON

ClassGroupSignUpRemove

ClassGroupSignUpRemove_JSON

GroupProjectsByUser

GroupProjectsByUser

Project_SelfEnrolGroups

Project_SelfEnrolGroups

ProjectGroupUsers

ProjectGroupUsers

Project_EnrolledGroups

Project_EnrolledGroups

ProjectGroup_SignUp

ProjectGroup_SignUp_JSON

ProjectGroup_RemoveSignUp

ProjectGroup_RemoveSignUp_JSON

Announcements

Announcements

Announcement_AddLog

Announcement_AddLog_JSON

Announcement_Add

Announcement_Add_JSON

Forums

Forums

Forum

Forum

Forum_Headings

Forum_Headings

Forum_HeadingThreads

Forum_HeadingThreads

Forum_Threads

Forum_Threads

Forum_Thread

Forum_Thread

Forum_PostNewThread

Forum_PostNewThread_JSON

Forum_ReplyThread

Forum_ReplyThread_JSON

Forum_Thread_AddLog

Forum_Thread_AddLog_JSON

Forum_SaleOfUsedTextbooks

Forum_SaleOfUsedTextbooks

Forum_StudentFeedback

Forum_StudentFeedback

Gradebook_ViewItems

Gradebook_ViewItems

Webcasts

Webcasts

Webcast_AddLog

Webcast_AddLog_JSON

Polls

Polls

Poll_SubmitVote

Poll_SubmitVote_JSON

Poll_GetVotedUser

Poll_GetVotedUser

Poll_GetVotedUser_Other

Poll_GetVotedUser_Other

Workbins

Workbins

LibEreserves

LibEreserves

LibEreserveFiles

LibEreserveFiles

MyOrganizer_Personal

MyOrganizer_Personal

MyOrganizer_IVLE

MyOrganizer_IVLE

MyOrganizer_Events

MyOrganizer_Events

MyOrganizer_AddPersonalEvent

MyOrganizer_AddPersonalEvent_JSON

MyOrganizer_UpdatePersonalEvent

MyOrganizer_UpdatePersonalEvent_JSON

MyOrganizer_DeletePersonalEvent

MyOrganizer_DeletePersonalEvent_JSON

MyOrganizer_SpecialDays

MyOrganizer_SpecialDays

MyOrganizer_AcadSemesterInfo

MyOrganizer_AcadSemesterInfo

Timetable_Student

Timetable_Student

CodeTable_WeekTypes

CodeTable_WeekTypes

Communities

Communities

Community_Search

Community_Search

CommunityCategories

CommunityCategories

CommunityTags

CommunityTags

Community

Community

CommunityMembers

CommunityMembers

CommunityAnnouncements

CommunityAnnouncements

CommunityWorkbinFolders

CommunityWorkbinFolders

CommunityWorkbinFiles

CommunityWorkbinFiles

CommunityForumHeadings

CommunityForumHeadings

CommunityForumPosts

CommunityForumPosts

CommunityForum_AddLogByPost

CommunityForum_AddLogByPost_JSON

CommunityForum_NewTopic

CommunityForum_NewTopic_JSON

CommunityForum_ReplyPost

CommunityForum_ReplyPost_JSON

CommunityWeblinks

CommunityWeblinks

Community_Join

Community_Join_JSON

Community_Quit

Community_Quit_JSON

Community_AddMember

Community_AddMember_JSON

Community_DeleteMember

Community_DeleteMember_JSON

Community_UpdateMember

Community_UpdateMember_JSON

Community_Create

Community_Create_JSON

Community_Update

Community_Update_JSON

OpenWebcasts

OpenWebcasts

OpenWebcast_AddLog

OpenWebcast_AddLog_JSON

StudentEvents

StudentEvents

StudentEvents_Categories

StudentEvents_Categories

StudentEvents_Committees

StudentEvents_Committees

StudentEvents_Category

StudentEvents_Category

StudentEvents_Committee

StudentEvents_Committee

StudentEvents_PostNewEvent

StudentEvent_PostNewEvent_JSON

PublicNews

PublicNews


Labels
  • None