groups.md

Code Lookups for Groups

GET /codes/groups.{format}

Description

This method returns a list of all code lookups for groups.

Summary

Name	Value	Name	Value
Request Protocol	GET	Requires API Key	Yes
Method ID	1229	Enabled	Yes
Service Name	codes	Service ID	263
Information Steward	Institution of Analysis & Planning (IAP)	Data Type	CSV
Update Frequency	When updated by steward/via pull request	Cache Time	0 seconds

Notes

• Usage won't increase if there is no data returned
• This data is community curated on github
• In Quest, there are units and groups. Units are inside groups. A unit is like a department and a group is like a faculty. Reason: not all units and departments and not all groups are faculties.
• Any value can be null

Sources

• https://github.com/uWaterloo/Datasets/blob/master/Quest/AcademicGroups.csv

Parameters

GET /codes/groups.{format}

Parameter	Type	Required	Description
key	filter	yes	Your API key
callback	filter	no	JSONP callback format

Output Formats

• json
• xml

Examples

GET /codes/groups.{format}

• https://api.uwaterloo.ca/v2/codes/groups.json
• https://api.uwaterloo.ca/v2/codes/groups.xml
• https://api.uwaterloo.ca/v2/codes/groups.json?callback=myResponse

Response

Field Name	Type	Value Description
group_code	string	Group Code
group_short_name	string	Group Short Name
group_full_name	string	Full group name

Any value can be null

Output

JSON

{
  "meta":{
    "requests":145,
    "timestamp":1382023751,
    "status":200,
    "message":"Request successful",
    "method_id":1229,
    "version":2.07,
    "method":{
      
    }
  },
  "data":[
    {
      "group_code":"AHS",
      "group_short_name":"Applied Health Sciences",
      "group_full_name":"Faculty of Applied Health Sciences"
    },
    {
      "group_code":"ART",
      "group_short_name":"Arts",
      "group_full_name":"Faculty of Arts"
    },
    {
      "group_code":"CGC",
      "group_short_name":"Conrad Grebel",
      "group_full_name":"Conrad Grebel University College"
    },
    {
      "group_code":"ENG",
      "group_short_name":"Engineering",
      "group_full_name":"Faculty of Engineering"
    },
    {
      "group_code":"ENV",
      "group_short_name":"Environment",
      "group_full_name":"Faculty of Environment"
    },
    {
      "group_code":"GRAD",
      "group_short_name":"Graduate Studies",
      "group_full_name":"Graduate Studies"
    },
    {
      "group_code":"IS",
      "group_short_name":"Independent Studies",
      "group_full_name":"Independent Studies"
    },
    {
      "group_code":"MAT",
      "group_short_name":"Mathematics",
      "group_full_name":"Faculty of Mathematics"
    },
    {
      "group_code":"REN",
      "group_short_name":"Renison",
      "group_full_name":"Renison University College"
    },
    {
      "group_code":"SCI",
      "group_short_name":"Science",
      "group_full_name":"Faculty of Science"
    },
    {
      "group_code":"STJ",
      "group_short_name":"St. Jeromes",
      "group_full_name":"St. Jerome's University"
    },
    {
      "group_code":"STP",
      "group_short_name":"St. Pauls",
      "group_full_name":"St. Paul's University College"
    },
    {
      "group_code":"THL",
      "group_short_name":"Theology",
      "group_full_name":"Theology"
    },
    {
      "group_code":"VPA",
      "group_short_name":"Interdisciplinary",
      "group_full_name":"Interdisciplinary Studies"
    }
  ]
}