Access and accepting suplements
:: services/pw_suplements module

These API methods allow you to check and acceptd suplements.

Methods

can_edit_suplement Funkcja pomocnicza do weryfikacji czy użytkownik jest uprawniony do edycji suplementu związanego z certyfikatem. (administrative)
fetch_pdf Download suplement document in PDF format (administrative)
history Zwraca historię komentarzy studenta. (administrative)
orders Zwraca informację o zamówieniach liczby sztuk dyplomu, suplementów oraz odpisów. (administrative)
suplements Zwraca listę suplementów związanych z certyfikatami dyplomów do akceptacji i już zaakceptowane. (administrative)
update_order_comments Aktualizacja preferencji dotyczącej zamówienia liczby sztuk dyplomu, suplementów oraz odpisów. (administrative)
update_orders Aktualizacja preferencji dotyczącej zamówienia liczby sztuk dyplomu, suplementów oraz odpisów. (administrative)
update_personal_data_decision Aktualizacja preferencji wyboru akceptacji danych o suplemencie. (administrative)
waiting Zwraca liczbę suplementów oczekujących na akceptację. (administrative)

services/pw_suplements/can_edit_suplement

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

Consumer: required (administrative) Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_suplements/can_edit_suplement

Funkcja pomocnicza do weryfikacji czy użytkownik jest uprawniony do edycji suplementu związanego z certyfikatem.

user_id required ID of user
cert_person_id optional ID of person certificate
suplement_id optional ID the suplement
fields optional

Default value: result|message_pl|message_en

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization.

Returned value:

The value result holds True, when the answer is positive, when negative it is False with the reason in attribute message.

services/pw_suplements/fetch_pdf

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

Consumer: required (administrative) Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_suplements/fetch_pdf

Download suplement document in PDF format

suplement_id required Document's ID
Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization.

Returned value:

File in PDF format containing suplement document.

Thrown errors:

  • object_not_found - some of the referenced objects do not exist; param_name is equal to suplement_id.

services/pw_suplements/history

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

Consumer: required (administrative) Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_suplements/history

Zwraca historię komentarzy studenta.

user_id required ID of user
cert_person_id required ID of person certificate
fields optional

Default value: items

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization.

Returned value:

Object with items attribute with collection of history of student comments.

services/pw_suplements/orders

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

Consumer: required (administrative) Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_suplements/orders

Zwraca informację o zamówieniach liczby sztuk dyplomu, suplementów oraz odpisów.

user_id required ID of user
cert_person_id required ID of person certificate
fields optional

Default value: result|message_pl|message_en

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of update_personal_data_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 optional oauth_token for Token authorization.

Returned value:

The value result holds True, when the answer is positive, when negative it is False with the reason in attribute message_pl and message_en.

services/pw_suplements/suplements

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

Consumer: required (administrative) Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_suplements/suplements

Zwraca listę suplementów związanych z certyfikatami dyplomów do akceptacji i już zaakceptowane.

user_id required ID of user
cert_person_id optional ID of person certificate
suplement_id optional ID of the suplement document
fields optional

Default value: items|id_person|firstname|firstname2|lastname|birthdate|birth_city|version|prog_desc|prog_desc_en|prog_code|cert_person_id|dissertation_number|cert_number|supl_id|language_code|language_name|comment|supl_id_en|language_code_en|language_name_en|comment_en|remarks_suplement|languages|defense_exam_date|thesis_issue_date|to_receive_date|received_date|description|description_en|cert_type_code|grade_descriptive|org_unit_code|org_unit_name|org_unit_name_en|grade_numeric|thesis_exam_final_grade|study_average|thesis_grade|final_studies_grade|thesis_with_honors|suplement_acceptance_status|decision|decision_date|statement|payment_type|payment|ostu|thesis_ordered_pl|thesis_ordered_en|thesis_ordered_es|thesis_ordered_ru|thesis_ordered_de|thesis_ordered_fr|suplement_ordered_pl|suplement_ordered_en

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization.

Returned value:

A dictionary: your suplements acceptance requets will be mapped to dictionary's keys, in the items collection.

services/pw_suplements/update_order_comments

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

Consumer: required (administrative) Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_suplements/update_order_comments

Aktualizacja preferencji dotyczącej zamówienia liczby sztuk dyplomu, suplementów oraz odpisów.

user_id required ID of user
suplement_id required ID of person certificate
comment_1 optional The comments to certificate and suplement orders.
status_1 optional Status to be set.
comment_2 optional The comments to certificate and suplement orders.
status_2 optional Status to be set.
fields optional

Default value: result|message_pl|message_en

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization.

Returned value:

The value result holds True, when the answer is positive, when negative it is False with the reason in attribute message_pl and message_en.

services/pw_suplements/update_orders

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

Consumer: required (administrative) Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_suplements/update_orders

Aktualizacja preferencji dotyczącej zamówienia liczby sztuk dyplomu, suplementów oraz odpisów.

user_id required ID of user
cert_person_id required ID of person certificate
thesis_pl optional Number of ordered theses in polish
thesis_en optional Number of ordered theses in english
thesis_es optional Number of ordered theses in spanish
thesis_ru optional Number of ordered theses in russian
thesis_de optional Number of ordered theses in german
thesis_fr optional Number of ordered theses in french
suplement_pl optional Number of ordered suplements in polish
suplement_en optional Number of ordered suplements in english
amount optional Amount to paid for the documents by the student
ui_options optional USOSWEB user interfaceoptions.
fields optional

Default value: result|message_pl|message_en

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of update_personal_data_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 optional oauth_token for Token authorization.

Returned value:

The value result holds True, when the answer is positive, when negative it is False with the reason in attribute message_pl and message_en.

services/pw_suplements/update_personal_data_decision

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

Consumer: required (administrative) Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_suplements/update_personal_data_decision

Aktualizacja preferencji wyboru akceptacji danych o suplemencie.

user_id required ID of user
cert_person_id required ID of person certificate
version required ID suplement version
decision required String value of the decision A - accepted, O - rejected, X - no decision
decision_date optional String value of the date time of making decision in format: Y-m-d hh:mm:ss
fields optional

Default value: result|message_pl|message_en

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization.

Returned value:

The value result holds True, when the answer is positive, when negative it is False with the reason in attribute message.

services/pw_suplements/waiting

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

Consumer: required (administrative) Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_suplements/waiting

Zwraca liczbę suplementów oczekujących na akceptację.

user_id required ID of user
fields optional

Default value: count

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section.

format optional

Default value: json

Format in which to return values. See supported output formats.

callback optional

Required only if you've chosen jsonp as a return format.

Plus required standard OAuth Consumer signing arguments: oauth_consumer_key, oauth_nonce, oauth_timestamp, oauth_signature, oauth_signature_method, oauth_version. Plus optional oauth_token for Token authorization.

Returned value:

Object with items attribute with collection of history of student comments.

USOS API ver. 7.0.4.0-2, ba531cb9, dirty (2024-06-28)