|
Student Eforms User Roles Admin
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| eform_role_user_delete | Delete eform role user assignment entry. (administrative) |
| eform_role_user_for_edit | Return data for editing role user assignment in an organizational unit. (administrative) |
| eform_role_user_update | Create or update eform type entry. (administrative) |
| eform_role_users_for_edit | Return eform user roles entries for editing. (administrative) |
| list_study_programmes_for_org_unit | List programs for specified org unit and subunits. (administrative) |
| user_roles | Return list of roles of a person. (administrative) |
services/eforms/userroles/eform_role_user_delete ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/userroles/eform_role_user_delete | ||||||
|
Delete eform role user assignment entry. | ||||||
| user_id | required | Required id of a person reponsible for deleting the eform type. | ||||
| role_user_id | required | Required id of a person assigned to the role. | ||||
| 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. |
||||
| 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/userroles/eform_role_user_for_edit ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/userroles/eform_role_user_for_edit | ||||||
|
Return data for editing role user assignment in an organizational unit. | ||||||
| user_id | required |
Required id of a person reponsible for requesting data to edit. |
||||
| role_user_id | optional | Optional id of a person assigned to the role. | ||||
| role_code | optional | Optional code of ... | ||||
| org_unit_code | optional | Optional code of ... | ||||
| category | optional | Category of submodule 'STUD','PRAC', 'DOKT'? | ||||
| fields | optional |
Default value: item|roles|org_units|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) if any of key fields are empty, alltogether with the roles and org_units lists.
| ||||||
services/eforms/userroles/eform_role_user_update ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/userroles/eform_role_user_update | ||||||
|
Update fields of an user role assignment: The parameters `role_user_id`, `role_code` and `org_unit_code` are required since they are composing a primary key. | ||||||
| user_id | required |
Required id of a person reponsible for updating attachments. |
||||
| role_user_id | required | Required id of a person assigned to the role. | ||||
| role_code | required | Required code of role... | ||||
| org_unit_code | required | Required code of organizational unit... | ||||
| 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:
{
"notes": "...",
"from_date": "...",
"to_date": "...",
"substitute_user_id": "...",
"substitute_from_date": "...",
"substitute_to_date": "...",
"programme_codes": "...",
"notify": "true/false",
"email": "...", # opcjonalny email, na który mają być wysyłane powiadomienia
}
|
||||
| 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/userroles/eform_role_users_for_edit ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/userroles/eform_role_users_for_edit | ||||||
|
Return eform user roles entries for editing. | ||||||
| user_id | required | Id of a user displaying list | ||||
| org_unit_code | required | Code of organisation unit | ||||
| role_user_id | optional | Id of a user for which to display assigned to him roles | ||||
| role_code_or_name | optional | Code or name of eform role used for ilike | ||||
| substitutes | optional | if None then skipped, else True or False | ||||
| recent | optional | if None then skipped, else True or False | ||||
| 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 user assignment entries... | ||||||
services/eforms/userroles/list_study_programmes_for_org_unit ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/userroles/list_study_programmes_for_org_unit | ||||||
|
List programs for specified org unit and subunits. | ||||||
| org_unit_code | required | Code of org units (with subunits) for which to filter programmes | ||||
| fields | optional |
Default value: items 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 JSON object with collection of matching programmes. | ||||||
services/eforms/userroles/user_roles ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/userroles/user_roles | ||||||
|
Return list of roles of a person. | ||||||
| user_id | required | User ID of a person for the list of roles should be returned. | ||||
| full | optional | If true then full information will be returned, otherwise only code, org_unit_code and if a role is an substitute. | ||||
| fields | optional |
Default value: roles 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 object containing collection of roles. | ||||||