Permalink - PaulaScharf/TwittStorm GitHub Wiki

0 Preface

This is the Permalink documentation for our TwittStorm - dynamic weather data system.
This documentation consists of our four main pages:

1. Map
2. Animation
3. Configuration
4. User documentation

Base URL

The base URL of the app is http://localhost:3000. All other URLs in this document depend on this root URL and need to be added to the end of this base URL. The sequence of the possible parameters appended might differ. Not all parameters are used at all times. Without any parameters appended, each of those four URLs will give a valid response as well.

1 Map [/map]

URL-Struktur:

GET /map?base={base}&mapZoom={mapZoom}&mapCenter={mapCenter}&wtype={wtype}&radProd={radprod}&timestamp={timestamp}&aoi={aoi}
  • Parameters
    • base - type of basemap {"streets", "satellite"}
    • mapZoom - zoom layer of map (a single number between 0.5507467649252522 and 22)
    • mapCenter - center coordinates of map in format [long, lat]
    • wtype - type of weather to display {"radar", "warnings"}
    • radProd - radar product {ry,rw,sf}, rw by default, just useful if wtype="radar"
    • timestamp - time for which the data should be displayed (a number in Epoch milliseconds)
    • aoi - coordinates of polygon that represents the Area Of Interest for tweet-search in format [[long,lat],[long,lat],[long,lat],...] - consider that the permissible length of the URL must not be exceeded

Example Request:

GET /map?base=streets&wtype=warnings&mapZoom=7.7&mapCenter=[9.75,51.61]&aoi=[10.884000667863717,52.15315621550823],[9.089395341091944,52.07090982307923],[8.705474798548948,51.50760364822386],[9.241177881166863,51.45756208893678],[9.223321111746372,51.077693623922556],[10.017947350963084,50.90347529909337],[10.223300199300496,51.31268899174819],[12.000048756651779,51.46868718105583],[10.884000667863717,52.15315621550823](/PaulaScharf/TwittStorm/wiki/10.884000667863717,52.15315621550823],[9.089395341091944,52.07090982307923],[8.705474798548948,51.50760364822386],[9.241177881166863,51.45756208893678],[9.223321111746372,51.077693623922556],[10.017947350963084,50.90347529909337],[10.223300199300496,51.31268899174819],[12.000048756651779,51.46868718105583],[10.884000667863717,52.15315621550823)

Example Response: HTTP 200 (text/html)
Screenshot of representation in browser:

images/map.png

2 Animation of last timesteps [/animation]

URL-Struktur:

GET /animation?base={base}&mapZoom={mapZoom}&mapCenter={mapCenter}&wtype={wtype}&radProd={radprod}&timestamp={timestamp}
  • Parameters
    • base - type of basemap {"streets", "satellite"}
    • mapZoom - zoom layer of map (a single number between 0.5507467649252522 and 22)
    • mapCenter - center coordinates of map in format [long, lat]
    • wtype - type of weather to display {"radar", "warnings"}
    • radProd - radar product {ry,rw,sf}, rw by default, just useful if wtype="radar"
    • timestamp - time for which the data should be displayed (a number in Epoch milliseconds)

Example Request:

GET /animation?base=satellite&wtype=radar&mapZoom=5&mapCenter=[10.5,51.2]&radProd=ry

Example Response: HTTP 200 (text/html)
Screenshot of representation in browser:

images/animation.png

3 Configuration [/config]

URL-Struktur:

GET /config

Example Request:

GET /config

Example Response: HTTP 200 (text/html)
Screenshot of representation in browser:

images/config.png

4 User documentation / Help [/help]

URL-Struktur:

GET /help

Example Request:

GET /help

Example Response: HTTP 200 (text/html)
Screenshot of representation in browser:

images/help.png