-
Notifications
You must be signed in to change notification settings - Fork 0
API
Retrieve a list of the latest announcements (by default 200)
GET http://localhost:8800/API/announcement[?count=<numberOfAnnouncements>]The following requests require the user to be logged in: Delete an announcement
DELETE http://localhost:8800/API/announcement?id=<announcementId>Edit an announcement
PUT http://localhost:8800/API/announcement?id=<announcementId>&title=<newTitle>&description=<newDescription>Add an announcement
POST http://localhost:8800/API/announcement?title=<title>&description=<description>Retrieve a list of the latest general information (by default 200)
GET http://localhost:8800/API/generalinfo?[?count=<numberOfPost>]The following requests require the user to be logged in: Delete general information
DELETE http://localhost:8800/API/generalinfo?id=<announcementId>Edit general information
PUT http://localhost:8800/API/generalinfo?id=<announcementId>&title=<newTitle>&description=<newDescription>&category=<newCategory>Add general information
POST http://localhost:8800/API/generalinfo/item?title=<title>&description=<description>&category=<category>Retrieve the events in a week. Passing a 0 for week represents the current week, whereas 1 would represent next week. Negative values are also possible to retrieve past events.
GET http://localhost:8800//calendar/event?week=<integer>Note: The schedule returns events sorted by the days of the week specified. These weekdays are all given the format: yyyy-MM-dd'T'HH:mm:ss.SSSZ where the time is: 23:59:59 +0000. Therefore, always interpret these dates with zero seconds from GMT (GMT+0) to avoid accidentally changing the day due to your time zone.
The following request requires the user to be logged in: Add an event
POST http://localhost:8800//calendar/event?title=<title>&ssid=<schoolName>&date=<date>&startHour=<startingHour>&startMinute=<startingMinute>&endHour=<endingHour>&endMinute=<endingMinute>GET http://localhost:8800/API/forum/thread[?count=<numberOfPost>]GET http://localhost:8800/API/forum/comment?id=<commentID>Create new thread
POST http://localhost:8800/API/forum/thread?title=<title>&description=<description>&author=<author>&posterID=<posterID>[&imgURL=<imgURL>]Create new comment
POST http://localhost:8800/API/forum/comment?text=<text>&author=<author>&posterID=<posterID>&parentThread=<parentThreadId>[&imgURL=<imgURL>]Edit thread
PUT http://localhost:8800/API/forum/thread?id=<threadID>&title=<title>&description=<description>Edit comment
PUT http://localhost:8800/API/forum/comment?id=<commentID>&text=<text>Delete thread
DELETE http://localhost:8800/API/forum/thread?id=<threadID>Delete comment
DELETE http://localhost:8800/API/forum/comment?id=<commentID>Retrieve login codes
GET http://localhost:8800/API/loginCode?code=<someCode>This get request will either return the ID of the school it is associated with, or return an HTTP 400 status code if the login code is not valid.
Add a token
POST http://localhost:8800/API/token?id=<token>Retrieve the starting and ending dates of a school
GET http://localhost:8800/API/school?id=<schoolid>Schoolids can be found on the webinterface under options>manage schools>view. This get request return a JSON file of the entire document. You can access the properties "startDate" and "endDate" for the starting and ending dates of the corresponding school.