diff --git a/README.md b/README.md index 73ee473..962fa3d 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,27 @@ A (hopefully soon) fully featured selft-hosted web interface and server-backend # API docs -## location data +## get locations +triggered by setting no GET parameter at all +### Parameters + +### Tags +- id +- locationname +- latitude +- longitude +- countryname + +## get location data +triggered by setting GET parameter 'locId' to a vaild location id +### Parameters +- locId: id of the location to display +- range: range of the data to display in unix time + - from + - to +- max vals: maximum measvals to be transmitted; if more are present in the timespan, the avarage will be calculated + +### Tags - id - locationname - latitude