Accessing information on Academic Terms
:: services/terms module

Basic methods which allow you to retrieve data on Academic Terms defined in this USOS installation. Terms might come in various types, but usually they will be limited to academic years and semesters.

Methods

search BETA Search for terms.
term Get information on a single term.
terms Get information on multiple terms.
terms_index Get the list of all terms. (administrative)
Consumer: ignored Token: ignored Scopes: n/a SSL: not required
https://apps.uwm.edu.pl/services/terms/search

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

Search for terms matching the given query and/or filters.

By default, this method will search among all terms. If you'd like to search only in a limited subset of them, then try using some of the optional parameters.

query optional

Default value: (empty string)

The search query. Query is not tokenized and (as a whole) is matched against any part of term name or id. Proper tokenization will likely be added in the future.

Returns all terms that satisfy other criteria if omitted.

min_finish_date optional

Default value: (empty string)

Date string (YYYY-MM-DD). If given, then only those terms which are finished on this day (inclusive), or later, will be returned.

max_start_date optional

Default value: (empty string)

Date string (YYYY-MM-DD). If given, then only those terms which start on this day (inclusive), or earlier, will be returned.

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

No additional OAuth arguments are required. If you provide any, they will be ignored.

Returned value:

List of terms objects as defined in the term method.

services/terms/term

Consumer: ignored Token: ignored Scopes: n/a SSL: not required
https://apps.uwm.edu.pl/services/terms/term
Get information on a single term.
term_id required ID of an Academic Term.
format optional

Default value: json

Format in which to return values. See supported output formats.
callback optional Required only if you've chosen jsonp as a return format.
No additional OAuth arguments are required. If you provide any, they will be ignored.

Returned value:

A dictionary of the following structure:

  • id - an ID of the term,
  • order_key - long int, used for ordering Academic Term objects (should not be displayed for users),
  • name - a LangDict object with the name of a term,
  • start_date - a Date string, the first day of this Academic Term,
  • end_date - a Date string, the last day of classes in this Academic Term,
  • finish_date - a Date string, the last day of this Academic Term (this day is part of this Academic Term.

Method will end with a 400 error, if referenced term cannot be found.

services/terms/terms

Consumer: ignored Token: ignored Scopes: n/a SSL: not required
https://apps.uwm.edu.pl/services/terms/terms
Get information on multiple terms.
term_ids required Pipe-separated list of Academic Term IDs.
format optional

Default value: json

Format in which to return values. See supported output formats.
callback optional Required only if you've chosen jsonp as a return format.
No additional OAuth arguments are required. If you provide any, they will be ignored.

Returned value:

A dictionary. Your term_ids will be mapped to the keys of this dictionary, each value will contain a dictionary describing a term (as defined in the term method). If term does not exist, it's key will be mapped to null.

services/terms/terms_index

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: ignored Scopes: n/a SSL: not required
https://apps.uwm.edu.pl/services/terms/terms_index

Get the list of all Academic Terms defined in this installation.

format optional

Default value: json

Format in which to return values. See supported output formats.
callback optional Required only if you've chosen jsonp as a return format.
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Token is not required.

Returned value:

The list of dictionaries, each dictionary describes one term (as defined in the term method. Returned items will be ordered by their order_key (ascending).

USOS API ver. 6.4.0.0-15, 9dcd97b9 (2019-02-25)