The main idea of this work is to come up with an easy and a user-friendly way of querying the datasets in terms of parameters namely SPACE, THEME AND TIME at the API level. Constraints about SPACE, THEME, and TIME are expressed using natural language terms. Examples about how to express these constraints are provided in this documentation. Further details about the work can be found in https://run.unl.pt/handle/10362/67707.
\n[SPACE]:
\nSpace refers to the cityName. Currently, for this study datasets are available for these cities only:
\n[THEME]:
\n[TIME]:
\n**[Note]:**
/api/all displays all the datasets currently available in the database.
This request gives all the theme datasets. \nExample: \nAbove endpoint gives all the population datasets.
\n","urlObject":{"path":["population"],"host":["{{myroute}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"494bea16-a6e9-4cfb-a4d6-edc9ed75ca6d"},{"name":"api/:cityName","id":"a3b133a4-76f0-432d-9c83-e78b47e62deb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{myroute}}/bonn","description":"This request gives all the datasets that are within a given city. \nExample: \nAbove endpoint gives all the available datasets within the City of Bonn.
\n","urlObject":{"path":["bonn"],"host":["{{myroute}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a3b133a4-76f0-432d-9c83-e78b47e62deb"},{"name":"api/:time","id":"bd85120b-8038-4f50-9bba-6a3542dc919a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{myroute}}/3 november 2017 to yesterday","description":"This request gives all the datasets based on time (date). \nExample: \nAbove endpoint gives all the available datasets from\\ \n3rd November 2017 to yesterday.
\n","urlObject":{"path":["3 november 2017 to yesterday"],"host":["{{myroute}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bd85120b-8038-4f50-9bba-6a3542dc919a"}],"id":"7864f448-a4c6-4a56-b4d1-708d8d54e312","description":"This is an end-point that gives an access to datasets using single parameter. This single parameter can be anything among (TIME, SPACE, AND THEME).
\nThis request gives all the datasets that are within a given city. \nExample: \nAbove endpoint gives all the crime datasets of Kathmandu City.This can also be queried as /api/Kathmandu/crime
\n","urlObject":{"path":["crime","kathmandu"],"host":["{{myroute}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c6b39419-922b-453b-87ac-7d64080bbd50"},{"name":"api/:cityName/:time","id":"2c730a62-4b9b-43be-abad-32e29f3b24e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{myroute}}/Bonn/november 3rd 2017","description":"This request gives all the datasets of specific date that are within a given city. \nExample: \nAbove endpoint gives all the datasets of City of Bonn.This can also be queried as
/api/november 3rd 2017/bonn
This request gives all the datasets of a specific date. \nExample: \nAbove endpoint gives all the economy datasets of november 3rd 2017. This can also be queried as /api/november 3rd 2017/economy
\n","urlObject":{"path":["economy","november 3rd 2017"],"host":["{{myroute}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1de12764-a487-418b-b55a-4114b1af3021"},{"name":"api/:time/:theme","id":"70d3928e-8e12-4bbf-a566-40a45589a50b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{myroute}}/october 12th 2013 to today/crime","description":"This request gives all the datasets that are available within a specific date range. \nExample: \nAbove endpoint gives all the crime datasets that are available from october 12th 2013 to today. This can also be queried as
/api/crime/october 12th 2013 to today
This request gives all the datasets that are within the defined radius from point of interest. \nExample: \nAbove endpoint gives all the weather datasets that are within the radius of 10000 meters from the point of interest denoted by an array of longitude and latitude.
\n","urlObject":{"path":["weather","radius=10000&long,lat=[85.2861785888672,27.7002479940336]"],"host":["{{myroute}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7157ef62-2da7-4388-b5db-4f3b4e548dde"}],"id":"efe9b7c4-dae0-4a71-b3bb-63576d787da8","description":"This is an end-point that gives an access to datasets using two parameters. These two parameters can be any two from (TIME, SPACE, AND THEME). The pair can be in any order. All the possible combination for these two parameters to query datasets is shown below along with an example:
\nThis request gives all the datasets of a specific date that are within a given city. \nExample:
\nAbove endpoint gives all the crime datasets of 11th December 2018 that are within the Kathmandu City. This can also be queried as any of the following:
\nThis request gives all the datasets that are within the given date range for a given city. \nExample:
\nAbove endpoint gives all the population datasets of Dortmund city from 17th December 2012 to yesterday.This can also be queried as any of the following:
\nThis is an end-point that gives an access to datasets using three parameters. These three parameters (TIME, SPACE, AND THEME) can be in any order. All the possible combination of these three parameters this API supports is shown below along with an example:
\n