Historisch Bestand API Guide

Historisch Bestand API Guide
Versie 1.0
Topsite B.V.
Authenticatie
Request URL’s
URL
/references/authenticate
Type
POST
Omschrijving
Log de gebruiker in aan de hand van een
gebruikersnaam en wachtwoord.
Parameters
https://api.historischbestand.nl/references/authentication
Het formaat waarin de data moet staan die met de request mee worden gestuurd.
Naam
username
password
Type
String
(verplicht)
String
(verplicht)
Omschrijving
Gebruikersnaam van de gebruiker
Wachtwoord van de gebruiker
Response
De volgende http status codes kunnen worden verwacht.
Status
code
200
Naam
Omschrijving
Ok
Deze status geeft aan dat de request succesvol uitgevoerd is
400
Bad request
401
Unauthorized
404
Not found
Deze status geeft aan dat er geen data of data die niet aan het
verwachte formaat voldoet is meegegeven aan de API call.
Deze status geeft aan dat er geen gebruiker kan worden gevonden
waarbij de gebruikersnaam overeenkomt met de gebruikersnaam
die in de data is meegestuurd.
Deze status geeft aan dat de combinatie van gebruikersnaam en
wachtwoord niet correct zijn.
Het formaat (JSON) van de data die als response wordt teruggeven wanneer de request met succes is
uitgevoerd.
{
token: “<token>”
}
Naam
Type
Omschrijving
token
String
Deze token moet met elke andere API call worden
meegegeven in de header als “Authorization: Bearer
<token>” van de request. De token is 1 dag geldig.
2
Zoeken
Request URL’s
URL
/references/search
Type
POST
Omschrijving
Het ophalen van referentie objecten.
Parameters
https://api.historischbestand.nl/references/authentication
Het formaat waarin de data moet staan die met de request mee worden gestuurd.
Naam
bagId *
zipcode *
housenumber
housenumber_addition
radius
Type
String
String (6)
Integer
String
Enum
type
Enum
Omschrijving
BAG-ID van een object voor oriëntatiepunt
Postcode van oriëntatiepunt bijv. “1111AA”
Huisnummer van oriëntatiepunt
Huisnummertoevoeging van oriëntatiepunt
Straal in meters vanaf oriëntatiepunt:
(1000,2500,5000)
Typewoning:
(2-onder-1-kapwoning, eindwoning, geschakelde 2-
onder-1-kapwoning, geschakelde woning,
halfvrijstaande woning, hoekwoning, tussenwoning,
vrijstaande woning, helft van dubbel,bovenwoning,
benedenwoning, maisonnette, portiekflat, beneden +
bovenwoning, penthouse, portiekwoning)
yearMin
yearMax
plotMin
plotMax
livingMin
livingMax
Integer (4)
Integer (4)
Integer
Integer
Integer
Integer
Minimale jaar, bijv. 1930
Maximale jaar, bijv. 1930
Minimale perceeloppervlakte in vierkantemeters
Maximale perceeloppervlakte in vierkantemeters
Minimale woonoppervlakte in vierkantemeters
De maximale woonoppervlakte in vierkantemeters
* bagId + radius of zipcode + housenumber + radius zijn verplichte parameter(s)
Response
De volgende http status codes kunnen worden verwacht.
Status
code
200
201
Naam
Omschrijving
Ok
Deze status geeft aan dat de request succesvol uitgevoerd is
No content
Deze status geeft aan dat er geen referenties kunnen worden
gevonden
400
Bad request
Deze status geeft aan dat er geen parameters of parameters die niet
aan het verwachte formaat voldoet is meegegeven aan de API call.
401
Unauthorized
Deze status geeft aan dat er geen gebruiker kan worden gevonden
waarbij de gebruikersnaam overeenkomt met de gebruikersnaam
die in de data is meegestuurd.
Het formaat (JSON) van de data die als response wordt teruggeven wanneer de request met succes is
uitgevoerd.
3
{
references: [
{
“address”:“<address>”,
“zipcode”:”<zipcode>”
“city”:”<city>”
“type”:“<type>”,
“year”:“<year>”,
“plot”:“<plot>”,
“living”:“<living>”,
“volume”:“<volume>”,
“price”:“<price>”,
“date”:“<date>”
},
{
ect.
},
]
}
Naam
address
Type
String
Omschrijving
Het adres van de referentie
zipcode
String
De postcode van de referentie
city
String
De plaats van de referentie
type
String
Het woningtype van de referentie
year
Integer
Het bouwjaar van de referentie
plot
Integer
De perceeloppervlakte van de referentie in vierkante meters
living
Integer
Het woonoppervlakte van de referentie referentie in vierkante meters
volume
Integer
De inhoud van de referentie in kubieke meters
price
Integer
De verkoopprijs van de referentie
date
date
De verkoopdatum van de referentie
4