|
Student Forms and Processes
|
services/eforms/calendars | Editing eform calendars |
services/eforms/comments | Interface for managing user comments. |
services/eforms/logs | Monitoring changes of forms and requests for admins |
services/eforms/modules | Modules |
services/eforms/operations | Allows to execute some bulk operations on selected eforms for admins |
services/eforms/opinions | Setting visibility of opinion of eform for admins |
services/eforms/processes | Administrative interface for managing processes flows. Typical CRUD. |
services/eforms/renderer | Based on the Mustache markup (library chevron) rendering engine for eform applications |
services/eforms/reports | Module rsponsible for generating and executing mass operations and reports |
services/eforms/roles | Submiting, monitoring and accepting form and requests |
services/eforms/statuses | Administrative interface for managing statuses. Typical CRUD. |
services/eforms/tasks | Managing daemon and tasks |
services/eforms/templates | Administering templates of opinions, decisions and emails |
services/eforms/types | Administering eform types. |
services/eforms/userroles | Administering user roles in eforms module |
Methods
__eforms | Return eforms list submitted by a student. (administrative) |
all_buttons | Returns list of all possible buttons (actually statuses) that can be assigned to the eform. (administrative) |
attachment_info | Return information about attachment. (administrative) |
attachment_rights | Return information about attachment. (administrative) |
cancel_decision_signature | Cancels decision signature. You need to pass GUID and reason of the removal. Appropriate record in the DZ_POD_PODPISY table will be updated with signature of the cancelling. The signature will contain the removing user information, the date and time and the reason. (administrative) |
change_processing_org_unit | Change processing org unit of the eform. The orginal org unit is archived in a separate column in the database and can be reverted back with revert_processing_org_unit endpoint. (administrative) |
create_eform | Save or update an eform. (administrative) |
delete_eform | Permanently deletes an eform. Verifies if the status is 1 (EFORM_IN_EDITING) and the user is the owner of the eform. Only the owner can permanently remove an application. The function also recursively deletes the attached files and blobbox references. It will fail to delete the application when the attached file can not be deleted. (administrative) |
delete_eform_parameter | Deletes an eform parameter eform identified by id. |
eform | Return eforms list submitted by a student. (administrative) |
eform_calendar | Return calendar entries for eform documents. (administrative) |
eform_types | Return a list of eform types. (administrative) |
eform_types_for_programme | Return list of eform types available for student to submit for a specific date. (administrative) |
eforms_to_admin | Return list of eforms. (administrative) |
eforms_to_opinion | Return list of submitted eforms assigned to a user. (administrative) |
frontend_data | Returns data for specific frontend view. Skips all eforms with status type code ='WED' and returns status types excluding 'WED'. (administrative) |
get_editable_parameters | Return editable parameters for a given template for a specific guid. (administrative) |
get_user_parameter | Update user parameter. (administrative) |
list_eforms_to_sign | Returns eforms waiting for final decision and signature under resolution or answer. (administrative) |
list_student_stages | List all student stages of a student. (administrative) |
list_valid_calendars | List of valid calendars to be selected for a given eform. (administrative) |
list_valid_programms | Returns valid programs for a students on which he can submit an eform. (administrative) |
log_to_log | Add a new log message netry in the log tables of the eforms (DZ_POD_LOG). (administrative) |
mark_read | Marks that the response to a form or a request was displayed by the person who submitted. (administrative) |
next_buttons | Returns list of buttons (actually statuses) that can be pressed on the current state of the process. (administrative) |
pw_decisions | Returns a list of decisions for an authorized employee |
revert_processing_org_unit | Revert processing org unit of the eform to the original main unit. The orginal org unit is reverted from the stored column. (administrative) |
save_attachments | Save or update attachments of an eform. (administrative) |
search | Returns objects for search components. |
sign_eform | Sign an eform. (administrative) |
stats | Returns information about ePodania module statistics. (administrative) |
status | Return status definition by code. (administrative) |
statuses_history | Return log history of statuses changes for a given eform. (administrative) |
student_programme | Returns student programme for a specified ID. (administrative) |
update_calendar | Update calendar assigned to the application (eform). (administrative) |
update_decision_role | Update decision role assigne to the application (eform). This value will override decision role code from calendar and type of the eform. (administrative) |
update_eform | Save or update an eform. (administrative) |
update_eform_parameter | Updates eform identified by a guid parameter. |
update_metadata | Update metadata of an eform. (administrative) |
update_process | Updates the proces according to which the eform is handled. By default, the proces from calendar cycle is used, when the value fot the eform is null. If for the eform a specific process is defined then it oveerides the default. (administrative) |
update_processing_person | Updates person who is responsible for processing the form in the administrating organizational unit. (administrative) |
update_status | Updates the status, registers change in the log of changes and returns an updated eform. Executes validations and scripts before and after defined in process configuration. (administrative) |
update_status_and_sign_decision | Updates the status, registers change in the log of changes and return an updated eform. (administrative) |
update_student_stage | Update student study stage assigned to the application (eform). (administrative) |
update_templates | Update templates of an eform. (administrative) |
update_user_parameter | Update user parameter. (administrative) |
user_eforms | Return eforms list submitted by a student. (administrative) |
validate_contents | Verifies if all requirements before submitting eform are satisfied. (administrative) |
validate_decision | Verifies if all requirements for signing decision for the eform are satisfied. (administrative) |
version | Returns information about version of the eforms USOSAPI extension module. (administrative) |
services/eforms/__eforms ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/__eforms | ||||||
Return eforms list submitted by a student. | ||||||
guid | required | GUID of the form to be returned | ||||
fields | optional |
Default value: item 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 forms submitted by a user. Optionally the programme_id can be added to make the list shorter. |
services/eforms/all_buttons ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/all_buttons | ||||||
Returns list of all possible buttons (actually statuses) that can be assigned to the eform. | ||||||
guid | required | GUID of the form | ||||
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 list all valid buttons... |
services/eforms/attachment_info ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/attachment_info | ||||||
Return information about attachment. | ||||||
id | optional | ID of a file | ||||
blob_id | optional | ID of a blob file | ||||
fields | optional |
Default value: item 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 forms submitted by a user. Optionally the programme_id can be added to make the list shorter. |
services/eforms/attachment_rights ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/attachment_rights | ||||||
Return information about attachment. | ||||||
user_id | optional | ID of a person to check rights | ||||
file_id | optional | ID of a file | ||||
blob_id | optional | ID of a blob file | ||||
fields | optional |
Default value: item 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 forms submitted by a user. Optionally the programme_id can be added to make the list shorter. |
services/eforms/cancel_decision_signature ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/cancel_decision_signature | ||||||
Cancels decision signature. You need to pass GUID and reason of the removal. Appropriate record in the DZ_POD_PODPISY table will be updated with signature of the cancelling. The signature will contain the removing user information, the date and time and the reason. | ||||||
guid | required | GUID of the eform | ||||
reason | required | Reason justifying removing the signature | ||||
fields | optional |
Default value: 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 status 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: An object representing the status definition. |
services/eforms/change_processing_org_unit ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/change_processing_org_unit | ||||||
Change processing org unit of the eform. The orginal org unit is archived in a separate column in the database and can be reverted back with revert_processing_org_unit endpoint. | ||||||
guid | required | GUID of the eform | ||||
org_unit_code | required | Code of the new processing org unit | ||||
new_status_code | optional | Optional new status code to be assigned after changing processing org unit. | ||||
skip_notifications | optional | Skip e-mail notifications when updating status | ||||
fields | optional |
Default value: message 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: An object representing the status definition. |
services/eforms/create_eform ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/create_eform | ||||||
Create a new eform or update existing one:
| ||||||
user_id | required |
Required id of a person. |
||||
type_code | required |
Required code of the EFORM TYPE to be created. |
||||
calendar_id | required |
Required submition round of calendar allowing to submit the form. |
||||
fields | optional |
Default value: guid Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
student_stage_id | optional |
Optional id of student stage. All student eform shoud be associated with some student_stage_id, it is optional only for employees. |
||||
status_code | optional |
Initial status of newly created eform. The default value is 'WED'. |
||||
preferred_lang_code | optional |
Default value: POL Preferred language of the application. The default value is 'POL'. |
||||
date_submitted | optional |
Date when the application was actually submitted. Used for applications submitted off-system (paper, email, etc.). |
||||
tags | optional |
Optional tags attached to the applications (like ZAREJPOZASYST, etc.). |
||||
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: Dictionary of the following structure:
|
services/eforms/delete_eform ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/delete_eform | ||||||
Permanently deletes an eform. Verifies if the status is 1 (EFORM_IN_EDITING) and the user is the owner of the eform. Only the owner can permanently remove an application. The function also recursively deletes the attached files and blobbox references. It will fail to delete the application when the attached file can not be deleted. | ||||||
user_id | required | User ID of a person deleting the form. | ||||
guid | required | GUID of the form to be deleted. | ||||
reason | optional | Reason for deleting the eform registerd in the system log. Default value is: "na żądanie użytkownika". | ||||
fields | optional |
Default value: message 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 statuses log entries. |
services/eforms/delete_eform_parameter ¶
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/delete_eform_parameter | ||||||
Deletes an eform parameter eform identified by id. | ||||||
id | optional | ID of the parameter. | ||||
guid | optional | guid of the eform | ||||
name | optional | name of the parameter | ||||
fields | optional |
Default value: message 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 status message 'SUCCESS' |
services/eforms/eform ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/eform | ||||||
Return eforms list submitted by a student. | ||||||
guid | required | GUID of the form to be returned | ||||
fields | optional |
Default value: item Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
with_decision_statuses | optional | Get list of matching statuses for recommended decision type. (Default: False) | ||||
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 forms submitted by a user. Optionally the programme_id can be added to make the list shorter. |
services/eforms/eform_calendar ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/eform_calendar | ||||||
Return calendar entries for eform documents. | ||||||
code | optional | Code of eform type | ||||
org_unit_code | optional | Code of organisation unit | ||||
for_date | optional | Day for which the eform should be active | ||||
student_programme_id | optional | ID of student programme. | ||||
fields | optional |
Default value: id|type|from_date|to_date|eform_type_code|cycle_code|description|description_en|information_en|metadata|org_unit_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. |
||||
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 calendar entries for eform types... |
services/eforms/eform_types ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/eform_types | ||||||
Return a list of eform types. | ||||||
code | optional | Code od eform type | ||||
org_unit_code | optional | Code of an organisation unit | ||||
for_date | optional | Day for which the eform should be active | ||||
fields | optional |
Default value: code|name_pl|name_en|has_subject|has_stage|has_content|has_list|information_pl|information_en|is_current|org_unit_code|max_attachments|process_id|template|template_en|metadata|internal_instruction 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 available eform types... |
services/eforms/eform_types_for_programme ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/eform_types_for_programme | ||||||
Return list of eform types available for student to submit for a specific date. | ||||||
student_programme_id | required | Id of student programme | ||||
for_date | required | Day for which the eform should be active | ||||
fields | optional |
Default value: code|name_pl|name_en|has_subject|has_stage|has_content|has_list|information_pl|information_en|is_current|org_unit_code|max_attachments|process_id|template|template_en|metadata|internal_instruction 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 available eform types... |
services/eforms/eforms_to_admin ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/eforms_to_admin | ||||||
Return list of eforms. | ||||||
user_id | required | user requesting data | ||||
options | optional |
List of filter parameters or sort options with the following structure: { "filters": [ { "colname": "the name", "value": "the value", "operator": "like | ilike | in | = | > | <" } ] "sort": "column to be sorted by", "asc: true /false }The operators: `ilike` and `in` are treated specially: * `ilike` - both the column value and the value are lowercased during the comparison, * `in` - we assume, that the value contains `|` (pipe character) splitted options Example of options value: {"filters": [ { "colname": "eform_guid", "value":"a3", "operator": "<" }, { "colname": "student_firstname", "value":"%URE%", "operator": "ilike" }, { "colname": "org_unit_code", "value":"1040", "operator": "=" } , { "colname": "role_code", "value":"OBSLUGA|THE_DZIEKAN", "operator": "in" }, { "colname": "eform_status_type", "value":"STUDENT|ROZP", "operator": "in" } ], "sort": "eform_guid", "asc": true } |
||||
category | optional | Category code. Default is "STUD". | ||||
start | optional | first record to return | ||||
num | optional | maximum number of records to return | ||||
only_count | optional | when True the data is skipped and only count data with submission dates are returned | ||||
persist_filters | optional |
Default value: true when True then the recent filters will be remembered for user account (DZ_PARAMETRY_OSOB) |
||||
fields | optional |
Default value: items|rownum|student_firstname|student_lastname|student_id|student_no|programme_code|programme_desc|programme_desc_en|mode_of_study|type_of_study|mode_of_study_en|type_of_study_en|study_stage_desc|cycle_code|eform_title|status_modified_date|eform_submitted_date|eform_guid|eform_type_code|eform_type_name|eform_type_name_en|org_unit_code|role_code|role_name|role_name_en|eform_status_id|eform_status_code|eform_status_desc|eform_status_desc_en|eform_status_type|student|handling_person|eform_number|comment_priv|calendar_id|decision_role_code|decision_role_name_pl|decision_role_name_en|study_stage_code|sign_decision_id|sign_decision_date|tags|pw_dec_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: Object containing list of eforms in the form: Each item has additional field: `user_has_role` which indicates if the `user_id` is assigned a role which is currently responsible for processing the eform. Additionally the org_unit of the eform is verfified. The condition si: User(user_id) has (EForm.Status.StatusType.Role) in (EFormType.ORG_UNIT). { "items": [ {...} ], 'total': 7, 'min_submitted_date': '2021-12-13 11:14:04', 'max_submitted_date': '2022-05-05 17:02:35' } |
services/eforms/eforms_to_opinion ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/eforms_to_opinion | ||||||
Return list of submitted eforms assigned to a user. | ||||||
user_id | optional | ID of a person to check rights | ||||
start | optional | first record to return | ||||
num | optional | maximum number of records to return | ||||
with_opinion | optional | if True then only eform with submitted opinion will be returned, when False then only waiting for an opinion eforms will be returned when null (or skipped) then all eform with opinion assigned to person will be returned | ||||
include_closed | optional | if True then even closed eforms will be returned | ||||
only_count | optional | when True the data is skipped and only count data with submission dates are returned | ||||
fields | optional |
Default value: item 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 forms submitted by a user. Optionally the programme_id can be added to make the list shorter. |
services/eforms/frontend_data ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/frontend_data | ||||||
Returns data for specific frontend view. Skips all eforms with status type code ='WED' and returns status types excluding 'WED'. | ||||||
user_id | required | User ID of a person who is displaying the frontent view. | ||||
view | required | Name of view for which the has to supplied. currently the following views are supprted: * `eforms_administration_list` (pl.: obsługa wniosków), `org_units_with_role` (pl: lista jednostek z daną rolą), options["role_code"]="???" | ||||
category | optional | Category code. Default is "STUD". | ||||
options | optional |
A JSON object with optional options. |
||||
fields | optional |
Default value: org_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 optional oauth_token for Token authorization. | ||||||
Returned value: An object with parameters. |
services/eforms/get_editable_parameters ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/get_editable_parameters | ||||||
Return editable parameters for a given template for a specific guid. | ||||||
user_id | required | User ID of a person updating the form. | ||||
eform_guid | required |
Required of eform type for which to return editable parameters. |
||||
templates | required |
Required Dictionary (a JSON object) with the following structure:. ``` { "items": [ "an example of editable template ", "yet another template" ] } ``` |
||||
fields | optional |
Default value: message 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: Status message and the follwing parameters: ``` { "message" : "SUCCESS", "items": [ { "label_en": "ala", "label_pl": "ala", "max_value": null, "min_value": null, "name": "ala", "size": null, "type": "str", "value": "" }... ], -- a list of parameters "rights": [ "WL" ] -- a collection of rights assign for the user in the specific eform, } ``` |
services/eforms/get_user_parameter ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/get_user_parameter | ||||||
Update user parameter. | ||||||
user_id | required | User id of the parameter | ||||
name | required | Name of the parameter. | ||||
fields | optional |
Default value: message 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 status message of the operation. |
services/eforms/list_eforms_to_sign ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/list_eforms_to_sign | ||||||
Returns eforms waiting for final decision and signature under resolution or answer. | ||||||
org_unit_code | required | Organizationkal unit code responsible for processing eform. | ||||
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. |
||||
role_code | optional | Role code responsible for considering eform. | ||||
status_code | optional | Status code of eforms. | ||||
eform_type_code | optional | Status code of eforms. | ||||
programme_code | optional | Mask of aprogramme code. | ||||
study_stage_code | optional | Mask of aprogramme code. | ||||
private_notes | optional | A mask to filter out a part of private notes. | ||||
type_of_decision | optional | Code of decision type to filter out. | ||||
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: An object with list pf eforms waiting for resolution signature. |
services/eforms/list_student_stages ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/list_student_stages | ||||||
List all student stages of a student. | ||||||
student_id | required | Id of a student | ||||
programme_code | optional |
Default value: (empty string) Id (code) of a programme to filter stages |
||||
fields | optional |
Default value: message|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 status message of the operation and a list of all student stages from table DZ_ETAPY_OSOB. |
services/eforms/list_valid_calendars ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/list_valid_calendars | ||||||
List of valid calendars to be selected for a given eform. | ||||||
guid | required | GUID of the eform | ||||
days | optional |
Default value: 365 Maximum number of days ago the calendar cycle ended or the close date is null |
||||
fields | optional |
Default value: message|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 status message of the operation. |
services/eforms/list_valid_programms ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/list_valid_programms | ||||||
Returns valid programs for a students on which he can submit an eform. | ||||||
user_id | required | User id of the person displaying the form | ||||
fields | optional |
Default value: progs 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 valid programs on which student can submit eforms (the condition: po.status in ('STU', 'ABS-PD', 'SKR')). |
services/eforms/log_to_log ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/log_to_log | ||||||
Add a new log message netry in the log tables of the eforms (DZ_POD_LOG). | ||||||
user_id | required | User id responsible for the operation | ||||
guid | required | GUID of the eform which is related to the log message. | ||||
message | required | Value of the parameter. | ||||
fields | optional |
Default value: message 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 status message of the operation. |
services/eforms/mark_read ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/mark_read | ||||||
Marks that the response to a form or a request was displayed by the person who submitted. | ||||||
guid | required | GUID of the displayed form | ||||
user_id | required | User id of the person displaying the form | ||||
clear | optional |
Default value: false Clear information that the response was read |
||||
fields | optional |
Default value: item 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 forms submitted by a user. Optionally the programme_id can be added to make the list shorter. |
services/eforms/next_buttons ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/next_buttons | ||||||
Returns list of buttons (actually statuses) that can be pressed on the current state of the process. | ||||||
guid | required | GUID of the form | ||||
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. |
||||
user_id | optional | User ID of a person requesting to get valid buttons. | ||||
for_external_opinion | optional | True if the buttons should be provided for external opinion. | ||||
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 valid buttons... |
services/eforms/pw_decisions ¶
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/pw_decisions | ||||||
Returns a list of decisions for an authorized employee | ||||||
decision_user_id | optional | ID of the user with decision | ||||
org_unit_code | optional | Faculty code of the decision | ||||
decision_id | optional | The decision id to be returned | ||||
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/eforms/revert_processing_org_unit ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/revert_processing_org_unit | ||||||
Revert processing org unit of the eform to the original main unit. The orginal org unit is reverted from the stored column. | ||||||
guid | required | GUID of the eform | ||||
new_status_code | optional | Optional new status code to be assigned after changing processing org unit. | ||||
skip_notifications | optional | Skip e-mail notifications when updating status | ||||
fields | optional |
Default value: message 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 status of the operation message. |
services/eforms/save_attachments ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/save_attachments | ||||||
Update attachments of an eform: If a new file will be on a list (which neither id nor the blob_id exist in a database) it will be added, if and existing file will be found then the description will be updated. Missing files policy: if in the databse there will be found files of specific type which are missing on the submitted list then they will be removed. | ||||||
eform_guid | required |
Required guid of an eform to which the files belong to. |
||||
user_id | required |
Required id of a person reponsible for updating attachments. |
||||
attachments | required |
A JSON object containg list of attachments to be inserted or updated. Expected structure example: { } |
||||
fields | optional |
Default value: attachments 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: Dictionary containg list of updated files ids with short information which was added, updated or deleted. { 'attachments': [ 'file_id': ..., 'blob_id': ..., 'opinion_id': ..., 'type': STUD|WEW|ODPOW|OPINIA|UZUPEL, 'operation': NEW|UPDATED|DELETED, ] } |
services/eforms/search ¶
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/search | ||||||
Returns objects for search components. | ||||||
query_type | required | Type of query type. | ||||
fields | optional |
Default value: id|name Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
ids | optional |
Pipe-separated list of object IDs. |
||||
name | optional | Query value. | ||||
lang | optional | Language code, accepted "pl" or other | ||||
guid | optional | Optional application (eform) guid. | ||||
num | optional | Maximum number of items returned (default = 10). | ||||
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: An object version of the EForms API Extension module version. |
services/eforms/sign_eform ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/sign_eform | ||||||
Create a snapshot content of the application in the DZ_POD_PODPISY table. | ||||||
eform_guid | required |
Required guid of the eform to be updated. |
||||
data | required |
A JSON object describing the data of the eform to be updated. It expects a 'data' atribute which represents the data section of the aplication (eform) stored in metadata field. If sig_type=='UPP' then the whole data is saved in the metadata_after part of the signature entry and the original data of the eform is not modified. |
||||
signature | required |
A JSON object representing th signature. |
||||
fields | optional |
Default value: guid Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
user_id | optional |
Required id of a signing person. |
||||
sig_type | optional |
Enum. Signature type enum: ROZST,INNE,UPP,UPO,UPD,OPINIA. Default value: INNE |
||||
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 standard result message. |
services/eforms/stats ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/stats | ||||||
Returns information about ePodania module statistics. | ||||||
fields | optional |
Default value: org_types|org_types_30|statuses 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: An object with statistics information. |
services/eforms/status ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/status | ||||||
Return status definition by code. | ||||||
code | required | Status code to be returned | ||||
fields | optional |
Default value: 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. |
||||
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: An object representing the status definition. |
services/eforms/statuses_history ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/statuses_history | ||||||
Return log history of statuses changes for a given eform. | ||||||
guid | required | GUID of an eform | ||||
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 list statuses log entries. |
services/eforms/student_programme ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/student_programme | ||||||
Returns student programme for a specified ID. | ||||||
id | required | Student programme ID (of a student) | ||||
fields | optional |
Default value: programme|user_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: A list valid programs on which student can submit eforms (the condition: po.status in ('STU', 'ABS-PD', 'SKR')). |
services/eforms/update_calendar ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/update_calendar | ||||||
Update calendar assigned to the application (eform). | ||||||
guid | required | GUID of the eform | ||||
calendar_id | required | Id of a new calendar cycle to assign to the eform. | ||||
comment | optional | A comment which will be attached to internal notes of the eform. | ||||
fields | optional |
Default value: message 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 status message of the operation. |
services/eforms/update_decision_role ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/update_decision_role | ||||||
Update decision role assigne to the application (eform). This value will override decision role code from calendar and type of the eform. | ||||||
guid | required | GUID of the eform | ||||
role_code | optional | Decision role code - can be None. | ||||
addressee | optional | New adressee of the application. | ||||
fields | optional |
Default value: message 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 status message of the operation. |
services/eforms/update_eform ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/update_eform | ||||||
Create a new eform or update existing one:
| ||||||
user_id | required |
Required id of a person. |
||||
eform_guid | required |
Required guid of the eform to be updated. |
||||
eform | required |
A JSON object describing the eform to be inserted (or the new content of the eform which you want replaced). It must have the same structure as the object returned by eform method. It also must meet the following requirements:
|
||||
fields | optional |
Default value: guid Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
eform_calendar_id | optional |
Required edition of calendar allowing to submit the form. |
||||
student_stage_id | optional |
Optional id of student stage. All student eform shoud be associated with some student_stage_id, it is optional only for employees. |
||||
validate_decision | optional | if True then the contents of the decision (form of text will be validated if it can be signed). | ||||
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: Dictionary of the following structure:
|
services/eforms/update_eform_parameter ¶
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/update_eform_parameter | ||||||
Updates eform identified by a guid parameter. | ||||||
user_id | required | ID of the user modifying | ||||
guid | required | guid of the eform | ||||
data | required | Parameter data to be set. | ||||
fields | optional |
Default value: message 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 status message 'SUCCESS' |
services/eforms/update_metadata ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/update_metadata | ||||||
Update metadata of the eform in an administrative way. | ||||||
guid | required |
Required guid of the eform to be updated. |
||||
metadata | required |
A JSON object describing the eform metadata to be updated. |
||||
fields | optional |
Default value: guid 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: Status of the operation message. |
services/eforms/update_process ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/update_process | ||||||
Updates the proces according to which the eform is handled. By default, the proces from calendar cycle is used, when the value fot the eform is null. If for the eform a specific process is defined then it oveerides the default. | ||||||
user_id | required | User ID of a person updating the form. | ||||
guid | required | GUID of the form to be deleted. | ||||
process_id | optional | Process ID or None if the value should be cleared. | ||||
comment | optional | A comment which will be attached to internal notes of the eform. | ||||
fields | optional |
Default value: message 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 status message. |
services/eforms/update_processing_person ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/update_processing_person | ||||||
Updates person who is responsible for processing the form in the administrating organizational unit. | ||||||
user_id | required | User ID of a person updating the form. | ||||
guid | required | GUID of the form to be deleted. | ||||
processing_person_id | optional | User ID of a person responsible for processing the form. | ||||
fields | optional |
Default value: message 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 status message. |
services/eforms/update_status ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/update_status | ||||||
Updates the status, registers change in the log of changes and returns an updated eform. Executes validations and scripts before and after defined in process configuration. | ||||||
user_id | required | User id of the person updating status | ||||
guid | required | GUID of the form to be returned | ||||
status_code | required | Code of a new status to be assigned | ||||
submitted | optional | If true then the submitted date will be set | ||||
check_rights | optional | Default True. Checks rights to update the status. If a user is owner and current status allow student to modify statuses else if the user has a role responsible for the status. | ||||
skip_notifications | optional | Default is False. If true then all notifications will be skipped | ||||
fields | optional |
Default value: item 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: An updated eform. |
services/eforms/update_status_and_sign_decision ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/update_status_and_sign_decision | ||||||
Updates the status, registers change in the log of changes and return an updated eform. | ||||||
user_id | required | User id of the person updating status | ||||
guid | required | GUID of the form to be returned | ||||
status_code | required | Code of a new status to be assigned | ||||
signature | required | Signature of the structure like {"kto": ...., "kiedy": ...., "ip":.....} | ||||
data_after | required | EForm data after signature. | ||||
check_rights | optional | Default True. Checks rights to update the status. If a user is owner and current status allow student to modify statuses else if the user has a role responsible for the status. | ||||
fields | optional |
Default value: item 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: An updated eform. |
services/eforms/update_student_stage ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/update_student_stage | ||||||
Update student study stage assigned to the application (eform). | ||||||
guid | required | GUID of the eform | ||||
student_stage_id | required | Id of a new study stage to assign to the eform. | ||||
comment | optional | A comment which will be attached to internal notes of the eform. | ||||
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 status message of the operation. |
services/eforms/update_templates ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/update_templates | ||||||
Update templates of the eform in an administrative way. | ||||||
templates | required |
A new values of templates which should be updated in the eform structure: {"pl": {....}, "en": {.....}}. |
||||
fields | optional |
Default value: guid Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
guid | optional |
Optional guid of the eform to be updated. |
||||
eform_type_code | optional |
Optional eform type code of the eforms to be updated (when specifed the `submitted_date_from` must be also provided). |
||||
created_date_from | optional |
Optional date from of creating of the eforms to be updated (when specifed the `eform_type_code` must be also provided). |
||||
created_date_to | optional |
Optional date to of creating of the eforms to be updated (when specifed the `eform_type_code` must be also provided). |
||||
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: Status of the operation message. |
services/eforms/update_user_parameter ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/update_user_parameter | ||||||
Update user parameter. | ||||||
user_id | required | User id of the parameter | ||||
name | required | Name of the parameter. | ||||
value | optional | Value of the parameter. | ||||
fields | optional |
Default value: message 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 status message of the operation. |
services/eforms/user_eforms ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/user_eforms | ||||||
Return eforms list submitted by a student. | ||||||
user_id | required | ID of user | ||||
programme_id | optional | ID of study programme | ||||
with_cancelled | optional | If yes, then also cancelled and deleted eforms will be returned. By default only not cancelled and not deleted are returned. | ||||
start | optional | first record to return | ||||
num | optional | maximum number of records to return | ||||
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 list of forms submitted by a user. Optionally the programme_id can be added to make the list shorter. |
services/eforms/validate_contents ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/validate_contents | ||||||
Verifies if all requirements before submitting eform are satisfied. | ||||||
user_id | required | User id of the person updating status | ||||
guid | required | GUID of the form to be returned | ||||
fields | optional |
Default value: message 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: status - SUCCESS? ERROR?. errors: [{ "pl":... "en":... },... ] |
services/eforms/validate_decision ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/validate_decision | ||||||
Verifies if all requirements for signing decision for the eform are satisfied. | ||||||
user_id | required | User id of the person updating status | ||||
guid | required | GUID of the form to be returned | ||||
fields | optional |
Default value: message 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: status - SUCCESS? ERROR?. errors: [{ "pl":... "en":... },... ] |
services/eforms/version ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://apps.usos.pw.edu.pl/services/eforms/version | ||||||
Returns information about version of the eforms USOSAPI extension module. | ||||||
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: An object version of the EForms API Extension module version. |