Erläuterung der Feldlisten

Navigation:  Introduction >

Erläuterung der Feldlisten

Previous pageReturn to chapter overviewNext page

Die Feldlisten der Webservice-Calls beschreiben detailliert den Aufbau der Webservice-Requests, bzw. -Respones. Die Bedeutung der jeweiligen Spalten wird im folgenden näher erläutert.

Spalte "Name"

Legt den Namen des entsprechenden XML-Elements oder XML-Attributs fest.

Spalte "Beschreibung"

Beschreibt kurz den Verwendungszweck, bzw. die Intention des Feldes.

Spalte "Anz."

Hier wird festgelegt mit welcher Häufigkeit ein Element innerhalb seines Eltern-Elementes vorkommen kann oder muss. Es existieren folgende Varianten:

Bezeichnung

Beschreibung

1

Das betroffene Element muss exakt ein mal im umgebenden Eltern-Element vorkommen.

0..1

Das betroffene Element ist optional und kann entweder gar nicht oder genau ein mal im umgebenden Eltern-Element vorkommen.

0..N

Das betroffene Element kann überhaupt nicht, oder in einer beliebigen Anzahl im umgebenden Eltern-Element vorkommen.

1..N

Das betroffene Element muss mindestens ein mal oder häufiger im umgebenden Eltern-Element vorkommen.

Spalte "Typ"

Die Spalte "Typ" spezifiziert die Art der Daten die im betroffenen Element übergeben werden.

Bezeichnung

Beschreibung

Beispiele

Element

Der Typ "Element" beschreibt keinen Datentyp im eigentlichen Sinn, sondern weist darauf hin das es sich beim betroffenen Daten-Element um einen Wrapper handelt, der weitere Daten in sich zusammenfasst.


integer

Repräsentiert ganze Zahlen

Wertebereich: [ -2147483648, ... , 0, ... , 2147483647 ] (Inklusive)

Entspricht dem Datentyp xs:int der XML-Schema-Definition.

-1000

0

500

long

Repräsentiert ganze Zahlen mit einem erweiterten Wertebereich

Wertebereich: [ -9223372036854775808, ... , 0, ... , 9223372036854775807  ] (Inklusive)

Entspricht dem Datentyp xs:long der XML-Schema-Definition.

-2999999999

0

500

3000000000

dateTime

Repräsentiert einen Zeitpunkt in der koordinierten Weltzeit (UTC)

Format:

oDatumsangabe im Format "YYYY-MM-DD"

oBei Bedarf Ergänzung einer Zeitangabe nach dem Trennzeichen "T" im Format "HH:mm:ss"

oEine Verfeinerung der Zeitangabe ist durch die optionale Ergänzung von Millisekunden im Format ".nnn" möglich.

oOptional ein Zeitzonen-Offset im Format "+HH:00" oder "-HH:00") zur Angabe einer Ortszeit ergänzt werden. Anstatt einem Offset von "+00:00" kann auch ein "Z" ergänzt werden.

Entspricht dem Datentyp xs:dateTime der XML-Schema-Definition des W3C.

Wird ein XML-Knoten dieses Datentyps leer übergeben, dann wird das Datum in diesem Feld gelöscht.

Beispiele:

oJava: javax.xml.datatype.DatatypeFactory.newInstance()
.newXMLGregorianCalendar(new java.util.GregorianCalendar()).toString();

oC#: System.DateTime.Now.ToString("o");

2012-10-02T00:00:00.000+02:00

2011-02-01T01:00:44.011Z

2012-12-12T13:45:00

2010-01-01

date

entspricht dem Format dateTime, allerdings ohne Zeitangaben

2010-01-01

string

Repräsentiert alphanumerische Zeichenketten.

Achtung: Die Daten in String-Feldern müssen XML-Encodiert in den Requests übergeben werden, und kommen in den Response-Daten auch codiert zurück. Die Verwendung von bestimmten uncodierten Sonderzeichen (z.B. "<") führt sonst zu einem Fehler bei der Auswertung der XML-Daten.

Entspricht dem Datentyp xs:string der XML-Schema-Definition.

Dies ist ein Beispiel-Text

&lt;html&gt;&lt;body&gt;Dies ist ein HTML-Beispieltext&lt;/body&gt;&lt;/html&gt;

boolean

Repräsentiert die Wahrheitswerte "Ja" und "Nein"

Wertemenge: { true, false, 1, 0 }

Entspricht dem Datentyp xs:boolean der XML-Schema-Definition.

true

false

1

0

decimal

Repräsentiert Fließkommazahlen

Als Sonderzeichen sind lediglich der Dezimaltrenner ("."), sowie bei Bedarf ein vorangestelltes "-" für negative Werte zugelassen.

Achtung: Ein häufiger Fehler ist die Übergabe eines Komma-Symbols (","). Unabhängig davon ob es als Dezimaltrenner oder zur Untergliederung des ganzzahligen Bereichs der Zahl verwendet wird, führt dies zu einem Fehler beim Auswerten des Requests und sollte daher unbedingt vermieden werden!

Entspricht dem Datentyp xs:decimal der XML-Schema-Definition.

1

1.29

-99.11

-5

Spalte "Sonstiges"

Die Spalte "Sonstiges" gibt ergänzende Hinweise zum Feld. Beispielsweise sei hier eine Längenbeschränkung bei String-Feldern genannt.

Änderungsübersicht

Version

Änderungsbeschreibung

3.2.9.75

Neu ergänzt.