|
Accessing data on faculties and departments
|
factsheet_get | Retrieve faculty's factsheet |
faculties | Get information on mulitple faculties. |
faculty | Get information on a given faculty. |
resolve_facpattern | Resolve facpattern value into a list of faculty IDs. |
search | Search among faculties. |
subfaculties_deep | Get all descendant faculty IDs. |
services/fac/factsheet_get ¶
|
||||||
https://usosapps.amu.edu.pl/services/fac/factsheet_get | ||||||
Retrieve faculty's factsheet | ||||||
fac_id | required | ID of the faculty | ||||
No additional OAuth arguments are required. If you provide any, they will be ignored. | ||||||
Returned value: Either a PDF file (with a valid Content-Type header), or a HTTP 4xx error response. |
services/fac/faculties ¶
|
||||||
https://usosapps.amu.edu.pl/services/fac/faculties | ||||||
Get information on mulitple faculties.
| ||||||
fac_ids | required | Pipe-separated list of faculty IDs. | ||||
fields | optional |
Default value: id|name Pipe-separated list of fields you're interested in. This must be a subset of keys described in the faculty 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 optional 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 dictionary with your fac_ids mapped to its keys. The value for a specific key depends whether it exists or not.
|
services/fac/faculty ¶
|
||||||
https://usosapps.amu.edu.pl/services/fac/faculty | ||||||
Get information on a given faculty.
| ||||||
fac_id | required | ID of the faculty. If it doesn't exist, you will get a HTTP 400 error. | ||||
fields | optional |
Default value: id|name Pipe-separated list of fields you're interested in. This must be a subset of keys 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 optional 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 dictionary of the fields you have supplied in your fields parameter. Available fields are:
|
services/fac/resolve_facpattern ¶
|
||||||
https://usosapps.amu.edu.pl/services/fac/resolve_facpattern | ||||||
This method allows the caller to "select" a set of faculties with help of a specially formatted string called a "facpattern". Other USOS API methods may make use of this method whenever they want their users to use facpatterns. This method serves as the primary location for facpattern's documentation. Facpattern is a string of pipe-separated "facpattern entries". Each of these entries consists of a single character prefix (described below), followed by a faculty ID (which MUST refer to an existing faculty). Depending on the prefix, different sets of faculties are added to the final result. Currently allowed prefixes are:
For example, Also note, that root faculty can be found via the institution field of the installation method. Using this ID with the "+" prefix will allow you to select all faculties. | ||||||
facpattern | required | The pattern, as desribed in the method above. | ||||
Plus optional 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 faculty IDs which matched the given pattern. If any of the facpattern entries refers to a non-existent faculty, USOS API will respond with a HTTP 400 error. |
services/fac/search ¶
|
||||||
https://usosapps.amu.edu.pl/services/fac/search | ||||||
Search for faculties matching given query and conditions. By default, this method will search among only such faculties which were marked as "publicly visible". See visibility parameter. | ||||||
lang | required | Code of the preferred language. This usually should match the language of your user interface. | ||||
query | required | The query to search with. Part of faculty's name or code, etc. | ||||
fields | optional |
Default value: id|match Pipe-separated list of fields. All fields described in the faculty method are allowed plus one more:
|
||||
visibility | optional |
Default value: public One of the following values:
|
||||
num | optional |
Default value: 6 The number of search results to return. The maximum allowed value of num is 20. |
||||
start | optional |
Default value: 0 Indicates the first matching search result that should be included in the response. This parameter uses a zero-based index, meaning the first result is 0, the second result is 1 and so forth. Note, that no more than 100 search results will ever be returned for any query, even if more than 100 matches were found. If you need more, than probably you're looking at a wrong method. Contact us if you're not sure. |
||||
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. Plus optional oauth_token for Token authorization. | ||||||
Returned value: A dictionary of the following structure:
|
services/fac/subfaculties_deep ¶
|
||||||
https://usosapps.amu.edu.pl/services/fac/subfaculties_deep | ||||||
Get the list of all descendant faculty IDs of a given faculty.
| ||||||
fac_id | required | ID of the faculty. | ||||
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 strings - all descendant faculty IDs of the given faculty (the root faculty is not included). |