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

PublicAPI_LAPI: Modules

UriTemplate

Method

GET

Response Format

Xml

Response Schema

https://ivle.nus.edu.sg/api/Lapi.svc/help/Modules/response/schema

Response Example

https://ivle.nus.edu.sg/api/Lapi.svc/help/Modules/response/example

Description

Shows the latest changes to the information or tools tied to the Modules within the last [Duration] minutes, set to 0 to show all.

Input Description

APIKey: The pre allocated API key
AuthToken: The authentication token generated by the login page. This determines the current user.
Duration: Changes within the last [Duration] in minutes (a number).
IncludeAllInfo: Whether to show detailed module information. [true] to display detailed module information and its tools. [false] to display basic module information

Output Description

Permission: [O] or [F] or [M] or [R] indicates staff modules. [S] indicates student modules. [BM] indicatoes bookmarked modules.

Examples

https://ivle.nus.edu.sg/api/Lapi.svc/Modules?APIKey=123456789&AuthToken=abcdefghijklmnopqrstuvwxyz&Duration=10&IncludeAllInfo=true
https://ivle.nus.edu.sg/api/Lapi.svc/Modules?APIKey=123456789&AuthToken=abcdefghijklmnopqrstuvwxyz&Duration=10&IncludeAllInfo=true&output=json

PublicAPI_LAPI: Modules_Staff

UriTemplate

Method

GET

Response Format

Xml

Response Schema

https://ivle.nus.edu.sg/api/Lapi.svc/help/Modules_Staff/response/schema

Response Example

https://ivle.nus.edu.sg/api/Lapi.svc/help/Modules_Staff/response/example

Description

Shows the latest changes to the information or tools tied to the Staff Modules within the last [Duration] minutes, set to 0 to show all.
Staff Modules refers to modules managed by the user.

Input Description

APIKey: The pre allocated API key
AuthToken: The authentication token generated by the login page. This determines the current user.
Duration: Changes within the last [Duration] in minutes (a number)
IncludeAllInfo: Whether to show detailed staff module information. [true] to display detailed staff module information and its tools. [false] to display basic staff module information

Output Description

Permission: [O] or [F] or [M] or [R] indicates staff modules. [S] indicates student modules. [BM] indicatoes bookmarked modules.

PublicAPI_LAPI: Modules_Student

UriTemplate

Method

GET

Response Format

Xml

Response Schema

https://ivle.nus.edu.sg/api/Lapi.svc/help/Modules_Student/response/schema

Response Example

https://ivle.nus.edu.sg/api/Lapi.svc/help/Modules_Student/response/example

Description

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 user is registered in or guest of the module.

Input Description

APIKey: The pre allocated API key
AuthToken: The authentication token generated by the login page. This determines the current user.
Duration: Changes within the last [Duration] in minutes (a number)
IncludeAllInfo: Whether to show detailed student module information. [true] to display detailed student module information and its tools. [false] to display basic module information

Output Description

Permission: [O] or [F] or [M] or [R] indicates staff modules. [S] indicates student modules. [BM] indicatoes bookmarked modules.

PublicAPI_LAPI: Module

UriTemplate

Method

GET

Response Format

Xml

Response Schema

https://ivle.nus.edu.sg/api/Lapi.svc/help/Module/response/schema

Response Example

https://ivle.nus.edu.sg/api/Lapi.svc/help/Module/response/example

Description

Shows the latest changes to the information or tools tied to the particular Module within the last [Duration] minutes, set to 0 to show all.

Input Description

APIKey: The pre allocated API key
AuthToken: The authentication token generated by the login page. This determines the current user.
Duration: Changes within the last [Duration] in minutes (a number)
IncludeAllInfo: Whether to show detailed student module information. [true] to display detailed student module information and its tools. [false] to display basic module information
CourseID: Module ID obtained from the Modules function
TitleOnly: Whether to display the basic information for the module's tools. [true] to display basic tools info. [false] to display detailed tools info

Output Description

Permission: [O] or [F] or [M] or [R] indicates staff modules. [S] indicates student modules. [BM] indicatoes bookmarked modules.

PublicAPI_LAPI: Modules_Search

UriTemplate

Method

GET

Response Format

Xml

Response Schema

https://ivle.nus.edu.sg/api/Lapi.svc/help/Modules_Search/response/schema

Response Example

https://ivle.nus.edu.sg/api/Lapi.svc/help/Modules_Search/response/example

Description

Shows the list of modules and its information according to the search criteria.

Input Description

APIKey: The pre allocated API key
AuthToken: The authentication token generated by the login page. This determines the current user. (If not supplied, means it is a public search.)
IncludeAllInfo: Whether to show detailed module information. [true] to display detailed module information and its tools. [false] to display basic module information
AuthToken, ModuleCode, ModuleTitle, LecturerName, Department, Semester, AcadYear, ModNameExact, LecNameExact, tag are optional fields. But at least one must be supplied.

PublicAPI_LAPI: Module_Lecturers

UriTemplate

Method

GET

Response Format

Xml

Response Schema

https://ivle.nus.edu.sg/api/Lapi.svc/help/Module_Lecturers/response/schema

Response Example

https://ivle.nus.edu.sg/api/Lapi.svc/help/Module_Lecturers/response/example

Description

Gets the related lecturers created within the last [Duration] minutes for the Module ID, set to 0 to show all

Input Description

APIKey: The pre allocated API key
AuthToken: The authentication token generated by the login page. This determines the current user.
Duration: Changes within the last [Duration] in minutes (a number)
CourseID: Module ID obtained from the Modules function

DisplayPhoto

UriTemplate

Method

GET

Description

Display lecturer's photo given by the Course-ID and the User-ID.

Input Description

APIKey: The pre allocated API key.
AuthToken: The authentication token generated by the login page. This determines the current user.
CourseID: Module ID obtained from the Modules function .
UserID: UserID of the lecturer.

PublicAPI_LAPI: Module_Information

UriTemplate

Method

GET

Response Format

Xml

Response Schema

https://ivle.nus.edu.sg/api/Lapi.svc/help/Module_Information/response/schema

Response Example

https://ivle.nus.edu.sg/api/Lapi.svc/help/Module_Information/response/example

Description

Gets the related course description sections created or updated within the last [Duration] minutes for the Module ID, set to 0 to show all

Input Description

APIKey: The pre allocated API key
AuthToken: The authentication token generated by the login page. This determines the current user.
Duration: Changes within the last [Duration] in minutes (a number)
CourseID: Module ID obtained from the Modules function

PublicAPI_LAPI: Module_Weblinks

UriTemplate

Method

GET

Response Format

Xml

Response Schema

https://ivle.nus.edu.sg/api/Lapi.svc/help/Module_Weblinks/response/schema

Response Example

https://ivle.nus.edu.sg/api/Lapi.svc/help/Module_Weblinks/response/example

Description

Gets the related weblinks for the Module ID, set to 0 to show all

Input Description

APIKey: The pre allocated API key
AuthToken: The authentication token generated by the login page. This determines the current user.
CourseID: Module ID obtained from the Modules function

PublicAPI_LAPI: Module_ReadingFormatted

UriTemplate

Method

GET

Response Format

Xml

Response Schema

https://ivle.nus.edu.sg/api/Lapi.svc/help/Module_ReadingFormatted/response/schema

Response Example

https://ivle.nus.edu.sg/api/Lapi.svc/help/Module_ReadingFormatted/response/example

Description

Gets the related formatted text and readings created or updated within the last [Duration] minutes for the Module ID, set to 0 to show all

Input Description

APIKey: The pre allocated API key
AuthToken: The authentication token generated by the login page. This determines the current user.
Duration: Changes within the last [Duration] in minutes (a number)
CourseID: Module ID obtained from the Modules function

PublicAPI_LAPI: Module_ReadingUnformatted

UriTemplate

Method

GET

Response Format

Xml

Response Schema

https://ivle.nus.edu.sg/api/Lapi.svc/help/Module_ReadingUnformatted/response/schema

Response Example

https://ivle.nus.edu.sg/api/Lapi.svc/help/Module_ReadingUnformatted/response/example

Description

Gets the related unformatted text and readings created or updated within the last [Duration] minutes for the Module ID, set to 0 to show all

Input Description

APIKey: The pre allocated API key
AuthToken: The authentication token generated by the login page. This determines the current user.
Duration: Changes within the last [Duration] in minutes (a number)
CourseID: Module ID obtained from the Modules function

PublicAPI_LAPI: Module_ReadingsFormatted_Coop

UriTemplate

Method

GET

Response Format

Xml

Response Schema

https://ivle.nus.edu.sg/api/Lapi.svc/help/Module_ReadingsFormatted_Coop/response/schema

Response Example

https://ivle.nus.edu.sg/api/Lapi.svc/help/Module_ReadingsFormatted_Coop/response/example

Description

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.]

Input Description

APIKey: The pre allocated API key
AuthToken: The authentication token generated by the login page. This determines the current user.
date: If empty, it will return new adoptions where are created today, else it will return adoptions which were created based on the supplied value. Format is dd/mm/yyyy

PublicAPI_LAPI: Module_Reading

UriTemplate

Method

GET

Response Format

Xml

Response Schema

https://ivle.nus.edu.sg/api/Lapi.svc/help/Module_Reading/response/schema

Response Example

https://ivle.nus.edu.sg/api/Lapi.svc/help/Module_Reading/response/example

Description

Gets the related formatted and unformatted text and readings created or updated within the last [Duration] minutes for the Module ID, set to 0 to show all

Input Description

APIKey: The pre allocated API key
AuthToken: The authentication token generated by the login page. This determines the current user.
Duration: Changes within the last [Duration] in minutes (a number)
CourseID: Module ID obtained from the Modules function

PublicAPI_LAPI: Modules_Taken

UriTemplate

Method

GET

Response Format

Xml

Response Schema

https://ivle.nus.edu.sg/api/Lapi.svc/help/Modules_Taken/response/schema

Response Example

https://ivle.nus.edu.sg/api/Lapi.svc/help/Modules_Taken/response/example

Description

Gets the list of modules taken for the student.

Input Description

APIKey: The pre allocated API key
AuthToken: The authentication token generated by the login page. This determines the current user.
StudentID: Student UserID

 

 

 

  • No labels
  1. in Modules_Search, the search parameters like deptarment, academic year, what's the expected input format?

  2. I'm not quite sure, but it seems that "Modules" part, student's bookmarked modules is not showing in the json return result.