Gedbas4all/API

Hinzufügen von Informationen

Mit einem POST-Request an xml/write kann man Daten schreiben. Das sieht z.B. so aus:

<add published="permanent" project="familienanzeigen">
<casAuthentication proxyTicket="PT-53829..." />
<persona id="#hermann" name="Hermann Janz" />
  <characteristic id="#c1">
    <part type="firstname" value="Hermann" />
    <part type="firstname" value="Heinrich" />
    <part type="lastname" value="Janz" />
  </characteristic>
  <event id="#e1" type="birth" place="Neumühlen-Dietrichsdorf">
    <date calendar="calendar_gregorian" type="point">
      <start>
         <datePart type="datePart_year" value="1896" />
         <datePart type="datePart_month" value="1" />
         <datePart type="datePart_day" value="22" />
      </start>
    </date>
  </event>
  <assertion subject1="#hermann" subject2="#c1"/>
  <assertion subject1="#hermann" subject2="#e1"/>
</add>

Als Antwort bekommt man eine Zuordnung von lokalen zu globalen IDs:

<response>
  <persona local="#hermann" global="7829384"/>
  <characteristic local="#c1" global="7829385"/>
  <event local="#e1" global="7829387"/>
</response>

Kennungen (IDs)

Es gibt dabei zwei Arten von IDs:

• global gültige IDs, die bereits in gedbas4all vorhanden sind
• nur für diese Übermittlung gültige IDs, die in gedbas4all globalen IDs zugeordnet werden. Diese beginnen mit dem #-Zeichen.

Authentifizierung

Für die Authentifizierung sind drei Möglichkeiten vorgesehen:

• Authentifizierung einer Applikation, die vertrauenswürdig ist und Daten verschiedener Benutzer eintragen darf
• Authentifizierung eines einzelnen Benutzers mit Hilfe einem CAS-Proxy Ticket. Alle Daten werden dabei diesem einem Benutzer geordnet.
• Authentifizierung eines einzelnen Benutzers mit Hilfe von Benutzername und Passwort. Alle Daten werden dabei diesem einem Benutzer geordnet.

Abrufen von Informationen

Über einen GET-Request an xml/event/7829387 kann man die Daten eines Objekts abrufen. Zurückgeliefert wird ein Dokument wie dieses:

<event id="#7829387" type="birth" place="Neumühlen-Dietrichsdorf">
    <date calendar="calendar_gregorian" type="point">
      <start>
         <datePart type="datePart_year" value="1896" />
         <datePart type="datePart_month" value="1" />
         <datePart type="datePart_day" value="22" />
      </start>
    </date>
</event>