Mobility
:: services/mobility module

This module provides access to data related to mobilities

Methods

approval Approval for LA version
approve Update component of LA
cancel_approvals Update component of LA
cancel_version Cancel empty version of LA
change_reason Reason of a change of component
change_reasons Reasons of changes of selected type
component Return specified component data
coordinator Mobilities that access token issuer may access as coordinator
create_cnr Send CNR again
create_component Create new new component for given version of LA
create_draft Create new version of LA
create_external_user Create external user
create_la Create LA for mobility
decision Ged decision
decision_points Decision points
decisions_course Decision course
delete_component Delete component of LA
delete_decisions_course Delete decisions course
delete_decisions_points Delete decisions points
delete_external_course Delete external course
delete_la Update LA
delete_version Delete empty version of LA
external_course External course
external_user External user description
institution Details of a institution
la Learning agreement
la_to_decision Ged decision
la_version Version of LA
mobility Object describing student's mobility
points_type Type of points description
points_type_index Index of points types
student Mobilities of access token issuer
update_component Update component of LA
update_decision Ged decision
update_decision_course External course
update_decision_points Update decisions points
update_external_course External course
update_external_user Create external user
update_la Update LA
update_la_status Update LA status
update_mobility Update mobility
update_status Update status (administrative)

services/mobility/approval

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/approval

Approval for LA version
id required ID of an approval
fields optional

Default value: id|la_version_id|side|full_name|position|email|timestamp

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 required oauth_token for Token authorization.

Returned value:

A dictionary of selected fields and their values.

Available fields:

  • id - ID of approval;

  • la_version_id - ID of a version where component was provided;

  • side - One of following values: sending, receiving;

  • full_name - Full name of approving person;

  • position - position of approving person;

  • email - email address of approving person;

  • timestamp - Datetime string.

services/mobility/approve

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/approve
Mark selected LA version as approved.
version_id required ID of a LA version
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:

Empty dict on success

Thrown errors:

  • object_invalid - object is in invalid state.

    Possible reasons:

    • already_approved - This LA version is already approved;

    • wrong_status - Version status permits actions.

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

    Possible reasons:

    • la_not_found - referenced learning agreement not found or access is forbidden.

services/mobility/cancel_approvals

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/cancel_approvals
Cancel all local approvals and changes status of a version from LearningAgreementVersionStatus.APPROVED_LOCALLY to LearningAgreementVersionStatus.NEW
version_id required ID of a LA version
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:

Empty dict on success

Thrown errors:

  • object_invalid - object is in invalid state.

    Possible reasons:

    • already_approved - This LA version is already approved;

    • wrong_status - Version status permits actions.

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

    Possible reasons:

    • la_not_found - referenced learning agreement not found or access is forbidden.

services/mobility/cancel_version

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/cancel_version

Cancel empty version of LA
version_id required ID of a LA
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:

ID of LA

Thrown errors:

  • object_invalid - object is in invalid state.

    Possible reasons:

    • version_not_empty - Version is not empty.

services/mobility/change_reason

Consumer: ignored Token: ignored Scopes: n/a SSL: required
https://usosapps.uni.opole.pl/services/mobility/change_reason

Reason of a change of component
id required ID of a change reason
fields optional

Default value: id|type|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.
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:

  • id - ID of a change reason;

  • type - type of a change.

    Possible values:

    • updated

    • deleted

  • description - description of a change.

services/mobility/change_reasons

Consumer: ignored Token: ignored Scopes: n/a SSL: required
https://usosapps.uni.opole.pl/services/mobility/change_reasons

Reasons of changes of selected type
type required Type of changes

Possible values: updated, deleted.
fields optional

Default value: id|type|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 change_reason 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:

List of change reason objects

services/mobility/component

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/component

Return specified component data
id required ID of a component
fields optional

Default value: id|la_version_id|number|type|course|points_count|points_type|la_table|los_id|los_code|course_name|loi_id|courses_time|ects_credits|recognition_conditions|short_description|added_reason|removed_reason|changes_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 required oauth_token for Token authorization.

Returned value:

A dictionary of selected fields and their values.

Available fields:

  • id - ID of a component;

  • la_version_id - ID of a version where component was provided;

  • number - Number of a component. Note that next version of same component keeps its number;

  • type - Type of component.

    Possible values:

    • points

    • internal_course

    • external_course

  • course - Course selected..

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

  • points_count - Points of component;

  • points_type - Points type of component.

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

  • la_table - LA table type.

    Possible values:

    • A

    • B

    • C

  • los_id - Learning opportunity specification ID;

  • los_code - Learning opportunity specification code (component's code);

  • course_name - Name of course from receiving faculty;

  • loi_id - Id of learning opportunity instance;

  • courses_time - String describing period of course e.g. 1/2;

  • ects_credits - Number of ECTS credits for a course;

  • recognition_conditions - String with description of recognition conditions;

  • short_description - String with short description of component;

  • added_reason - reason object or null.

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

  • removed_reason - reason object or null.

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

  • changes_description - short description of changes.

services/mobility/coordinator

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/coordinator

Mobilities that access token issuer may access as coordinator
fields optional

Default value: id|user|faculty|term|state|role|receiving_institution|why_cannot_create_la|esi|start_date|end_date|isced_code|contact_person

Selector of result fields you are interested in. The selector must contain subset of primary fields, which are described in the returns section of mobility method.

la_status optional

Default value: (empty string)

One of following values ...
latest_version_status optional

Default value: (empty string)

One of following values ...
faculty_id optional

Default value: (empty string)

ID of a faculty
country_name optional

Default value: (empty string)

Country of mobility
receiving_institution_name optional

Default value: (empty string)

Name of receiving institution
term_id optional

Default value: (empty string)

Term of mobility
isced optional

Default value: (empty string)

Erasmus code
user_id optional

Default value: (empty string)

User ID of a student
supervisor_id optional

Default value: (empty string)

User ID of supervisor
organizational_supervisor_id optional

Default value: (empty string)

One of following values
order_by optional

Default value: id

One of following values
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.
page optional

Default value: (empty string)

page number - use only together with per_page parameter.
per_page optional

Default value: (empty string)

If this parameted is used. Instead of usual result,paged version will be returned. Result will be dictionary of following fields:count - number of elemensts in regular result, num_pages - number of pages, object_list - list of items from original result from selected page
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 mobilities

services/mobility/create_cnr

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/create_cnr

Send CNR again
la_id required ID of a LA
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:

Empty dict on success

services/mobility/create_component

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/create_component

Create new new component for given version of LA
version_id required ID of a LA version
copy_from optional

Default value: (empty string)

create component using existing one
type optional

Default value: (Parameter is used only if copy_from is not used)

Type of component

Possible values: points, internal_course, external_course.
la_table optional

Default value: (Required for "Semester" LA type)

LA table type

Possible values: A, B, C.
course_id optional

Default value: (empty string)

ID of a course
points_type_id optional

Default value: (empty string)

Type of points of component
points_count optional

Default value: (empty string)

count of points of component
los_id optional

Default value: (empty string)

Learning opportunity specification id
los_code optional

Default value: (empty string)

Learning opportunity specification code.
course_name optional

Default value: (empty string)

Learning opportunity specification name.
loi_id optional

Default value: (empty string)

Id of learning opportunity instance
courses_time optional

Default value: (empty string)

String describing period of course e.g. 1/2
ects_credits optional

Default value: (empty string)

Number of ECTS credits for a course
recognition_conditions optional

Default value: (empty string)

String with description of recognition conditions
short_description optional

Default value: (empty string)

String with short description of component
changes_description optional

Default value: (empty string)

short description of changes
added_reason_id optional

Default value: (empty string)

id of a reason object
fields optional

Default value: id|la_version_id|number|type|course|points_count|points_type|la_table|los_id|los_code|course_name|loi_id|courses_time|ects_credits|recognition_conditions|short_description|added_reason|removed_reason|changes_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 component 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:

Created component

services/mobility/create_draft

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/create_draft

Create new version of LA
la_id required ID of a LA
copy_from_final_version optional

Default value: false

set to true if components for new version should be copied from final one
copy_from optional

Default value: (empty string)

Version that components will be copied from
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:

ID of created version of LA

services/mobility/create_external_user

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/create_external_user

Create external user
first_name required First name of a user
last_name required Last name of a user
email required email address
mobility_id required ID of a mobility that user will be assigned as contact person
fields optional

Default value: id|first_name|last_name|email

Selector of result fields you are interested in. The selector must contain subset of primary fields, which are described in the returns section of external_user 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:

Created object on success

services/mobility/create_la

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/create_la
Create new LA for mobility. Note that only coordinator of mobilities may execute this method
mobility_id required ID of a mobility
mobility_type required mobility type for LA

Possible values: semester, blended, doctoral.
eqf_level required Level of studies of mobility
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:

ID of created LA

Thrown errors:

  • object_invalid - object is in invalid state.

    Possible reasons:

    • la_already_exists - Learning agreement already exists.

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

    Possible reasons:

    • mobility_not_found - Referenced mobility does not exist or access is forbidden.

services/mobility/decision

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/decision

Ged decision
id required ID of a decision
fields optional

Default value: id|students_programme|stage|term|state|decision_type|decision_date|deadline_date|substate|why_cannot_import|comment|is_empty|external_courses|decision_points|decisions_courses

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 required oauth_token for Token authorization.

Returned value:

A dictionary of selected fields and their values.

Available fields:

  • Primary:

    • id - ID of a decision;

    • students_programme - Students programme.

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

    • stage - Stage.

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

    • term - Term.

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

    • state - State of decision;

    • decision_type - Kind;

    • decision_date - Date of decision;

    • deadline_date - Date of decision;

    • substate - sub state;

    • mobility - mobility.

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

    • why_cannot_import - null if can import, langdict with reason otherwise;

    • comment - Comment of decision;

    • is_empty - true if decision is empty.

  • Secondary:

    • external_courses - External courses of decision.

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

    • decision_points - Points of decision.

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

    • decisions_courses - Courses of decision.

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

services/mobility/decision_points

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/decision_points

Decision points
id required ID of points
decision_id required ID of a decision
fields optional

Default value: id|points_type_id|count|decision_type|comment

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 required oauth_token for Token authorization.

Returned value:

A dictionary of selected fields and their values.

Available fields:

  • id - ID of points;

  • points_type_id - Points type id;

  • count - count of the points;

  • decision_type - decisions type;

  • comment - comment.

services/mobility/decisions_course

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/decisions_course

Decision course
id required Decisions course
decision_id required ID of a decision
fields optional

Default value: id|course|decision_type|credits|achievements|comment

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 required oauth_token for Token authorization.

Returned value:

A dictionary of selected fields and their values.

Available fields:

  • id - ID of a course;

  • course - course.

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

  • decision_type - course type;

  • credits - number of ECTS credits;

  • achievements - achievements;

  • comment - comment.

services/mobility/delete_component

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/delete_component
Update existing component of LA.
component_id required ID of a LA
removed_reason_id optional

Default value: (empty string)

ID of a reason
changes_description optional

Default value: (empty string)

short description of changes
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:

Empty dict on success

services/mobility/delete_decisions_course

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/delete_decisions_course

Delete decisions course
id required ID of a course
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:

Empty dict on success

services/mobility/delete_decisions_points

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/delete_decisions_points

Delete decisions points
id required ID of a course
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:

Empty dict on success

services/mobility/delete_external_course

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/delete_external_course

Delete external course
id required ID of a course
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:

Empty dict on success

services/mobility/delete_la

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/delete_la
Update existing LA. Note that only coordinator of mobilities may execute this method.
la_id required ID of a LA
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:

Empty dict on success

Thrown errors:

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

    Possible reasons:

    • la_not_found - referenced learning agreement not found or access is forbidden.

services/mobility/delete_version

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/delete_version

Delete empty version of LA
version_id required ID of a LA
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:

ID of LA

Thrown errors:

  • object_invalid - object is in invalid state.

    Possible reasons:

    • version_not_empty - Version is not empty.

services/mobility/external_course

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/external_course

External course
id required ID of a course
decision_id required ID of a decision
fields optional

Default value: id|name|term|is_passed|code|ects_credits|status|grade|grades_count|grades_sum

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 required oauth_token for Token authorization.

Returned value:

A dictionary of selected fields and their values.

Available fields:

  • id - ID of a course;

  • name - name of a course;

  • term - term of a course.

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

  • is_passed - True if course is passed;

  • code - Code of the course;

  • ects_credits - Number of ects credits;

  • status - Status of a course;

  • grade - Grade;

  • grades_count - Grades count;

  • grades_sum - Grades sum.

services/mobility/external_user

Consumer: required Token: ignored Scopes: n/a SSL: required
https://usosapps.uni.opole.pl/services/mobility/external_user

External user description
id required ID of a user
fields optional

Default value: id|first_name|last_name|email|institution

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. Token is not required.

Returned value:

A dictionary of selected fields and their values.

Available fields:

  • Primary:

    • id - ID of a user;

    • first_name - First name;

    • last_name - Last name;

    • email - email of a user.

  • Secondary:

    • institution - Institution that user is assigned to.

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

services/mobility/institution

Consumer: optional Token: optional Scopes: n/a SSL: not required
https://usosapps.uni.opole.pl/services/mobility/institution

Details of a institution
id required ID of a institution
fields optional

Default value: id|name|type|erasmus_code|country_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.
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:

  • Primary:

    • id - ID of a institution;

    • name - a langdict object;

    • type - Type of a institution.

      Possible values:

      • state_institution

      • private_institution

      • high_school

      • foreign_institution

      • external_institution

      • examination_board

    • erasmus_code - Erasums code of a institution;

    • country_name - Name of insitution's country.

  • Secondary:

    • assigned_users - List of assigned users.

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

services/mobility/la

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/la

Learning agreement
id required ID of a Learning Agreement
fields optional

Default value: id|mobility_id|mobility_type|academic_year|eqf_level|learning_outcomes_url|provisions_url|versions|final_version|allowed_actions|latest_significant_version_id|date_created|technical_info|status|decision|decision_to_link

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 required oauth_token for Token authorization.

Returned value:

A dictionary of selected fields and their values.

Available fields:

  • Primary:

    • id - ID of a LA;

    • mobility_id - ID of a mobility;

    • mobility_type - Type of a mobility that LA is created for.

      Possible values:

      • semester

      • blended

      • doctoral

    • academic_year - Academic year of a mobility;

    • eqf_level - level of studies;

    • learning_outcomes_url - URL providing learning outcomes;

    • provisions_url - URL providing regulations according to not passed courses;

    • versions - List of versions.

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

    • final_version - Visualisation of a final version.

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

    • allowed_actions - List of allowed actions - one of following values: create_draft, delete_draft.

      Possible values:

      • create_draft

      • copy_draft

      • delete_la

      • create_cnr

      • create_decision

    • latest_significant_version_id - ID o latest significant version;

    • date_created - Datetime string with creation time;

    • technical_info - Technical informations about Learning Agreement, usefull in contact with helpdesks;

    • status - statis of LA.

  • Secondary:

    • decision - Decision related to LA.

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

    • decision_to_link - Decision that can be linked with LA instead of creating new one.

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

services/mobility/la_to_decision

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/la_to_decision

Ged decision
la_id required ID of a LearningAgreement
decision_id required ID of a Decision
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:

empty dict on success

services/mobility/la_version

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/la_version

Version of LA
id required ID of a version
fields optional

Default value: id|la_id|date_created|status|status_description|approvals|components|comment|allowed_actions|diff_from|is_significant

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 required oauth_token for Token authorization.

Returned value:

A dictionary of selected fields and their values.

Available fields:

  • id - ID of a version;

  • la_id - ID of Learning Agreement;

  • date_created - Datetime string;

  • status - TODO!!!.

    Possible values:

    • new

    • coordinator_edits

    • student_approved

    • coordinator_approved

    • approved_locally

    • approved

    • cancelled

    • rejected

    • virtual

  • status_description - Description of current status;

  • approvals - list of approvals for this version.

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

  • components - list of components for this version.

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

  • comment - Comment for version;

  • allowed_actions - List of actions that access token issuer can perform.

    Possible values:

    • edit

    • approve

    • cancel_approvals

    • cancel

    • delete

    • edit_with_reason

  • diff_from - If version is treated as diff from first approved version, then id of that version is returned, null otherwise;

  • is_significant - True if version should be displayed to user as significant.

services/mobility/mobility

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/mobility

Object describing student's mobility
id required ID of a mobility
fields optional

Default value: id|user|faculty|term|state|role|receiving_institution|why_cannot_create_la|esi|start_date|end_date|isced_code|contact_person|learning_agreements|application_programme|application_year_of_study|student_programme|year_of_study|supervisor|organizational_supervisor

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 required oauth_token for Token authorization.

Returned value:

A dictionary of selected fields and their values.

Available fields:

  • Primary:

    • id - ID of a mobility;

    • user - Student whose that mobility is.

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

    • faculty - Sending faculty related to mobility.

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

    • term - Academic term of mobility.

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

    • state - Current state of a mobility.

      Possible values:

      • in_preparation

      • active

      • reserve

      • resignation

    • role - one of following values: student, coordinator;

    • receiving_institution - Details of receiving institution.

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

    • why_cannot_create_la - langidct with information of user;

    • esi - European Student Identifier of a student;

    • start_date - Mobility start date;

    • end_date - Mobility end date;

    • isced_code - ISCED code;

    • contact_person - Contact person.

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

  • Secondary:

    • learning_agreements - list of LA object related to mobility.

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

    • application_programme - Student's programme declared at application stage.

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

    • application_year_of_study - Year of study declared at application stage;

    • student_programme - Student's programme related to mobility.

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

    • year_of_study - Year of study on mobility;

    • supervisor - Supervisor of a mobility.

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

    • organizational_supervisor - Supervisor of a mobility.

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

services/mobility/points_type

Consumer: ignored Token: ignored Scopes: n/a SSL: required
https://usosapps.uni.opole.pl/services/mobility/points_type

Type of points description
id required ID of a points type
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.
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:

  • id - ID of a points type;

  • description - langdict object.

services/mobility/points_type_index

Consumer: ignored Token: ignored Scopes: n/a SSL: required
https://usosapps.uni.opole.pl/services/mobility/points_type_index

Index of points types
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 points_type 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:

List of points type objects

services/mobility/student

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/student

Mobilities of access token issuer
fields optional

Default value: id|user|faculty|term|state|role|receiving_institution|why_cannot_create_la|esi|start_date|end_date|isced_code|contact_person

Selector of result fields you are interested in. The selector must contain subset of primary fields, which are described in the returns section of mobility 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 mobilities related to access token issuer

services/mobility/update_component

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/update_component
Update existing component of LA.
component_id required ID of a LA
course_id optional

Default value: (empty string)

ID of a course
points_type_id optional

Default value: (empty string)

Type of points of component
points_count optional

Default value: (empty string)

count of points of component
los_id optional

Default value: (empty string)

Learning opportunity specification id
los_code optional

Default value: (empty string)

Learning opportunity specification code.
course_name optional

Default value: (empty string)

Learning opportunity specification name.
loi_id optional

Default value: (empty string)

Id of learning opportunity instance
courses_time optional

Default value: (empty string)

String describing period of course e.g. 1/2
ects_credits optional

Default value: (empty string)

Number of ECTS credits for a course
recognition_conditions optional

Default value: (empty string)

String with description of recognition conditions
short_description optional

Default value: (empty string)

String with short description of component
changes_description optional

Default value: (empty string)

short description of changes
added_reason_id optional

Default value: (empty string)

id of a reason object
fields optional

Default value: id|la_version_id|number|type|course|points_count|points_type|la_table|los_id|los_code|course_name|loi_id|courses_time|ects_credits|recognition_conditions|short_description|added_reason|removed_reason|changes_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 component 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:

Created component

services/mobility/update_decision

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/update_decision

Ged decision
id required ID of a decision
term_id required ID of academic term
la_id required ID of learningAgreement that has to be related with decision
decision_type required Kind of decision

Possible values: substitution, modification.
decision_date required Date of decision
deadline_date required Deadline of modification in USOSweb
stage_id optional

Default value: (empty string)

Stage id related to decision
comment optional

Default value: (empty string)

Comment of a decision
fields optional

Default value: id|students_programme|stage|term|state|decision_type|decision_date|deadline_date|substate|why_cannot_import|comment|is_empty

Selector of result fields you are interested in. The selector must contain subset of primary fields, which are described in the returns section of decision 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:

Updated decision object

services/mobility/update_decision_course

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/update_decision_course

External course
id required ID of a course
decision_id required ID of a decision
decision_type required Course type
comment required comment
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:

Empty dict on success

services/mobility/update_decision_points

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/update_decision_points

Update decisions points
id required ID of a points
decision_id required ID of a decision
decision_type required Course type
comment required comment
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:

Empty dict on success

services/mobility/update_external_course

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/update_external_course

External course
id required ID of a course
decision_id required ID of a decision
grade required Grade
ects_credits required ECTS credits
grades_count required Number of grades
grades_sum required Sum of grades
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:

Empty dict on success

services/mobility/update_external_user

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/update_external_user

Create external user
id required ID of external user
first_name required First name of a user
last_name required Last name of a user
email required email address
fields optional

Default value: id|first_name|last_name|email

Selector of result fields you are interested in. The selector must contain subset of primary fields, which are described in the returns section of external_user 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:

Created object on success

services/mobility/update_la

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/update_la
Update existing LA. Note that only coordinator of mobilities may execute this method.
la_id required ID of a LA
eqf_level optional

Default value: (empty string)

level of studies
learning_outcomes_url optional

Default value: (empty string)

URL providing learning outcomes
provisions_url optional

Default value: (empty string)

URL providing regulations according to not passed 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:

Empty dict on success

Thrown errors:

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

    Possible reasons:

    • la_not_found - referenced learning agreement not found or access is forbidden.

services/mobility/update_la_status

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/update_la_status

Update LA status
la_id required ID of a LearningAgreement
status required status of a LA

Possible values: editable, decision_editable, coordinator_approved, approved.
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:

empty dict on success

services/mobility/update_mobility

Consumer: required Token: required Scopes: none SSL: required
https://usosapps.uni.opole.pl/services/mobility/update_mobility

Update mobility
id required ID of a mobility
start_date optional

Default value: (empty string)

Mobility start date
end_date optional

Default value: (empty string)

Mobility end date
contact_person_id optional

Default value: (empty string)

Contact person id
fields optional

Default value: id|user|faculty|term|state|role|receiving_institution|why_cannot_create_la|esi|start_date|end_date|isced_code|contact_person|learning_agreements|application_programme|application_year_of_study|student_programme|year_of_study|supervisor|organizational_supervisor

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of mobility 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:

Updated mobility on success

services/mobility/update_status

Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.

Consumer: required (administrative) Token: ignored Scopes: n/a SSL: required
https://usosapps.uni.opole.pl/services/mobility/update_status

Update status
version_id required ID of a LA version
status required status that should be set

Possible values: new, coordinator_edits, student_approved, coordinator_approved, approved_locally, approved, cancelled, rejected, virtual.
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. Token is not required.

Returned value:

null
USOS API ver. 7.1.0.0-4, 0e1fe7fc, dirty (2024-08-27)