Scans zoeken

API beschrijving

Deze webservice (v1) doorzoekt het register van online beschikbare scans op basis van gebeurtenis type, plaats en datum. Het resultaat is een lijst met bronnamen- en links.

Request

URL

http://api.coret.org/scanszoeken/v1/

Parameters

Parameter Type Beschrijving
etype string (verplicht)
geb, huw of ovl
Het type gebeurtenis waar een akte van wordt gezocht: geboorte of doop ('geb'), huwelijk ('huw) of overlijden of begraven ('ovl').
ejaar numeriek (verplicht)
tussen 1000 en 2000
Het jaartal dat gebeurtenis plaatsvond waar een akte van wordt gezocht.
eplaats string (verplicht) De plaatsnaam waar de gebeurtenis plaatsvond waar een akte van wordt gezocht. In de plaatsnaam dient geen provincie danwel landnaam opgenomen te worden.
eprovincie string (optioneel)
twee hoofdletters
De provincie waar de gebeurtenis plaatsvond waar een akte van wordt gezocht. Voor Nederland is dit één van de volgende waarden: Drenthe (DR), Friesland (FR), Gelderland (GE), Groningen (GR), Limburg (LI), Noord-Brabant (NB), Noord-Holland (NH), Overijssel (OV), Utrecht (UT), Zeeland (ZE) of Zuid-Holland (ZH). Deze waarde heeft een beperkende werking op plaats.
eland string (optioneel)
twee hoofdletters
Het land waar de gebeurtenis plaatsvond waar een akte van wordt gezocht. Hiervoor dient de 2-letterige landcode volgens ISO 3166-1 gebruikt te worden. Deze waarde heeft een beperkende werking op plaats en provincie.
ifamilienaam string (verplicht)
hoofdletterongevoelig
De familienaam van de persoon (of één van de personen in het geval van een huwelijk). Deze familienaam wordt gebruikt om bij sommige bronnen de zoekopdracht nauwer te specificeren. Tussenvoegsel (van der, 't, ten, enz.) hoeven niet opgegeven te worden, deze worden automatisch uit de familienaam gefilterd.
igeslacht string (optioneel)
m of v
(nog niet geïmplementeerd) Sommige bronnen hebben alleen betrekking op vrouwen (bijv. Register van Bruiden) of mannen.
output string (optioneel) Formaat van de uitvoer (altijd UTF-8):
  • xml - voor XML (standaard)
  • json - voor JSON
  • php - voor geserialiseerd PHP
  • jswrite - voor uitvoer van Javascript via document.write's
api_sleutel string (verplicht)
34 tekens
De uitgereikte API sleutel (zie paragraaf Gebruik). Voor test- en demodoeleinden kan de volgende demo sleutel gebruikt worden: 1cc4515dfdd7f97d0d90eeca27e3cd44
Let op: deze demo sleutel wijzigt dagelijks.

Uitproberen

Response

Elementen

Er wordt een set met bronnen geretourneerd waar mogelijkerwijs een scan beschikbaar is van de gezochte gebeurtenis. Een resultaat kan één van de volgende waarden geven:

  • Een directe link naar een scan (dit kan ook een heel register zijn van honderden pagina's);
  • Een link naar een zoekresultaat pagina bij een bronhouder, vanaf hier kan de gebruiker het juiste resultaat aanklikken en dan de scan inzien;
  • Een link als hiervoor die - om technische redenen - via een Genealogie Online link loopt.

De fout code in het resultaat als er iets niet goed is aan het request heeft de volgende betekenis:

  1. Verplichte veld etype ontbreekt of is ongeldig (niet 'geb', 'huw' of 'ovl').
  2. Verplichte veld ejaar ontbreekt of is ongeldig (niet tussen 1000 en 2000).
  3. Verplichte veld eplaats ontbreekt.
  4. Optionele veld eprovincie is ongeldig (zie paragraaf Parameters voor geldige waarden).
  5. Optionele veld eland is ongeldig (zie paragraaf Parameters voor geldige waarden).
  6. Verplichte veld ifamilienaam ontbreekt.
  7. Optionele veld igeslacht is ongeldig (niet 'm' of 'v').
  8. Verplichte veld api_sleutel ontbreekt, is ongeldig (niet 34 tekens) of onbekend (zie paragraaf Gebruik).

Voorbeeld XML uitvoerformaat

<?xml version="1.0" encoding="utf-8" standalone="yes"?> <Coret> <ScansZoekenService> <Resultaten> <Resultaat> <Archief>Alle Friezen</Archief> <Bron>geboorteregister</Bron> <Plaats>Leeuwarden</Plaats> <Provincie>Friesland</Provincie> <Adres>http://www.allefriezen.nl/nl/component/...</Adres> </Resultaat> </Resultaten> </ScansZoekenService> </Coret>

Gebruik

U kunt gratis gebruik maken van deze API met een limiet van 1 request per 5 seconden (per IP adres). U dient wel een API sleutel aan te vragen per e-mail (apicoret.org) en dient u een link (naar http://www.genealogieonline.nl/?gw=ap) en één van de volgende logo's zichtbaar op te nemen:

(212×35)    (64x64)    (83x50)


Terug naar de Scans zoeken Inleiding pagina

Terug naar de Startpagina