|
Accessing API documentation
|
method | Get information on a given USOS API method. |
method_index | Get a list of USOS API methods with brief descriptions. |
module | Get information on a given USOS API module. |
scopes | Get a list of all available scopes. |
services/apiref/method ¶
|
||||||
https://usosapps.demo.usos.edu.pl/services/apiref/method | ||||||
Get information on a given USOS API method.
| ||||||
name | required | Name of a method (begins with "services/"). | ||||
fields | optional |
Default value: (most of them) Pipe-separated list of fields which you are interested in. Initially, this method did not take the fields parameter. That's why, for backwards compatibility, all the fields which were exposed by this method before the fields parameter was added, are now also included by default. |
||||
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 optional 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 requested fields. Allowed fields include:
|
services/apiref/method_index ¶
|
||||||
https://usosapps.demo.usos.edu.pl/services/apiref/method_index | ||||||
Get a list of USOS API methods with brief descriptions.
| ||||||
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. | ||||
No additional OAuth arguments are required. If you provide any, they will be ignored. | ||||||
Returned value: A list of dictionaries, each of which contains one API method description in the following format:
|
services/apiref/module ¶
|
||||||
https://usosapps.demo.usos.edu.pl/services/apiref/module | ||||||
Get information on a given USOS API module. Modules are like folders - they group methods and other modules related to one topic. | ||||||
name | required | Name of a module (begins with "services/"). | ||||
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. | ||||
No additional OAuth arguments are required. If you provide any, they will be ignored. | ||||||
Returned value: A dictionary of the following structure:
|
services/apiref/scopes ¶
|
||||||
https://usosapps.demo.usos.edu.pl/services/apiref/scopes | ||||||
Get a list of all scopes which are available in this USOS API installation. Note, that if you want to determine if a specific installation supports some functionality, you may also refer to its version string (see services/apisrv/installations 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. | ||||
No additional OAuth arguments are required. If you provide any, they will be ignored. | ||||||
Returned value: A list od dictionaries, each of the following structure:
|