GoliathAPIStandard
Objektbeispiel
Objektbeschreibung
JSON-Pfad | Ausprägungen | Beschreibung |
---|---|---|
APIRueckmeldung |
| Wird ausschließlich von der API selbst in das JSON eingefügt, welches dem aufrufenden System als Rückmeldung zurückgegeben wird. Darüber kann das Ergebnis vom aufrufenden System strukturiert verarbeitet werden. |
APIRueckmeldung.Fehler |
|
|
APIRueckmeldung.Informationen |
|
|
APIRueckmeldung.Valide |
| Sobald eine der enthaltenen Transaktionen nicht valide ist, wird das gesamte JSON als nicht Valide gekennzeichnet. Für die Verarbeitung bleibt jedoch jede Transaktion gekapselt, so dass diese verarbeitet wird wenn die Transaktion selbst valide ist. |
APIRueckmeldung.Warnungen |
| JSON bleibt bei vorkommenden Warnungen valide. |
APITyp | GoliathAPIStandard | Gibt das verwendete API-Schema vor. |
APIVersion | v0.0.0 | Definiert die Version des verwendeten API-Schema. Hat nichts mit der GoliathAPI.DLL-Version zu tun! |
Einreicher |
|
|
Einreicher.SystemID |
| Gibt an aus welchem Programm die Daten kommen. |
Einreicher.TeilsystemID |
| Gibt einen genaueren Bereich des Programms an von welchem die Daten kommen |
Transaktionen[Anzahl] |
|
|
Transaktionen[Anzahl].APIOperation |
| Definiert was mit der Transaktion gemacht werden soll. |
Transaktionen[Anzahl].APIOperation.Aktion | Anlegen, Aktualisieren |
|
Transaktionen[Anzahl].APIOperation.Aufgabe | Vorabcheck, Verarbeiten |
|
Transaktionen[Anzahl].APIOperation.Typ | Kundenauftrag | Definiert das zu verwendende Transaktions-Schema. |
Transaktionen[Anzahl].APIOperation.Version | v0.0.0 | Definiert die Transaktions-Schema Version. |
Transaktionen[Anzahl].APIRueckmeldung |
| Wird ausschließlich von der API selbst in das JSON eingefügt, welches dem aufrufenden System als Rückmeldung zurückgegeben wird. Darüber kann das Ergebnis vom aufrufenden System strukturiert verarbeitet werden. |
Transaktionen[Anzahl].APIRueckmeldung.Fehler |
| Sobald 1 Fehler enthalten ist, ist die gesamte Transaktion nicht valide und wird nicht verarbeitet. |
Transaktionen[Anzahl].APIRueckmeldung.Informationen |
|
|
Transaktionen[Anzahl].APIRueckmeldung.Valide |
|
|
Transaktionen[Anzahl].APIRueckmeldung.Warnungen |
| Transaktion bleibt bei vorkommenden Warnungen valide. |
Transaktionen[Anzahl].Daten |
| Beinhaltet das Datenobjekt des angegebenen Transaktionsobjekts, welches in Transaktionen[Anzahl].APIOperation.Typ angegeben wurde. |