|
Buildings, rooms and other geographical data
|
building | (deprecated) Get information on a given building |
building2 | Get information on a given building |
building_index | Get the list of all buildings. |
buildings | (deprecated) Get information on multiple buildings |
buildings2 | Get information on multiple buildings. |
room | Get information on a given room. |
rooms | Get information on multiple rooms. |
staticmap | Get a map of the surroundings of a given point (administrative) |
services/geo/building ¶
|
||||||
https://usosapps.demo.usos.edu.pl/services/geo/building | ||||||
This method is deprecated, please avoid using it - read more Suggested replacement: services/geo/building2 Get information on a given building. This method had multiple errors and has been deprecated. We advise not to use it. | ||||||
building_id | required | ID of the building. | ||||
fields | optional |
Default value: id|name|location 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. |
||||
No additional OAuth arguments are required. If you provide any, they will be ignored. | ||||||
Returned value: A dictionary of selected fields and their values. Available fields:
| ||||||
Thrown errors:
|
services/geo/building2 ¶
|
||||||
https://usosapps.demo.usos.edu.pl/services/geo/building2 | ||||||
Get information on a given building | ||||||
building_id | required | ID of the building. | ||||
langpref | optional |
Default value: en A code of the preferred language ("pl" or "en"). It may influence the order of data and other display properties of the returned fields. |
||||
fields | optional |
Default value: id|name|location 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. |
||||
No additional OAuth arguments are required. If you provide any, they will be ignored. | ||||||
Returned value: A dictionary of selected fields and their values. Available fields:
| ||||||
Thrown errors:
|
services/geo/building_index ¶
|
||||||
https://usosapps.demo.usos.edu.pl/services/geo/building_index | ||||||
Get the list of all buildings known to the institution. | ||||||
fields | optional |
Default value: id|name|location Selector of result fields you are interested in. The selector must contain subset of primary fields, which are described in the returns section of building2 method. |
||||
fac_ids | optional |
Default value: (empty string) Pipe-separated list of faculty IDs. If given, then the result will contain only such buildings which are related to one of more of the given faculties. |
||||
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: Unordered list of dictionaries. Each dictionary will contain a building description (as described in the building2 method) with the chosen fields. |
services/geo/buildings ¶
|
||||||
https://usosapps.demo.usos.edu.pl/services/geo/buildings | ||||||
This method is deprecated, please avoid using it - read more Suggested replacement: services/geo/buildings2 Get information on multiple buildings. This method is similar to the building method, and it was deprecated for the same reasons. Please use the buildings2 method instead. | ||||||
building_ids | required | Pipe-separated list of building IDs. | ||||
fields | optional |
Default value: id|name|location Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of building 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. |
||||
No additional OAuth arguments are required. If you provide any, they will be ignored. | ||||||
Returned value: A dictionary: your building_ids will be mapped to dictionary's keys, and each value will contain the description of a building, as defined in the building method. |
services/geo/buildings2 ¶
|
||||||
https://usosapps.demo.usos.edu.pl/services/geo/buildings2 | ||||||
Get information on multiple buildings. This method is similar to the building2 method, but it can return multiple objects at one time. | ||||||
building_ids | required | Pipe-separated list of building IDs. | ||||
langpref | optional |
Default value: en As described in the building2 method. |
||||
fields | optional |
Default value: id|name|location Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of building2 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. |
||||
No additional OAuth arguments are required. If you provide any, they will be ignored. | ||||||
Returned value: A dictionary: your building_ids will be mapped to dictionary's keys, and each value will contain the description of a building, as defined in the building2 method. |
services/geo/room ¶
|
||||||
https://usosapps.demo.usos.edu.pl/services/geo/room | ||||||
Get information on a given room. | ||||||
room_id | required | ID of the room. | ||||
fields | optional |
Default value: id|number|building_id|building_name 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 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 selected fields and their values. Available fields:
| ||||||
Thrown errors:
|
services/geo/rooms ¶
|
||||||
https://usosapps.demo.usos.edu.pl/services/geo/rooms | ||||||
Get information on multiple rooms. This method is similar to the room method, but it works with multiple rooms. | ||||||
room_ids | required | Pipe-separated list of room IDs. | ||||
fields | optional |
Default value: id|number|building_id|building_name Selector of result fields you are interested in. The selector may contain any subset of fields, which are described in the returns section of room 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: your room_ids will be mapped to dictionary's keys, and each value will contain the description of a room, as defined in the room method. |
services/geo/staticmap ¶
Administrative: This method requires a proper Administrative Consumer Key. Contact us to get one.
|
||||||
https://usosapps.demo.usos.edu.pl/services/geo/staticmap | ||||||
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 a static map image of the surroundings of a given point. This method uses external OpenStreetMap tile servers. Please keep the following in mind:
This method was not checked to work in edge cases. Keep your queries "rational". | ||||||
lat | required |
Latitude of the image center. |
||||
long | required |
Longitude of the image center. |
||||
zoom | optional |
Default value: 15 Zoom level to use (0..18). |
||||
width | optional |
Default value: 200 The width of the result image, in pixels (1..800). |
||||
height | optional |
Default value: 200 The height of the result image, in pixels (1..800). |
||||
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:
|