Student Forms - bulk operations
:: services/eforms/operations module

These API methods allow you to search eforms and execute a predifined set of operations.

Methods

list_operations Return available operations to be executed. (administrative)
process Exeutes a given operation on a collection of eforms provided as a list of guids. (administrative)
search Return eforms filtered by criteria. (administrative)

services/eforms/operations/list_operations

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/operations/list_operations

Return available operations to be executed.

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 available operations to be taken...

services/eforms/operations/process

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/operations/process

Exeutes a given operation on a collection of eforms provided as a list of guids.

user_id required Id of a user who executes the operation.
operation_code required A code of operation (should be from a list returned by list_operations)
guids required Guids for which the operation should be executed
arguments optional List of arguments with stringular represantation of the arguments. The apropriate operation will cast the strings to required data types.
fields optional

Default value: msg|guids

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 operaion or error...

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/operations/search

Return eforms filtered by criteria.

guid optional Code or name of eform used for ilike
eform_type optional Type of eform
mod_date_from optional Starting day and time for which the eform should be filtered
mod_date_to optional End day and time for which the eform should be filtered
sub_date_from optional Starting day and time for which the eform should be filtered
sub_date_to optional End day and time for which the eform should be filtered
processing_user_id optional Id of modifier
eform_user_id optional Id of submitter
org_unit_code optional Code of organisation unit
eform_status optional Status of eform
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 filtered eform logs...

USOS API ver. 7.0.3.0-0, 51dd8c6b, dirty (2024-04-02)