Skip to content

Latest commit

 

History

History
363 lines (332 loc) · 7.32 KB

services.md

File metadata and controls

363 lines (332 loc) · 7.32 KB

API Services List

GET /api/services.{format}

Description

This method returns all api services available to use

Summary

Name Value Name Value
Request Protocol GET Requires API Key No
Method ID 1081 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 if no data is returned
  • Any value can be null

Sources

Parameters

GET /api/services.{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/services.{format}

Response

Field Name Type Value Description
service_id integer API assigned service ID
service_name string API assigned service name
service_url string API assigned service endpoint url
methods list Available endpoints under the service
method_id string API assigned method under service id
method_url string API assigned method endpoint udner service

Any value can be null

Output

JSON

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