|
Student Forms and Processes Roles Admin
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| delete | Delete eform role. (administrative) |
| get_for_edit | Return data for editing role. (administrative) |
| list | Return eform roles entries. (administrative) |
| list_for_edit | Return eform user roles entries for editing. (administrative) |
| update | Create or update eform role. (administrative) |
| users_with_role_in_orgunit | List users with role in org unit. (administrative) |
services/eforms/roles/delete ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/roles/delete | ||||||
|
Delete eform role. | ||||||
| user_id | required | Required id of a person reponsible for deleting the eform role. | ||||
| role_code | required | Required code of ... | ||||
| 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/roles/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/roles/get_for_edit | ||||||
|
Return data for editing role. | ||||||
| user_id | required |
Required id of a person reponsible for requesting data to edit. |
||||
| role_code | optional | Optional code of ... | ||||
| 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/roles/list ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/roles/list | ||||||
|
Return eform roles entries. | ||||||
| role_code_or_name | optional | Code or name of eform role used for ilike | ||||
| category | optional | Category code. Default is "STUD". | ||||
| non_admin_only | optional | If true (default) the only non administrative roles will be returned. | ||||
| 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 role entries... | ||||||
services/eforms/roles/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/roles/list_for_edit | ||||||
|
Return eform user roles entries for editing. | ||||||
| user_id | required | Id of a user displaying list | ||||
| role_code_or_name | optional | Code or name of eform role used for ilike | ||||
| category | optional | Category code. Default is "STUD". | ||||
| 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 role entries... | ||||||
services/eforms/roles/update ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/roles/update | ||||||
|
Update fields of a role: The parameter `role_code` is required. | ||||||
| user_id | required |
Required id of a person reponsible for updating attachments. |
||||
| role_code | required | Required code of ... | ||||
| 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:
{
"name_pl": "...",
"name_en": "...",
"description_pl": "...",
"description_en": "...",
"role_type": "...",
"rights": ["CODE1","CODE2",....]
}
|
||||
| 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. |
||||
| category | optional | Category code. Default is "STUD". | ||||
| 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/roles/users_with_role_in_orgunit ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/roles/users_with_role_in_orgunit | ||||||
|
List users with role in org unit. | ||||||
| role_code | required | Required code of ... | ||||
| org_unit_code | required | Required code of ... | ||||
| 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. |
||||
| category | optional | Category code. Default is "STUD". | ||||
| 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 | ||||||