GetFieldInfosCommon

Updated on
 
Delivers meta information on all data fields, which occur during import or export for every
tracking type. These data can be used by the client, in order to conduct plausibility and
validity checks prior to the import.

Input

None

Output

<GetFieldInfosCommonResponse xmlns="http://services.zanox.com/erp">
    <fieldinfos>
        <fieldlist trackingtype="3">
            <field intern="currency_alias" type="String" maxlen="3">
                <xpath>amount/price/@currency</xpath>
                <use insert="1" update="0" />
            </field>
            ...
        </fieldlist>
        ...
    </fieldinfos>
</GetFieldInfosCommonResponse>
                

Element Description

<fieldinfos>

Object Data type Description
<fieldinfos>   Contains n elements <fieldlist> as children
<fieldlist>   Contains n elements <field> as children
trackingtype unsignedbyte ID of the tracking type assigned to the element
<fieldlist>
<field>    
intern normalizedstring Internally-used field name
Is used in the ERP profile (refer to the section
ERP profile) during the assignment of individual
fields to one another
type normalizedstring Precise data type or value range of the field
maxlen int Maximum length of the field
(only if "String" or "normalizedstring" is stated
as the type)
<xpath> normalizedstring XPath printout, with which the date can be directly
extracted from the XML dataflow, provided
it is available
<use>    
insert unsignedbyte 0 > Field will be disregarded in the case of an
Insert
1 > Optional field in the case of an Insert
2 > Required field in the case of an Insert
update unsignedbyte 0 > Field will be disregarded in the case of an
Update
1 > Optional field in the case of an Update
2 > Required field in the case of an Update

 

Resource Information

Rate Limited? No
Requests per rate limit window N/A
Authentication Requires Authentication
Response Formats xml
Resource family fieldinfos
Response Object fieldlist
API Version 3.0.1.1