Student Forms - Comments management
:: services/eforms/comments module

These API methods allow to remember templates and comment eforms.

Methods

add_template Add comment template (administrative)
delete_template Delete comment template (administrative)
list_templates List comments template (administrative)
update_comments Updates comments of an eform. (administrative)

services/eforms/comments/add_template

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/comments/add_template

Add comment template

user_id required User id of the person updating status
comment_type required Type of the comment template to add. (eg.: public, private, answer, answer_motivation)
comment required The comment contents
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:

An updated eform.

services/eforms/comments/delete_template

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/comments/delete_template

Delete comment template

user_id required User id of the person updating status
comment_type required Type of the comment template to add. (eg.: public, private, answer, answer_motivation)
comment required The comment contents 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:

An updated eform.

services/eforms/comments/list_templates

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/comments/list_templates

List comments template

user_id required User id of the person for which templates should be returned
comment_type required Type of the comment template to list. (eg.: public, private, answer, answer_motivation)
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 JSON object with a list of templates in form:

{
    "items": ["....", "...."]
}

services/eforms/comments/update_comments

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/comments/update_comments

Updates comments of an eform.

user_id required User id of the person updating status
guid required GUID of the form to be returned
comments required A dictionary like JSON object with comments to be updated. The json object is expected to have the following structure, where the fields are optional:
{
    'private': 'some internal comment unvisible to student...',
    'public': 'some comment available to student...',
    'answer': 'some deans decision... (odpowiedz dziekana)',
    'motivation': 'some deans decision motivation... (uzasadnienie)',
}
fields optional

Default value: item

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 updated eform.

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