6 Spezifische Endpunkte
Eigenen Kontakt aufrufen
GET /api/kontakt/ichDer Kontakt, der dem Zugang, der aktuell zum Zugreifen der API verwendet wird, kann so abgerufen werden. Auch alle Kindlisten und Methoden von Kontakt können so aufgerufen werden. Bspw. kann mit
GET /api/kontakt/ich/termine auf die Termine des eigenen Kontaktes zugegriffen werden, oder mit POST /api/kontakt/ich/emailadresse eine neue E-Mailadresse hinterlegt werden.Anschrift mit Adressangabe erstellen
Eine Adresse besteht üblicherweise aus Straße, Hausnummer, PLZ, Ort, Bundesland und Land sowie optional u.a. Postfach, Längengrad und Breitengrad oder Bezirk. Eine Adresse sollte im System nur ein mal existieren. Wenn sich mehrere Kontakte und/oder Orte an derselben Adresse befinden, werden diese mit demselben Adressobjekt verknüpft.
Bei Kontakten passiert das über die Anschrift, welche dann auch Informationen wie "zu Händen" oder "c/o" enthalten kann. Die API bietet einen einfachen Endpunkt, mit dem für einen Kontakt eine Anschrift unter Angabe von Adressdaten erstellt werden kann:
POST /api/kontakt/{autowert|"ich"}/anschriftHier können neben dem normalem Erstellen einer Anschrift unter Angabe des Adressen-Autowerts unter f_adresse auch die Adressdaten direkt übergeben werden. Das System sucht dann nach bestehenden Adressen mit diesen Daten. Wenn eine gefunden wird, wird diese verwendet. Anderenfalls wird eine neue Adresse mit diesen Daten erstellt. Folgende Felder können dabei verwendet werden:
strasseplzortpostfachlaengengradbreitengradbeschreibunghausnummerortsteilbezirkzusatz_1zusatz_2land– ISO 3166-1 ALPHA-2 oder ALPHA-3-Kürzel oder Name auf Deutsch- oder
f_land– Autowert des Landes bundesland– Kürzel (Deutschland: zweistellig) oder Name auf Deutsch- oder
f_bundesland– Autowert des Bundeslandes regierungsbezirk
Längengrad und Breitengrad werden bei eingerichteter OpenStreetMap-Schnittstelle automatisch aus Straße, Hausnummer und PLZ/Ort generiert. Ebenso wird, sobald diese drei Werte gesetzt sind, auch PLZ/Ort, Bundesland, Land und ggf. Ortsteil und Bezirk befüllt. Es reicht also in der Regel, Straße, Hausnummer und PLZ oder Ort zu befüllen.
