WSE-Definition
Hinweis: Die Inhalte dieser Seite wurden mit Unterstützung von KI erstellt.
Was ist eine WSE-Definition?
Eine WSE-Definition (WebService Export-Definition) ist kein Webservice selbst, sondern die Beschreibung einer Datenstruktur, die von einer fremden API erwartet wird.
Sie dient als Basis für das Mapping zwischen den Feldern unserer frei definierbaren Formulare und den Datenfeldern der Fremd-API.
Erst durch diese Definition wird es möglich, dass Anträge oder mehrere Anträge gesammelt in die Fremdsoftware exportiert werden können.
Zweck der WSE-Definition
Abbildung der API-Struktur
Die WSE-Definition spiegelt die erwartete Datenstruktur des Zielsystems wider.Vorprüfung
Bereits vor einem Export kann geprüft werden, ob ein Antrag überhaupt exportfähig ist. Damit werden unnötige Fehlermeldungen aus der Fremdsoftware vermieden.Sicherheit der Datenübertragung
Beim Umwandeln der Daten wird durch die Definition sichergestellt, dass das Fremdsystem die übermittelten Informationen entgegennehmen kann.Flexibilität
Da die Definition unabhängig vom eigentlichen Export erstellt und gepflegt wird, kann das Mapping jederzeit angepasst werden, ohne dass die Fremdschnittstelle selbst verändert werden muss.
Aufbau einer WSE-Definition
Eine WSE-Definition besteht aus mehreren Grundelementen:
Feld | Beschreibung |
|---|---|
Name | Bezeichnung der WSE-Definition. Dient der internen Identifikation im System. |
Ziel-URL | Die URL des fremden Web-APIs, an die die Daten beim Export gesendet werden. |
Container | Oberste logische Einheit der Datenstruktur. Entspricht meist dem Hauptobjekt, das in der Fremd-API erwartet wird. |
Format | Gibt das Übertragungsformat an (z. B. JSON, XML). |
Ziel-API-Felder innerhalb einer WSE-Definition
Innerhalb der Grunddefinition können beliebig viele Ziel-API-Felder eingetragen werden.
Diese Felder entsprechen den Datenfeldern, die das Fremdsystem erwartet.
Grundlage ist in der Regel ein Datenschema der Fremd-API, das vom API-Anbieter bereitgestellt wird.
Jedes Ziel-API-Feld beschreibt ein einzelnes Element der zu übertragenden Datenstruktur.
Bei der späteren Zuordnung (Mapping) werden diese Ziel-API-Felder mit den Feldern unserer frei definierbaren Formulare verknüpft.
Eigenschaften von Ziel-API-Feldern
Die Eingabeoptionen eines Ziel-API-Feldes hängen vom gewählten Datentyp im Export ab.
Neben allgemeinen Einstellungen (Name, Pflichtfeld, Standardwert, Beschreibung, Beispiel) gibt es spezifische Eigenschaften je nach Datentyp.
Allgemeine Eigenschaften (für alle Datentypen verfügbar)
Eigenschaft | Beschreibung |
|---|---|
Name | Eindeutige Bezeichnung des Ziel-API-Feldes. |
Datentyp im Export | Bestimmt den Typ des exportierten Wertes (z. B. String, Int32, Double, UnixTimeStamp, StringValueList). |
Statischer Wert verwenden | Falls aktiviert, wird immer ein fester Wert exportiert. In diesem Fall ist keine Zuordnung möglich. |
Pflichtfeld im Export | Gibt an, ob dieses Feld zwingend befüllt werden muss, damit das Fremdsystem den Import erfolgreich verarbeiten kann. |
Standardwert | Wird genutzt, falls keine Zuordnung vorhanden ist. Bei „Statischer Wert“ wird immer dieser Wert verwendet. |
Beschreibung | Zweck und Funktion des Feldes im Fremdsystem. Diese Information stammt in der Regel vom Anbieter der Fremd-API. |
Beispiel | Typischer oder gültiger Beispielwert, um die Verwendung in der Zielapplikation zu verdeutlichen. |
Zusätzliche Eigenschaften je nach Datentyp
Datentyp | Zusätzliche Eigenschaften | Beschreibung |
|---|---|---|
String | Maximale Zeichenlänge | Gibt die maximale Länge des Textes an. |
Int32 | Minimaler Wert, Maximaler Wert | Legt den erlaubten Wertebereich für Ganzzahlen fest. |
Double | Minimaler Wert, Maximaler Wert | Legt den erlaubten Wertebereich für Dezimalzahlen fest. |
UnixTimeStamp | – | Keine zusätzlichen Eingabefelder, der Wert wird als Zeitstempel exportiert. |
StringValueList | Maximale Zeichenlänge, Erlaubte Schlüsselwerte (Keys) | Es können können Schlüsselwerte definiert werden; nur diese werden beim Export akzeptiert. |
Hinweise zur Pflege einer WSE-Definition
Eine WSE-Definition wird im Normalfall einmalig bei der Einrichtung des Fremd-APIs erstellt.
Eine Bearbeitung ist nur dann erforderlich, wenn der Anbieter des Fremdsystems Änderungen an der API vornimmt (z. B. neue Felder, geänderte Strukturen).
Beispiele für Ziel API Felder
Datentyp String (statischer Wert)
Eigenschaft | Beschreibung |
|---|---|
Name | foreignSystemName |
Datentyp im Export | String |
Statischer Wert verwenden | aktiviert |
Pflichtfeld im Export | nein |
Maximale Zeichenlänge | 200 |
Standardwert | scholarships.at |
Beschreibung | Name des Zielsystems, wird bei jedem Export fix übergeben. |
Beispiel | AH Plus |
Datentyp String (dynamischer Wert)
Eigenschaft | Beschreibung |
|---|---|
Name | applicantLastName |
Datentyp im Export | String |
Statischer Wert verwenden | deaktiviert |
Pflichtfeld im Export | ja |
Maximale Zeichenlänge | 200 |
Standardwert | – |
Beschreibung | Nachname des Antragstellers, wie er im Formular angegeben ist. |
Beispiel | Mustermann |
Datentyp UnixTimeStamp
Eigenschaft | Beschreibung |
|---|---|
Name | submissionOn |
Datentyp im Export | UnixTimeStamp |
Statischer Wert verwenden | nicht möglich |
Pflichtfeld im Export | ja |
Standardwert | – |
Beschreibung | Datum der Einreichung als Zeitstempel (Unix Timestamp). Beispiel: 20.08.1997 (dd.MM.yyyy) = 872028000000 |
Beispiel | 1648585194210 |
Datentyp StringValueList
Eigenschaft | Beschreibung |
|---|---|
Name | gender |
Datentyp im Export | StringValueList |
Statischer Wert verwenden | möglich |
Pflichtfeld im Export | ja |
Maximale Zeichenlänge | 1 |
Erlaubte Schlüsselwerte (Keys) | M, W, I, T, U |
Standardwert | – |
Beschreibung | Gender (z. B. gemäß Schema |
Beispiel | M |
Datentyp Int32 (dynamischer Wert)
Eigenschaft | Beschreibung |
|---|---|
Name | scholarshipYear |
Datentyp im Export | Int32 |
Statischer Wert verwenden | deaktiviert |
Pflichtfeld im Export | ja |
Minimaler Wert | 2021 |
Maximaler Wert | 2099 |
Standardwert | – |
Beschreibung | Scholarship year ( |
Beispiel | 2021 |