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 creëren van een nieuwe publicatie.
De request is een HTTP POST bericht.
https://api.coret.org/publiceren/creatie/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_naam | string (verplicht, max. 200 tekens) | Naam van de publicatie, bijvoorbeeld "Stamboom Coret". |
| publicatie_info | string (optioneel,max. 2000 tekens) | Vrij tekst: toelichting, dankbetuigingen, bronvermeldingen, enz. |
| auteur_naam | string (verplicht, max. 200 tekens) | Naam van de auteur van de publicatie. |
| auteur_email | string (verplicht, max. 200 tekens) | E-mail adres van de auteur van de publicatie (deze wordt niet gepubliceerd, maar is wel nodig voor communicatie over de publicatie). |
| inclusief_afbeeldingen | boolean (verplicht) | Geeft aan of er na de aanroep van de creatie functie een aanroep zal plaatsvinden van de afbeeldingen functie, dus publicatie inclusief afbeeldingen (true) of publicatie zonder afbeeldingen (false). Als er nog afbeeldingen volgen zal het verwerken van de genealogische data pas plaatsvinden nadat de afbeeldingen zijn ge-upload. |
| toon_leverancier | boolean (optioneel) | Geeft aan of er de naam van het leverende stamboomprogramma wel (true) of niet (false = standaard) getoond mag worden in de publicatie. |
| bestand_gedcom_zip | bestand (verplicht, max. 100MB) | Gecomprimeerd (ZIP) GEDCOM bestand. Het ZIP bestand dient één bestand te bevatten met de extensie .ged. |
Via onderstaand formulier kan de Creatie 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).