Student Applications Rendering Enginge
:: services/eforms/renderer module

These API methods allow you to render content to html.

Methods

foredit Return rendered edit template. (administrative)
forvalidate Return information if validation was passed successfully. (administrative)
forview Return rendered view template. (administrative)
parameters Return collection of editable filed for specified rights as a list. (administrative)

services/eforms/renderer/foredit

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/renderer/foredit

Return rendered edit template.

template required

Required template to be rendered.

data required Required data of to be feeded to the template

rights optional Optional right which editing is rendered. If the editable field skips the 'rights' key, then the field rendered as editable ignoring the passed right.
fields optional

Default value: html|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 rendered in HTML content.

services/eforms/renderer/forvalidate

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/renderer/forvalidate

Return information if validation was passed successfully.

template required

Required template to be validated.

data required Required data of to be feeded to the template

rights optional Optional right which editing is rendered. If the editable field skips the 'rights' key, then the field rendered as editable ignoring the passed right.
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:

A status message with validation result.

services/eforms/renderer/forview

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/renderer/forview

Return rendered view template.

template required

Required template to be rendered.

data required Required data of to be feeded to the template

br optional

Default value: true

Should the new lines be replaced with br? Default: true.

fields optional

Default value: html|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 rendered in HTML content.

services/eforms/renderer/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/renderer/parameters

Return collection of editable filed for specified rights as a list.

template required

Required template from which is parsed to find editable parameters.

rights required

Required template to be rendered.

data optional Optional data dictionary to find current values of editable parameters.
fields optional

Default value: html|message

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of forview method.

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 collection of editable parameters.

USOS API ver. 6.8.0.0-5, 56083cef, dirty (2022-12-14)