Skip to content
This repository has been archived by the owner on Jun 20, 2024. It is now read-only.

Latest commit

 

History

History
310 lines (278 loc) · 5.99 KB

term_enrollment.md

File metadata and controls

310 lines (278 loc) · 5.99 KB

Course enrollment by term

GET /terms/{term}/enrollment.{format}

Description

This method returns enrollment numbers for all classes in a term

Summary

Name Value Name Value
Request Protocol GET Requires API Key Yes
Method ID 1871 Enabled Yes
Service Name terms Service ID 241
Information Steward Registrar Data Type Scraped
Update Frequency Every hour Cache Time 0 seconds

Notes

  • Any value can be null

Sources

Parameters

GET /terms/{term}/enrollment.{format}
Parameter Type Required Description
term input yes Four digit term representation
format input yes The format of the output
key filter yes Valid API key
callback filter no JSONP callback format

Output Formats

  • json
  • xml

Examples

GET /terms/{term}/enrollment.{format}

Response

Field Name Type Value Description
subject string Requested subject acronym
catalog_number string Registrar assigned class number
class_number integer Associated term specific class enrollment number
section string Class instruction and number
enrollment_capacity integer Class enrollment capacity
enrollment_total integer Total current class enrollment
waiting_capacity integer Class waiting capacity
waiting_total string Total current waiting students
last_updated string ISO8601 timestamp of when the data was last updated

Any value can be null

Output

JSON

The sample response has been trimmed and the endpoint will return data for an entire term.

{
  "meta":{
    "requests":723413,
    "timestamp":1447986011,
    "status":200,
    "message":"Request successful",
    "method_id":1871,
    "method":{

    }
  },
  "data":[
    {
      "subject":"ACC",
      "catalog_number":"770",
      "class_number":3901,
      "section":"LEC 001",
      "enrollment_capacity":8,
      "enrollment_total":0,
      "waiting_capacity":0,
      "waiting_total":0
    },
    {
      "subject":"ACC",
      "catalog_number":"772",
      "class_number":3902,
      "section":"LEC 001",
      "enrollment_capacity":8,
      "enrollment_total":1,
      "waiting_capacity":0,
      "waiting_total":0
    },
    {
      "subject":"ACC",
      "catalog_number":"781",
      "class_number":3903,
      "section":"SEM 001",
      "enrollment_capacity":5,
      "enrollment_total":4,
      "waiting_capacity":0,
      "waiting_total":0
    },
    {
      "subject":"ACINTY",
      "catalog_number":"600",
      "class_number":2921,
      "section":"OLN 081",
      "enrollment_capacity":9999,
      "enrollment_total":219,
      "waiting_capacity":0,
      "waiting_total":0
    },
    {
      "subject":"ACINTY",
      "catalog_number":"600",
      "class_number":2922,
      "section":"OLN 082",
      "enrollment_capacity":9999,
      "enrollment_total":22,
      "waiting_capacity":0,
      "waiting_total":0
    },
    {
      "subject":"ACINTY",
      "catalog_number":"610",
      "class_number":2967,
      "section":"OLN 081",
      "enrollment_capacity":9999,
      "enrollment_total":275,
      "waiting_capacity":0,
      "waiting_total":0
    },
    {
      "subject":"ACINTY",
      "catalog_number":"610",
      "class_number":2968,
      "section":"OLN 082",
      "enrollment_capacity":9999,
      "enrollment_total":42,
      "waiting_capacity":0,
      "waiting_total":0
    },
    {
      "subject":"WS",
      "catalog_number":"325",
      "class_number":4354,
      "section":"LEC 001",
      "enrollment_capacity":5,
      "enrollment_total":4,
      "waiting_capacity":0,
      "waiting_total":0
    },
    {
      "subject":"WS",
      "catalog_number":"334",
      "class_number":7896,
      "section":"LEC 001",
      "enrollment_capacity":15,
      "enrollment_total":6,
      "waiting_capacity":0,
      "waiting_total":0
    },
    {
      "subject":"WS",
      "catalog_number":"475",
      "class_number":7898,
      "section":"RDG 001",
      "enrollment_capacity":1,
      "enrollment_total":0,
      "waiting_capacity":0,
      "waiting_total":0
    },
    {
      "subject":"WS",
      "catalog_number":"499A",
      "class_number":3886,
      "section":"RDG 001",
      "enrollment_capacity":1,
      "enrollment_total":2,
      "waiting_capacity":0,
      "waiting_total":0
    }
  ]
}