|
Accessing information on courses
|
classtypes_index | Get a list of all possible class types. |
coordinator | Get course editions that user is coordinator of |
course | Get information on a given course. |
course2 | Get information on a given course. |
course_edition | Get information on a given course edition. |
course_edition2 | Get information on a given course edition. |
course_unit | Get information on a given unit. |
courses | Get information on multiple courses. |
is_coordinator | Is staff member a course edition coordinator. |
is_lecturer | Is staff member a course edition lecturer. |
is_participant | Is student participant of course edition. |
search | Search for courses. |
unit | Get information on a given unit. |
units | Get information on multiple course units. |
user | Get information on user's courses. |
user_ects_points | Get ECTS points count for user courses |
services/courses/classtypes_index ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/courses/classtypes_index | ||||||
Get a list of all possible class types.
| ||||||
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. IDs of class types will be mapped to keys of this dictionary. Each value will contain a description of one class type. Each description is a dictionary of the following structure (currently only one field):
|
services/courses/coordinator ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/courses/coordinator | ||||||
Get course editions that user is coordinator of | ||||||
user_id | optional |
Default value: (access token issuer) ID of a user. |
||||
active_terms_only | optional |
Default value: true If true, only course editions from active academic terms will be returned |
||||
fields | optional |
Default value: course|term Selector of result fields you are interested in. The selector must contain subset of primary fields, which are described in the returns section of course_edition2 method. |
||||
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 optional standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization. | ||||||
Returned value: List of course editions |
services/courses/course ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/courses/course | ||||||
Get information on a given course. | ||||||
course_id | required |
Pipe-separated list of course IDs. |
||||
fields | optional |
Default value: id|name Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
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 selected fields and their values. Available fields:
|
services/courses/course2 ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/courses/course2 | ||||||
Get information on a given course. | ||||||
course_id | required |
Pipe-separated list of course IDs. |
||||
fields | optional |
Default value: id|name Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
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 selected fields and their values. Available fields:
|
services/courses/course_edition ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/courses/course_edition | ||||||
Get information on a given course edition. | ||||||
course_id | required | ID of a course | ||||
term_id | required | ID of an academic term | ||||
fields | optional |
Default value: course_id|course_name|term_id|user_groups Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
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 optional standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization. | ||||||
Returned value: A dictionary of selected fields and their values. Available fields:
| ||||||
Thrown errors:
|
services/courses/course_edition2 ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/courses/course_edition2 | ||||||
Get information on a given course edition. | ||||||
course_id | required | ID | ||||
term_id | required | ID | ||||
fields | optional |
Default value: course|term Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
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 optional standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization. | ||||||
Returned value: A dictionary of selected fields and their values. Available fields:
|
services/courses/course_unit ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/courses/course_unit | ||||||
Get information on a given unit. | ||||||
course_unit_id | required | ID of a course unit | ||||
fields | optional |
Default value: id Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
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 optional standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization. | ||||||
Returned value: A dictionary of selected fields and their values. Available fields:
|
services/courses/courses ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/courses/courses | ||||||
Get information on multiple courses. This method is similar to the course method, but it works with multiple courses. It also has a limited fields support. | ||||||
course_ids | required |
Pipe-separated list of course IDs. |
||||
fields | optional |
Default value: id|name Selector of result fields you are interested in. The selector must contain subset of primary fields, which are described in the returns section of course method. |
||||
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 course_ids will be mapped to dictionary's keys, and each value will contain the description of a course, as defined in the course method. |
services/courses/is_coordinator ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/courses/is_coordinator | ||||||
Is staff member a course edition coordinator.
| ||||||
course_id | required | ID of a course unit (first part of primary key). | ||||
term_id | required | ID of a term (second part of primary key). | ||||
user_id | optional |
Default value: access token issuer. ID of a user. |
||||
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 optional standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization. | ||||||
Returned value: Boolean value. |
services/courses/is_lecturer ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/courses/is_lecturer | ||||||
Is staff member a course edition lecturer.
| ||||||
course_id | required | ID of a course unit (first part of primary key). | ||||
term_id | required | ID of a term (second part of primary key). | ||||
user_id | optional |
Default value: access token issuer. ID of a user. |
||||
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 optional standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization. | ||||||
Returned value: Boolean value |
services/courses/is_participant ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/courses/is_participant | ||||||
Is student participant of course edition.
| ||||||
course_id | required | ID of a course unit. | ||||
term_id | required | ID of a 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. | ||||
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus required oauth_token for Token authorization. | ||||||
Returned value: Boolean value - true if user is participant of that course edition. |
services/courses/search ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/courses/search | ||||||
Search for courses matching given query. | ||||||
lang | required | A code of the preferred language ("pl" or "en"). It will influence the order and other display properties of the returned matches. | ||||
name | optional | Course name (or part of it). USOS API will match this against names and IDs of courses. | ||||
fields | optional |
Default value: course_id|match Pipe-separated list of fields. See the returned value section below for the list of available fields. |
||||
num | optional |
Default value: 6 Identifies the number of search results to return. The maximum value of num is 20. |
||||
start | optional |
Default value: 0 Indicates the first matching result that should be included in the search results. This parameter uses a zero-based index, meaning the first result is 0, the second result is 1 and so forth. Note, that no more than 100 search result will ever be returned for any query, even if more than 100 matches were found. If you need more, than probably you're looking at a wrong method. Contact us if you're not sure. |
||||
fac_id | optional | A faculty ID. If given, it restricts the search to courses run by this faculty. | ||||
fac_deep | optional |
Default value: false Boolean. Valid only when used along with the fac_id parameter. By default, fac_id restricts the search to courses run ONLY by a given faculty. Set fac_deep to "true" in order to also include courses run by subfaculties of this faculty. |
||||
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:
|
services/courses/unit ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/courses/unit | ||||||
Get information on a given unit. | ||||||
unit_id | required | ID of a unit. | ||||
fields | optional |
Default value: id Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
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 optional standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization. | ||||||
Returned value: A dictionary of selected fields and their values. Available fields:
|
services/courses/units ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/courses/units | ||||||
Get information on multiple course units. This method is similar to the unit method, but it works with multiple units. It also has a limited fields support. | ||||||
unit_ids | required | Pipe-separated list of unit IDs. | ||||
fields | optional |
Default value: id Selector of result fields you are interested in. The selector must contain subset of primary fields, which are described in the returns section of unit method. |
||||
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 optional standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization. | ||||||
Returned value: A dictionary: your unit_ids will be mapped to dictionary's keys, and each value will contain the description of a course, as defined in the unit method (or null if the given unit_id has not been found). |
services/courses/user ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/courses/user | ||||||
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. Get information on user's courses. | ||||||
fields | optional |
Default value: course_editions Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
active_terms_only | optional |
Default value: true Return only these course editions which are related to the currently active academic terms. |
||||
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. Plus required oauth_token for Token authorization. | ||||||
Returned value: A dictionary of selected fields and their values. Available fields:
|
services/courses/user_ects_points ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/courses/user_ects_points | ||||||
Get ECTS points count for user courses | ||||||
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. Plus required oauth_token for Token authorization. | ||||||
Returned value: Map from term IDs to map from course IDs to ECTS point count as string or null if ECTS for this course could not be calculated. |