Last Update: 2024-03-21
<?xml version="1.0" encoding="utf-8"?>
<formparticipate id="" source="">
<!-- Salutation //-->
<formitem id="">Herr</formitem>
<!-- Textfield //-->
<formitem id="">John</formitem>
<formitem id="">Doe</formitem>
<formitem id="">john.doe@eyepin.com</formitem>
<!-- Textarea //-->
<formitem id=""><![CDATA[...]]></formitem>
<!-- RadioList //-->
<formitem id="">
<option id="">1</option>
</formitem>
<!-- CheckboxList //-->
<formitem id="">
<option id="">1</option>
<option id=""><![CDATA[Other answer]]></option>
</formitem>
<!-- Selectbox/Dropdown (single select) <select size="1" ...> //-->
<formitem id="">
<!-- same elements as for type="CheckboxList", but only one option //-->
</formitem>
<!-- Checkbox/Term //-->
<formitem id="">1</formitem>
<!-- File/Image //-->
<formitem id="">
<name>document.pdf</name>
<data type="url">https://...</data>
</formitem>
<formitem id="">
<name>image.jpg</name>
<data type="base64">...</data>
</formitem>
<!-- NewsletterSignIn //-->
<formitem id="">
<customer id="">
<topic id="">1</topic>
<topic id="">1</topic>
...
</customer>
<customer id=""></customer>
...
</formitem>
<!-- Extra user data (optional to set address fields) //-->
<address>
<mobile><![CDATA[...]]></mobile>
<fax><![CDATA[...]]></fax>
...
</address>
</formparticipate>
| Element | Format | Mandatory | Description |
|---|---|---|---|
formparticipate | |||
↳ @id | int | yes | ID of form |
↳ @source | Event|Landingpage|Sweepstake|Survey | yes | Determines the type of form |
↳ formitem | |||
↳ @id | yes | ID of formitem | |
↳ option | option of the formitem | ||
↳ @id | yes | ID of the option | |
↳ customer | customer of the NewsletterSignIn | ||
↳ @id | yes | ID of the customer | |
↳ topic | ID of the topic | ||
↳ @id | yes | ID of the topic | |
↳ address | For adding extra address information that does not exist in the form | ||
↳ fax | fax of the user | ||
↳ mobile | mobile number of the user |
<?xml version="1.0"?>
<response>
<code>2000</code>
<description>
<![CDATA[OK]]>
</description>
<data>
On success the ID of the created form.
</data>
</response>
| Element | Format | Description |
|---|---|---|
data |
| Code | Description |
|---|---|
| 2000 | OK |
| 3011 | Error: id missing |
| 3013 | Error: Parameter invalid |
| 3015 | Error: Form or Item not found |