University guide
:: services/guide module

This is a BETA module. 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 module, please let us know. Then, we will work with you and move it out of beta as soon as we can.

These methods allow you to get html views with info about the university divided into categories and subcategories.

Methods

chapter BETA Get a single university guide chapter info.
chapters BETA Get guide chapters.
entries BETA Get guide entries by its ids.
entry BETA Get a single university guide entry.
guide BETA Get whole guide structure.
page BETA Get a single university guide page.
pages BETA Get guide pages by its ids.

services/guide/chapter

Consumer: required Token: optional Scopes: n/a SSL: required
https://api.pwsip.edu.pl/usosapps/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:

  • Primary:

    • id - Id of the guide chapter;

    • title - Title of the guide chapter as a langdict (you can use it eg. as a tab name);

    • pages - Pages that belong to the chapter.

      This field references objects returned by page method. See its returns section for possible subfields.

services/guide/chapters

Consumer: required Token: optional Scopes: n/a SSL: required
https://api.pwsip.edu.pl/usosapps/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

Consumer: required Token: optional Scopes: n/a SSL: required
https://api.pwsip.edu.pl/usosapps/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

Consumer: required Token: optional Scopes: n/a SSL: required
https://api.pwsip.edu.pl/usosapps/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:

  • Primary:

    • id - Id of the guide entry;

    • title - Title of the guide entry;

    • content - Content of the guide page as langdict;

    • page - Page the entry should be placed on. It is used to group entries on the same topic.

      This field references objects returned by page method. See its returns section for possible subfields.

    • image_urls - URLs of the main image for the guide entry.

      URLs of the main image for the guide entry in various dimensions or a set of nulls if this entry does not have a main image. Use the subfield selector to choose the wanted size/dimensions of the image.

      Currently available subfields:

      • original - original version of the image; the exact dimensions are undocumented and depend on the image. Note, that in some rare cases, this image can be actually smaller than the others.

      • 16:9 aspect ratio images

        • 270x152 - 270px x 152px,
        • 360x203 - 360px x 203px,
        • 540x304 - 540px x 304px,
        • 720x405 - 720px x 405px,
        • 1080x608 - 1080px x 608px,
        • 1440x810 - 1440px x 810px,

services/guide/guide

Consumer: required Token: optional Scopes: n/a SSL: required
https://api.pwsip.edu.pl/usosapps/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: pages[id|title]|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

Consumer: required Token: optional Scopes: n/a SSL: required
https://api.pwsip.edu.pl/usosapps/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:

  • Primary:

    • id - Id of the guide page;

    • title - Title of the guide page (you can use it eg. as a tab name);

    • entries - Entries on the page.

      This field references objects returned by entry method. See its returns section for possible subfields.

    • chapter - Chapter of the guide page. It is used to group pages on the similar topics.

      This field references objects returned by chapter method. See its returns section for possible subfields.

services/guide/pages

Consumer: required Token: optional Scopes: n/a SSL: required
https://api.pwsip.edu.pl/usosapps/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.

USOS API ver. 6.4.0.0-15, 9dcd97b9 (2019-02-25)