|
Student Forms and Processes Calendars Admin
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| calendar | Return eform calendar. (administrative) |
| eform_calendar_delete | Delete eform calendar entry. (administrative) |
| eform_calendar_for_edit | Return calendar entries for eform documents. (administrative) |
| eform_calendar_update | Create or update eform calendar entry. (administrative) |
| eform_calendars_for_edit | Return calendar entries for eform documents. (administrative) |
| get_editable_parameters | Return editable parameters for calendar. (administrative) |
| list_study_programmes | List programs matching a study program code patterns list. (administrative) |
| list_study_stages | List stages matching a study stages code patterns list. (administrative) |
services/eforms/calendars/calendar ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/calendars/calendar | ||||||
|
Return eform calendar. | ||||||
| calendar_id | optional | If of a calendar to be returned | ||||
| fields | optional |
Default value: item 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 envelope with the item calendar entry. | ||||||
services/eforms/calendars/eform_calendar_delete ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/calendars/eform_calendar_delete | ||||||
|
Delete eform calendar entry. | ||||||
| user_id | required |
Required id of a person reponsible for updating attachments. |
||||
| id | required |
Optional id of the eform calendar item to be updated. If null then a new item will be created. |
||||
| 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/calendars/eform_calendar_for_edit ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/calendars/eform_calendar_for_edit | ||||||
|
Return calendar entries for eform documents. | ||||||
| user_id | required | Id of user reuesting data to edit | ||||
| category | optional | Category code. Default is "STUD". | ||||
| id | optional | EForm calendar id | ||||
| fields | optional |
Default value: item|message|processes 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 calendar entries... | ||||||
services/eforms/calendars/eform_calendar_update ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/calendars/eform_calendar_update | ||||||
|
Update fields of an eform calendar: If the passed parameter `id` will be None then a new item will be created and the new id will be returned in the response. | ||||||
| user_id | required |
Required id of a person reponsible for updating attachments. |
||||
| data | required |
A JSON object containg atributes of a new item to be updated. Only passed fields will be updated. Expected structure example:
{
'description_pl': '...',
'description_en': '...',
'from_date': '2022-06-06'| null,
'to_date': '2022-06-06' | null,
'cycle_code': '2022L',
'eform_type_code': '1040-PD-150',
'type': 'SK',
'org_unit_code': '1040',
'metadata': '...',
'study_programme_codes': ['....', '....'],
'study_stage_codes': ['....', '....'],
'process_id': '...'
'addressee_pl': '...'
'addressee_en': '...',
'decision_role_code': '...',
'processing_person_id': '...',
'org_unit_submitter_code': '10000000'
}
|
||||
| fields | optional |
Default value: message|eform_calendar_id Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section. |
||||
| id | optional |
Optional id of the eform calendar item to be updated. If null then a new item will be created. |
||||
| 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/calendars/eform_calendars_for_edit ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/calendars/eform_calendars_for_edit | ||||||
|
Return calendar entries for eform documents. | ||||||
| user_id | required | Id of user displaying list | ||||
| org_unit_code | required | Code of organisation unit | ||||
| eform_code | optional | Code of eform type | ||||
| from_date | optional | Starting day for which the eform should be active | ||||
| to_date | optional | End day for which the eform should be active | ||||
| cycle_code | optional | teaching cycle code (usually academic semester) | ||||
| cycle_code_with_null | optional | True / false indicating if the null cycles shoud be included | ||||
| category | optional | Category code. Default is "STUD". | ||||
| eform_code_or_name | optional | Pattern matched to eform code or eform name with ilike option. | ||||
| 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 calendar entries... | ||||||
services/eforms/calendars/get_editable_parameters ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/calendars/get_editable_parameters | ||||||
|
Return editable parameters for calendar. | ||||||
| eform_type_code | required |
Required of eform type for which to return editable parameters. |
||||
| 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. |
||||
| id_calendar | optional |
Optional id of the eform calendar item for which parameters will be extracted. If specified then the process will be explored for embeded tempates to find editable parameters by ADMKAL right. |
||||
| id_process | optional |
Optional id of the process to find editable parameters by ADMKAL right. |
||||
| 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/calendars/list_study_programmes ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/calendars/list_study_programmes | ||||||
|
List programs matching a study program code patterns list. | ||||||
| data | required | A JSON object with structure { "codes": [ "c1", "c2", ... ] } | ||||
| 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/calendars/list_study_stages ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.pw.edu.pl/services/eforms/calendars/list_study_stages | ||||||
|
List stages matching a study stages code patterns list. | ||||||
| data | required | A JSON object with structure { "codes": [ "c1", "c2", ... ] } | ||||
| org_unit_code | required | Code of org units (with subunits) for which to filter stages | ||||
| 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 stages. | ||||||