Modules
:: services/eforms/modules module

These API methods allow you to administer modules

Methods

delete Delete eform module entry. (administrative)
get_for_edit Return data for editing a module. (administrative)
list_for_edit Return eform modules for editing. (administrative)
run Run a specific automatization module on an eform. (administrative)
update Create or update eform module. (administrative)

services/eforms/modules/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/modules/delete

Delete eform module entry.

user_id required Required id of a person responsible for deleting the eform module.
code required Required code of the eform module item to be deleted.

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/modules/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/modules/get_for_edit

Return data for editing a module.

user_id required

Required id of a person reponsible for requesting data to edit.

code optional Optional code of a module
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:

An item to be edited (can be null).

services/eforms/modules/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/modules/list_for_edit

Return eform modules for editing.

user_id required Id of a user displaying list
name_or_code optional Module code or name
start optional first record to return
num optional maximum number of records to return
fields optional

Default value: items|total

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 modules entries...

services/eforms/modules/run

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/modules/run

Run a specific automatization module on an eform.

user_id required Id of a user runnning
guid required GUID of the application for which to run the automatization
module_code required Code of a module to be executed
fields optional

Default value: message|progress_token

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 'STATUS' and progress execution.

services/eforms/modules/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/modules/update

Update fields of an eform module:

The parameter `code` is required. If the eform module with the given code does not exist then a new one will be created.

user_id required

Required id of a person responsible for updating attachments.

code required

Required code of the eform module item to be updated or created. If the item with the given code will not exist then a new item will be created.

name required

Required name of the eform module item to be updated or created.

module_type required Required type of module.
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.

description optional Descrption of template to be created.
db_view optional Name of view in database
db_function optional Name of database function
db_sql optional SQL query
php_local_function optional Name and localization of php function
python_function optional Function in Python
template_edit_pl optional View template of edition
template_edit_en optional Category code. Default is "STUD".
template_view_pl optional Category code. Default is "STUD".
template_view_en optional Category code. Default is "STUD".
template_print_pl optional Category code. Default is "STUD".
template_print_en optional Category code. Default is "STUD".
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.3.0-0, 51dd8c6b, dirty (2024-04-02)