-
Notifications
You must be signed in to change notification settings - Fork 12
/
params.json
1 lines (1 loc) · 15 KB
/
params.json
1
{"name":"UIUC-Open-Data","tagline":"Open Data API for UIUC","body":"# UIUC Open Data API\r\n\r\n[](https://gitter.im/xasos/UIUC-Open-Data?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\r\n\r\n<!--[![Build Status][travis-image]][travis-url] [![Requirements Status][require-image]][require-url]-->\r\n\r\nUnofficial Open Data API for the University of Illinois at Urbana-Champaign. Provides data for various services on campus such as Dining, Weather, Wi-Fi, etc. The API is built with Python, Flask + [Flask RESTful](https://github.com/flask-restful/flask-restful), and Redis. Interest in the project was gauged [here](https://www.reddit.com/r/UIUC/comments/2hhlhn/would_anyone_be_interested_in_a_uiuc_open_data_api/\r\n). This is still very much a WIP, so please feel free to [submit an issue](https://github.com/xasos/UIUC-Open-Data/issues/new) or [contribute](https://github.com/xasos/UIUC-Open-Data/blob/master/CONTRIBUTING.md)!\r\n\r\n*Note: This is an unofficial API and is not supported or controlled by the University of Illinois at Urbana-Champaign itself. Any questions, comments, feedback or feature requests should be directed to [xasos](https://github.com/xasos) or via an [issue](https://github.com/xasos/UIUC-Open-Data/issues/new) in this repo.*\r\n\r\n## Usage\r\n**Base URL:** http://uiuc-api.herokuapp.com\r\n\r\n**Output:** JSON\r\n\r\n## Dining Services\r\n\r\nGet information about food options from all dining halls.\r\n\r\n#### `GET /dining/:hall/:dateFrom/:dateTo`\r\n\r\n*Get detailed menus from specific dining halls.*\r\n\r\nList of Halls:\r\n\r\n| Residence Hall | Dining Hall | Hall Nickname | Hall ID |\r\n| -------------- | ----------- | ------------- | ------- |\r\n| Lincoln Avenue (LAR) | Lincoln/Allen Dining Hall | lar | 5 |\r\n| Lincoln Avenue (LAR) | Field of Greens | fieldofgreens | 12 |\r\n| Lincoln Avenue (LAR) | Leafy! | leafy | 13 |\r\n| Pennsylvania Avenue (PAR) | PAR Dining Hall | par | 2 |\r\n| Pennsylvania Avenue (PAR) | Penn Station | pennstation | 14 |\r\n| Illinois Street (ISR) | ISR Dining Hall | isr | 3 |\r\n| Illinois Street (ISR) | CHOMPS | chomps | 18 |\r\n| Illinois Street (ISR) | Cocina Mexicana | cocinamexicana |10 |\r\n| Illinois Street (ISR) | Taste of Asia | tasteofasia | 17 |\r\n| Ikenberry | Ikenberry Dining Hall | ikenberrydininghall | 1 |\r\n| Ikenberry | 57 North | 57north | 7 |\r\n| Ikenberry | Better Burger | betterburger | 20 |\r\n| Ikenberry | Caffeinator | caffeinator | 9 |\r\n| Ikenberry | Neo Soul Ingredient | neosoulingredient | 21 |\r\n| Florida Avenue (FAR) | FAR Dining Hall | far | 6 |\r\n| Florida Avenue (FAR) | Cracked Egg Café | crackedeggcafe | 8 |\r\n| Florida Avenue (FAR) | Soul Ingredient | soulingredient | 16 |\r\n| Busey-Evans | Busey-Evans Dining Hall | buseyevans | 4 |\r\n| Busey-Evans | Busey Bean and Green | buseybeanandgreen | 11 |\r\n| Busey-Evans | Oodles | oodles | 19 |\r\n\r\n*`Hall` route parameter can use the Hall ID or Hall nickname when querying.*\r\n\r\nExample Query:\r\n```\r\nhttp://uiuc-api.herokuapp.com/dining/par/2015-11-08/2015-11-08\r\n```\r\n\r\nResponse:\r\n```json\r\n{\r\n \"Menus\":{\r\n \"Item\":[\r\n {\r\n \"EventDate\":1446962400,\r\n \"DiningMenuID\":52456,\r\n \"ServiceUnit\":\"Arugula's Serving\",\r\n \"Course\":\"Salads\",\r\n \"CourseSort\":250,\r\n \"FormalName\":\"Fruit & Nut Chicken Salad\",\r\n \"Meal\":\"Dinner\",\r\n \"Traits\":\"Eggs,Soy,Tree Nuts,\",\r\n \"DiningOptionID\":2,\r\n \"ScheduleID\":9,\r\n \"ItemID\":5978\r\n },\r\n {\r\n \"EventDate\":1446962400,\r\n \"DiningMenuID\":50688,\r\n \"ServiceUnit\":\"Arugula's Serving\",\r\n \"Course\":\"Salads\",\r\n \"CourseSort\":250,\r\n \"FormalName\":\"Macaroni Salad\",\r\n \"Meal\":\"Dinner\",\r\n \"Traits\":\"Corn,Eggs,Gluten,Soy,Vegetarian,Wheat,\",\r\n \"DiningOptionID\":2,\r\n \"ScheduleID\":9,\r\n \"ItemID\":3208\r\n },\r\n ...\r\n ...\r\n```\r\n\r\n#### `GET /dining/search/:query`\r\n\r\n*Search dining halls for specific foods.*\r\n\r\nExample Query:\r\n```\r\nhttp://uiuc-api.herokuapp.com/dining/search/pasta\r\n```\r\n\r\nResponse:\r\n```json\r\n{\r\n \"Data\":{\r\n \"Table\":[\r\n {\r\n \"name\":\"ItemList\",\r\n \"Row\":[\r\n {\r\n \"Item_IntID\":\"16596\",\r\n \"FormalName\":\"BLT Pasta Salad\",\r\n \"ScheduleIDs\":[\r\n {\r\n \"ScheduleID\":4,\r\n \"DiningOptionID\":4,\r\n \"EventDate\":1447221600\r\n }\r\n ]\r\n },\r\n {\r\n \"Item_IntID\":\"17136\",\r\n \"FormalName\":\"Campanelle Pasta\",\r\n \"ScheduleIDs\":[\r\n {\r\n \"ScheduleID\":21,\r\n \"DiningOptionID\":5,\r\n \"EventDate\":1447653600\r\n },\r\n {\r\n \"ScheduleID\":42,\r\n \"DiningOptionID\":1,\r\n \"EventDate\":1447308000\r\n },\r\n {\r\n \"ScheduleID\":42,\r\n \"DiningOptionID\":1,\r\n \"EventDate\":1447912800\r\n }\r\n ]\r\n },\r\n ...\r\n ...\r\n```\r\n\r\n#### `GET /dining/`\r\n\r\nExample Query:\r\n```\r\nhttp://uiuc-api.herokuapp.com/dining/search/pasta\r\n```\r\n\r\nResponse:\r\n```json\r\n\r\n ...\r\n ...\r\n```\r\n\r\n (https://web.housing.illinois.edu/MobileDining/WebService/SettingTable.aspx?k=7A828F94-620B-4EE3-A56F-328036CC3C04&t=json&ts=5-10-2012%2014:30:00)\r\n (https://web.housing.illinois.edu/MobileDining/WebService/MyBalances.asmx/GetBalances?k=7A828F94-620B-4EE3-A56F-328036CC3C04&HT=)\r\n (https://web.housing.illinois.edu/MobileDining/WebService/MobileDining.asmx/SearchMenus?k=7A828F94-620B-4EE3-A56F-328036CC3C04&SearchPhrase=salsa)\r\n\r\n\r\n## Weather\r\n\r\nGet weather information from the [Department of Atmospheric Sciences](https://www.atmos.illinois.edu/weather/).\r\n\r\n#### `GET /weather`\r\n\r\n*Get Champaign-Urbana weather information from the Williard Airport weather station.*\r\n\r\nExample Query:\r\n```\r\nhttp://uiuc-api.herokuapp.com/weather\r\n```\r\n\r\nResponse:\r\n```json\r\n {\r\n \"weather_station_location\": \"Willard Airport\",\r\n \"last_recorded_time\": \"1446098674\",\r\n \"weather_condition\": \"Cloudy Skies\",\r\n \"temperature\": \"54\",\r\n \"dew_point\": \"45\",\r\n \"relative_humidity\": \"71%\",\r\n \"winds\": \"NW at 17 mph\",\r\n \"visibility\": \"10 miles\",\r\n \"pressure\": \"1020.0 mb (30.13 in)\",\r\n \"sunrise\": \"7:13AM\", \r\n \"sunset\": \"6:01PM\",\r\n \"images\": {\r\n \"latest_radar_image\": \"https://www.atmos.illinois.edu/weather/tree/prods/current/nicerad/nicerad_N.gif\",\r\n \"storm_total_precip_image\": \"https://www.atmos.illinois.edu/weather/tree/prods/current/niceradilxpretx/niceradilxpretx_N.gif\",\r\n \"surface_temp_image\": \"https://www.atmos.illinois.edu/weather/tree/prods/current/sfctmp/sfctmp_N.gif\",\r\n \"surface_dew_point_temp_image\": \"https://www.atmos.illinois.edu/weather/tree/prods/current/sfctdp/sfctdp_N.gif\",\r\n \"sea_level_pressure\": \"https://www.atmos.illinois.edu/weather/tree/prods/current/sfcslp/sfcslp_N.gif\",\r\n \"mdw_surface_observations\": \"https://www.atmos.illinois.edu/weather/tree/prods/current/sfcslp/sfcslp_N.gif\",\r\n \"composite_ir_image\": \"https://www.atmos.illinois.edu/weather/tree/prods/current/satconusenhir/satconusenhir_N.gif\",\r\n \"composite_enhanced_ir_image\": \"https://www.atmos.illinois.edu/weather/tree/prods/current/satnoamir/satnoamir_N.gif\"\r\n },\r\n \"\": \"\"\r\n }\r\n```\r\n\r\n## Wi-Fi\r\n\r\nGet Wi-Fi information for various places around campus.\r\n\r\n#### `GET /wifi`\r\n\r\nExample Query:\r\n```\r\nhttp://uiuc-api.herokuapp.com/wifi\r\n```\r\n\r\nResponse:\r\n```json\r\n {\r\n \"weather_station_location\": \"Willard Airport\"\r\n }\r\n```\r\n\r\n#### `GET /wifi/nearme/:latitude/:longitude` \r\n<!-- Switch to query-based parameters and add section -->\r\n\r\nExample Query:\r\n```\r\nhttp://uiuc-api.herokuapp.com/wifi\r\n```\r\n\r\nResponse:\r\n```json\r\n {\r\n \"weather_station_location\": \"Willard Airport\"\r\n }\r\n```\r\n\r\n## Laundry\r\n\r\nGet information about campus laundry.\r\n\r\n#### `GET /laundry`\r\n\r\n*Get washing machine/dryer usage information for all residence halls.*\r\n\r\nExample Query:\r\n```\r\nhttp://uiuc-api.herokuapp.com/laundry\r\n```\r\n\r\nResponse:\r\n```json\r\n{\r\n\t\"location\": {\r\n\t\t\"name\": \"University of Illinois at Urbana\",\r\n\t\t\"code\": \"urba7723\",\r\n\t\t\"networked\": \"false\",\r\n\t\t\"company\": \"Jetz Service Co\",\r\n\t\t\"rooms\": [{\r\n\t\t\t\"id\": \"110959186\",\r\n\t\t\t\"name\": \"1107 West Green\",\r\n\t\t\t\"networked\": \"A\",\r\n\t\t\t\"machines\": [{\r\n\t\t\t\t\"port\": \"1\",\r\n\t\t\t\t\"label\": \"1\",\r\n\t\t\t\t\"description\": \"Front-Load Washer\",\r\n\t\t\t\t\"status\": \"Available\",\r\n\t\t\t\t\"startTime\": \"0000-00-00 00:00:00\",\r\n\t\t\t\t\"timeRemaining\": \"0\"\r\n\t\t\t}, {\r\n\t\t\t\t\"port\": \"2\",\r\n\t\t\t\t\"label\": \"2\",\r\n\t\t\t\t\"description\": \"Front-Load Washer\",\r\n\t\t\t\t\"status\": \"Available\",\r\n\t\t\t\t\"startTime\": \"0000-00-00 00:00:00\",\r\n\t\t\t\t\"timeRemaining\": \"0\"\r\n\t\t\t}, {\r\n\t\t\t\t\"port\": \"3\",\r\n\t\t\t\t\"label\": \"3\",\r\n\t\t\t\t\"description\": \"Front-Load Washer\",\r\n\t\t\t\t\"status\": \"Available\",\r\n\t\t\t\t\"startTime\": \"0000-00-00 00:00:00\",\r\n\t\t\t\t\"timeRemaining\": \"0\"\r\n\t\t\t},\r\n\t\t\t...\r\n\t\t\t...\r\n```\r\n\r\n## University Directory\r\n\r\nSearch the university directory for students, academic departments, and faculty/staff.\r\n\r\n#### `GET /directory/search/:searchType/:query`\r\n\r\nSearch types:\r\n\r\n| Search Type | Search Type ID |\r\n| ----------- | --------------- |\r\n| All | all |\r\n| Faculty/Staff | faculty |\r\n| Student | student |\r\n| NetID | netid |\r\n| Department | department |\r\n| Phone | phone |\r\n\r\n*`searchType` route parameter can use the Search Type ID when querying.*\r\n\r\nExample Query:\r\n```\r\nhttp://uiuc-api.herokuapp.com/directory/search/netid/npant3\r\n```\r\n\r\nResponse:\r\n```json\r\n{\r\n\t\"success\": \"true\",\r\n\t\"type\": \"student\",\r\n\t\"email\": \"[email protected]\"\r\n}\r\n```\r\n\r\n## The Daily Illini\r\n\r\nGet stories, classifieds, events, and more from UIUC's campus newspaper, [The Daily Illini](http://www.dailyillini.com/).\r\n\r\n#### `GET /dailyillini/search/:query`\r\n\r\nExample Query:\r\n```\r\nhttp://uiuc-api.herokuapp.com/directory/search/netid/npant3\r\n```\r\n\r\nResponse:\r\n```json\r\n\r\n```\r\n\r\n## Buildings\r\n\r\nSearch the university directory for students, academic departments, and faculty/staff.\r\n\r\n#### `GET /directory/search/:searchType/:query`\r\n\r\nSearch types:\r\n\r\n| Search Type | Search Type ID |\r\n| ----------- | --------------- |\r\n| All | all |\r\n| Faculty/Staff | faculty |\r\n| Student | student |\r\n| NetID | netid |\r\n| Department | department |\r\n| Phone | phone |\r\n\r\n*`searchType` route parameter can use the Search Type ID when querying.*\r\n\r\nExample Query:\r\n```\r\nhttp://uiuc-api.herokuapp.com/directory/search/netid/npant3\r\n```\r\n\r\nResponse:\r\n```json\r\n\r\n```\r\n\r\n## Atheletic schedule\r\n\r\nGet the Fighting Illini's athletic schedule across all sports.\r\n\r\n- do individual sports\r\n\r\n#### `GET /directory/search/:searchType/:query`\r\n\r\nSearch types:\r\n\r\n| Search Type | Search Type ID |\r\n| ----------- | --------------- |\r\n| All | all |\r\n| Faculty/Staff | faculty |\r\n| Student | student |\r\n| NetID | netid |\r\n| Department | department |\r\n| Phone | phone |\r\n\r\n*`searchType` route parameter can use the Search Type ID when querying.*\r\n\r\nExample Query:\r\n```\r\nhttp://uiuc-api.herokuapp.com/directory/search/netid/npant3\r\n```\r\n\r\nResponse:\r\n```json\r\n\r\n```\r\n\r\n## Course Information\r\nUIUC's Student Services Development Team offers an [API](http://courses.illinois.edu/cisdocs/) for information on Class Schedule, Course Catalog, and Gened data. However, since the data is not publibly available, you must sign up for access [here](http://courses.illinois.edu/cisdocs/authentication).\r\n\r\n## Transportation\r\nThe Champaign-Urbana Mass Transit District offers an [API](https://developer.cumtd.com/) for transporation information in the Champaign-Urbana metropolitan area. There are several API wrappers and Open-source applications written with the CUMTD API on [GitHub](https://github.com/search?utf8=%E2%9C%93&q=cumtd) as well as in their [App Garage](http://www.cumtd.com/maps-and-schedules/app-garage).\r\n \r\n## Run Locally\r\n```sh\r\n$ pip install -r requirements.txt\r\n$ python api.py\r\n```\r\n\r\n## Deploy to Heroku \r\n```sh\r\n$ pip install -r requirements.txt\r\n$ heroku create\r\n$ (git add, git commit)\r\n$ git push heroku master\r\n```\r\n\r\n## Client Libraries\r\n - [UIUC.py]() (Python)\r\n - [node-uiuc]() (Node.js)\r\n - []() (Java/Android)\r\n - []() (Swift)\r\n - []() (Objective-C)\r\n - []() (Scala)\r\n - []() (Ruby)\r\n - []() (Clojure)\r\n - []() (Golang)\r\n \r\n*If you've built a wrapper for this API, feel free to add it to this list by sending a PR!*\r\n \r\n## Expo\r\nSome apps built using this API: \r\n\r\n| Name | Description | URL |\r\n| ---- | ---- | ---- |\r\n| uiuc-cli | CLI to university services | https://github.com/xasos/uiuc-cli |\r\n\r\n*If you've built an app using this API, feel free to add it to this list by sending a PR!*\r\n\r\n## Contributing\r\nPlease refer to the [Contributing Guidelines](https://github.com/xasos/UIUC-Open-Data/blob/master/CONTRIBUTING.md) before submitting any pull requests!\r\n\r\n## To-Do List\r\nThe To-Do List can be found [here](https://github.com/xasos/UIUC-Open-Data/blob/master/todo.md).\r\n \r\n## Statistics\r\nSo far, x users have used the API and over y requests have been made!\r\n\r\n## Disclaimer\r\nUse of this API\r\n\r\n## License\r\n[MIT License](LICENSE)\r\n\r\n\r\n[travis-url]: https://travis-ci.org/xasos/UIUC-Open-Data\r\n[travis-image]: https://travis-ci.org/xasos/UIUC-Open-Data.svg?branch=master\r\n[require-image]: https://requires.io/github/xasos/UIUC-Open-Data/requirements.svg?branch=master\r\n[require-url]: https://requires.io/github/xasos/UIUC-Open-Data/requirements/?branch=master\r\n[daviddm-url]: https://david-dm.org/xasos/Coins.svg?theme=shields.io\r\n[daviddm-image]: https://david-dm.org/xasos/Coins\r\n","google":"","note":"Don't delete this file! It's used internally to help with page regeneration."}