Ihr könnt Gefahrenwarnungen über zwei Schnittstellen abfragen.
1. Gefahrenwarnungen im Umkreis einer bestimmten Koordinate für einen definierten Zeitraum.
2. Alle Gefahrenwarnungen für einen definierten Zeitraum.
Request Gefahrenwarnungen im Umkreis einer bestimmten Koordinate für einen definierten Zeitraum
POST dogguard-api.de/open/dogguards/location/read
Ihr müsst der Schnittstelle im Body folgende Attribute übergen.
token: Der API-Schlüssel
location: Die GPS-Koordinate für die ihr Warnungen abrufen wollt.
radius: Der Umkreis der Koordinate in Metern, für die ihr Warnungen abrufen wollt.
range: Ein definierter Zeitraum, für den ihr Warnungen abrufen wollt. Das Datum müsst ihr im ISO-8601 Format übergeben.
Request:
{
"token": API-Key,
"location": {
"lon":-122.0312186,
"lat":37.33233141
},
"radius": 20000,
"range": {
"from": "2020-04-17 23:10:09.294Z",
"backTo": "2020-04-14 00:10:09.294Z"
}
}
Response Gefahrenwarnungen für einen definierten Zeitraum
Die API antwortet euch mit einer Liste von Dog Guards. Also den Gefahrenwarnungen. Die Attribute bedeuten folgendes.
_id: Die ID vom Dog Guard, der Gefahrenwarnung.
protection: Eine Angabe, um welche Gefahr es sich handelt.
poisonBait: Giftköder
studdedFood: Gespickte Nahrung
glassFragments: Glasscherben
oakProcessionary: Eichenprozessionsspinner
location: Die Position der Warnung. Sofern vorhanden mit: GPS-Koordinaten, Land, Stadt, Postleiztahl, Straße, Hausnummer.
created: Das Erstellungsdatum der Warnung.
hasImage: Sofern die API das Attribut ausspielt, könnt ihr für die Gefahrenwarnung ein Bild abrufen.
Response:
[
{
"_id": "5eabd86210427417c7a26555",
"protection": "poisonBait",
"location": {
"lat": 50.9299317,
"country": "Deutschland",
"lon": 11.5907967,
"city": "Jena"
},
"created": "2020-05-01T08:05:54.004Z"
},
{
"_id": "5eac015010427417c7a26557",
"protection": "poisonBait",
"location": {
"lat": 50.9299317,
"country": "Deutschland",
"lon": 11.5907967,
"city": "Jena"
},
"created": "2020-05-01T11:00:32.503Z",
"hasImage": true,
"countOfComments": 4
}
]
Request Gefahrenwarnungen für einen definierten Zeitraum
POST dogguard-api.de/open/dogguards/read
Ihr müsst der Schnittstelle im Body folgende Attribute übergen.
token: Der API-Schlüssel
range: Ein definierter Zeitraum, für den ihr Warnungen abrufen wollt. Das Datum müsst ihr im ISO-8601 Format übergeben.
Request:
{
"token": API-Key,
"range": {
"from": "2020-04-17 23:10:09.294Z",
"backTo": "2020-04-14 00:10:09.294Z"
}
}
Response Gefahrenwarnungen für einen definierten Zeitraum
Die API antwortet euch mit einer Liste von Dog Guards. Also den Gefahrenwarnungen. Die Attribute bedeuten folgendes.
_id: Die ID vom Dog Guard, der Gefahrenwarnung.
protection: Eine Angabe, um welche Gefahr es sich handelt.
poisonBait: Giftköder
studdedFood: Gespickte Nahrung
glassFragments: Glasscherben
oakProcessionary: Eichenprozessionsspinner
location: Die Position der Warnung. Sofern vorhanden mit: GPS-Koordinaten, Land, Stadt, Postleiztahl, Straße, Hausnummer.
created: Das Erstellungsdatum der Warnung.
hasImage: Sofern die API das Attribut ausspielt, könnt ihr für die Gefahrenwarnung ein Bild abrufen.
Response:
[
{
"_id": "5eabd86210427417c7a26555",
"protection": "poisonBait",
"location": {
"lat": 50.9299317,
"country": "Deutschland",
"lon": 11.5907967,
"city": "Jena"
},
"created": "2020-05-01T08:05:54.004Z"
},
{
"_id": "5eac015010427417c7a26557",
"protection": "poisonBait",
"location": {
"lat": 50.9299317,
"country": "Deutschland",
"lon": 11.5907967,
"city": "Jena"
},
"created": "2020-05-01T11:00:32.503Z",
"hasImage": true,
"countOfComments": 4
}
]