|
Accessing activity timetables
|
classgroup | Get activities related to single class group. |
classgroup_dates | Get dates of all activities related to a class group. |
classgroup_dates2 | Get all activities related to a class group. |
classgroups | Get activities related to given class groups. |
course_edition | Get all activities related to a specified course edition. |
course_editions | Get all activities related to specified course editions. |
room | Get activities for a given room. |
staff | Get public staff member's activities. |
student | Get activities related to user's studies. |
upcoming_ical | Get iCalendar file with the user's upcoming events |
upcoming_share | Get the webcal feed of the user's upcoming events |
user | Get all activities related to the user. |
services/tt/classgroup ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/tt/classgroup | ||||||
Get activities related to single class group. Usually one class group meets up once a week
at specified hours, but there's no any real rule for that.
| ||||||
unit_id | required | ID of class group's "parent" course unit. | ||||
group_number | required | Group number of the class. | ||||
start | optional |
Default value: today A date string, yyyy-mm-dd format. A first (earliest) day to include in the results. |
||||
days | optional |
Default value: 7 Number of days (starting with start) to include in the results. No more than 7 is allowed. |
||||
fields | optional |
Default value: start_time|end_time|name Pipe-separated list of informational fields/sections you're interested in. This must be any subset of keys, 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. | ||||
No additional OAuth arguments are required. If you provide any, they will be ignored. | ||||||
Returned value: A list of Activity objects. Each Activity object is a dictionary of fields. There are different types of Activity objects, these are the fields they all have in common:
Depending on type of the activity, some "extra" fields become available:
Please note, that you may receive more fields than you specified. Still, you may not expect to receive fields you did not specify. |
services/tt/classgroup_dates ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/tt/classgroup_dates | ||||||
This is an older version of classgroup_dates method. It takes the same parameters, but it returns dates only. Also, some of the dates with "unsure" frequency are removed from the results. | ||||||
unit_id | required | ID of class group's "parent" course unit. | ||||
group_number | required | Group number of the class. | ||||
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. Each string is a date in the "YYYY-MM-DD" format. |
services/tt/classgroup_dates2 ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/tt/classgroup_dates2 | ||||||
Other methods have a limit workspan of 7 days. This one does not, but it is limited to a single classgroup (and it takes no timeframe-related arguments). It gives you a full list of activities related to a single classgroup. | ||||||
unit_id | required | ID of class group's "parent" course unit. | ||||
group_number | required | Group number of the class. | ||||
fields | optional |
Default value: start_time|end_time|name Pipe-separated list of informational fields/sections you're interested in. This must be any subset of keys, 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. | ||||
No additional OAuth arguments are required. If you provide any, they will be ignored. | ||||||
Returned value: A list of Activity objects, as in the classgroup method. |
services/tt/classgroups ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/tt/classgroups | ||||||
Get activities related to given user's study. This means, that if the user is also a staff
member, then this method will NOT include entries related to his staff-activities.
| ||||||
classgroup_ids | required | Pipe-separated list of class group IDs. Since there's no such thing as a class group ID (each class group is identified by two columns, not one!), we have to develop one for the purpose of this argument. Class group ID is "unit_id|group_number", where unit_id and group_number are keys which identify the class group (you'll get something like "unit|group|unit|group|..." etc.). | ||||
partial | optional |
Default value: false If set to true, response will be wrapped with PartialResponse object. This will allow invalid references to be treated as warnings, instead of errors. |
||||
start | optional |
Default value: today A date string, yyyy-mm-dd format. A first (earliest) day to include in the results. |
||||
days | optional |
Default value: 7 Number of days (starting with start) to include in the results. No more than 7 is allowed. |
||||
fields | optional |
Default value: start_time|end_time|name Pipe-separated list of informational fields/sections you're interested in. This must be any subset of keys, 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. | ||||
No additional OAuth arguments are required. If you provide any, they will be ignored. | ||||||
Returned value: A list of Activity objects, as in the classgroup method. |
services/tt/course_edition ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/tt/course_edition | ||||||
Get all activities related to a specified course edition. This includes ALL activities of
ALL class groups of this course.
| ||||||
course_id | required | ID of the course. | ||||
term_id | required | ID of the term during which the course edition is run. | ||||
start | optional |
Default value: today A date string, yyyy-mm-dd format. A first (earliest) day to include in the results. |
||||
days | optional |
Default value: 7 Number of days (starting with start) to include in the results. No more than 7 is allowed. |
||||
fields | optional |
Default value: start_time|end_time|name Pipe-separated list of informational fields/sections you're interested in. This must be any subset of keys, 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. | ||||
No additional OAuth arguments are required. If you provide any, they will be ignored. | ||||||
Returned value: A list of Activity objects, as in the classgroup method. |
services/tt/course_editions ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/tt/course_editions | ||||||
Get all activities related to specified course editions. This method is similar to the course_edition method, but it works with multiple editions.
| ||||||
course_edition_ids | required | Pipe-separated list of course edition IDs. Since there's no such thing as a course edition ID (each course edition is identified by two columns, not one!), we have to develop one for this purpose. Course Edition ID is "course_id|term_id", where course_id and term_id are keys which identify the course_edition (you'll get something like "course|term|course|term|..." etc.). | ||||
partial | optional |
Default value: false If set to true, response will be wrapped with PartialResponse object. This will allow invalid references to be treated as warnings, instead of errors. |
||||
start | optional |
Default value: today A date string, yyyy-mm-dd format. A first (earliest) day to include in the results. |
||||
days | optional |
Default value: 7 Number of days (starting with start) to include in the results. No more than 7 is allowed. |
||||
fields | optional |
Default value: start_time|end_time|name Pipe-separated list of informational fields/sections you're interested in. This must be any subset of keys, 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. | ||||
No additional OAuth arguments are required. If you provide any, they will be ignored. | ||||||
Returned value: A list of Activity objects, as in the classgroup method. |
services/tt/room ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/tt/room | ||||||
Get activities which take place in a given room.
| ||||||
room_id | required | ID of the room. | ||||
start | optional |
Default value: today A date string, yyyy-mm-dd format. A first (earliest) day to include in the results. |
||||
days | optional |
Default value: 7 Number of days (starting with start) to include in the results. No more than 7 is allowed. |
||||
fields | optional |
Default value: start_time|end_time|name Pipe-separated list of informational fields/sections you're interested in. This must be any subset of keys, 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. Token is not required. | ||||||
Returned value: A list of Activity objects, as in the classgroup method. |
services/tt/staff ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/tt/staff | ||||||
Get public activities related to given staff member. Public means, that you may anonymously
access such activities of ALL staff members, you don't need their approval for this
(teachers' schedules are publicly available).
| ||||||
user_id | optional | ID of a staff member. Required, if you don't sign your request with a proper Access Token. | ||||
start | optional |
Default value: today A date string, yyyy-mm-dd format. A first (earliest) day to include in the results. |
||||
days | optional |
Default value: 7 Number of days (starting with start) to include in the results. No more than 7 is allowed. |
||||
fields | optional |
Default value: start_time|end_time|name Pipe-separated list of informational fields/sections you're interested in. This must be any subset of keys, 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 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 Activity objects, as in the classgroup method. |
services/tt/student ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/tt/student | ||||||
Get activities related to given user's study. This means, that if the user is also a staff
member, then this method will NOT include entries related to his staff-activities.
| ||||||
start | optional |
Default value: today A date string, yyyy-mm-dd format. A first (earliest) day to include in the results. |
||||
days | optional |
Default value: 7 Number of days (starting with start) to include in the results. No more than 7 is allowed. |
||||
fields | optional |
Default value: start_time|end_time|name Pipe-separated list of informational fields/sections you're interested in. This must be any subset of keys, 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 required oauth_token for Token authorization. | ||||||
Returned value: A list of Activity objects, as in the classgroup method. |
services/tt/upcoming_ical ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/tt/upcoming_ical | ||||||
Get iCalendar file with the user's upcoming events. This method can be accessed anonymouosly so that it can be used with the webcal scheme. If you don't have the key, then it has to be accessed with the Access Token and the "studies" scope. Upcoming events include only those events which are in near future. Events in the past and events in the far future will not be included. The exact definition of "near future" is left undocumented (and may change in time). | ||||||
user_id | required | ID of the user. (If you use an Access Token, then it has to match this user.) | ||||
lang | required | Preferred language of the calendar and its entries. This should be either pl or en. | ||||
key | optional |
Default value: (empty string) Optional secret key generated for this user. Use the upcoming_share method to retrieve it. If key is provided, then no other authentication is required. If you have the key, then you may access this method anonymously. |
||||
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: HTTP 200 response with the iCalendar file. |
services/tt/upcoming_share ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/tt/upcoming_share | ||||||
Get the webcal feed of the user's upcoming events. Use this method to get the webcal URI needed to import user's upcoming events into external applications. | ||||||
lang | required | Preferred language of the calendar and its entries. This should be either pl or en. | ||||
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 required oauth_token for Token authorization. | ||||||
Returned value: A dictionary of following fields and their values:
|
services/tt/user ¶
|
||||||
https://www.usosapi.amuz.bydgoszcz.pl/services/tt/user | ||||||
start | optional |
Default value: today A date string, yyyy-mm-dd format. A first (earliest) day to include in the results. |
||||
days | optional |
Default value: 7 Number of days (starting with start) to include in the results. No more than 7 is allowed. |
||||
fields | optional |
Default value: start_time|end_time|name Pipe-separated list of informational fields/sections you're interested in. This must be any subset of keys, 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 required oauth_token for Token authorization. | ||||||
Returned value: A list of Activity objects, as in the classgroup method. |