|
Access and signing statements
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| awaiting_statements | Get all awaiting statement declarations. (administrative) |
| statement | Get information of a single statement. (administrative) |
| statement_declaration | Get single statement declaration. (administrative) |
| statement_declarations | Get information of a multiple statement declarations. (administrative) |
| statements | Get information of a multiple statements. (administrative) |
| user_statements | Get all statement declarations for user. (administrative) |
| user_status | Check if user has all required declarations and is allowed to use USOS. (administrative) |
services/statements/awaiting_statements ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.uj.edu.pl/services/statements/awaiting_statements | ||||||
|
Get all awaiting statement declarations. | ||||||
| user_id | required | ID of user | ||||
| fields | optional |
Default value: id Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of statement_declaration method. |
||||
| 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. Token is not required. | ||||||
|
Returned value: List of statement declarations, as defined in the statement_declaration method. | ||||||
services/statements/statement ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.uj.edu.pl/services/statements/statement | ||||||
|
Get information of a single statement. Note that either | ||||||
| statement_id | optional | ID of the statement | ||||
| statement_code | optional | code of the statement | ||||
| version | optional | version of the statement | ||||
| fields | optional |
Default value: id|title|content 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. Token is not required. | ||||||
|
Returned value: A dictionary of selected fields and their values. Available fields:
| ||||||
|
Thrown errors:
| ||||||
services/statements/statement_declaration ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.uj.edu.pl/services/statements/statement_declaration | ||||||
|
Get single statement declaration. | ||||||
| declaration_id | required | ID of declaration | ||||
| fields | optional |
Default value: id 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. Token is not required. | ||||||
|
Returned value: A dictionary of selected fields and their values. Available fields:
| ||||||
services/statements/statement_declarations ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.uj.edu.pl/services/statements/statement_declarations | ||||||
|
Get information of a multiple statement declarations. | ||||||
| declaration_ids | required |
Pipe-separated list of declaration IDs. |
||||
| fields | optional |
Default value: id Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of statement_declaration method. |
||||
| 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. Token is not required. | ||||||
|
Returned value: A dictionary: your declaration_ids will be mapped to dictionary's keys, and each value will contain the description of one statement declaration, as defined in the statement_declaration method. For invalid declaration_ids (declarations which do not exist) null will be returned (instead of the declaration object). | ||||||
services/statements/statements ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.uj.edu.pl/services/statements/statements | ||||||
|
Get information of a multiple statements. | ||||||
| statement_ids | required |
Pipe-separated list of statement IDs. |
||||
| fields | optional |
Default value: id|title|content Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of statement method. |
||||
| 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. Token is not required. | ||||||
|
Returned value: A dictionary: your statement_ids will be mapped to dictionary's keys, and each value will contain the description of one statement, as defined in the statement method. For invalid statement_ids (statements which do not exist) null will be returned (instead of the statement object). | ||||||
services/statements/user_statements ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.uj.edu.pl/services/statements/user_statements | ||||||
|
Get all statement declarations for user. | ||||||
| user_id | required | ID of user | ||||
| fields | optional |
Default value: id Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of statement_declaration method. |
||||
| 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. Token is not required. | ||||||
|
Returned value: List of statement declarations, as defined in the statement_declaration method. | ||||||
services/statements/user_status ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
| https://apps.usos.uj.edu.pl/services/statements/user_status | ||||||
|
Check if user has all required declarations and is allowed to use USOS. | ||||||
| user_id | required | ID of user | ||||
| 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. Token is not required. | ||||||
|
Returned value: A dictionary of the following format:
| ||||||