Calendar
:: services/calendar 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.

Retrieve Intitution calendar

Methods

calendar_event BETA Get event details
search BETA Search for events in calendar

services/calendar/calendar_event

Consumer: required Token: optional Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.pl/services/calendar/calendar_event

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 event details

id required Event id
fields optional

Default value: id|name|start_date|end_date|type|is_day_off

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 and their values.

Available fields:

  • id - A calendar event id;

  • name - LangDict;

  • start_date - A datetime string;

  • end_date - A datetime string;

  • faculty - An associated faculty.

    This field references objects returned by services/fac/faculty method. See its returns section for possible subfields.

  • type - one of following values:

    • rector
    • dean
    • holidays
    • public_holidays
    • exam_session
    • academic_year
    • break
    • links_edit
    • public_holidays
    • undefined
    ;

  • is_day_off - true if day of event is off from classes.

Consumer: required Token: optional Scopes: n/a SSL: required
https://usosapps.demo.usos.edu.pl/services/calendar/search

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 all events for selected faculty and date range not longer than month
faculty_id required ID of faculty that calendar should be returnes
start_date required Events that ends after selected date will be returned
end_date required Events that starts before selected date will be returned.Note that maximal allowed period is one month
fields optional

Default value: id|name|start_date|end_date|type|is_day_off

Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of calendar_event 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:

List of calendar events objects

Thrown errors:

  • object_not_found - some of the referenced objects do not exist;

  • params_invalid - parameters start_date and end_date have invalid values.

    Possible reasons:

    • session_not_found - and_date must follow end_date;

    • too_long_date_range - date range must be not longer than one month.

USOS API ver. 6.5.0.0-7, 9e2c370d, dirty (2019-11-14)