|
Visibility of opinion for student
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| change_giving_opinion | Change person giving opinion. (administrative) |
| create | Create opinion to eform. (administrative) |
| delete | Delete opinion to eform. (administrative) |
| get_frontend_data | Get opinion to eform for administrative purpose (skips authorization). (administrative) |
| get_opinion | Get opinion to eform for administrative purpose (skips authorization). (administrative) |
| opinion | Get opinion to eform. (administrative) |
| save_visibility | Setting visibility of opinion. (administrative) |
| submit | Submit contents of opinion to eform. (administrative) |
| update_comment | Update private comment in opinion to eform. (administrative) |
services/eforms/opinions/change_giving_opinion ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/opinions/change_giving_opinion | ||||||
|
| ||||||
| opinion_id | required |
Required id of a request to submit opinion (DZ_OPINIE_PODAN.ID). |
||||
| eform_guid | required |
Required guid of an eform to which the files belong to. |
||||
| user_id | required |
Required id of a person reponsible for submitting opinion. |
||||
| 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. |
||||
| opinion_person_id | optional |
Id of a person who is requested to submit opinion. |
||||
| role_code | optional |
Required code of a role requested to submit opinion. |
||||
| optional |
Required email of a person submitting external opinion. |
|||||
| comment_priv | optional |
Optional comment value to be updated. |
||||
| max_attachments | optional |
Allow attachments number optional parameter. |
||||
| 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='SUCCESS'` indicating success of the operation and the updated version of the opinion. | ||||||
services/eforms/opinions/create ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/opinions/create | ||||||
|
| ||||||
| eform_guid | required |
Required guid of an eform to which the files belong to. |
||||
| user_id | required |
Required id of a person reponsible for submitting opinion. |
||||
| fields | optional |
Default value: message|opinion Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
| opinion_person_id | optional |
Id of a person who is requested to submit opinion. |
||||
| role_code | optional |
Required code of a role requested to submit opinion. |
||||
| opinion_template | optional |
Default content of the opinion. |
||||
| print_opinion | optional |
Determines if th eopinion should be printed. |
||||
| published_to_student | optional |
Determines if the opinion should be published to student. Default: False |
||||
| share | optional |
Should the opinion contents be shared for the reviewer. Default: False |
||||
| optional |
External email where the invitation to submit opinion review was sent. |
|||||
| comment_priv | optional |
A private comment available to opinioning person, servicinig and deciding. |
||||
| max_attachments | optional |
Allow attachments number optional parameter. |
||||
| 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: Newly created opinion. | ||||||
services/eforms/opinions/delete ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/opinions/delete | ||||||
|
| ||||||
| opinion_id | required |
Required id of a request to submit opinion (DZ_OPINIE_PODAN.ID). |
||||
| eform_guid | required |
Required guid of an eform to which the files belong to. |
||||
| user_id | required |
Required id of a person reponsible for submitting opinion. |
||||
| 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: Deleteing opinion. | ||||||
services/eforms/opinions/get_frontend_data ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/opinions/get_frontend_data | ||||||
|
| ||||||
| eform_guid | required |
Required eform guid for the frontend data should be returned. |
||||
| kind | required |
Required kind of frontend data to be returne. Supported valuesa are: `ADD_OPINION`. |
||||
| 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: Depending on the kind of data. When 'kind' == 'ADD_OPINION'
{
"message": "SUCCESS",
"templates": [{
"id": a unique id of template,
"name_pl": ...
"name_en": ...
"opinion_type": "TEXT", "TEMPLATE", "TEMPLATE_ID",
"opinion": {
"edit_pl", ...
"edit_en", ...
"view_pl", ...
"view_en", ...
"text_pl", ...
"text_en", ...
} or {
"plaintext_pl", ...
"plaintext_en", ...
}
}],
"statuses": [
{
"code": ...,
"name_pl": ...,
"name_en": ....
}
]
}
| ||||||
services/eforms/opinions/get_opinion ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/opinions/get_opinion | ||||||
|
| ||||||
| 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. |
||||
| opinion_id | optional |
Required id (or opinion_token) of a request to submit opinion (DZ_OPINIE_PODAN.ID). |
||||
| opinion_token | optional |
Required token (or opinion_id) of request to submit opinion (DZ_OPINIE_PODAN.TOKEN). |
||||
| 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: Opinion of the eform. | ||||||
services/eforms/opinions/opinion ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/opinions/opinion | ||||||
|
| ||||||
| eform_guid | required |
Required guid of an eform to which the files belong to. |
||||
| 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. |
||||
| user_id | optional |
Required id of a person reponsible for submitting opinion. |
||||
| opinion_id | optional |
Required id (or opinion_token) of a request to submit opinion (DZ_OPINIE_PODAN.ID). |
||||
| opinion_token | optional |
Required token (or opinion_id) of request to submit opinion (DZ_OPINIE_PODAN.TOKEN). |
||||
| role_code | optional |
Optional code of a role of a person updating the eform. |
||||
| 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: Opinion of the eform. | ||||||
services/eforms/opinions/save_visibility ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/opinions/save_visibility | ||||||
|
Setting visibility of opinion. | ||||||
| user_id | required | Required id of a person reponsible for setting visibility. | ||||
| opinion_id | required | Id of eform. | ||||
| visible_to_student | optional | The visibility of the opinion to student to save. | ||||
| visible_on_printout | optional | The visibility of the opinion on the printout of the eform. | ||||
| 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/opinions/submit ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/opinions/submit | ||||||
|
| ||||||
| eform_guid | required |
Required guid of an eform to which the files belong to. |
||||
| content | required |
The textual content of the opinion. |
||||
| 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. |
||||
| opinion_id | optional |
Required id of a request to submit opinion (DZ_OPINIE_PODAN.ID). |
||||
| user_id | optional |
Required id of a person reponsible for submitting opinion or public token. |
||||
| token | optional |
Required public token or id of a person reponsible for submitting opinion. |
||||
| role_code | optional |
Required code of a role of a person updating the eform. |
||||
| published_to_student | optional |
Determines if the opinion should be published to student. Default: False |
||||
| host | optional |
Optional host address or name of a user. |
||||
| username_external | optional |
Optional first and last name of a user submitting the opinion. |
||||
| comment_priv | optional |
A private comment available to opinioning person, servicinig and deciding. |
||||
| 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 of opinion saving. | ||||||
services/eforms/opinions/update_comment ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/opinions/update_comment | ||||||
|
| ||||||
| user_id | required |
Required id of th euser updating the comment. |
||||
| opinion_id | required |
Required id of a request to submit opinion (DZ_OPINIE_PODAN.ID). |
||||
| comment_priv | required |
Required comment value to be updated. |
||||
| 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: Update a private opinion comment. | ||||||