Readme.md

modis-snow-server API-DOC

Open Endpoints

Open endpoints require no Authentication.

Catchment Information

• Catchment List : GET /catchments
• Catchment : GET /catchments/<catchmentid>

Catchment Data

• Timeseries List : GET /catchments/<catchmentid>/timeseries
• Timeseries : GET /catchments/<catchmentid>/timeseries/<timeseriesid>
• Geotiff List : GET /catchments/<catchmentid>/geotiffs
• Geotiff : GET /catchments/<catchmentid>/geotiffs/<geotiffid>
• Geojson : GET /catchments/<catchmentid>/geojson

Data Processor

• View Data Processor Status : GET /data_processor

Shapefile conversion

• Shapefile2json : POST /shapefile2geojson

Endpoints that require Authentication

Closed endpoints require basic authentication, e.g. curl -u <user>:<password> <url>

Manipulating Catchments

• Add Catchment : POST /catchments
• Delete Catchment : DELETE /catchments/<catchmentid>

Data Processor

• Trigger Execution : PUT /data_processor

Error Response

The error responses to expect are listed in each description. Every error response contains a json in its body with the field "message". This field gives more detailed information about what went wrong and might help to identify and solve the problem.

Start server

cd /srv/modis-snow-server/
source virtualenv/bin/activate
cd bin/server/
gunicorn --bind 0.0.0.0:8000 server:app --daemon