Access USOS data - PW decisions
:: services/pw_decisions module

These API methods allow you to operate on pw user decisions.

Methods

add_user_signatures Returns a list of type of decisions for an employee
cancel_decision Cancel decision.
decision_fields Returns the descriptive fields of the decision.
decisions Returns a list of decisions related to the selected person
decisions_types_for_user Returns a list of type of decisions for an employee
delete_signature Delete signature
document_history Returns document history.
document_history_formatted Returns document history - based on select from database.
document_history_user Returns document history - based on select from database.
fetch_empty_pdf Download decision, PDF format
fetch_pdf Download decision, PDF format
get_decisions_types Get types of documents
get_notification_data Returns email of user who created decision
get_upd Download decision UPD, XML format
get_upo Download decision UPO, XML format
get_user_signatures Get user`s signatures to decisions
has_new_decisions Returns true or false if any desicion is shared and pending
is_user_authorized Returns whether the given user is authorized to the document
save_doc_code Save UPO to database
save_document Adding a signed document to the database
save_document_status Adding information about the change of the document status to the database; utw_data automatically with a trigger at the time of insert
save_documents_status Adding information about the change of documents status to the database; utw_data automatically with a trigger at the time of insert
save_notification Save notification status
save_upo Save UPO to database
supervisor_decisions Returns a list of decisions for an authorized employee
user_decisions_semester Returns unique semesters od e-decisions for user
user_signature Returns signature of the user (if allowed to sign document)
verify_auth_code Verifies auth code.

services/pw_decisions/add_user_signatures

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/add_user_signatures

Returns a list of type of decisions for an employee

employee_id optional ID of the employee
decisions optional ID`s of the decisions, comma separated
can_sign_document optional Can user sign decision or is preview only (T/N)
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:

ATrue/False

services/pw_decisions/cancel_decision

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/cancel_decision

Cancel decision.

dok_id required ID of document
comment required Comment
fields optional

Default value: result

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:

Executes document cancelation.

services/pw_decisions/decision_fields

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/decision_fields

Returns the descriptive fields of the decision.

doc_id required ID of the document
user_id required ID of the suer
user_context required Context of authorization - user or employee
fields optional

Default value: items|doc_id|tdok_id|header_note|city_date|sender|addressee|header|cause|substantiation|instruction|signature|note|addressed_to|footer|substantiation_header|instruction_header|addressed_to_header|sygnatura|data_dec

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: list of fields to generate decision.

services/pw_decisions/decisions

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/decisions

Returns a list of decisions related to the selected person

user_id required ID of user
jed_org_kod optional ID of the faculty
status optional Document status
doc_id optional Document ID - to get one decision details
fields optional

Default value: items|id|jed_org_kod|jed_org_name|cdyd_kod|code|description|descriptionEN|date_from|date_to|os_id|uwt_id_email|prgos_id|sygnatura|decision_date|received_date|cancellation_date|application_date|surname_name|indeks|prg_code|jez_id|prg_description|status|electronic_decision|has_history|delivered|is_document|is_document_signed|validation_date

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

format optional

Default value: json

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

callback optional

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

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

Returned value:

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

services/pw_decisions/decisions_types_for_user

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/decisions_types_for_user

Returns a list of type of decisions for an employee

employee_id optional ID of the employee
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:

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

services/pw_decisions/delete_signature

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/delete_signature

Delete signature

id required ID of the signature
fields optional

Default value: result

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:

.

services/pw_decisions/document_history

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/document_history

Returns document history.

doc_id required ID of the document
fields optional

Default value: doc_id|utw_data|os_id|status|sequence

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 decisions will be mapped to dictionary's keys, in the items collection.

services/pw_decisions/document_history_formatted

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/document_history_formatted

Returns document history - based on select from database.

doc_id required ID of document
user_id required ID of the user
user_context required Context of the user
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_decisions/document_history_user

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/document_history_user

Returns document history - based on select from database.

doc_id required ID of document
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_decisions/fetch_empty_pdf

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/fetch_empty_pdf

Download decision, PDF format

(this method takes no parameters)
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 decision document.

services/pw_decisions/fetch_pdf

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/fetch_pdf

Download decision, PDF format

doc_id required Document's ID
user_id required user id
user_context required user context - user or employee
version required Document's version - plain or signed
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 decision document.

Thrown errors:

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

services/pw_decisions/get_decisions_types

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/get_decisions_types

Get types of documents

fields optional

Default value: items|kod|opis|opis_ang

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 list of decisions

services/pw_decisions/get_notification_data

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/get_notification_data

Returns email of user who created decision

doc_id required ID of document
fields optional

Default value: email

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:

User email.

services/pw_decisions/get_upd

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/get_upd

Download decision UPD, XML format

user_id required user's ID
id required Document's ID
user_context required Context of authorization - user or employee
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 XML format containing decision UPD document.

Thrown errors:

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

services/pw_decisions/get_upo

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/get_upo

Download decision UPO, XML format

user_id required user's ID
id required Document's ID
user_context required Context of authorization - user or employee
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 XML format containing decision UPO document.

Thrown errors:

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

services/pw_decisions/get_user_signatures

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/get_user_signatures

Get user`s signatures to decisions

employee_id required employee id
fields optional

Default value: kod

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 list of decisions

services/pw_decisions/has_new_decisions

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/has_new_decisions

Returns true or false if any desicion is shared and pending

user_id required USOS os_id
fields optional

Default value: id

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:

User email.

services/pw_decisions/is_user_authorized

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/is_user_authorized

Returns whether the given user is authorized to the document

doc_id required ID of document
user_context required Context of authorization - user or employee
user_id optional ID of user
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_decisions/save_doc_code

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/save_doc_code

Save UPO to database

id required ID of document
code required Auth code
duration required Code valid time in minutes
fields optional

Default value: doc_id

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:

services/pw_decisions/save_document

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/save_document

Adding a signed document to the database

dok_id required ID of document
doc_object required Signed document object
version required Version of the document
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_decisions/save_document_status

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/save_document_status

Adding information about the change of the document status to the database; utw_data automatically with a trigger at the time of insert

os_id required ID of user
doc_id required ID of document
status required Document status
comment optional Document comment
fields optional

Default value: result

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_decisions/save_documents_status

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/save_documents_status

Adding information about the change of documents status to the database; utw_data automatically with a trigger at the time of insert

json_string required String json
fields optional

Default value: result

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:

-

services/pw_decisions/save_notification

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/save_notification

Save notification status

dok_id required ID of document
email_adresata required recipient`s email
tytul required message title
tresc required message body
fields optional

Default value: result

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:

Saves info of sent email do user.

services/pw_decisions/save_upo

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/save_upo

Save UPO to database

doc_id required ID of document
upo required Signed document object
fields optional

Default value: doc_id

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_decisions/supervisor_decisions

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/supervisor_decisions

Returns a list of decisions for an authorized employee

doc_id optional ID of the decision
user_faculty optional User faculty
filter optional Determines filter for decisionsthat are shown
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:

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

services/pw_decisions/user_decisions_semester

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/user_decisions_semester

Returns unique semesters od e-decisions for user

fields optional

Default value: cdyd_kod

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:

User signature pl/en.

services/pw_decisions/user_signature

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/user_signature

Returns signature of the user (if allowed to sign document)

user_id required User ID
doc_id required ID of the document
fields optional

Default value: podpis|podpis_ang

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:

User signature pl/en.

services/pw_decisions/verify_auth_code

Consumer: required Token: optional Scopes: n/a SSL: required
https://apps.usos.pw.edu.pl/services/pw_decisions/verify_auth_code

Verifies auth code.

id required ID of the document
code required Auth code of the document
fields optional

Default value: is_valid

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:

True if provided auth code is valid;
code expired - if code has expired;
invalid code if code is not correct

USOS API ver. 7.0.3.0-1, 76759f3d, dirty (2024-05-13)