Student Applications Report Engine
:: services/eforms/reports module

These API methods allow you to generate reports and edit the reports definitions.

Methods

delete Delete eform report. (administrative)
get_for_edit Return a list of reports for edit. (administrative)
list_for_edit Return a list of reports for edit. (administrative)
update Create or update eform report. (administrative)

services/eforms/reports/delete

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

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

Delete eform report.

user_id required Required id of a person reponsible for deleting the eform role.
report_code required Required code of ...

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

services/eforms/reports/get_for_edit

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

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

Return a list of reports for edit.

code optional

Optional filter code or name of a report.

fields optional

Default value: item|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 of defined reports in the "items" key.

services/eforms/reports/list_for_edit

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

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

Return a list of reports for edit.

code_or_name optional

Optional filter code or name of a report.

category optional Category code. Default is "STUD".
start optional first record to return
num optional maximum number of records to return
fields optional

Default value: items|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 of defined reports in the "items" key.

services/eforms/reports/update

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

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

Update fields of a report:

The parameter `report_code` is required.

user_id required

Required id of a person reponsible for updating attachments.

report_code required Required code of ...

data required

A JSON object containg atributes of a new item or the one to be updated. Only passed fields will be updated.

Expected structure example:

            {
                "name_pl": "...",
                "name_en": "...",
                "category": "...",
                "description_pl": "...",
                "description_en": "...",
                "right_code": "...",
                "active" : "...",
                "sql_query": "...",
                "python_filter": "...",
                "python_mapper": "...",
                "template_pl": "...",
                "template_en": "...",
                "metadata": "...",
            }
            
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

USOS API ver. 7.0.0.0-0, c59b550f, dirty (2023-07-17)