Skip to content Skip to site navigation Skip to service navigation

CourseClass RESTful Web Services API

The CourseClass web service provides a way to retrieve the Course class XML and the Course term XML.

This includes:

  • Getting the Course Class XML given a CourseClass ID
  • Getting the Course term XML of a specified term (we can get the data for current term or for three past terms or for four future terms)

How to get started with the CourseClass API

Follow the Middleware and Integration Services Integration (MaIS) checklist for RESTful Web Services. If you need help, are not sure whether the Web APIs are the best method for integrating with the registry, or just have some questions, contact the MaIS team.

HTTP status codes

Code Conditions
200 OK The usual successful return code.
403 Access Denied The request was made without valid certificate.
404 Not Found The record you're looking for doesn't exist.
500 Internal Server Error Something broke with our code. Please tell us about it.

Error handling

Course API sends error status via standard HTTP status codes (4xx or 5xx)

Get Course XML

Description Get Course XML
URL https://registry.stanford.edu/doc/courseclass/{courseClassId}
UAT URL https://registry-uat.stanford.edu/doc/courseclass/{courseClassId}
Method GET
Returns 200 & Course XML
403 & error: not authorized to access the service.
404 & error: CourseId is invalid.

courseClassId should look like termId-courseId or termId-subject-catalogNumber ex: 1026-103398 or 1026-CHEMENG-450

Get Course term XML

Description Get Course term XML
We can get the data for current term or for three past terms or for four future terms.
URL https://registry.stanford.edu/doc/courseterm/{term}
UAT URL https://registry-uat.stanford.edu/doc/courseterm/{term}
Method GET
Returns 200 & course term XML
403 & error: not authorized to access the service.
404 & error: term is invalid.

 

DTDs

Last modified April 13, 2022