Objecten
Via de volgende endpoint kan je bij de aangesloten makelaar objectinformatie ophalen. Zo worden veel details, perceelinformatie en afbeeldingen meegestuurd. Zo krijg je een zo compleet mogelijk overzicht van de woning. Je kan ook filteren op specifieke gegevens om een zo accuraat mogelijke response te krijgen.
| Method: | GET | ||
| Endpoint: | http://localhost:8000/api/v1/{format}/objects | ||
| Headers: | public-key | {public-key} | |
| private-key | {private-key} | ||
| Variabelen: (verplicht) | {format} | Keuze uit: JSON of XML Dit bepaald in welk formaat de data wordt teruggestuurd naar jou. | |
| Parameters: (niet verplicht) | {id} | Type: Omschrijving: | String Id van het object. Is altijd uniek |
| {house_nr} | Type: Maximale lengte: Omschrijving: | String 191 Huisnummer van het object | |
| {addition} | Type: Maximale lengte Omschrijving | String 191 Huisnummertoevoeging en huisletter (1A) | |
| {zipcode} | Type: Maximale lengte Omschrijving | String 6 Postcode van het object (9672AC) | |
{status}
| Type: | String | |
| Keuzes: | beschikbaar, onder bod, onder optie, verkocht onder voorbehoud, verhuurd onder voorbehoud, verhuurd, verkocht, geveild, verkocht bij inschrijving | ||
| Maximale lengte | n.v.t. | ||
Omschrijving
| De status van het object | ||
| Voorbeeld | Stuur bijvoorbeeld “beschikbaar, onder bod, onder optie” om alle objecten met die status te krijgen | ||
Response
Dit zijn de waarden die je terug kan krijgen
| Naam | Regels | Method/Waarden | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Straatnaam | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Huisnummer | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Postcode | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| HuisnummerToevoeging | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Huisletter | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Plaats | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Provincie | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Soort | Maximaal 1 waarde | "Woonhuis", "Appartement", "Bouwgrond", "Inpandige Garage", "Garage", "Parkeerkelder", "Parkeerplaats", "Berging", "Woonwagenstandplaats", "Stacaravanstandplaats", "Ligplaats", "Onderstuk", “Opslagruimte” | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Type | Maximaal 1 waarde | "Koop", "Huur", "Veiling" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Status | Maximaal 1 waarde | “Prospect”, “In Aanmelding”, “Beschikbaar”, “Onder Bod”, “Onder Optie”, “Verkocht Onder Voorbehoud”, “Verhuurd Onder Voorbehoud”, “Verhuurd”, “Verkocht”, “Geveild”, “Ingetrokken”, “Verkocht ” | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Publicatiedatum | nullable | datum | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Details |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Woonlagen | Meerdere lagen mogelijk |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Percelen | Meerdere percelen mogelijk |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Afbeeldingen | Meerdere afbeeldingen mogelijk |
|
Hieronder staan de responses in 2 verschillende formaten. JSON en XML.
JSON
{
"endpoint": "http://localhost:8000/api/v1/json/objects?huisnummer=18&postcode=9672AC",
"resultaten": 1,
"objects": [
{
"Id": "",
"Straatnaam": "",
"Huisnummer": "",
"Postcode": "",
"HuisnummerToevoeging": "",
"Huisletter": "",
"Plaats": "",
"Provincie": "",
"Soort": "",
"Type": "",
"Status": "",
"Publicatiedatum": "",
"Details": {
"Aanbiedingstekst": "",
"Prijs": "",
"Soort": "",
"Type": "",
"Isolatievormen": [],
"PermanenteBewoning": false,
"RecreatieWoning": false,
"Bouwjaar": "",
"Energielabel": "",
"EnergielabelEinddatum": "",
"Verwarming": [],
"WarmWater": "",
"Woonoppervlakte": "",
"OverigeInpandigeRuimte": "",
"GebouwgebondenBuitenruimte": "",
"ExterneBergruimte": "",
"Inhoud": "",
"Tuin": {
"Soort": [],
"Oppervlakte": "",
"Hoofdtuin": ""
},
"Garage": {
"Soort": [],
"Capaciteit": "",
"Voorzieningen": "",
"Isolatie": ""
},
"Parkeren": {
"Faciliteiten": [],
"Capaciteit": "1"
},
"Financieel": {
"Conditie": "",
"Prijsvoegsel": "",
"Aanvaarding": "",
"AanvaardingDatum": "",
"ServicekostenPerMaand": ""
},
"Woonlagen": [
{
"Naam": "",
"VerdiepingNr": 0,
"AantalKamers": 1,
"AantalSlaapkamers": 0,
"AantalBadkamers": 0,
"Kamers": [
{
"Naam": "Woonkamer",
"HeeftTrap": false,
"Afmetingen": {
"Soort": null,
"Lengte": null,
"Breedte": null,
"Hoogte": null,
"Diameter": null
}
},
]
},
],
},
"Percelen": [
{
"KadastraalID": 1,
"KadastraleGegevens": {
"KadastraleGemeente": "",
"KadastraleGemeenteCode": "",
"Sectie": "",
"Perceel": "",
"Oppervlakte": “”,
"Omvang": ""
}
},
],
"Afbeeldingen": [
{
"mime": "image/jpeg",
"path": "",
"thumbnail": "",
"order": 1,
"type": "afbeelding"
},
]
}
]
}
XML
<?xml version="1.0"?>
<root>
<endpoint>http://localhost:8000/api/v1/xml/objects?huisnummer=1&postcode=9672AC</endpoint>
<resultaten>1</resultaten>
<objects>
<objects>
<Id/>
<Straatnaam/>
<Huisnummer/>
<Postcode/>
<HuisnummerToevoeging/>
<Huisletter/>
<Plaats/>
<Provincie/>
<Soort/>
<Type/>
<Status/>
<Publicatiedatum/>
<Details>
<Aanbiedingstekst/>
<Prijs/>
<Soort/>
<Type/>
<Isolatievormen>
<Isolatievormen/>
</Isolatievormen>
<PermanenteBewoning/>
<RecreatieWoning/>
<Bouwjaar/>
<Energielabel/>
<EnergielabelEinddatum/>
<Verwarming>
<Verwarming/>
</Verwarming>
<WarmWater/>
<Woonoppervlakte/>
<OverigeInpandigeRuimte/>
<GebouwgebondenBuitenruimte/>
<ExterneBergruimte/>
<Inhoud/>
<Tuin>
<Soort>
<Soort/>
</Soort>
<Oppervlakte/>
<Hoofdtuin/>
</Tuin>
<Garage>
<Soort>
<Soort/>
</Soort>
<Capaciteit/>
<Voorzieningen/>
<Isolatie/>
</Garage>
<Parkeren>
<Faciliteiten>
<Faciliteiten/>
</Faciliteiten>
<Capaciteit/>
</Parkeren>
<Financieel>
<Conditie/>
<Prijsvoegsel/>
<Aanvaarding/>
<AanvaardingDatum/>
<ServicekostenPerMaand/>
</Financieel>
<Woonlagen>
<Woonlagen>
<Naam>Begane grond</Naam>
<VerdiepingNr>0</VerdiepingNr>
<AantalKamers>8</AantalKamers>
<AantalSlaapkamers>1</AantalSlaapkamers>
<AantalBadkamers>1</AantalBadkamers>
<Kamers>
<Kamers>
<Naam>Woonkamer</Naam>
<HeeftTrap>false</HeeftTrap>
<Afmetingen>
<Soort>null</Soort>
<Lengte>null</Lengte>
<Breedte>null</Breedte>
<Hoogte>null</Hoogte>
<Diameter>null</Diameter>
</Afmetingen>
</Kamers>
</Kamers>
</Woonlagen>
</Woonlagen>
</Details>
<Percelen>
<Percelen>
<KadastraalID/>
<KadastraleGegevens>
<KadastraleGemeente/>
<KadastraleGemeenteCode/>
<Sectie/>
<Perceel/>
<Oppervlakte/>
<Omvang/>
</KadastraleGegevens>
</Percelen>
</Percelen>
<Afbeeldingen>
<Afbeeldingen>
<mime>image/jpeg</mime>
<path/>
<thumbnail/>
<order>799915</order>
<type>afbeelding</type>
</Afbeeldingen>
</Afbeeldingen>
</objects>
</objects>
</root>
Foutcodes
| 403 | Toegang geweigerd | Het kan zijn dat jouw authenticatie gegevens niet correct zijn check deze. |
| 404 | Pagina niet gevonden | Je hebt een endpoint aangeroepen die niet bestaat. |
| 406 | Niet gewenst formaat | Let op! Je kan alleen XML en JSON gebruiken in de endpoint. |
| 429 | Te vaak geprobeerd | Je kan maximaal 10x per minuut deze call uitvoeren. |
| 500 | Interne server error | Er is iets fout gegaan intern in de api. Dit zal z.s.m. worden opgelost |