Parameter der OPENWOWI

Welche generellen Parameter gibt es?

Die OPENWOWI hat seit der Version 1.1 immer mehr auf die Individualisierung der API-Abrufe für die spezifischen Partnerbedürfnisse gesetzt. Die API-Endpunkte sind deshalb mit einer Reihe von Parametern ausgestattet, welche es den Anwendern erlauben, den Inhalt der API-Antwort den eigenen Anforderungen anzupassen.

Einige Parameter sind hierbei erwähnenswert.

Limit Limit gibt an, wie viele Datenobjekte geliefert werden sollen. Das Limit liegt zwischen 1 und 100. Das Limit ist notwendig, um die Antwortzeiten und die Arbeitslast auf den Datenbankservern besser steuern zu können.
Offset Der Offset gibt an, mit welchem Datenobjekt gestartet wird. Ein Offset von "0" startet mit dem ersten Objekt. Ein Limit von 100 liefert also die Datensätze 0 bis 99. Ein Offset von 100 liefert dann die nächsten 100 Datensätze.
Id Die Id bezieht sich immer auf die spezifischen Objekte des gerade genutzten Endpunktes. Dieser Parameter erlaubt es dem Nutzer, gezielt einen einzelnen Datensatz abzufragen.
IdNum, ...Number Die IdNum ist die alphanumerische ID, welche in WOWIPORT als Identifikator für den Nutzer erkennbar ist. Die Struktur der IdNum wird in WOWIPORT über die Nummernlogik gesteuert und kann nicht von externen Anwendungen vorgegeben werden.
showNullValues Diese Option erlaubt es dem Nutzer, leere Datenfelder mit auszugeben. Diese Option ist insbesondere für die Tests in Kundensystemen sinnvoll, da hiermit verifiziert werden kann, dass bestimmte, erwartete Daten tatsächlich nicht vorhanden sind.
include... Parameter, welche mit dem "include"-Zusatz versehen sind, erlauben es, die API-Antwort durch zusätzliche Daten zu erweitern, welche ggf. einen erneuten Abruf über einen anderen Endpunkt überflüssig machen.
...Id Der Zusatz "Id" an einem Parameter bedeutet, dass der Endpunkt über diese IDs eine Filterung der Ergebnisse vornehmen kann. Es werden also nur Ergebnisse ausgegeben, bei denen der Datenschlüssel für die ID dem angegebenen Parameter entspricht.
valid... , ...Date... und ...ActiveOn Die Zusätze "valid", "Date" und "ActiveOn" bedeuten, dass es möglich ist, Daten anzugeben, an oder in denen ein bestimmter Datensatz gültig war. Dies ist insbesondere bei Verträgen sinnvoll. Durch diesen Parameter können z. B. ungültige Verträge herausgefiltert werden. Das Format lautet hier "YYYY-MM-dd".
BookingPeriodNumber... und BookingDate... Die Buchungsperioden werden für die jeweiligen Geschäftsjahre angelegt. Die Anzahl und Dauer der Buchungsperioden können vom Kunden individuell festgelegt werden. Die Buchungsperiode wird als ganze Zahl ausgedrückt. Das Buchungsdatum grenzt den Zeitraum nach Datum ein. Das Format lautet hier "YYYY-MM-dd".
FiscalYearNumber Das Fiskaljahr wird in den Buchungen verwendet und wird im Format "YYYY" angegeben.
includeAdditionalFieldDieser Parameter erlaubt den Einbezug von undefinierten Zusatzfelddaten. Diese Felder sind für jeden Kunden unterschiedlich und müssen durch zusätzliche Einstellungen in den Zusatzfelddefinitionen für die API freigegeben werden. Wurde ein Feld für die OPEN WOWI freigegeben, ist dieses für alle API-Keys verfügbar, welche auf den entsprechenden Endpunkt zugreifen können.

Last updated 11 months ago

Welche generellen Parameter gibt es?

Einige Parameter sind hierbei erwähnenswert.

Limit Limit gibt an, wie viele Datenobjekte geliefert werden sollen. Das Limit liegt zwischen 1 und 100. Das Limit ist notwendig, um die Antwortzeiten und die Arbeitslast auf den Datenbankservern besser steuern zu können.

Offset Der Offset gibt an, mit welchem Datenobjekt gestartet wird. Ein Offset von "0" startet mit dem ersten Objekt. Ein Limit von 100 liefert also die Datensätze 0 bis 99. Ein Offset von 100 liefert dann die nächsten 100 Datensätze.

Id Die Id bezieht sich immer auf die spezifischen Objekte des gerade genutzten Endpunktes. Dieser Parameter erlaubt es dem Nutzer, gezielt einen einzelnen Datensatz abzufragen.

IdNum, ...Number Die IdNum ist die alphanumerische ID, welche in WOWIPORT als Identifikator für den Nutzer erkennbar ist. Die Struktur der IdNum wird in WOWIPORT über die Nummernlogik gesteuert und kann nicht von externen Anwendungen vorgegeben werden.

showNullValues Diese Option erlaubt es dem Nutzer, leere Datenfelder mit auszugeben. Diese Option ist insbesondere für die Tests in Kundensystemen sinnvoll, da hiermit verifiziert werden kann, dass bestimmte, erwartete Daten tatsächlich nicht vorhanden sind.

include... Parameter, welche mit dem "include"-Zusatz versehen sind, erlauben es, die API-Antwort durch zusätzliche Daten zu erweitern, welche ggf. einen erneuten Abruf über einen anderen Endpunkt überflüssig machen.

...Id Der Zusatz "Id" an einem Parameter bedeutet, dass der Endpunkt über diese IDs eine Filterung der Ergebnisse vornehmen kann. Es werden also nur Ergebnisse ausgegeben, bei denen der Datenschlüssel für die ID dem angegebenen Parameter entspricht.

valid... , ...Date... und ...ActiveOn Die Zusätze "valid", "Date" und "ActiveOn" bedeuten, dass es möglich ist, Daten anzugeben, an oder in denen ein bestimmter Datensatz gültig war. Dies ist insbesondere bei Verträgen sinnvoll. Durch diesen Parameter können z. B. ungültige Verträge herausgefiltert werden. Das Format lautet hier "YYYY-MM-dd".

BookingPeriodNumber... und BookingDate... Die Buchungsperioden werden für die jeweiligen Geschäftsjahre angelegt. Die Anzahl und Dauer der Buchungsperioden können vom Kunden individuell festgelegt werden. Die Buchungsperiode wird als ganze Zahl ausgedrückt. Das Buchungsdatum grenzt den Zeitraum nach Datum ein. Das Format lautet hier "YYYY-MM-dd".

FiscalYearNumber Das Fiskaljahr wird in den Buchungen verwendet und wird im Format "YYYY" angegeben.

includeAdditionalFieldDieser Parameter erlaubt den Einbezug von undefinierten Zusatzfelddaten. Diese Felder sind für jeden Kunden unterschiedlich und müssen durch zusätzliche Einstellungen in den Zusatzfelddefinitionen für die API freigegeben werden. Wurde ein Feld für die OPEN WOWI freigegeben, ist dieses für alle API-Keys verfügbar, welche auf den entsprechenden Endpunkt zugreifen können.