Functie: suggest

Met de functie suggest wordt op basis van één of meerdere karakters een alfabetisch overzicht gegeven van plaats- of straatnamen die beginnen met deze karakters. Bekijk een uitgewerkt voorbeeld van deze functie.

Plaatsnaam


Aanroepen van de functie
Verplichte parameters
Optionele parameters
Return values
Voorbeeld resultaat in XML
Voorbeeld resultaat in json

Straatnaam


Aanroepen van de functie
Verplichte parameters
Optionele parameters
Return values
Voorbeeld resultaat in XML
Voorbeeld resultaat in json  

Aanroepen van de functie (plaatsnaam)

api.postcodes.nl/1.0/suggest/?apikey=KEY&city=den&maxresults=3
 

Verplichte parameters

apikeyEen identificerende sleutel voor gebruik van de API, vraag deze gratis aan
cityeen (gedeelte) van de plaatsnaam waarop gezocht moet worden
 

Optionele parameters

outputEen identificerende sleutel voor gebruik van de API, vraag deze gratis aan
maxresultsHet maximaal aantal resultaten dat getoond wordt, default=5, maximaal=25
 

Return values

Als resultaat wordt een status (ok of error) teruggestuurd. Indien de status "ok" is volgen results met hierin onderstaande waarden. Indien er een fout optreedt, dan wordt dit gevolgd door een errorcode en een errormessage. Kijk voor meer informatie naar de foutmeldingen die kunnen optreden.

cityDe plaatsnaam die voldoet aan de invoer
officialcitynameDe officiële schrijfwijze van een plaatsnaam
 

Voorbeeld resultaat in XML

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>ok</status>
    <results>
        <result>
            <city>Den Andel</city>
            <officialcityname>Den Andel</officialcityname>
        </result>
        <result>
            <city>Den Bommel</city>
            <officialcityname>Den Bommel</officialcityname>
        </result>
        <result>
            <city>Den Bosch</city>
            <officialcityname>'s-Hertogenbosch</officialcityname>
        </result>
    </results>
</response>
 

Voorbeeld resultaat in json

({"status":"ok",
    "results":[
        {
            "city":"Den Andel",
            "officialcityname":"Den Andel"
        },
        {
            "city":"Den Bommel",
            "officialcityname":"Den Bommel"
        },
        {
            "city":"Den Bosch",
            "officialcityname":"'s-Hertogenbosch"
        }
    ]
});
 

Aanroepen van de functie (straatnaam)

api.postcodes.nl/1.0/suggest/?apikey=KEY&city=andel&streetname=h
 

Verplichte parameters

apikeyEen identificerende sleutel voor gebruik van de API, vraag deze gratis aan
cityDe officiële plaatsnaam, zie resultaat aanvullen plaatsnaam
streetnameeen (gedeelte) van de straatnaam waarop gezocht moet worden
 

Optionele parameters

outputEen identificerende sleutel voor gebruik van de API, vraag deze gratis aan
maxresultsHet maximaal aantal resultaten dat getoond wordt, default=5, maximaal=25
 

Return values

Als resultaat wordt een status (ok of error) teruggestuurd. Indien de status "ok" is volgen results met hierin onderstaande waarden. Indien er een fout optreedt, dan wordt dit gevolgd door een errorcode en een errormessage. Kijk voor meer informatie naar de foutmeldingen die kunnen optreden.

streetnameDe straatnamen die voldoen aan de invoer
 

Voorbeeld resultaat in XML

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <status>ok</status>
    <results>
        <result>
            <streetname>Hoefweg</streetname>
        </result>
        <result>
            <streetname>Hofflaan</streetname>
        </result>
        <result>
            <streetname>Hoge Maasdijk</streetname>
        </result>
        <result>
            <streetname>Hoofdgraaf</streetname>
        </result>
        <result>
            <streetname>Huiswerf</streetname>
        </result>
    </results>
</response>
 

Voorbeeld resultaat in json

({"status":"ok",
    "results":[
        {
            "streetname":"Hoefweg"
        },
        {
            "streetname":"Hofflaan"
        },
        {
            "streetname":"Hoge Maasdijk"
        },
        {
            "streetname":"Hoofdgraaf"
        },
        {
            "streetname":"Huiswerf"
        }
    ]
});