Student Forms and Processes Templates
:: services/eforms/templates module

These API methods allow you to administer various templates used in the eforms module.

Methods

delete Delete eform template. (administrative)
get_for_edit Return data for editing a template. (administrative)
list_for_edit Return eform templates for editing. (administrative)
update Create or update eform template. (administrative)

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

Delete eform template.

user_id required Required id of a person reponsible for deleting the template.
id required Required id of a template 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/templates/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/templates/get_for_edit

Return data for editing a template.

user_id required

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

id optional Optional ID of a template
code optional Optional code of a template
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/templates/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/templates/list_for_edit

Return eform templates for editing.

user_id required Id of a user displaying list
name_or_desc optional Template name or description
template_type optional Type of templates. Accepted: "OP" or "ROZ" or "EMAIL". (Deafult: None)
category optional Category code. Default is "STUD". Accepted: "STUD" or "PRAC" or "DOKT"
active optional Should show only active templates. Default: None meaning show all.
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 template entries...

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

Update fields of a template:

The parameter `id` is required.

user_id required

Required id of a person reponsible for updating template.

name required Name of template to be created.
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.

id optional Optional id of the template to be updated (if null then a new one will be created)

code optional Optional code of the template. Some template codes are required for EForm module.
description optional Descrption of template to be created.
category optional Category code. Default is "STUD".
template_type optional Type of template to be created. Default is "OP".
active optional Set the activity flag of the template. Default is True.
metadata optional

A JSON object representing the temeplate. The template content depends on th etemplate type.

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)