Feedback reporting
:: services/feedback module

This is a BETA module. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this module, please let us know. Then, we will work with you and move it out of beta as soon as we can.

This is an experimental module which contains methods which receive (and otherwise process) feedback reports from the users.

Methods

report_db BETA Report invalid data in USOS database.
status BETA Get the module status.

services/feedback/report_db

Consumer: required Token: optional Scopes: n/a SSL: not required
https://usosapps.uni.opole.pl/services/feedback/report_db

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

Report feedback from the user, regarding invalid (or outdated) data in the USOS database. User's feedback will be logged, and might help to fix the errors later.

This is an experimental feature. There's a big chance that this method will be either removed, or changed in a backward incompatible way (e.g. we may require captchas).

Before you use this method, please make sure that the module is enabled - see the status method.
user_form required

JSON-encoded list of dictionaries. These dictionaries represent user inputs present in the feedback form, that the user has submitted. The list can be empty, but usually it should contain at least element (user's comment).

Each dictionary has two fields:

  • title - string, the title of the field, exactly as displayed to the user (in the language the user was seeing it at the time the form was submitted). Usually these titles are presented as questions for the user (e.g. "What's wrong with this address?", "What is the correct value of this field?").
  • value - string, the answer that the user has supplied (can be empty).
meta required

JSON-encoded object. It may contain any data you want. The format of this object is currently left undocumented, but some of the keys are recommended. You should include at least such data which would enable the report reader to pinpoint the entity the user is reporting.

Some example meta keys:/p>

  • feedback_type - e.g. "invalid-building-address",
  • building_id, user_id, course_id or any other ID of the entity the user is reporting to be invalid,
  • displayed_value - the value of the field, that the user is reporting to be invalid, exactly as it was displayed to the user,
  • url - URL which may enable the report reader to see what the user had seen,
  • comment - additional comment supplied by the developer (preferably in Polish, as it is probably this language that the report reader will understand best).
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:

If the report has been successfully stored, {"success": true} will be returned.

In case of error, you should check the user_messages field and display the proper message for the user.

services/feedback/status

Consumer: ignored Token: ignored Scopes: n/a SSL: not required
https://usosapps.uni.opole.pl/services/feedback/status

This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can.

This module is in early BETA state. As such, it is not enabled by default. You should allowed the users to submit feedback only when it is enabled!
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.
No additional OAuth arguments are required. If you provide any, they will be ignored.

Returned value:

A dictionary of the following format:

  • enabled - boolean, true if the module is enabled, and there is a chance that the submitted reports are read by someone.
USOS API ver. 7.1.0.0-4, 0e1fe7fc, dirty (2024-08-27)