Skip to content

Latest commit

 

History

History
177 lines (146 loc) · 2.86 KB

terms.md

File metadata and controls

177 lines (146 loc) · 2.86 KB

Code Lookups for Terms

GET /codes/terms.{format}

Description

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

Summary

Name Value Name Value
Request Protocol GET Requires API Key Yes
Method ID 1249 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

Parameters

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

Output Formats

  • json
  • xml

Examples

GET /codes/terms.{format}

Response

Field Name Type Value Description
term string Term
description string Description of term

Any value can be null

Output

JSON

{
  "meta":{
    "requests":128,
    "timestamp":1381958213,
    "status":200,
    "message":"Request successful",
    "method_id":1249,
    "version":2.07,
    "method":{
      
    }
  },
  "data":[
    {
      "abbreviation":"F",
      "description":"Fall"
    },
    {
      "abbreviation":"S",
      "description":"Spring"
    },
    {
      "abbreviation":"W",
      "description":"Winter"
    },
    {
      "abbreviation":"J",
      "description":"Summer; first half; August"
    },
    {
      "abbreviation":"A",
      "description":"Summer; second half; August"
    },
    {
      "abbreviation":"M",
      "description":"Summer; both terms; July, August"
    }
  ]
}