|
Mobility
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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_external_unit | Delete external course unit |
| delete_la | Update LA |
| delete_version | Delete empty version of LA |
| external_course | External course |
| external_course_unit | External course unit |
| external_user | External user description |
| fetch_pdf | Download EWP LA report |
| institution | Details of a institution |
| la | Learning agreement |
| la_to_decision | Ged decision |
| la_version | Version of LA |
| language | Language |
| languages_index | Languages index |
| mobility | Object describing student's mobility |
| points_type | Type of points description |
| points_type_index | Index of points types |
| search_course | Search for internal course |
| 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_unit | External course unit |
| 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 ¶
|
||||||
| https://usos-api.wab.edu.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:
| ||||||
services/mobility/approve ¶
|
||||||
| https://usos-api.wab.edu.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:
| ||||||
services/mobility/cancel_approvals ¶
|
||||||
| https://usos-api.wab.edu.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:
| ||||||
services/mobility/cancel_version ¶
|
||||||
| https://usos-api.wab.edu.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:
| ||||||
services/mobility/change_reason ¶
|
||||||
| https://usos-api.wab.edu.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:
| ||||||
services/mobility/change_reasons ¶
|
||||||
| https://usos-api.wab.edu.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 ¶
|
||||||
| https://usos-api.wab.edu.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:
| ||||||
services/mobility/coordinator ¶
|
||||||
| https://usos-api.wab.edu.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|extended_date|isced_code|declared_language|declared_language_level|contact_person|mobility_window 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 ¶
|
||||||
| https://usos-api.wab.edu.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 ¶
|
||||||
| https://usos-api.wab.edu.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 componentPossible values: points, internal_course, external_course, mobility_window. |
||||
| la_table | optional |
Default value: (Required for "Semester" LA type) LA table typePossible 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: (unchanged) short description of changes |
||||
| added_reason_id | optional |
Default value: (unchanged) 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 ¶
|
||||||
| https://usos-api.wab.edu.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 ¶
|
||||||
| https://usos-api.wab.edu.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 | ||||
| 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 ¶
|
||||||
| https://usos-api.wab.edu.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:
| ||||||
services/mobility/decision ¶
|
||||||
| https://usos-api.wab.edu.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:
| ||||||
services/mobility/decision_points ¶
|
||||||
| https://usos-api.wab.edu.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:
| ||||||
services/mobility/decisions_course ¶
|
||||||
| https://usos-api.wab.edu.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:
| ||||||
services/mobility/delete_component ¶
|
||||||
| https://usos-api.wab.edu.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 ¶
|
||||||
| https://usos-api.wab.edu.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 ¶
|
||||||
| https://usos-api.wab.edu.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 ¶
|
||||||
| https://usos-api.wab.edu.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_external_unit ¶
|
||||||
| https://usos-api.wab.edu.pl/services/mobility/delete_external_unit | ||||||
|
Delete external course unit | ||||||
| external_course_id | required | ID of a external_course | ||||
| decision_id | required | ID of a decision | ||||
| classtype_id | required | ID of a class type | ||||
| 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 ¶
|
||||||
| https://usos-api.wab.edu.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:
| ||||||
services/mobility/delete_version ¶
|
||||||
| https://usos-api.wab.edu.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:
| ||||||
services/mobility/external_course ¶
|
||||||
| https://usos-api.wab.edu.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|name_en|language|comment|term|is_passed|code|ects_credits|status|grade|grades_count|grades_sum|units 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:
| ||||||
services/mobility/external_course_unit ¶
|
||||||
| https://usos-api.wab.edu.pl/services/mobility/external_course_unit | ||||||
|
External course unit | ||||||
| external_course_id | required | ID of a external_course | ||||
| decision_id | required | ID of a decision | ||||
| classtype_id | required | ID of a class type | ||||
| fields | optional |
Default value: grade|hours_count|classtype 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:
| ||||||
services/mobility/external_user ¶
|
||||||
| https://usos-api.wab.edu.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:
| ||||||
services/mobility/fetch_pdf ¶
|
||||||
| https://usos-api.wab.edu.pl/services/mobility/fetch_pdf | ||||||
|
This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can. Download EWP LA report | ||||||
| mobility_id | required | Mobility ID | ||||
| 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: File in PDF format containing EWP LA report for selected mobility. | ||||||
|
Thrown errors:
| ||||||
services/mobility/institution ¶
|
||||||
| https://usos-api.wab.edu.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:
| ||||||
services/mobility/la ¶
|
||||||
| https://usos-api.wab.edu.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_to_link|decision 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:
| ||||||
services/mobility/la_to_decision ¶
|
||||||
| https://usos-api.wab.edu.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 ¶
|
||||||
| https://usos-api.wab.edu.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:
| ||||||
services/mobility/language ¶
|
||||||
| https://usos-api.wab.edu.pl/services/mobility/language | ||||||
|
Language | ||||||
| id | required | ID of a language | ||||
| fields | optional |
Default value: id|name|iso_code Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
| format | optional |
Default value: json Format in which to return values. See supported output formats. |
||||
| callback | optional |
Required only if you've chosen jsonp as a return format. |
||||
| No additional OAuth arguments are required. If you provide any, they will be ignored. | ||||||
|
Returned value: A dictionary of selected fields and their values. Available fields:
| ||||||
services/mobility/languages_index ¶
|
||||||
| https://usos-api.wab.edu.pl/services/mobility/languages_index | ||||||
|
Languages index | ||||||
| fields | optional |
Default value: id|name|iso_code Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of language 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 language objects | ||||||
services/mobility/mobility ¶
|
||||||
| https://usos-api.wab.edu.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|extended_date|isced_code|declared_language|declared_language_level|contact_person|mobility_window|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:
| ||||||
services/mobility/points_type ¶
|
||||||
| https://usos-api.wab.edu.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:
| ||||||
services/mobility/points_type_index ¶
|
||||||
| https://usos-api.wab.edu.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/search_course ¶
|
||||||
| https://usos-api.wab.edu.pl/services/mobility/search_course | ||||||
|
Search for internal course | ||||||
| query | required | Query that course matching that will be returned | ||||
| lang | required | Language that name will be matched | ||||
| num | required | Number of items that will be returned | ||||
| mobility_id | required | Mobility for what ECTS will be calculated | ||||
| 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 the following structure:
| ||||||
services/mobility/student ¶
|
||||||
| https://usos-api.wab.edu.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|extended_date|isced_code|declared_language|declared_language_level|contact_person|mobility_window 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 ¶
|
||||||
| https://usos-api.wab.edu.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: (unchanged) short description of changes |
||||
| added_reason_id | optional |
Default value: (unchanged) 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 ¶
|
||||||
| https://usos-api.wab.edu.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 ¶
|
||||||
| https://usos-api.wab.edu.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 ¶
|
||||||
| https://usos-api.wab.edu.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 ¶
|
||||||
| https://usos-api.wab.edu.pl/services/mobility/update_external_course | ||||||
|
External course | ||||||
| id | required | ID of a course | ||||
| decision_id | required | ID of a decision | ||||
| grade | required | Grade | ||||
| name_en | required | English name | ||||
| language_id | required | ID of a language | ||||
| comment | required | Comment | ||||
| 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_unit ¶
|
||||||
| https://usos-api.wab.edu.pl/services/mobility/update_external_unit | ||||||
|
External course unit | ||||||
| external_course_id | required | ID of a external_course | ||||
| decision_id | required | ID of a decision | ||||
| classtype_id | required | ID of a class type | ||||
| grade | required | Grade | ||||
| hours_count | required | Hours count | ||||
| 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 ¶
|
||||||
| https://usos-api.wab.edu.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 | ||||
| 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 ¶
|
||||||
| https://usos-api.wab.edu.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:
| ||||||
services/mobility/update_la_status ¶
|
||||||
| https://usos-api.wab.edu.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 ¶
|
||||||
| https://usos-api.wab.edu.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|extended_date|isced_code|declared_language|declared_language_level|contact_person|mobility_window|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.
|
||||||
| https://usos-api.wab.edu.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 | ||||||