instructions.md

List of Instructions

GET /codes/instructions.{format}

Description

This method returns a list of Instructions.

Summary

Name	Value	Name	Value
Request Protocol	GET	Requires API Key	Yes
Method ID	1259	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
• Any value can be null

Sources

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

Parameters

GET /codes/instructions.{format}

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

Output Formats

• json
• xml

Examples

GET /codes/instructions.{format}

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

Response

Field Name	Type	Value Description
abbreviation	string	Abbreviation
description	string	Description

Any value can be null

Output

JSON

{
  "meta":{
    "requests":129,
    "timestamp":1381958251,
    "status":200,
    "message":"Request successful",
    "method_id":1259,
    "version":2.07,
    "method":{
      
    }
  },
  "data":[
    {
      "abbreviation":"CLN",
      "description":"Clinic"
    },
    {
      "abbreviation":"DIS",
      "description":"Discussion"
    },
    {
      "abbreviation":"ENS",
      "description":"Ensemble"
    },
    {
      "abbreviation":"ESS",
      "description":"Essay"
    },
    {
      "abbreviation":"FLD",
      "description":"Field Study"
    },
    {
      "abbreviation":"LAB",
      "description":"Laboratory"
    },
    {
      "abbreviation":"LEC",
      "description":"Lecture"
    },
    {
      "abbreviation":"ORL",
      "description":"Oral Conversation"
    },
    {
      "abbreviation":"PRA",
      "description":"Practicum"
    },
    {
      "abbreviation":"PRJ",
      "description":"Project"
    },
    {
      "abbreviation":"RDG",
      "description":"Reading"
    },
    {
      "abbreviation":"SEM",
      "description":"Seminar"
    },
    {
      "abbreviation":"STU",
      "description":"Studio"
    },
    {
      "abbreviation":"TLC",
      "description":"Test\/Lecture"
    },
    {
      "abbreviation":"TST",
      "description":"Test"
    },
    {
      "abbreviation":"TUT",
      "description":"Tutorial"
    },
    {
      "abbreviation":"WRK",
      "description":"Work Term"
    },
    {
      "abbreviation":"WSP",
      "description":"Workshop"
    }
  ]
}