API's » Publiceren op Genealogie Online » Ping

Deze webservice (v1) is geschikt om de beschikbaarheid van de pulicatieservice te testen.

Request

De request is een HTTP POST bericht.

URL

https://api.coret.org/publiceren/ping/v1/

Parameters

De volgorde van de parameters is niet relevant.

Parameter	Type	Beschrijving
api_sleutel	string (verplicht, 34 tekens)	De aan de softwareleverancier verstrekte API sleutel.

Uitproberen

Via onderstaand formulier kan de Ping functie getest worden (alle controles zijn actief!):

api_sleutel

Deze Ping functie kan ook eenvoudig via de command-line via Curl aangeroepen worden (waar de api-sleutel op de plaats van de X-en moet worden ingevuld):

curl --data "api_sleutel=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
  "https://api.coret.org/publiceren/ping/v1/"

Response

De response bestaat uit een XML bericht.

Elementen

• Foutmelding - als de verwerking fout is gegaan wordt er een code groter dan 0 geretourneerd.

Een succesvolle aanroep van deze functie (foutcode=0) duidt op een beschikbaar zijnde publicatieservice.

Voorbeeld XML uitvoerformaat

<?xml version="1.0" encoding="utf-8" standalone="yes"?> <Coret> <Publiceren> <Ping> <Foutmelding>0</Foutmelding> </Ping> </Publiceren> </Coret>

Mogelijke fouten

• 0 - Geen fout.
• 1 - De webservice is (tijdelijk) niet beschikbaar. Meer informatie is te vinden op https://www.genealogieonline.nl/publiceren_offline.php.
• 12 - Het veld api_sleutel ontbreekt.
• 13 - Het veld api_sleutel heeft een ongeldige inhoud.
• 18 - De ongegeven api_sleutel is onbekend.
• 403 - De functie kan alleen worden aangeroepen via het https protocol (vanaf 1 september 2018).