|
Student Forms and Processes Statuses Admin
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| delete | Delete eform status. (administrative) |
| get_for_edit | Return data for editing status. (administrative) |
| list_for_edit | Return eform statuses for editing. (administrative) |
| update | Create or update eform status. (administrative) |
services/eforms/statuses/delete ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/statuses/delete | ||||||
|
Delete eform status. | ||||||
| user_id | required | Required id of a person reponsible for deleting the eform status. | ||||
| 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. |
||||
| status_id | optional | Optional id of status to edit | ||||
| code | optional | Optional code of status to edit | ||||
| 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/statuses/get_for_edit ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/statuses/get_for_edit | ||||||
|
Return data for editing status. | ||||||
| user_id | required |
Required id of a person reponsible for requesting data to edit. |
||||
| status_id | optional | Optional id of status to edit | ||||
| code | optional | Optional code of status to edit | ||||
| fields | optional |
Default value: item|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 item to be edited (can be null).
| ||||||
services/eforms/statuses/list_for_edit ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/statuses/list_for_edit | ||||||
|
Return eform statuses for editing. | ||||||
| user_id | required | Id of a user displaying list | ||||
| code_or_description | optional | Code or description of eform status (using ilike) | ||||
| process_code | optional | A pattern matching the procedure code (using ilike) | ||||
| start | optional | first record to return | ||||
| num | optional | maximum number of records to return | ||||
| fields | optional |
Default value: items|total 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 list of eform statuses entries... | ||||||
services/eforms/statuses/update ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/statuses/update | ||||||
|
Update fields of a status: The parameter `status_id` or `code` is required. | ||||||
| user_id | required |
Required id of a person reponsible for updating attachments. |
||||
| data | required |
A JSON object containg atributes of a new item or the one to be updated. Only passed fields will be updated. Expected structure example:
{
"code": ..., # KOD
"name_pl": ..., # OPIS
"name_en": ..., # OPIS_ANG
"description_pl": ..., # INSTRUKCJA
"description_en": ..., # INSTRUKCJA_ANG
"type": ..., # TYP_STATUSU
"owner_can_read": true/false, # WLASCICIEL_ODCZYT
"owner_can_modify": true/false, # WLASCICIEL_ZMIANA
"metadata": ..., # METADANE
"role_responsible_code": ..., # ROLA_ODPOWIEDZIALNA
"notify_role_by_email": true/false, # CZY_EMAIL_ROLA
"notify_role_email_pl": ..., # ROLA_EMAIL_SZABLON
"notify_role_email_en": ..., # ROLA_EMAIL_SZABLON_ANG
"notify_owner_by_email": true/false, # CZY_EMAIL_WLASCICIEL
"notify_owner_email_pl": ..., # WLASC_EMAIL_SZABLON
"notify_owner_email_en": ..., # WLASC_EMAIL_SZABLON_ANG
"button_label_pl": ..., # ETYKIETA_PRZYCISKU
"button_label_en": ..., # ETYKIETA_PRZYCISKU_ANG
"confirmation_question_pl": ..., # POTWIERDZENIE_PRZYCISKU
"confirmation_question_en": ..., # POTWIERDZENIE_PRZYCISKU_ANG
"required_fields": ..., # WYMAGANE_POLA
"automatization": ... # AUTOMATYZACJA
"is_considered": ... # CZY_ROZPATRZONE
"is_closed": ... # CZY_ZAMKNIETE
"decision_type": ... # TYP_ROZSTRZYGNIECIA
}
|
||||
| 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. |
||||
| status_id | optional | Optional id of status to edit | ||||
| code | optional | Optional code of status to edit | ||||
| 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 | ||||||