|
Satisfaction surveys
|
fill_out | (deprecated) Post a survey result in the name of a user. |
fill_out2 | Post a survey result in the name of a user. |
survey | (deprecated) Get a single survey. |
survey2 | Get a single survey. |
surveys | (deprecated) Get surveys. |
surveys2 | Get surveys. |
surveys_about_me | (deprecated) Retrieve all surveys "about" the caller. |
surveys_about_me2 | Retrieve all surveys "about" the caller. |
surveys_to_fill | (deprecated) Get the list of surveys waiting to be filled out by the user. |
surveys_to_fill2 | Get the list of surveys waiting to be filled out by the user. |
services/surveys/fill_out ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/surveys/fill_out | ||||||
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 method is deprecated, please avoid using it - read more Suggested replacement: services/surveys/fill_out2 Post a survey result in the name of a user. | ||||||
survey_id | required | ID of the survey. | ||||
answers | required |
A JSON-formatted object, mapping question IDs to their answers: {"question1_id": "possible_answer_id", "question2_id": "possible_answer_id"}. Note, that all values of this objects are strings (because the IDs of possible answers are strings). |
||||
comment | optional |
Default value: (empty string) An optional comment to be submitted along the answer. |
||||
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 required oauth_token for Token authorization. | ||||||
Returned value: An empty dictionary returned if the method has been executed successfully. Some keys may be added in the future. | ||||||
Thrown errors:
|
services/surveys/fill_out2 ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/surveys/fill_out2 | ||||||
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. Post a survey result in the name of a user. | ||||||
survey_id | required | ID of the survey. | ||||
answers | required |
A JSON-formatted object, mapping question IDs to their answers:
{"question1_id": {"answers": ["possible_answer1_id", "possible_answer2_id", ...], "comment": "comment or null"},
"question2_id": ...}
Note, that all values of this objects are strings (because the IDs of possible answers are strings). If comment should be left empty or the question does not allow comments, null has be passed in comment field. |
||||
comment | optional |
Default value: (empty string) An optional comment to be submitted along the answer. Note that this parameter has to be null if the survey does not allow final comment. |
||||
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 required oauth_token for Token authorization. | ||||||
Returned value: An empty dictionary returned if the method has been executed successfully. Some keys may be added in the future. | ||||||
Thrown errors:
|
services/surveys/survey ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/surveys/survey | ||||||
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 method is deprecated, please avoid using it - read more Suggested replacement: services/views/survey2 Deprecation reason: This method does not support some surveys (e.g. surveys with open questions) and will treat them as non-existent. Get a single survey (either general or course survey). | ||||||
survey_id | required |
ID of the survey. You may notice that this ID is constructed from a set of survey attributes, but you should not construct it by yourself, as its structure is subject to change. Use dedicated methods (eg. surveys_to_fill) to obtain proper survey IDs. |
||||
fields | optional |
Default value: id|survey_type|name 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 required oauth_token for Token authorization. | ||||||
Returned value: A dictionary of selected fields:
|
services/surveys/survey2 ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/surveys/survey2 | ||||||
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. Get a single survey (either general or course survey). | ||||||
survey_id | required |
ID of the survey. You may notice that this ID is constructed from a set of survey attributes, but you should not construct it by yourself, as its structure is subject to change. Use dedicated methods (eg. surveys_to_fill) to obtain proper survey IDs. |
||||
fields | optional |
Default value: id|survey_type|name 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 required oauth_token for Token authorization. | ||||||
Returned value: A dictionary of selected fields:
|
services/surveys/surveys ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/surveys/surveys | ||||||
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 method is deprecated, please avoid using it - read more Suggested replacement: services/surveys/surveys2 Deprecation reason: This method does not support some surveys (e.g. surveys with open questions) and will treat them as non-existent. Get general or course surveys. | ||||||
survey_ids | required | Pipe-separated list of survey IDs, as described in survey method. | ||||
fields | optional |
Default value: id|survey_type|name Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of survey 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 required oauth_token for Token authorization. | ||||||
Returned value: A dictionary that will map your survey_ids to survey objects, as defined in the survey method. |
services/surveys/surveys2 ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/surveys/surveys2 | ||||||
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. Get general or course surveys. | ||||||
survey_ids | required | Pipe-separated list of survey IDs, as described in survey2 method. | ||||
fields | optional |
Default value: id|survey_type|name Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of survey2 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 required oauth_token for Token authorization. | ||||||
Returned value: A dictionary that will map your survey_ids to survey objects, as defined in the survey2 method. |
services/surveys/surveys_about_me ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/surveys/surveys_about_me | ||||||
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 method is deprecated, please avoid using it - read more Suggested replacement: services/surveys/surveys_about_me2 Deprecation reason: This method does not support some surveys (e.g. surveys with open questions) and will treat them as non-existent. This method allows the lecturer to retrieve a list of all surveys by which he or she is evaluated. Note that lecturers can be evaluated only the the "course"-type surveys. Hence, all of the returned surveys will always have the type of "course". | ||||||
term_ids | optional |
Default value: (empty string) Pipe-separated list of academic term IDs. If given, then the results will be narrowed down to only such course surveys which refer to course units of specified term_ids. |
||||
fields | optional |
Default value: id|survey_type|name Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of survey 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 required oauth_token for Token authorization. | ||||||
Returned value: List of survey objects, as defined in the survey method. |
services/surveys/surveys_about_me2 ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/surveys/surveys_about_me2 | ||||||
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 method allows the lecturer to retrieve a list of all surveys by which he or she is evaluated. Note that lecturers can be evaluated only the the "course"-type surveys. Hence, all of the returned surveys will always have the type of "course". | ||||||
term_ids | optional |
Default value: (empty string) Pipe-separated list of academic term IDs. If given, then the results will be narrowed down to only such course surveys which refer to course units of specified term_ids. |
||||
fields | optional |
Default value: id|survey_type|name Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of survey2 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 required oauth_token for Token authorization. | ||||||
Returned value: List of survey objects, as defined in the survey2 method. |
services/surveys/surveys_to_fill ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/surveys/surveys_to_fill | ||||||
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 method is deprecated, please avoid using it - read more Suggested replacement: services/surveys/surveys_to_fill2 Deprecation reason: This method does not support some surveys (e.g. surveys with open questions) and will treat them as non-existent. Get the list of surveys waiting to be filled out by the user. | ||||||
include_filled_out | optional |
Default value: false Boolean. "true" if already filled out surveys should be included in results |
||||
fields | optional |
Default value: id|survey_type|name Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of survey 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 required oauth_token for Token authorization. | ||||||
Returned value: List of survey objects, as defined in the survey method. |
services/surveys/surveys_to_fill2 ¶
|
||||||
https://usosapi.panschelm.edu.pl/services/surveys/surveys_to_fill2 | ||||||
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. Get the list of surveys waiting to be filled out by the user. | ||||||
include_filled_out | optional |
Default value: false Boolean. "true" if already filled out surveys should be included in results |
||||
fields | optional |
Default value: id|survey_type|name Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of survey2 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 required oauth_token for Token authorization. | ||||||
Returned value: List of survey objects, as defined in the survey2 method. |