Skip to content
This repository has been archived by the owner on Nov 14, 2017. It is now read-only.

API Calls

Eric Jiang edited this page Jan 15, 2017 · 5 revisions

V0.5.15-rc1 API Calls

P - POST Request

G - GET Request

General Requests

T Instruction Storage Type Intro (Current) Returns
G /basic/(types) Local JSON v0.3 Returns basic type maps, based off (types), types include: units, teachingperiods, etc.
G /courses/(courseCode) Local JSON v0.4 Returns course maps based off study.monash courses
G /courses/info/(code) mongoDB v0.5 Returns course information based off
G /spec/(specCode) Local JSON v0.2 Returns JSON response for specialisations

Unit Calls

T Instruction Storage Type Intro (Current) Returns
G /units/ mongoDB v0.1 (v0.4) Returns _every unit with descriptive details (Name, Description, Faculty, Prerequisites, Prohibitions, SETU results)
G /units/(unitCode) mongoDB v0.1 (v0.4) Returns descriptive (same as course/ext details about the course
G /rules/(unitCode) mongoDB v0.5.15 Returns an array of rules based for the Unit specified UnitCode

User Snapshots

T Instruction Storage Type Intro (Current) Returns
G /snaps/(identifier) mongoDB v0.5.10 Returns JavaScript object of saved course maps
P /snaps/ mongoDB v0.5.10 ADD COURSESTRUCTURE ONTO BODY REQUEST under the KEY COURSE
Clone this wiki locally