|
Study programmes
|
programme | Get information on a given study programme. |
programmes | Get information on multiple study programmes. |
search | Search for programmes. |
search_history_affect | Add a programme to search history. |
stage | Get stage info |
student | Get information on student programmes of a given user. |
student_programme | Get information on a given student programme. |
student_programmes | Get information on multiple student programmes. |
services/progs/programme ¶
|
||||||
https://api.usos.tu.kielce.pl/services/progs/programme | ||||||
Get information on a given study programme. | ||||||
programme_id | required |
ID of a programme. |
||||
fields | optional |
Default value: id|description 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. Token is not required. | ||||||
Returned value: A dictionary of selected fields and their values. Available fields:
| ||||||
Thrown errors:
|
services/progs/programmes ¶
|
||||||
https://api.usos.tu.kielce.pl/services/progs/programmes | ||||||
Get information on multiple stidy programmes at once. | ||||||
programme_ids | required |
List of programme IDs. |
||||
fields | optional |
Default value: id|description Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of programme 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. Token is not required. | ||||||
Returned value: A dictionary.
|
services/progs/search ¶
|
||||||
https://api.usos.tu.kielce.pl/services/progs/search | ||||||
Search for programmes matching the given query and/or filters. USOS API supports personalized search results. For example, it may display certain items higher in the results, based on personal user preferences and connections. You should include Access Tokens in your requests in order to make use of these features. For best results, you should also use the search_history_affect method. | ||||||
lang | required |
A code of the preferred language ("pl" or "en"). It may influence the order and other properties of the returned matches (in particular, the language used in the match field). |
||||
fields | optional |
Default value: items[programme[id]|match]|next_page A selector of result fields you are interested in. |
||||
query | optional |
Default value: (empty string) The search query. The most obvious value for this field is the programme title, but we'll try to be smart about it. |
||||
num | optional |
Default value: 6 The number of search results to return. The maximum allowed value of num is 20. |
||||
start | optional |
Default value: 0 Zero-based offset of the first item that should be included in the response. (Or, in other words, the number of items to strip from the beginning of the items-list.) Note, that currently no more than 100 items will be returned for any query, even if more than 100 matches were found. |
||||
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/progs/search_history_affect ¶
|
||||||
https://api.usos.tu.kielce.pl/services/progs/search_history_affect | ||||||
Add a programme to search history. This method aims at improving user experience while searching. Call this method once your user visits programme's page, or when he/she selects a programme while searching for prorgammes, etc. Given programme will be added to search history. Items saved in search history may appear more frequently in search results. | ||||||
programme_id | required |
The ID of the programme you want saved to the search history. |
||||
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: Currently, it always returns |
services/progs/stage ¶
|
||||||
https://api.usos.tu.kielce.pl/services/progs/stage | ||||||
Get stage info | ||||||
id | required | ID of a stage | ||||
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/progs/student ¶
|
||||||
https://api.usos.tu.kielce.pl/services/progs/student | ||||||
This is similar to the student_programmes field of the services/users/user method, but allows you to explicitly decide if you want only the active student programmes. | ||||||
user_id | optional |
Default value: (access token issuer) ID of a user. |
||||
fields | optional |
Default value: id|programme Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of student_programme method. |
||||
active_only | optional |
Default value: true By default, you will get only student programmes with the status equal to active or graduated_before_diploma. Set this to false if you want to include all student programmes. Please note, that only these student programmes which you have access to will be included. And even if you have access to a student programme, some of its fields may still be hidden (see the student_programme method for details). |
||||
old_programs | optional |
Default value: true Get only programs which ended in past |
||||
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 optional oauth_token for Token authorization. | ||||||
Returned value: List of student_programme objects. |
services/progs/student_programme ¶
|
||||||
https://api.usos.tu.kielce.pl/services/progs/student_programme | ||||||
Get information on a given student programme. Visibility of the fields depends on many variables which are not publicly documented. However, some general rules apply:
| ||||||
student_programme_id | required |
ID of a student programme. If the student programme does not exist or you don't have the access to view it, you will get a HTTP 400 response. |
||||
fields | optional |
Default value: id|programme 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 required 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/progs/student_programmes ¶
|
||||||
https://api.usos.tu.kielce.pl/services/progs/student_programmes | ||||||
Get information on a multiple student programmes at once. | ||||||
student_programme_ids | required |
Pipe-separated list of student programme IDs. |
||||
fields | optional |
Default value: id|programme Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of student_programme 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 required 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.
|