|
University guide
|
chapter | Get a single university guide chapter info. |
chapters | Get guide chapters. |
entries | Get guide entries by its ids. |
entry | Get a single university guide entry. |
guide | Get whole guide structure. |
page | Get a single university guide page. |
pages | Get guide pages by its ids. |
services/guide/chapter ¶
|
||||||
https://usosapps.demo.usos.edu.pl/services/guide/chapter | ||||||
This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can. Allows to get an university guide chapter by its id. | ||||||
chapter_id | required | Id of the guide chapter. You may think of chapters as of categories that group pages on similar topic. | ||||
lang | optional |
Default value: pl A code of the preferred language ("pl" or "en"). It may influence the order of pages in the chapter. |
||||
fields | optional |
Default value: id|title 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 dictionary of selected fields:
|
services/guide/chapters ¶
|
||||||
https://usosapps.demo.usos.edu.pl/services/guide/chapters | ||||||
This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can. Get university guide chapters by its ids. You may think of chapters as of categories that group pages on similar topic. | ||||||
chapter_ids | required | Pipe-separated list of guide chapter ids as described in chapter method. | ||||
lang | optional |
Default value: pl A code of the preferred language ("pl" or "en"). It may influence the order of pages in the chapter. |
||||
fields | optional |
Default value: id|title Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of chapter 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. Plus optional oauth_token for Token authorization. | ||||||
Returned value: A dictionary that will map your chapter_ids to chapter objects, as defined in the chapter method. |
services/guide/entries ¶
|
||||||
https://usosapps.demo.usos.edu.pl/services/guide/entries | ||||||
This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can. Get university guide entries by its ids. | ||||||
entry_ids | required | Pipe-separated list of guide page ids as described in page method. | ||||
lang | optional |
Default value: pl A code of the preferred language ("pl" or "en"). It may influence the order of data returned. |
||||
fields | optional |
Default value: id|title Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of entry 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. Plus optional oauth_token for Token authorization. | ||||||
Returned value: A dictionary that will map your entry_ids to entry objects, as defined in the entry method. |
services/guide/entry ¶
|
||||||
https://usosapps.demo.usos.edu.pl/services/guide/entry | ||||||
This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can. Allows to get an university guide entry (the smallest piece of information) by its id. | ||||||
entry_id | required | Id of the guide entry. | ||||
lang | optional |
Default value: pl A code of the preferred language ("pl" or "en"). It may influence the order of data returned. |
||||
fields | optional |
Default value: id|title 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 dictionary of selected fields:
|
services/guide/guide ¶
|
||||||
https://usosapps.demo.usos.edu.pl/services/guide/guide | ||||||
This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can. Get university guide structure. | ||||||
lang | required |
A code of the preferred language ("pl" or "en"). |
||||
fields | optional |
Default value: id|title|pages[id|title] Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of chapter 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. Plus optional oauth_token for Token authorization. | ||||||
Returned value: A list of chapter objects ( as defined in the chapter method) in order you should place them in your menu or on a page. |
services/guide/page ¶
|
||||||
https://usosapps.demo.usos.edu.pl/services/guide/page | ||||||
This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can. Allows to get an university guide page by its id. | ||||||
page_id | required | Id of the guide page. | ||||
lang | optional |
Default value: pl A code of the preferred language ("pl" or "en"). It may influence the order of entries on the page. |
||||
fields | optional |
Default value: id|title 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 dictionary of selected fields:
|
services/guide/pages ¶
|
||||||
https://usosapps.demo.usos.edu.pl/services/guide/pages | ||||||
This is a BETA method. We're looking for beta-testers. Until we find them, there's a substantial probability it won't stay backwards-compatible! If you are planning on using this method, please let us know. Then, we will work with you and move it out of beta as soon as we can. Get university guide pages by its ids. | ||||||
page_ids | required | Pipe-separated list of guide page ids as described in page method. | ||||
lang | optional |
Default value: pl A code of the preferred language ("pl" or "en"). It may influence the order of entries on the page. |
||||
fields | optional |
Default value: id|title Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of page 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. Plus optional oauth_token for Token authorization. | ||||||
Returned value: A dictionary that will map your page_ids to page objects, as defined in the page method. |