Registrations
:: services/registrations module

Retrieve registrations information

Methods

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

Consumer: required Token: optional Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.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

Consumer: required Token: optional Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.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:

  • links - list of programmes and stages to which the course was linked to.

    Each list element is a dictionary of following structure:

    • programme - programme (as in services/progs/programme);
    • stage - stage or null if the course was not pinned to specific stage, may contain following fields:
      • id - ID of stage;
      • name - LangDict, name of stage.
  • course - course related to cart entry.

    This field references objects returned by services/courses/course method. See its returns section for possible subfields (only primary are allowed).

  • term - term of the entry.

    This field references objects returned by services/terms/term method. See its returns section for possible subfields.

  • user_registration_status - Registration status.

    Possible values:

    • accepted - user's application was accepted

    • ask - user has applied for the course

    • refused_permanently - user's application was refused permanently

    • refused - user's application was refused

    • not_concerning - user is registered

    • cancelled - user is signed out from the course (has withdrawn an accepted application)

    • cancelled_ask - user has withdrawn an application

  • is_registration_valid - boolean, is registration valid or null if the course is not in any registration.

    In some rare cases, the course can be available in active round of two different registrations at once.

    This is an error state and we block registrations for those courses. If registration is not valid, some fields may be returned as if there was no registration to the course.

  • choice_number - user choice number if priorities are required, null else;

  • limits - integer, registration limits or null if the course is not in any registration;

  • is_linkage_required - boolean, is linkage required or null if the course is not in any registration;

  • registrations_count - number of currently registered users or null if the course is not in any registration;

  • registration_status - Status of current registration.

    Possible values:

    • register_and_unregister - user can register to and unregister from course

    • unregister_only - user can only unregister from course

    • closed - the registration is closed

    • register_only - user can only register to course

    • null - the course is not in any registration

  • active_registration_round_id - ID of active registration round or null if the course is not in any registrations or no round is active.

services/registrations/faculty_registrations

Consumer: required Token: optional Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.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

Consumer: required Token: optional Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.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

Consumer: required Token: optional Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.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:

  • code - Code;

  • name - LangDict, ranking name;

  • description - LangDict, description;

  • is_summary - is summary;

  • course_group_flag - Course group flag;

  • ranking_code - Ranking code;

  • faculty - An associated faculty.

    This field references objects returned by services/fac/faculty method. See its returns section for possible subfields.

  • precision - Precision.

services/registrations/register

Consumer: required Token: optional Scopes: studies SSL: required
https://usosapps.demo.usos.edu.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

Consumer: required Token: optional Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.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:

  • Primary:

    • id - Registration id;

    • description - LangDict;

    • message - LangDict;

    • type - A string;

    • status - A string;

    • faculty - An associated faculty.

      This field references objects returned by services/fac/faculty method. See its returns section for possible subfields.

    • is_linkage_required - true if linkage is required;

    • www_instance - WWW instance code this registration belongs to.

  • Secondary:

    • rounds - Associated registration rounds.

      This field references objects returned by registration_round method. See its returns section for possible subfields (only primary are allowed).

    • related_courses - Related course editions.

      This field references objects returned by registration_course method. See its returns section for possible subfields.

services/registrations/registration_course

Consumer: required Token: optional Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.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:

  • registration_id - Registration id;

  • course_id - Course id;

  • term_id - Term id;

  • status - A string;

  • limits - Registration limits;

  • www_instance - WWW instance code this registration belongs to.

services/registrations/registration_round

Consumer: required Token: optional Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.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:

  • Primary:

    • id - Registration round ID;

    • name - LangDict, registration name;

    • status - Status of the round.

      Possible values:

      • active

      • preparing

      • closed

    • registration_mode - Registration mode.

      Possible values:

      • double_for_courses - two-step for courses

      • double_for_group_with_ask - two-step for groups by asking

      • double_group_manual - two-step for groups without approval

      • direct_for__courses_and_groups - direct for courses and groups

    • start_date - datetime, round start;

    • end_date - datetime, round end;

    • selection_limit - integer, number of choices in this round;

    • is_dedicated - boolean, is round dedicated;

    • is_overflow_allowed - boolean, is overflow allowed;

    • is_exchange - boolean, is this round a group exchange one;

    • is_only_entitled - boolean, is round only for students with permissions;

    • rank_code - Code of rank used in this round;

    • ranking - ranking.

      This field references objects returned by ranking method. See its returns section for possible subfields.

    • is_processed - boolean, is round processed.

  • Secondary:

    • registration - Related registration.

      This field references objects returned by registration method. See its returns section for possible subfields (only primary are allowed).

services/registrations/registration_round_courses

Consumer: required Token: optional Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.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:

  • course - Course object.

    This field references objects returned by services/courses/course method. See its returns section for possible subfields (only primary are allowed).

  • term_id - ID of term;

  • status - status of course registration.

    Possible values:

    • register_and_unregister - user can register to and unregister from course

    • unregister_only - user can only unregister from course

    • closed - the registration is closed

    • register_only - user can only register to course

  • limits - integer, registration limits;

  • is_linkage_required - boolean, is linkage required;

  • registrations_count - number of currently registered users;

  • user_registration_status - status of user registration.

    Possible values:

    • accepted - user's application was accepted

    • ask - user has applied for the course

    • refused_permanently - user's application was refused permanently

    • refused - user's application was refused

    • not_concerning - user is registered

    • cancelled - user is signed out from the course (has withdrawn an accepted application)

    • cancelled_ask - user has withdrawn an application

    • null - user did not try to register to the course

  • user_choice_number - number of choice if registration requires priorities and user has registered to the course or else null;

  • is_registration_valid - boolean, is registration correctly defined.

    Registration will fail if trying registration is not defined correctly.

services/registrations/search_rounds

Consumer: required Token: optional Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.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:

  • object_not_found - some of the referenced objects do not exist;

  • params_invalid - parameters start_date and end_date have invalid values.

    Possible reasons:

    • session_not_found - end_date must follow start_date;

    • too_long_date_range - date range must be not longer than one month.

services/registrations/search_token_rounds

Consumer: required Token: optional Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.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:

  • object_not_found - some of the referenced objects do not exist;

  • params_invalid - parameters start_date and end_date have invalid values.

    Possible reasons:

    • session_not_found - end_date must follow start_date;

    • too_long_date_range - date range must be not longer than one month.

services/registrations/token_registration

Consumer: required Token: optional Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.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:

  • Primary:

    • id - Token registration id;

    • description - LangDict;

    • message - LangDict;

    • status - A string;

    • faculty - An associated faculty.

      This field references objects returned by services/fac/faculty method. See its returns section for possible subfields.

    • is_linkage_required - true if linkage is required;

    • short_description - A string with short description of registration.

  • Secondary:

    • rounds - Associated registration rounds.

      This field references objects returned by token_registration_round method. See its returns section for possible subfields (only primary are allowed).

    • related_courses - Related course editions.

      This field references objects returned by token_registration_course method. See its returns section for possible subfields.

services/registrations/token_registration_course

Consumer: required Token: optional Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.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:

  • registration_id - Token registration id;

  • course_id - Course id;

  • term_id - Term id;

  • status - A string;

  • limits - Registration limits;

  • tst_code - A string;

  • lower_limit - A string;

  • start_date - A string.

services/registrations/token_registration_round

Consumer: required Token: optional Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.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:

  • Primary:

    • id - Registration round id;

    • name - LangDict;

    • start_date - A datetime string;

    • end_date - A datetime string;

    • selection_limit - Number of choices in this round;

    • is_dedicated - Is dedicated round;

    • is_exchange - Is exchange;

    • is_only_entitled - Is only for students with permissions;

    • micro_round_length - Length of one micro round;

    • micro_break_length - Break between micro rounds;

    • is_prioritized - Is prioritized;

    • first_round_scale - Scale of first round.

  • Secondary:

    • registration - Related registration.

      This field references objects returned by token_registration method. See its returns section for possible subfields (only primary are allowed).

services/registrations/unregister

Consumer: required Token: optional Scopes: studies SSL: required
https://usosapps.demo.usos.edu.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

Consumer: required Token: required Scopes: studies SSL: required
https://usosapps.demo.usos.edu.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

Consumer: required Token: required Scopes: studies SSL: required
https://usosapps.demo.usos.edu.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.
USOS API ver. 6.7.0.2-4, aedaa64b (2021-09-16)