Op deze pagina vindt u een overzicht van alle API-statuscodes
De NDFF-API is een REST-service. Wanneer u een request op de API uitvoert geeft de API altijd een Http-status retour. Deze status heeft een nummer, een titel, een korte beschrijving en een URL naar een pagina waar meer informatie is te vinden over de vermelde statuscode. Indien het een fout of waarschuwing betreft kunt u worden doorgeleid naar een tekstblok op deze pagina. In het tekstblok vindt u de titel van e statuscode terug met daarbij een korte of langere uitleg over de reden van de vermelde fout of waarschuwing en wat u kunt doen om deze melding van de API te voorkomen.
400
POST – Validatie mislukt – De door u opgegeven parameters zijn incorrect
e-mailadres:
Een e-mailadres bevat tenminste een gebruikersnaam, een domeinnaam en een geldig toplevel domein, waarbij de er een @ staat tussen de gebruikersnaam en de domeinnaam en een punt tussen de domeinnaam en de toplevel-domeinnaam, zoals: ontvanger@postbus.nl
telefoonnummer:
Een telefoonnummer bestaat uit tenminste cijfers, waarvan het eerste cijfer in ieder geval een nul is.
PATCH – Validatie mislukt – De door u opgegeven parameters zijn incorrect
wachtwoord:
Een wachtwoord moet tenminste 8 tekens lang zijn.
404
GET – De aanvraag bestaat niet
Het aanvraag heeft geen resultaat opgeleverd. Kijk op de URL https://accapi.ndff.nl/docs/v2/ welke aanvragen mogelijk zijn op de API.
DELETE – De door u opgegeven object bestaat niet
U kunt alleen al bestaande objecten (dataset/observatie/persoon) verwijderen.
Al eerder verwijderde objecten kunnen niet nogmaals worden verwijderd
PATCH – De aanvraag bestaat niet
U kunt alleen al bestaande objecten (dataset/observatie/persoon) verwijderen.
405
DELETE – Het verwijderen van de door u opgegeven object is niet toegestaan
Het verwijderen van de door u opgegeven dataset/observatie/persoon is niet toegestaan. U kunt alleen al bestaande objecten verwijderen. Al eerder verwijderde objecten kunnen niet nogmaals worden verwijderd
POST – Het verzoek is niet toegestaan voor deze resource
Op de pagina https://accapi.ndff.nl/docs/v2/ kunt u per zien welke acties op de door u opgegeven resource zijn toegestaan.
PATCH – De aanvraag kon niet worden gewijzigd
De aanvraag kon niet worden gewijzigd
406
METHODE NOT ACCEPTABLE – Het verwijderen van het door u opgegeven object is niet toegestaan
Het verwijderen van de door u opgegeven dataset/observatie/persoon is niet toegestaan. U kunt alleen al bestaande objecten verwijderen. Al eerder verwijderde objecten kunnen niet nogmaals worden verwijderd.
409
CONFLICT – De door u gecreëerde identity bestaat al
De persoon/dataset/waarneming die u aanbiedt bestaat al in de NDFF. Wijzig uw actie naar PUT om een update uit te voeren. Daarbij is belangrijk dat die PUT request gericht wordt aan een specifieke waarneming, omdat het immers de bedoeling is om die waarneming te wijzigen. Daarvoor is het nodig om de resource uri van die waarneming te kennen, dat is het web adres waarop de waarneming beschikbaar is in de API. Als u die niet heeft vastgelegd bij het aanmaken van de waarneming is dat geen probleem: deze kan worden opgevraagd met de identity van de waarneming.
429
TOO MANY REQUESTS – Het verzoek kan niet worden afgehandeld omdat het maximum aantal verzoeken per tijdseenheid voor uw domein is overschreden.
Op de API is zogenaamde throttling ingesteld, waarbij er een maximum is ingesteld op een aantal acties per gebruiker. Ondervindt u hier (veel) hinder van, meldt dit dan aan het serviceteam (serviceteamNDFF@natuurloket.nl) en vermeld hierbij welke API-requests u hinder ondervindt van de ingestelde maxima.
500
INTERNAL SERVER ERROR – Er is iets misgegaan.
Er is een fout opgetreden bij het verwerken van uw verzoek. Veel voorkomende fouten zijn:
– Er wordt een lettercode aangeboden bij een numerieke schaal (aantallen, percentages, etc)
– Er wordt een aantal of lettercode aangeboden als bedekkingsklasse op een vegetatieschaal of aantalsklassenschaal, terwijl dit een URI moet zijn. U kunt meer informatie vinden over de toegestane waarden in het NDFF-woordenboek of op de NDFF-API.
– Er wordt een waarneming of dataset gecreëerd zonder een geldige opgegeven parent-dataset.