In order to keep the implementation of the interface as simple as possible, detailed field lists of the individual processes, such as offer export or order import, are available. The meaning of the respective columns is explained in more detail below.
Column 'Name'
Determines the name of the corresponding XML element or XML attribute.
Column 'Type'
The column 'Type' specifies the type of data to be transferred in the affected element.
Column 'Cardinality'
Here you define the number of elements in a set. The following variants exist:
Designation |
Description |
|---|---|
1 |
The affected element must occur exactly once in the surrounding parent element. |
0..1 |
The affected element is optional and can occur either not at all or only once in the surrounding parent element. |
0..N |
The affected element cannot occur at all, or in any number in the surrounding parent element. |
1..N |
The affected element must occur at least once or more frequently in the surrounding parent element. |
Column 'Description'
Describes briefly the purpose or intention of the field.
Designation |
Description |
Example |
|---|---|---|
Element |
The type "Element" does not describe a data type in the true sense of the word, but indicates that the data element concerned is a wrapper that combines further data. |
|
integer |
•Value range: [ -214748364848,..., 0,..., 2147483647] (Included) •Corresponds to the data type xs:int of the XML Schema definition. |
•-1000 •0 •500 |
long |
•Represents integers with an extended range of values •Value range:[ -922337203372036854775808,..., 0,..., 922333372036854775807] (Included) •Corresponds to the data type xs:long of the XML Schema definition. |
•-2999999999 •0 •3000000000 |
dateTime |
•Presents a time in Coordinated Universal Time (UTC) •Format: oDate in format "YYYY-MM-DD" oAddition of a time specification after the separator "T" in the format "HH:mm:ss" if required oThe time specification can be refined by adding milliseconds in the format ".nnn" as an optional extra. oOptionally, a time zone offset in the format "+HH:00" or "-HH:00") can be added to indicate a local time. Instead of an offset of "+00:00", a "Z" can also be added. •Corresponds to the data type xs:dateTime of the XML Schema definition of the W3C. |
•2012-10-02T00:00:00.000+02:00 •2011-02-01T01:00:44.011Z •2012-12-12T13:45:00 •2010-01-01 |
string |
•Represents alphanumeric strings. •Note: The data in string fields must be transferred in XML-encoded form in the requests, and are also returned in coded form in the response data. The use of certain uncoded special characters (e. g."<") will otherwise lead to an error in the evaluation of the XML data. •Corresponds to the data type xs:string of the XML Schema definition. |
•This is an example text •<html><body>This is an HTML sample text</body></html>. |
boolean |
•Represents the truth values "yes" and "no". •value set: { true, false, 1.0 } •Corresponds to the data type xs:boolean of the XML Schema definition. |
•true •false •1 •0 |
decimal |
•Representes floating point values •As special characters, only the decimal separator (".") and, if necessary, a preceding "-" for negative values are permitted. •Note: A common error is the transfer of a comma symbol (","). Regardless of whether it is used as a decimal separator or for subdividing the integer range of the number, this leads to an error when evaluating the request and should therefore be avoided at all costs! •Corresponds to the data type xs:decimal of the XML Schema definition. |
•1 •1.29 •-99.11 •-5 |
Column 'Comment'
The column "Type" provides additional information regarding the field. For example, a length restriction for fields is mentioned here.
The column "usage" provides information about how to use the parameter.There are three possible values: M for mandatory, O for optional and R for recommended.
