Forum

PublicAPI_LAPI: Forums

UriTemplate
Method	GET
Response Format	Xml
Response Schema	https://ivle.nus.edu.sg/api/Lapi.svc/help/Forums/response/schema
Response Example	https://ivle.nus.edu.sg/api/Lapi.svc/help/Forums/response/example
Description	Gets all the related forums for the Module ID. Display of headings and threads for the past [Duration] minutes with new postings, set 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. IncludeThreads: Whether to show threads for the forums. [true] to display threads. [false] to not display threads. TitleOnly: Whether to display the basic information for the forums. [true] to display basic information on forum with no threads display. [false] to display detailed information on forum.
Output Description	BadgeTool: Indicates the number of unread postings for the past [Duration] minutes, with new postings not more than 14 days ago. BadgeHeading: Indicates the number of unread postings for each of the headings for the past [Duration] minutes, with new postings not more than 14 days ago. hasItems: Refers to whether there are new postings for the past [Duration] minutes. isNewPost: Whether the thread is a new post for the past [Duration] minutes. False for all threads if duration = 0. isRead: Whether the thread is read by the user, with new postings not more than 14 days ago. isPosterStaff: Whether the thread is posted by Staff.

PublicAPI_LAPI: Forum

UriTemplate
Method	GET
Response Format	Xml
Response Schema	https://ivle.nus.edu.sg/api/Lapi.svc/help/Forum/response/schema
Response Example	https://ivle.nus.edu.sg/api/Lapi.svc/help/Forum/response/example
Description	Gets the forum information for the past [Duration] minutes with new postings, set 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) ForumID: Forum ID obtained from the [Forums] function IncludeThreads: Whether to show threads for the forum. [true] to display threads. [false] to not display threads.
Output Description	BadgeTool: Indicates the number of unread postings for the past [Duration] minutes, with new postings not more than 14 days ago. BadgeHeading: Indicates the number of unread postings for each of the headings for the past [Duration] minutes, with new postings not more than 14 days ago. hasItems: Refers to whether there are new postings for the past [Duration] minutes. isNewPost: Whether the thread is a new post for the past [Duration] minutes. False for all threads if duration = 0. isRead: Whether the thread is read by the user, with new postings not more than 14 days ago. isPosterStaff: Whether the thread is posted by Staff.

PublicAPI_LAPI: Forum_Headings

UriTemplate
Method	GET
Response Format	Xml
Response Schema	https://ivle.nus.edu.sg/api/Lapi.svc/help/Forum_Headings/response/schema
Response Example	https://ivle.nus.edu.sg/api/Lapi.svc/help/Forum_Headings/response/example
Description	Gets the related forum headings belonging to the particular Forum for the past [Duration] minutes with new postings, set 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. ForumID: Forum ID obtained from the [Forums] function Duration: Changes within the last [Duration] in minutes. IncludeThreads: Whether to show threads for the forum. [true] to display threads. [false] to not display threads.
Output Description	BadgeHeading: Indicates the number of unread postings for each of the headings for the past [Duration] minutes, and with new postings not more than 14 days ago. hasItems: Refers to whether there are new postings for the past [Duration] minutes. isNewPost: Whether the thread is a new post for the past [Duration] minutes. False for all threads if duration = 0. isRead: Whether the thread is read by the user, with new postings not more than 14 days ago. isPosterStaff: Whether the thread is posted by Staff.

PublicAPI_LAPI: Forum_HeadingThreads

UriTemplate
Method	GET
Response Format	Xml
Response Schema	https://ivle.nus.edu.sg/api/Lapi.svc/help/Forum_HeadingThreads/response/schema
Response Example	https://ivle.nus.edu.sg/api/Lapi.svc/help/Forum_HeadingThreads/response/example
Description	Gets the related threads belonging to the heading (Non-hierachy) for the past [Duration] minutes with new postings, set 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. HeadingID: Heading ID obtained from the various forum functions Duration: Changes within the last [Duration] in minutes (a number) GetMainTopicsOnly: Whether to display the main topics only. true to display just the main topics. false to not display all threads.
Output Description	The display is in non-hierachy format. isNewPost: Whether the thread is a new post for the past [Duration] minutes. False for all threads if duration = 0. isRead: Whether the thread is read by the user, with new postings not more than 14 days ago. isPosterStaff: Whether the thread is posted by Staff.

PublicAPI_LAPI: Forum_Threads

UriTemplate
Method	GET
Response Format	Xml
Response Schema	https://ivle.nus.edu.sg/api/Lapi.svc/help/Forum_Threads/response/schema
Response Example	https://ivle.nus.edu.sg/api/Lapi.svc/help/Forum_Threads/response/example
Description	Gets the thread and/or subthreads for the past [Duration] minutes with new postings, set 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. ThreadID: Thread ID obtained from the various forum functions Duration: Changes within the last [Duration] in minutes (a number) GetSubThreads: Whether to display the sub threads. [true] to display sub threads. [false] to not display sub threads.

PublicAPI_LAPI: Forum_Thread

UriTemplate
Method	GET
Response Format	Xml
Response Schema	https://ivle.nus.edu.sg/api/Lapi.svc/help/Forum_Thread/response/schema
Response Example	https://ivle.nus.edu.sg/api/Lapi.svc/help/Forum_Thread/response/example
Description	Gets the thread information
Input Description	APIKey: The pre allocated API key AuthToken: The authentication token generated by the login page. This determines the current user. ThreadID: Thread ID obtained from the various forum functions

PublicAPI_LAPI: Forum_PostNewThread

UriTemplate
Method	POST
Request Format	xml or json
Response Format	Xml
Description	Post a new thread, returns the new thread id (XML format)
Input Description	APIKey: The pre allocated API key AuthToken: The authentication token generated by the login page. This determines the current user. HeadingID: Heading to which the new thread is posted. Title: Title of the new thread Reply: Message body of the new thread

PublicAPI_LAPI: Forum_PostNewThread_JSON

UriTemplate
Method	POST
Request Format	xml or json
Response Format	Json
Description	Post a new thread, returns the new thread id (Json format)
Input Description	APIKey: The pre allocated API key AuthToken: The authentication token generated by the login page. This determines the current user. HeadingID: Heading to which the new thread is posted. Title: Title of the new thread Reply: Message body of the new thread

PublicAPI_LAPI: Forum_ReplyThread

UriTemplate
Method	POST
Request Format	xml or json
Response Format	Xml
Description	Reply to a thread, returns the new thread id (XML format)
Input Description	APIKey: The pre allocated API key AuthToken: The authentication token generated by the login page. This determines the current user. ThreadID: Thread which the new thread is to reply. Title: Title of the reply thread Reply: Message body of the reply thread

PublicAPI_LAPI: Forum_ReplyThread_JSON

UriTemplate
Method	POST
Request Format	xml or json
Response Format	Json
Description	Reply to a thread, returns the new thread id (Json format)
Input Description	APIKey: The pre allocated API key AuthToken: The authentication token generated by the login page. This determines the current user. ThreadID: Thread which the new thread is to reply. Title: Title of the reply thread Reply: Message body of the reply thread

PublicAPI_LAPI: Forum_Thread_AddLog

UriTemplate
Method	POST
Request Format	xml or json
Response Format	Xml
Description	Add log when user clicks to read the forum thread. (XML format)
Input Description	APIKey: The pre allocated API key AuthToken: The authentication token generated by the login page. This determines the current user. ThreadID: Thread which read by the user.

PublicAPI_LAPI: Forum_Thread_AddLog_JSON

UriTemplate
Method	POST
Request Format	xml or json
Response Format	Json
Description	Add log when user clicks to read the forum thread. (Json format)
Input Description	APIKey: The pre allocated API key AuthToken: The authentication token generated by the login page. This determines the current user. ThreadID: Thread which read by the user.

PublicAPI_LAPI: Forum_SaleOfUsedTextbooks

UriTemplate
Method	GET
Response Format	Xml
Response Schema	https://ivle.nus.edu.sg/api/Lapi.svc/help/Forum_SaleOfUsedTextbooks/response/schema
Response Example	https://ivle.nus.edu.sg/api/Lapi.svc/help/Forum_SaleOfUsedTextbooks/response/example
Description	Gets the Sale Of Used Textbooks open forum information for the past [Duration] minutes with new postings, set 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) IncludeThreads: Whether to show threads for the forum. [true] to display threads. [false] to not display threads.
Output Description	BadgeTool: Indicates the number of unread postings for the past [Duration] minutes, with new postings not more than 14 days ago. BadgeHeading: Indicates the number of unread postings for each of the headings for the past [Duration] minutes, with new postings not more than 14 days ago. hasItems: Refers to whether there are new postings for the past [Duration] minutes. isNewPost: Whether the thread is a new post for the past [Duration] minutes. False for all threads if duration = 0. isRead: Whether the thread is read by the user, with new postings not more than 14 days ago. isPosterStaff: Whether the thread is posted by Staff.

PublicAPI_LAPI: Forum_StudentFeedback

UriTemplate
Method	GET
Response Format	Xml
Response Schema	https://ivle.nus.edu.sg/api/Lapi.svc/help/Forum_StudentFeedback/response/schema
Response Example	https://ivle.nus.edu.sg/api/Lapi.svc/help/Forum_StudentFeedback/response/example
Description	Gets the Student Feedback open forum information for the past [Duration] minutes with new postings, set 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) IncludeThreads: Whether to show threads for the forum. [true] to display threads. [false] to not display threads.
Output Description	BadgeTool: Indicates the number of unread postings for the past [Duration] minutes, with new postings not more than 14 days ago. BadgeHeading: Indicates the number of unread postings for each of the headings for the past [Duration] minutes, with new postings not more than 14 days ago. hasItems: Refers to whether there are new postings for the past [Duration] minutes. isNewPost: Whether the thread is a new post for the past [Duration] minutes. False for all threads if duration = 0. isRead: Whether the thread is read by the user, with new postings not more than 14 days ago. isPosterStaff: Whether the thread is posted by Staff.

Forum

1 Comment

Phan Shi Wen