v0.7.0 API Calls

Current Version: v0.7.2

Docs API Version: v0.7.2

General Requests

Type	Instruction	Storage Type	Intro (Current)	Returns	Example Return
GET	/basic/units	Google Datastore	v0.7.0 New!	Returns basic type maps, based off (types), types include: units, teachingperiods, etc.	{ unitCode: %%%####, unitName: "...", faculty: "..." }
GET	/basic/periods	Google Datastore	v0.7.0 New!	Returns common teaching periods information	[..., {id: ###.., ,"name":"...","code":"%#-##","startDate":"YYYY-MM-DD","endDate":"YYYY-MM-DD"}, ...]
GET	/basic/courses	Google Datastore	v0.7.0 New!	Returns all the course maps availiable, once you have a courseCode, you can then perform a courseMap search	[..., { "id":"#####","aosCode":"L3002-4","aosName":"Materials Engineering specialisation","courseCode":"L3002","courseName":"Bachelor of Laws and Engineering (double)","managingFaculty":"Faculty of Law"}, ...]
GET	/basic/courses/{courseCode}	Google Datastore	v0.7.0 New!	Returns all the course maps availiable that have a matching course code	[..., { "id":"#####","aosCode":"L3002-4","aosName":"Materials Engineering specialisation","courseCode":"L3002","courseName":"Bachelor of Laws and Engineering (double)","managingFaculty":"Faculty of Law"}, ...]
GET	/basic/schools/	Google Datastore	v0.7.2 New !	Returns details about every school in Australia

Unit Calls

T	Instruction	Storage Type	Intro (Current)	Returns
G	/units/(unitCode)	Datastore	v0.1 (v0.7.0 New! )	Returns everything about the course about the course including unit rules
G	/rules/(unitCode)	Datastore	v0.3 (v0.7.1)	Returns rule strings about that given unit, including Teaching Periods

Example Return

{
  "preqs": "VCE Mathematics Methods or Specialist Mathematics units 3 & 4 with a study score of 25 or MTH1010.Note: For 2016 Further Mathematics with a study score of 35 will be accepted.",
  "creditPoints": 6,
  "rules": [
    {
      "startDate": "1/01/2017",
      "status": "ACTIVE",
      "ruleSummary": "INCOMP-IW",
      "ruleString": "Incompatible with achievement in (I/W) {FIT1029}",
      "endDate": ""
    },
    {
      "startDate": "1/01/2016",
      "status": "ACTIVE",
      "ruleSummary": "INCOMP-IW",
      "ruleString": "Incompatible with achievement in (I/W) {FIT1029}",
      "endDate": "31/12/2016"
    }
  ],
  "locationAndTime": "...",
  "enjoyScore": 3.47826087,
  "learnScore": 3.390116526,
  "learnResponse": 45,
  "proh": "FIT1029",
  "scaBand": "FIT1045",
  "unitName": "Algorithms and programming fundamentals in python",
  "enjoyResponse": 90,
  "faculty": "Faculty of Information Technology",
  "unitCode": "FIT1045",
  "eftsl": 0.125
}

Course Calls

T	Instruction	Storage Type	Intro (Current)	Returns
GET	/courses/(code)	Datastore	v0.1 (v0.7.0 New! )	Returns descriptive (same as course/ext details about the course
GET	/courseMaps/(code)	Google Datastore	v0.5 (v0.7.0 New!)	Returns as an earlier version, under PropertyMap do note that you will need to use JSON.parse() on teachingperiods

User Snapshots

T	Instruction	Storage Type	Intro (Current)	Returns
G	/snaps/(identifier)	Datastore	v0.5.10 (v0.7.0)	The CourseStructure
P	/snaps/	Datastore	v0.5.10 (v0.7.0)	Append CourseStructure JSON to Body