|
Registrations
|
course_registration_rounds | Get list of course registration rounds |
courses_cart | Get user courses cart with registrations information. |
faculty_registrations | Get faculty registrations |
faculty_token_registrations | Get faculty token registrations |
ranking | Get details of specified ranking |
register | Register to a course. |
registration | Get registration details |
registration_course | Get details of course related to registrations |
registration_round | Get registration round details |
registration_round_courses | Get list of course registration entries for specific registration round. |
search_rounds | Search for registrations rounds in calendar |
search_token_rounds | Search for token registrations rounds in calendar |
token_registration | Get token registration details |
token_registration_course | Get details of course related to token registration |
token_registration_round | Get token registration round details |
unregister | Unregister from course. |
user_registrations | Get user registrations |
user_token_registrations | Get user token registrations |
services/registrations/course_registration_rounds ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/registrations/course_registration_rounds | ||||||
Get list of course registration rounds | ||||||
registration_id | required | Registration ID | ||||
fields | optional |
Default value: id|name|status|registration_mode|start_date|end_date Selector of result fields you are interested in. The selector must contain subset of primary fields, which are described in the returns section of registration_round 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: List of course registration rounds, each one as defined in registration_round. |
services/registrations/courses_cart ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/registrations/courses_cart | ||||||
Get user courses cart with registrations information. | ||||||
fields | optional |
Default value: course|term|user_registration_status|is_registration_valid|limits|is_linkage_required|registrations_count 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:
|
services/registrations/faculty_registrations ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/registrations/faculty_registrations | ||||||
Get all registrations for selected faculty
| ||||||
faculty_id | required | ID of faculty that registrations should be returned | ||||
active_only | optional |
Default value: true Only active registrations |
||||
user_related | optional |
Default value: false Only registrations related to user |
||||
fields | optional |
Default value: id|description|message|type|status|is_linkage_required|www_instance Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of registration 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: List of registration objects, as defined in registration method. |
services/registrations/faculty_token_registrations ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/registrations/faculty_token_registrations | ||||||
Get all token registrations for selected faculty
| ||||||
faculty_id | required | ID of faculty that registrations should be returned | ||||
active_only | optional |
Default value: true Only active registrations |
||||
user_related | optional |
Default value: false Only registrations related to user |
||||
fields | optional |
Default value: id|description|message|status|is_linkage_required Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of token_registration 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: List of registration objects, as defined in token_registration method. |
services/registrations/ranking ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/registrations/ranking | ||||||
Get details of specified ranking | ||||||
ranking_code | required | Ranking code | ||||
fields | optional |
Default value: code|name|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 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:
|
services/registrations/register ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/registrations/register | ||||||
Register to a course. | ||||||
round_id | required | Registration round ID | ||||
course_id | required | Course code | ||||
term_id | required | Cycle code | ||||
user_programme_id | optional | User program ID | ||||
user_stage_id | optional | User stage ID | ||||
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: Empty dict on success. |
services/registrations/registration ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/registrations/registration | ||||||
Get registration details | ||||||
id | required | Registration id | ||||
fields | optional |
Default value: id|description|message|type|status|is_linkage_required|www_instance 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:
|
services/registrations/registration_course ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/registrations/registration_course | ||||||
Get details of course related to registrations | ||||||
registration_id | required | Registration id | ||||
course_id | required | Course id | ||||
term_id | required | Term id | ||||
fields | optional |
Default value: course_id|term_id|status|limits 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:
|
services/registrations/registration_round ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/registrations/registration_round | ||||||
Get registration round details | ||||||
id | required | Registration round id | ||||
fields | optional |
Default value: id|name|status|registration_mode|start_date|end_date 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:
|
services/registrations/registration_round_courses ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/registrations/registration_round_courses | ||||||
Get list of course registration entries for specific registration round. | ||||||
registration_round_id | required | Registration round ID | ||||
fields | optional |
Default value: course|term_id|status|limits|is_linkage_required|registrations_count 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: List of courses in specific registration round. Available fields:
|
services/registrations/search_rounds ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/registrations/search_rounds | ||||||
Get all registrations rounds for selected faculty and date range
not longer than month
| ||||||
start_date | required | Round that ends after selected date will be returned | ||||
end_date | required | Round that starts before selected date will be returned.Note that maximal allowed period is one month | ||||
faculty_id | optional |
Default value: (empty string) ID of faculty that registration rounds should be returned |
||||
user_related | optional |
Default value: false Only registrations related to user |
||||
fields | optional |
Default value: id|name|status|registration_mode|start_date|end_date Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of registration_round 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: List of registrations rounds objects | ||||||
Thrown errors:
|
services/registrations/search_token_rounds ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/registrations/search_token_rounds | ||||||
Get all token registrations rounds for selected faculty and date range
not longer than month
| ||||||
start_date | required | Round that ends after selected date will be returned | ||||
end_date | required | Round that starts before selected date will be returned.Note that maximal allowed period is one month | ||||
faculty_id | optional |
Default value: (empty string) ID of faculty that registration rounds should be returned |
||||
user_related | optional |
Default value: false Only registrations related to user |
||||
fields | optional |
Default value: id|name|start_date|end_date Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of token_registration_round 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: List of token registrations rounds objects, as defined in token_registration_round method. | ||||||
Thrown errors:
|
services/registrations/token_registration ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/registrations/token_registration | ||||||
Get token registration details | ||||||
id | required | Token registration id | ||||
fields | optional |
Default value: id|description|message|status|is_linkage_required 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:
|
services/registrations/token_registration_course ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/registrations/token_registration_course | ||||||
Get details of course related to token registration | ||||||
registration_id | required | Token registration id | ||||
course_id | required | Course id | ||||
term_id | required | Term id | ||||
fields | optional |
Default value: course_id|term_id|status|limits|start_date 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:
|
services/registrations/token_registration_round ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/registrations/token_registration_round | ||||||
Get token registration round details | ||||||
id | required | Token registration round id | ||||
fields | optional |
Default value: id|name|start_date|end_date 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:
|
services/registrations/unregister ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/registrations/unregister | ||||||
Unregister from course. | ||||||
round_id | required | ID of registration round | ||||
course_id | required | ID of course | ||||
term_id | required | ID of 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 optional oauth_token for Token authorization. | ||||||
Returned value: Empty dict on success. |
services/registrations/user_registrations ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/registrations/user_registrations | ||||||
Get all registrations related to user
| ||||||
active_only | optional |
Default value: true Only active registrations |
||||
fields | optional |
Default value: id|description|message|type|status|is_linkage_required|www_instance Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of registration 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 required oauth_token for Token authorization. | ||||||
Returned value: List of registration objects, as defined in registration method. |
services/registrations/user_token_registrations ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/registrations/user_token_registrations | ||||||
Get all token registrations related to user
| ||||||
active_only | optional |
Default value: true Only active registrations |
||||
fields | optional |
Default value: id|description|message|status|is_linkage_required Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of token_registration 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 required oauth_token for Token authorization. | ||||||
Returned value: List of registration objects, as defined in token_registration method. |