Skip to end of metadata
Go to start of metadata

Die Schnittstellen der Cloud API bestehen aus Entitäten, die im Json Format abgebildet werden. Für jeden Anwendungsfall ist eine eigene Kombination dieser Entitäten einzusetzen. Die einzige zulässige Zeichenkodierung ist UTF-8.

Diese Datenstrukturen werden im Folgenden beschrieben und den verschiedenen Requesttypen zugeordnet. Alle Entitäten werden als Collections übertragen (siehe Beispiel in Kapitel 6). Es ist prinzipiell möglich, mehrere Entitäten desselben Typs in einem Job zu versenden. Alle Felder werden als Zeichenkette übergeben. Im Bemerkungsfeld der Tabelle werden ggf. besondere Formatierungen der jeweiligen Zeichenkette aufgeführt.


Beschreibung der Feld-Typen

Feld-TypJson-Typ Json Null-Wert*Json-BeispielKommentar

string

null
"Beispiel Text"
Einzeiliger Text
stringnull"Das ist ein\nText mit Zeilenumbruch."Mehrzeiliger Fließtext. "\n" markiert einen Zeilenumbruch.
arraynull
[ "Text1", "Text2" ]

objectnull
{ "key1": "Text1", "key2", "Text2" }

objectnull

{ ... }


stringnull"2021-09-01" ISO-8601 Spezifikation (JJJJ-MM-TT)
stringnull2021Format JJJJ
stringnull"XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"GUIDs werden im 8-4-4-4-12 Format angegeben und erwartet (36 Buchstaben (A–F|a-f)/Ziffern (0–9)/Bindestriche)
arraynull[ "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX" ]
stringnull"DE"

Ländercodes werden gemäß ISO 3166-1 Alpha-2 angegeben: XX

stringnull"1234,56"

Format: 999999999,99, Dezimalzeichen:  Komma

arraynull 

[{ ... }, { ... }, { ... }]


stringnull"[seniorengerecht, barrierefrei]"Kommasepariertes String-Array 
stringnull"true" or "false"Bitte beachten, dass es sich hierbei um eine Zeichenkette "true" bzw. "false" handelt und nicht den Json Datentyp boolean. 
stringnull"1234"
stringnull "950,52"
stringnull"1234,45"
stringnull"Bedarfsausweis"Wert aus einer festgelegten Enumeration z.B. 

nicht vorhanden,

Verbrauchsausweis

Bedarfsausweis

stringnull"1234,21"Geldbetrag in Euro

*Sind Json-Properties im Json-Dokument nicht vorhanden, ist das gleichbedeutend als ob die Properties mit einem Null-Wert im Dokument vorhanden sind.


  • No labels