Skip to content

Latest commit

 

History

History
226 lines (195 loc) · 3.65 KB

list.md

File metadata and controls

226 lines (195 loc) · 3.65 KB

Terms Listings

GET /terms/list.{format}

Description

This method returns the current, previous and next term's id along with a list of terms in the past year and the next year

Summary

Name Value Name Value
Request Protocol GET Requires API Key Yes
Method ID 1409 Enabled Yes
Service Name terms Service ID 241
Information Steward UW API Data Type Time computed
Update Frequency On request Cache Time 0 seconds

Notes

  • Any value can be null

Sources

Parameters

GET /terms/list.{format}
Parameter Type Required Description
key filter yes Valid API key
callback filter no JSONP callback format

Output Formats

  • json
  • xml

Examples

GET /terms/list.{format}

Response

Field Name Type Value Description
current_term integer Current Term's numerical value
previous_term integer Previous term's numerical value
next_term integer Upcoming term's numerical value
listings object Term listings by year
{year} list First item is previous year, second is current, last is next year
id integer Term's numeric ID
name string Parsed term name (human readable)

Any value can be null

Output

JSON

{
  "meta":{
    "requests":156,
    "timestamp":1383680452,
    "status":200,
    "message":"Request successful",
    "method_id":1409,
    "version":2.07,
    "method":{
      
    }
  },
  "data":{
    "current_term":1139,
    "previous_term":1135,
    "next_term":1141,
    "listings":{
      "2012":[
        {
          "id":1121,
          "name":"Winter 2012"
        },
        {
          "id":1125,
          "name":"Spring 2012"
        },
        {
          "id":1129,
          "name":"Fall 2012"
        }
      ],
      "2013":[
        {
          "id":1131,
          "name":"Winter 2013"
        },
        {
          "id":1135,
          "name":"Spring 2013"
        },
        {
          "id":1139,
          "name":"Fall 2013"
        }
      ],
      "2014":[
        {
          "id":1141,
          "name":"Winter 2014"
        },
        {
          "id":1145,
          "name":"Spring 2014"
        },
        {
          "id":1149,
          "name":"Fall 2014"
        }
      ]
    }
  }
}