Schoolwijzer OpenData API

Schoolwijzer biedt haar data aan in de vorm van een OpenData API.

De data wordt op die manier toegankelijk voor ontwikkelaars die hier hun eigen toepassingen op kunnen schrijven.

Structuur van de API

De API volgt de JSON:API standaard. Alle informatie hierover kan gevonden worden op https://jsonapi.org/. De volledige spec wordt ondersteund door deze API. 

Alle API requests kunnen gedaan worden naar https://schoolwijzer.amsterdam.nl/api/v2/{datatype}. Zie hieronder een lijst met de beschikbare datatypes.

Gebruik sparse fieldsets om de dataset die je ophaalt zo klein mogelijk te maken. Dit maakt requests sneller en bespaart bandbreedte: https://jsonapi.org/format/#fetching-sparse-fieldsets

Let op: alle API responses zijn gelimiteerd op 75 resultaten. Zie de JSON:API documentatie over pagination om meer te weten te komen over hoe de volledige dataset uitgelezen kan worden.

Datatypes

Vestigingen

Root URL: https://schoolwijzer.amsterdam.nl/api/v2/vestigingen.

Inhoud: een volledig overzicht van alle vestigingen in Amsterdam.

Beschikbare filters

soort_onderwijs

Meerdere opties mogelijk. Kies uit:

  • basisonderwijs
  • speciaal-basisonderwijs
  • speciaal-onderwijs
  • voortgezet-en-speciaal-basisonderwijs
  • voortgezet-speciaal-onderwijs
  • voortgezet-onderwijs
  • middelbaar-beroepsonderwijs

Let op, geef deze filterwaarde mee als array. Zie voorbeeld: https://schoolwijzer.amsterdam.nl/api/v2/vestigingen?filter[soort_onderwijs][]=basisonderwijs

brin6

Gebruik deze filter om een enkele vestiging aan de hand van diens unieke brin6 code op te zoeken.
Voorbeeld: https://schoolwijzer.amsterdam.nl/api/v2/vestigingen?filter[brin6]=04IU00

stadsdeel

Kies uit:

  • Centrum
  • Noord
  • Oost
  • Zuidoost
  • Zuid
  • West
  • Nieuw-west
  • Westpoort
  • Weesp
  • Buiten Amsterdam

Voorbeeld: https://schoolwijzer.amsterdam.nl/api/v2/vestigingen?filter[stadsdeel]=Noord

grondslag

Filter vestigingen op grondslag. Kies uit:

  • algemeen-bijzonder
  • antroposofisch
  • evangelisch
  • evangelische-broedergemeenschap
  • gereformeerd
  • gereformeerd-vrijgemaakt
  • hindoeistisch
  • humanistisch
  • interconfessioneel
  • islamitisch
  • joods
  • levensbeschouwelijk
  • oecumenisch
  • openbaar
  • protestants-christelijk
  • katholiek
  • rooms-katholiek
  • samenwerking-pc-rk

Voorbeeld: https://schoolwijzer.amsterdam.nl/api/v2/vestigingen?filter[grondslag]=openbaar

onderconcept

Filter vestigingen op onderwijsconcept. Kies uit:

  • dalton
  • jenaplan
  • ontwikkelingsgericht
  • vrije-school
  • montessori
  • natuurlijk-leren

Voorbeeld: https://schoolwijzer.amsterdam.nl/api/v2/vestigingen?filter[onderwijsconcept]=dalton

Kinderopvang

Root URL: https://schoolwijzer.amsterdam.nl/api/v2/kinderopvang.

Inhoud: een volledig overzicht van alle kinderopvanglocaties in Amsterdam.

Beschikbare filters

lrkp_id

Gebruik deze filter om een enkele locatie aan de hand van diens unieke lrkp_id op te zoeken.

Voorbeeld: https://schoolwijzer.amsterdam.nl/api/v2/kinderopvang?filter[lrkp_id]=101160434

vroegschool

Gebruik deze filter om alleen locaties op te halen die een vroegschool zijn. Geaccepteerde waardes zijn 1 of 0, yes of no.

Voorbeeld: https://schoolwijzer.amsterdam.nl/api/v2/kinderopvang?filter[vroegschool]=1

Voorscholen per basisschool

Alle voorscholen kunnen dus opgehaald worden door de Kinderopvang locaties te bevragen met bovengenoemde vroegschool.

Om de voorscholen per basisschool vestiging op te halen kunt u het beste gebruik maken van de include query parameter, een standaard uit de JSON:API standaard. 

De volgende URL geeft alle voorscholen in Amsterdam, met de bijbehorende vestigingen: https://schoolwijzer.amsterdam.nl/api/v2/kinderopvang?filter[vroegschool]=1&include=vestigingen. Hiermee is het mogelijk om vroegscholen te relateren aan basisscholen.

Voorrangsscholen

👉 Let op: de voorrangsscholen kunnen op een speciaal daarvoor ingericht endpoint opgehaald worden. Dit wijkt dus af van de overige API endpoints!

Root URL: https://microservices.schoolwijzer.ivs.amsterdam/voorrangsscholen/api/v1/voorrangsscholen

Inhoud: de lijst voorrangsscholen voor een gegeven adres. Let op: het is verplicht een adres op te geven in deze API, daar de voorrangsscholen altijd gekoppeld zijn aan een specifiek huisadres.

Verplichte filters:

  • page[number] Verplichte parameter. Waarde is 1.
  • filter[jaargang] Een tekstuele weergave van het schooljaar waarin de voorrangsscholen geldig zijn. Bijvoorbeeld "2021-2022".
  • filter[postcode] Postcode van het adres waarvoor voorrangsscholen worden opgevraagd.
  • filter[huisnummer] Het huisnummer zonder toevoeging of huisletter.
  • filter[huisletter] Eventueel een bijbehorende huisletter.
  • filter[huisnummertoevoeging] Eventueel een bijbehorende huisnummertoevoeging.

Let op: alle filters zijn verplicht. Indien een waarde leeg is kan deze gespecificeerd worden in de URL als &huisletter=, zonder waarde. Zie ook hieronder de voorbeeld URL.

Voorbeeld: https://microservices.schoolwijzer.ivs.amsterdam/voorrangsscholen/api/v1/voorrangsscholen?page[number]=1&filter[jaargang]=2021-2022&filter[postcode]=1094HE&filter[huisnummer]=131&filter[huisletter]=&filter[huisnummertoevoeging]=

GEOJSON

Vestigingen en kinderopvang kan ook bekeken worden in GeoJSON formaat.

Root URLs:

Deze APIs kunnen gebruikt worden om vestigingen op een kaart te plotten.

Individuele vestigingen kunnen gevonden worden in de API door hun ID achter de root URL te plakken: