Skip to content
This repository has been archived by the owner on Jun 20, 2024. It is now read-only.

Latest commit

 

History

History
506 lines (475 loc) · 10.9 KB

methods.md

File metadata and controls

506 lines (475 loc) · 10.9 KB
Raw

API Methods List

GET /api/methods.{format}

Description

This method returns all api endpoint methods available to use

Summary

Name Value Name Value
Request Protocol GET Requires API Key No
Method ID 1103 Enabled Yes
Service Name api Service ID 223
Information Steward UW OpenData Data Type Direct DB Connection
Update Frequency Every request (live) Cache Time 0 seconds

Notes

  • Usage won't increase for calling this method
  • Any value can be null

Sources

Parameters

GET /api/methods.{format}
Parameter Type Required Description
format input yes The format of the output
callback filter no JSONP callback format

Output Formats

  • json
  • xml

Examples

GET /api/methods.{format}

Response

Field Name Type Value Description
method_id integer API assigned method ID
method_url string API assigned method endpoint url
service_id integer API assigned method's parent service's id
service_name string API assigned method's parent service's name
parameters list String of acceptable method parameters

Any value can be null

Output

JSON

{
  "meta":{
    "requests":3799,
    "timestamp":1381933890,
    "status":200,
    "message":"Request successful",
    "method_id":1103,
    "version":2.07,
    "method":{
      
    }
  },
  "data":[
    {
      "method_id":1081,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/api\/services.{format}",
      "service_id":223,
      "service_name":"api",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1087,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/server\/time.{format}",
      "service_id":227,
      "service_name":"server",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1091,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/server\/codes.{format}",
      "service_id":227,
      "service_name":"server",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1093,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/server\/admin.{format}",
      "service_id":227,
      "service_name":"server",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1097,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/api\/usage.{format}",
      "service_id":223,
      "service_name":"api",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1103,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/api\/methods.{format}",
      "service_id":223,
      "service_name":"api",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1109,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/api\/versions.{format}",
      "service_id":223,
      "service_name":"api",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1117,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/api\/changelog.{format}",
      "service_id":223,
      "service_name":"api",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1123,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/resources\/printers.{format}",
      "service_id":229,
      "service_name":"resources",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1129,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/resources\/infosessions.{format}",
      "service_id":229,
      "service_name":"resources",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1153,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/courses\/{department}.{format}",
      "service_id":239,
      "service_name":"courses",
      "parameters":[
        "department",
        "format"
      ]
    },
    {
      "method_id":1163,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/courses\/{department}\/{number}.{format}",
      "service_id":239,
      "service_name":"courses",
      "parameters":[
        "department",
        "number",
        "format"
      ]
    },
    {
      "method_id":1171,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/courses\/{department}\/{number}\/schedule.{format}",
      "service_id":239,
      "service_name":"courses",
      "parameters":[
        "department",
        "number",
        "format"
      ]
    },
    {
      "method_id":1181,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/courses\/{subject}\/{number}\/prerequisites.{format}",
      "service_id":239,
      "service_name":"courses",
      "parameters":[
        "subject",
        "number",
        "format"
      ]
    },
    {
      "method_id":1187,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/terms\/{term}\/examschedule.{format}",
      "service_id":241,
      "service_name":"terms",
      "parameters":[
        "term",
        "format"
      ]
    },
    {
      "method_id":1193,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/terms\/{term}\/{subject}\/{number}\/schedule.{format}",
      "service_id":241,
      "service_name":"terms",
      "parameters":[
        "term",
        "subject",
        "number",
        "format"
      ]
    },
    {
      "method_id":1213,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/buildings\/list.{format}",
      "service_id":257,
      "service_name":"buildings",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1217,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/buildings\/{building}.{format}",
      "service_id":257,
      "service_name":"buildings",
      "parameters":[
        "building",
        "format"
      ]
    },
    {
      "method_id":1223,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/buildings\/{building}\/{room}\/courses.{format}",
      "service_id":257,
      "service_name":"buildings",
      "parameters":[
        "building",
        "room",
        "format"
      ]
    },
    {
      "method_id":1229,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/resources\/academics\/groups.{format}",
      "service_id":263,
      "service_name":"resources",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1231,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/resources\/academics\/organizations.{format}",
      "service_id":263,
      "service_name":"resources",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1237,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/resources\/academics\/subjects.{format}",
      "service_id":263,
      "service_name":"resources",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1249,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/resources\/academics\/terms.{format}",
      "service_id":263,
      "service_name":"resources",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1259,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/resources\/academics\/instructions.{format}",
      "service_id":263,
      "service_name":"resources",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1277,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/foodservices\/products\/{id}.{format}",
      "service_id":269,
      "service_name":"foodservices",
      "parameters":[
        "id",
        "format"
      ]
    },
    {
      "method_id":1279,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/foodservices\/products\/search.{format}",
      "service_id":269,
      "service_name":"foodservices",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1283,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/foodservices\/outlets.{format}",
      "service_id":269,
      "service_name":"foodservices",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1289,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/foodservices\/watcard.{format}",
      "service_id":269,
      "service_name":"foodservices",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1291,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/foodservices\/{year}\/{week}\/{id}\/menu.{format}",
      "service_id":269,
      "service_name":"foodservices",
      "parameters":[
        "year",
        "week",
        "id",
        "format"
      ]
    },
    {
      "method_id":1297,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/foodservices\/{year}\/{week}\/{id}\/notes.{format}",
      "service_id":269,
      "service_name":"foodservices",
      "parameters":[
        "year",
        "week",
        "id",
        "format"
      ]
    },
    {
      "method_id":1301,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/foodservices\/{year}\/{week}\/{id}\/announcements.{format}",
      "service_id":269,
      "service_name":"foodservices",
      "parameters":[
        "year",
        "week",
        "id",
        "format"
      ]
    },
    {
      "method_id":1303,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/foodservices\/menu.{format}",
      "service_id":269,
      "service_name":"foodservices",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1307,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/foodservices\/notes.{format}",
      "service_id":269,
      "service_name":"foodservices",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1319,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/foodservices\/announcements.{format}",
      "service_id":269,
      "service_name":"foodservices",
      "parameters":[
        "format"
      ]
    },
    {
      "method_id":1321,
      "method_url":"https:\/\/api.uwaterloo.ca\/v2\/foodservices\/diets.{format}",
      "service_id":269,
      "service_name":"foodservices",
      "parameters":[
        "format"
      ]
    }
  ]
}