Registrations
:: services/registrations module

Retrieve registrations information

Methods

faculty_registrations Get faculty registrations
faculty_token_registrations Get faculty token registrations
registration Get registration details
registration_course Get details of course related to registrations
registration_round Get registration round details
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
user_registrations Get user registrations
user_token_registrations Get user token registrations

services/registrations/faculty_registrations

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

services/registrations/faculty_token_registrations

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

services/registrations/registration

Consumer: required Token: optional Scopes: n/a SSL: required
https://usosapps.umk.pl/services/registrations/registration

Get registration details
id required Registration id
fields optional

Default value: id|description|message|type|status|is_pin_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_pin_required - true if pin 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.umk.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.umk.pl/services/registrations/registration_round

Get registration round details
id required Registration round id
fields optional

Default value: id|name|start_date|end_date|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 round id;

    • name - LangDict;

    • registration_mode - A string;

    • start_date - A datetime string;

    • end_date - A datetime string;

    • selection_limit - Number of choices in this round;

    • is_dedicated - Is dedicated round;

    • is_overflow_allowed - Is overflow allowed;

    • is_stock_active - Is stock active;

    • is_only_for_allowed - Is only for students with permissions;

    • rank_code - Code of rank used in this round;

    • is_processed - Is round processed;

    • www_instance - WWW instance code this round belongs to.

  • 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/search_rounds

Consumer: required Token: optional Scopes: n/a SSL: required
https://usosapps.umk.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|start_date|end_date|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_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.umk.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

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.umk.pl/services/registrations/token_registration

Get token registration details
id required Token registration id
fields optional

Default value: id|description|message|status|is_pin_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_pin_required - true if pin 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.umk.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.umk.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_stock_active - Is stock active;

    • is_only_for_allowed - 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/user_registrations

Consumer: required Token: required Scopes: studies SSL: required
https://usosapps.umk.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_pin_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

services/registrations/user_token_registrations

Consumer: required Token: required Scopes: studies SSL: required
https://usosapps.umk.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_pin_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
USOS API ver. 6.6.0.0-14, cdb6615, dirty (2020-12-22)