Last Update: 2024-03-21

Form: Get form

Request:

<?xml version="1.0" encoding="utf-8"?>
<getform id="" source="" customerid=""/>
Description of XML-Tags:
Element Format Mandatory Description
getform
↳ @idintyesID of form
↳ @sourceEvent|Landingpage|Sweepstake|SurveyyesDetermines the type of form
↳ @customeridintyesCustomerID of customer used for request. Only usable with admin customer privileges.

Response:

<?xml version="1.0"?>
<response>
    <code>2000</code>
    <description>
        <![CDATA[OK]]>
    </description>
    <data>
        <formitem type="Title" id="" required="0" pos="1" layout="vertical">lorem ipsum ...</formitem>
        <formitem type="Textarea" id="" required="0" pos="2" layout="horizontal">
            <title/>
            <description><![CDATA[...]]></description>
        </formitem>
        <formitem type="Image" id="" required="0" pos="3" layout="vertical">
            <url>http://...</url>
            <size>17295</size>
            <type>jpg</type>
            <name>download.jpeg</name>
            <width>700</width>
            <height>466</height>
            <copyright/>
            <alttext/>
        </formitem>
        <formitem type="CheckboxList" id="" required="1" pos="" layout="vertical">
            <title><![CDATA[...]]></title>
            <description/>
            <options max-answers="">
                <option id="" pos="1">
                    <title><![CDATA[...]]></title>
                    <description/>
                    <list name=""/>
                    <image id="">
                        <url>http://...</url>
                        <size>4283</size>
                        ...
                    </image>
                </option>
                <option id="" pos="2">
                    <title><![CDATA[...]]></title>
                    <description/>
                </option>
                ...
            </options>
        </formitem>
        <formitem type="PriceRadioList" id="" required="0" pos="" layout="vertical">
            <title></title>
            <description></description>
            <options>
                ...
            </options>
        </formitem>
        <formitem type="NewsletterSignIn" id="" required="0" pos="" layout="vertical">
            <title></title>
            <description></description>
            <options>
                <option customerid="" pos="1">
                    <title></title>
                    <topics>
                        <topic pos="1">
                            <title/>
                            <description/>
                        </topic>
                        ...
                    </topics>
                </option>
                ...
            </options>
        </formitem>
        <formitem type="Fileupload" id="" required="0" pos="" layout="vertical">
            <title></title>
            <description></description>
        </formitem>
        <formitem type="Term" language="de" expand-includes-checkbox="1" id="" required="0" pos="" layout="vertical">
            <text></text>
            <checkbox></checkbox>
            <link></link>
        </formitem>
        <formitem type="Separator" id="" required="0" pos="" layout="vertical"/>
    </data>
</response>
Description of XML-Tags:
Element Format Description
data
↳ formitem
 ↳ @type Title|Textarea|Textfield|Image|Select| CheckboxList|RadioList|NewsletterSignIn| PriceRadioList|PriceList|Term| Checkbox|Password|PageBreak|Separator| Fileupload|Imageupload|... Type of formitem
 ↳ @id int ID of formitem
 ↳ @required 0|1 If set to "1" field is mandatory.
 ↳ @pos int Position of formitem
 ↳ @layout vertical|horizontal Layout of formitem
 ↳ @expand-includes-checkbox 0|1 If set to "1" field is expandable. (Only for type "Term")
 ↳ title varchar Title of formitem
 ↳ description varchar Description of formitem
 ↳ text varchar Text of Term
 ↳ checkbox Ckeckbox label of Term
 ↳ link Link of Term
 ↳ options List of options
  ↳ @max-answers int
  ↳ option varchar
   ↳ @id int|varchar ID of the option
   ↳ @customerid int ID of the customer
   ↳ @pos int Position of option
   ↳ title varchar Title of option
   ↳ description varchar Description of option
   ↳ image Details of image
    ↳ @id int ID of option image
    ↳ url varchar URL of option image
    ↳ size int Size of option image
    ↳ type varchar Type of option image
    ↳ name varchar Name of option image
    ↳ width int Width of option image
    ↳ height int Height of option image
    ↳ copyright
    ↳ alttext
   ↳ topics Topics of option-NewsletterSignIn
    ↳ topic Topic of option-NewsletterSignIn
     ↳ @pos int Position of topic
     ↳ title varchar Title of topic
     ↳ description varchar Description of topic
   ↳ list (Event form)
    ↳ @name varchar Name of address list (Event form)
Possible Response-Codes
Code Description
2000 OK
3011 Error: id missing
3012 ERR: Access violation
3013 Error: Parameter invalid
3015 Error: Form not found
Für Rückfragen stehen wir Ihnen jederzeit gerne unter support@eyepin.com zur Verfügung.