Student EForm Types
:: services/eforms/types module

These API methods allow you administer eform types.

Methods

eform_type_delete Delete eform type entry. (administrative)
eform_type_for_edit Return calendar entries for eform documents. (administrative)
eform_type_update Create or update eform type entry. (administrative)
eform_types_for_edit Return eform types entries for editing. (administrative)
get_editable_parameters Return editable parameters for eform type. (administrative)
list_valid_processes Return valid processes for eform type. (administrative)

services/eforms/types/eform_type_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/types/eform_type_delete

Delete eform type entry.

user_id required Required id of a person reponsible for deleting the eform type.
code required Required code of the eform type 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/types/eform_type_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/types/eform_type_for_edit

Return calendar entries for eform documents.

user_id required Id of user displaying item to edit
code optional EForm Type code
category optional Category code. Default is "STUD".
fields optional

Default value: item|roles|org_units|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 calendar entries...

services/eforms/types/eform_type_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/types/eform_type_update

Update fields of an eform type:

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

user_id required

Required id of a person reponsible for updating attachments.

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:

            {
                    'code': '...',
                    'name_pl': '...',
                    'addressee_pl': '...',
                    'addressee_en': '...',
                    'addressee_editable': '...',
                    'has_subject': '...',
                    'has_stage': '...',
                    'has_content': '...',
                    'has_list': '...',
                    'information': '...',
                    'is_active': '...',
                    'org_unit_code': '...',
                    'name_en': '...',
                    'information_en': '...',
                    'max_attachments': '...',
                    'min_attachments': '...',
                    'max_open': '...',
                    'template': '...',
                    'template_en': '...',
                    'metadata': '...',
                    'internal_instruction': '...',
                    'case_type': '...',
                    'category': '...',
                    'valid_proc_codes': '...',
                    'modules': ['CODE1','CODE2',...]
            }
            
code required

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

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.

category 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

services/eforms/types/eform_types_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/types/eform_types_for_edit

Return eform types entries for editing.

user_id required Id of user displaying list
org_unit_code required Code of organisation unit
eform_code_or_name optional Code or name of eform type used for ilike
active optional if None then skipped, else True or False
process_id optional id of a process
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|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 eform types entries...

services/eforms/types/get_editable_parameters

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/types/get_editable_parameters

Return editable parameters for eform type.

eform_type_code required

Required of eform type for which to return editable parameters.

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/types/list_valid_processes

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/types/list_valid_processes

Return valid processes for eform type.

eform_type_code required

Required of eform type for which to return valid processes.

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.

for_calendar optional

Should the list be dedicated for calendar? The calendar list also takes into account the list of valid processes for eform type. When false, then all active processes are listed.

category optional

Category, eg. default: '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-1, 76759f3d, dirty (2024-05-13)