FYI: All lines within code blocks are numbered, regardless of whether there is more than one line of code provided.

This article covers documentation related to the initial version (v0) of the course listing API.

Request

To retrieve JSON for a course listing, first see Retrieval under the API - General Usage article.

For the course_ids operation, you can provide any mix of search parameters described below. You must be a system administrator to access any course listing JSON. For example:

/api?version=0&operation=course_ids&year=2021&template=templates

Requests can also be made programmatically by supplying your API key in the X-AUTH-KEY request header, providing your root domain, and appending the aforementioned path.

Response

This API produces output in a JSON format. Below is a formatted excerpt of what you might find when retrieving JSON for a course listing.

[
{
    "id":"307",
    "external_id":"ACCT221_MASTER"
  },
  {
    "id":"310",
    "external_id":"ECON313_12919_202020"
  },
  {
    "id":"8398",
    "external_id":null
  }
]

Note: courses that have no external ID will contain null in the output.

Parameters

To generate a course listing, you may use any combination of the criteria offered on the Concourse Search page. These include:

• Keyword(s)
  
  • keyword=string
• Keyword Mode: One of "all" or "any"
  
  • keyword_mode=all
• Course Title
  
  • title=string
• Subject
  
  • prefix=string
• Number
  
  • number=string
• Campus
  
  • campus_id=string
• School
  
  • school_id=string
• Department
  
  • department_id=string
• Instructor
  
  • instructor=string
• Session
  
  • session=string
• Year
  
  • year=string
• Time Frame: One of "past", "past_current", "current", "current_future", or "future"
  
  • timeframe=current_future
• Credits
  
  • credits=string
• Delivery
  
  • delivery_method=string
• Course tags
  
• tag_id=string
• Templates: One of "templates" or "non"
  
• template=templates
  
• Audit Status: One of "0", "1", "2", "3", or "4".
  
  • audit_status=1
  • For the purpose of this API, 0 means New, 1 means In Progress, 2 means Reviewed, 3 means Modified Since Review, and 4 means Submitted For Review.
    

While each of these parameters are optional, we recommend you apply at least one criteria to limit the number of matching courses in your JSON output.

Note that if courses are hidden in your Concourse system, they will NOT display in the course listing API.