Deze webservice (v1) maakt het mogelijk om genealogische data (in de vorm van GEDCOM) aan te bieden ter publicatie op Genealogie Online. Het gaat hierbij om het bijwerken van een bestaande publicatie.
De request is een HTTP POST bericht.
https://api.coret.org/publiceren/bijwerken/v1/
De volgorde van de parameters is niet relevant.
| Parameter | Type | Beschrijving |
|---|---|---|
| api_sleutel | string (verplicht, 34 tekens) | De aan de softwareleverancier verstrekte API sleutel. |
| publicatie_code | string (verplicht, 16 tekens) | De unieke code van de publicatie die bijgewerkt moet worden. |
| bestand_gedcom_zip | bestand (verplicht, max. 100MB) | Gecomprimeerd (ZIP) GEDCOM bestand. Het ZIP bestand dient één bestand te bevatten met de extensie .ged. |
| inclusief_afbeeldingen | boolean (verplicht, true/false) | Geeft aan of er na de aanroep van de creatie functie een aanroep zal plaatsvinden van de afbeeldingen functie (dus publicatie inclusief afbeeldingen). Als dit het geval is (dus bij waarde true) zal het verwerken van de genealogische pas plaatsvinden na dat ook de afbeeldingen zijn ge-upload. |
Via onderstaand formulier kan de Bijwerken functie getest worden (alle controles zijn actief!):
De response bestaat uit een XML bericht.
Na een succesvolle aanroep van deze functie (foutcode=0) kan de Afbeeldingen functie 1 of meer keer aangeroepen worden (als inclusief_afbeelding op true stond).
Het is aan te raden om in het geval van een update van een publicatie (in de wizard) eerst de publicatie_code te controleren alvorens de GEDCOM te produceren/comprimeren/transporteren. Dit kan door deze Bewerk functie aan te roepen met de parameter bestand_gedcom_zip leeg en api_key en publicatie_code gevuld met de juiste waarden. De te verwachten error code is dan 10.
Auteurs die reeds een publicatie op Genealogie Online hebben door directe aanlevering via e-mail zullen bij ingebruikname van de API door een specifiek stamboomprogramma op de hoogte worden gesteld van deze nieuwe mogelijkheid. In deze e-mail zullen de auteurs voor hun publicatie een publicatie code ontvangen, zodat zij eenvoudig vanuit hun stamboomprogramma hun (bestaande) publicatie kunnen bijwerken.
Naast de eenmalige e-mail kunnen auteurs zelf via de self-service website mijn.genealogieonline.nl de publicatie code van hun publicatie opzoeken. Het is aan te raden om deze functionaliteit te noemen in de dialoog of helptekst van het stamboomprogramma.