referenceData_geography belgianCities

Typologie
Service
Eigenaar
Smals

Overzicht

Service waarmee de lijst met Belgische gemeentes, beschikbaar in drie talen (FR, NL, DE), geraadpleegd kan worden.

Beschrijving

De REST-service referenceData_geography biedt, voor de resource 'belgianCities', volgende functionaliteiten:

  • Verkrijgen van een lijst met alle Belgische gemeentes, hoofdgemeentes en/of niet-gefusioneerde gemeentes
  • Verkrijgen van de Belgische gemeentes, hoofdgemeentes en/of niet-gefusioneerde gemeentes op basis van een (gedeeltelijke of volledige) naam van de gemeente
  • Verkrijgen van de Belgische gemeentes, hoofdgemeentes en/of niet-gefusioneerde gemeentes op basis van een officiële (gedeeltelijke of volledige) postcode van de gemeente
  • Verkrijgen van de Belgische gemeentes, hoofdgemeentes en/of niet-gefusioneerde gemeentes op basis van een officiële (gedeeltelijke of volledige) postcode en van een (gedeeltelijke of volledige) naam van de gemeente

Voor elke Belgische gemeente kan men de volgende gegevens verkrijgen:

  • NIS-code van de gemeente, als het om een hoofdgemeente gaat
  • Officiële Belgische postcode van de gemeente
  • Naam van de gemeente (hoofdgemeente of niet-gefusioneerde gemeente) in drie talen (FR, NL, DE)
  • Het taalregime, als het om een hoofdgemeente gaat (F, FN, FD, N, NF, DF, FN_NF, NL_FN waarbij F = Frans, N = Nederlands en D = Duits)
  • Begindatum van geldigheid
  • Einddatum van geldigheid
  • Indien de gemeente niet de hoofdgemeente is, de link van de technische identificatie van de bijbehorende hoofdgemeente
  • De link van zijn technische identificatie

Aangezien de REST-service referenceData_geography, voor de resource ‘belgianCities’, gebaseerd is op de postcodes van de Belgische post, komen bepaalde codes niet overeen met een gemeente.
Voorbeeld: 1012 = Parlement van de Franse Gemeenschap.

Merk anderzijds op dat

  • bepaalde speciale 'gemeentes’ geen NIS-code hebben, bv.: Brussel X, Brussel NAVO...
  • bij elke niet-gefusioneerde gemeente een hoofdgemeente hoort
  • we met de parameter 'isMainCity=true' de lijst kunnen beperken tot de hoofdgemeentes

Hoewel de service de naam van de gemeentes in drie talen aanbiedt, is het aanbevolen om de naam van de gemeentes enkel in hun taal te gebruiken.

Voorbeelden: 'Antwerpen' en niet 'Anvers', 'Liège' en niet 'Luik'!

Gebruikersgroepen

Elke toepassing die Belgische adressen verwerkt en die een postcode, een NIS-code van de gemeente en/of geldigheidsdata van de Belgische gemeenten vereist.

Integratie voorwaarden

Er zijn geen bijzondere integratievoorwaarden, aangezien de service niet beveiligd is.

Voor Angular-toepassingen zal men echter de URN van de toepassing moeten doorsturen om de toegang tot de service te configureren.

Contact: TransversalTeamFunctional@smals.be

Documentatie

back2top