The following SOAP methods are provided specifically for interaction with forms.
create
Create webform
EvalancheResourceInformation create (int pool_id, string name)
Details
Parameters
- int pool_id: ID of the Pool
- string name: Name of the Form
Return value
- EvalancheResourceInformation: Object analogous to the method getById (retrieve information about an object using object ID)
Required rights
create Webform
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:form="https://core-staging.dev.broem/soap.php/soap/form">
<soapenv:Header/>
<soapenv:Body>
<form:create>
<pool_id>POOL_ID</pool_id>
<name>NAME</name>
</form:create>
</soapenv:Body>
</soapenv:Envelope></soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/form">
<SOAP-ENV:Body>
<ns1:createResponse>
<createResult>
<url>FORM_URL</url>
<type_id>FORM_TYPE_ID</type_id>
<category_id>FOLDER_ID</category_id>
<customer_id>MANDATOR_ID</customer_id>
<id>FORM_ID</id>
<name>FORM_NAME</name>
</createResult>
</ns1:createResonse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
updateTemplate
Update individual template
EvalancheResourceInformation updateTemplate ( int form_id, string template )
Details
Parameters
- int form_id: ID of the form
- string template: Template as well-formed XML string, UTF-8 encoded
Return value
- EvalancheResourceInformation: Object analogous to the method getById (retrieve information about an object using object ID)
Required rights
none
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:form="https://scnem.com/soap.php/soap/form">
<soapenv:Header/>
<soapenv:Body>
<form:updateTemplate>
<form_id>FORM_ID</form_id>
<source>FORM_TEMPLATE_SOURCE</source>
</form:updateTemplate>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/form">
<SOAP-ENV:Body>
<ns1:updateTemplateResponse>
<updateTemplateResult>
<url>FORM_URL</url>
<type_id>FORM_TYPE_ID</type_id>
<category_id>FOLDER_ID</category_id>
<customer_id>MANDATOR_ID</customer_id>
<id>FORM_ID</id>
<name>FORM_NAME</name>
</updateTemplateResult>
</ns1:updateTemplateResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
addAttributeOption
Add Attribute Option
bool addAttributeOption ( int form_id, int option_id )
Details
Parameters
- int form_id: ID of the form
- int option_id: ID of the pool attribute Option
Return value
- bool: true in case of success
Required rights
none
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:form="https://scnem.com/soap.php/soap/form">
<soapenv:Header/>
<soapenv:Body>
<form:addAttributeOption>
<form_id>FORM_ID</form_id>
<option_id>ATTRIBUTE_OPTION_ID</option_id>
</form:addAttributeOption>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/form">
<SOAP-ENV:Body>
<ns1:addAttributeOptionResponse>
<addAttributeOptionResult>true</addAttributeOptionResult>
</ns1:addAttributeOptionResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
removeAttributeOption
Remove Attribute Option
bool removeAttributeOption ( int form_id, int option_id )
Details
Parameters
- int form_id: ID of the form
- int option_id: ID of the pool attribute Option
Return value
- bool: true in case of success
Required rights
none
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:form="https://scnem.com/soap.php/soap/form">
<soapenv:Header/>
<soapenv:Body>
<form:removeAttributeOption>
<form_id>FORM_ID</form_id>
<option_id>ATTRIBUTE_OPTION_ID</option_id>
</form:removeAttributeOption>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/form">
<SOAP-ENV:Body>
<ns1:removeAttributeOptionResponse>
<removeAttributeOptionResult>true</removeAttributeOptionResult>
</ns1:removeAttributeOptionResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
createAlias
Create a form alias
EvalancheResourceInformation createAlias ( int form_id, string name, int category_id )
Details
Parameters
- int form_id: ID of the form
- string name: Name of the form Alias
- int category_id: ID of the folder in which the alias should be created
Return value
- EvalancheResourceInformation: Object analogous to the method getById (retrieve information about an object using object ID)
Required rights
none
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:form="https://scnem.com/soap.php/soap/form">
<soapenv:Header/>
<soapenv:Body>
<form:createAlias>
<form_id>FORM_ID</form_id>
<name>ALIAS_NAME</name>
<category_id>FOLDER_ID</category_id>
</form:createAlias>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/form">
<SOAP-ENV:Body>
<ns1:createAliasResponse>
<createAliasResult>
<url>FORM_ALIAS_URL</url>
<type_id>FORM_ALIAS_TYPE_ID</type_id>
<category_id>FOLDER_ID</category_id>
<customer_id>MANDATOR_ID</customer_id>
<id>FORM_ALIAS_ID</id>
<name>FORM_ALIAS_NAME</name>
</createAliasResult>
</ns1:createAliasResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getAliases
Read form aliases for a specific form
EvalancheResourceInformation[] getAliases ( int form_id )
Details
Parameters
- int form_id: ID of the form
Return value
- EvalancheResourceInformation[]: List of objects analogous to the method getById (retrieve information about an object using object ID)
Required rights
none
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:form="https://scnem.com/soap.php/soap/form">
<soapenv:Header/>
<soapenv:Body>
<form:getAliases>
<form_id>FORM_ID</form_id>
</form:getAliases>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/form">
<SOAP-ENV:Body>
<ns1:getAliasesResponse>
<getAliasesResult>
<item>
<url>FORM_ALIAS_URL</url>
<type_id>FORM_ALIAS_TYPE_ID</type_id>
<category_id>FOLDER_ID</category_id>
<customer_id>MANDATOR_ID</customer_id>
<id>FORM_ALIAS_ID</id>
<name>FORM_ALIAS_NAME</name>
</item>
[...]
</getAliasesResult>
</ns1:getAliasesResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getFormByAlias
Reading the form of an alias
EvalancheResourceInformation getFormByAlias ( int form_id )
Details
Parameters
- int form_id: ID of the form
Return value
- EvalancheResourceInformation: Object analogous to the method getById (retrieve information about an object using object ID)
Required rights
none
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:form="https://scnem.com/soap.php/soap/form">
<soapenv:Header/>
<soapenv:Body>
<form:getFormByAlias>
<formalias_id>FORM_ALIAS_ID</formalias_id>
</form:getFormByAlias>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/form">
<SOAP-ENV:Body>
<ns1:getFormByAliasResponse>
<getFormByAliasResult>
<url>FORM_URL</url>
<type_id>FORM_TYPE_ID</type_id>
<category_id>FOLDER_ID</category_id>
<customer_id>MANDATOR_ID</customer_id>
<id>FORM_ID</id>
<name>FORM_NAME</name>
</getFormByAliasResult>
</ns1:getFormByAliasResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getStatistics
Read out form statistics
EvalancheFormStatistics[] getStatistics ( int form_id, bool with_aliases )
Details
Parameters
- int form_id: ID of the form
- bool with_aliases: If this parameter is true, the statistics of all aliases of the form are also returned
Return value
- EvalancheFormStatistics[]: List of objects with the following attributes:
- int id: ID of the form or form alias
- string name: Name of the form or form alias
- bool is_alias: true, if it is a form alias
- int impressions: Number of page impressions or openings
- int succeeded: Number of successful entries
- int identity_errors: Number of identity errors (for login forms)
- int duplication_errors: Number of prevented duplicate entries
- int validation_errors: Number of validation errors
- int mandatory_errors: Number of breaches of duty
Required rights
none
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:form="https://scnem.com/soap.php/soap/form">
<soapenv:Header/>
<soapenv:Body>
<form:getStatistics>
<formular_id>FORM_ID</formular_id>
<with_aliases>INCLUDE_ALIASES</with_aliases>
</form:getStatistics>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/form">
<SOAP-ENV:Body>
<ns1:getStatisticsResponse>
<getStatisticsResult>
<item>
<is_alias>IS_ALIAS</is_alias>
<impressions>IMPRESSIONS</impressions>
<succeeded>ENTRIES</succeeded>
<identity_errors>IDENTITY_ERRORS</identity_errors>
<duplication_errors>DUPLICATION_ERRORS</duplication_errors>
<validation_errors>VALIDATION_ERRORS</validation_errors>
<mandatory_errors>MANDATORY_ERRORS</mandatory_errors>
<id>FORM_ID</id>
<name>FORM_NAME</name>
</item>
[...]
</getStatisticsResult>
</ns1:getStatisticsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
removeAttribute
Remove fields from form
EvalancheFormStatistics[] removeAttribute ( int form_id, int attribute_id )
Details
Parameters
- int form_id: ID of the form
- int form_attribute_id: ID of the attribute field to be removed. The attribute ID does not correspond to the pool attribute ID. The attribute ID is returned as a response to the addition of an attribute.
Return value
- bool: true in case of success
Required rights
none
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:form="https://scnem.com/soap.php/soap/form">
<soapenv:Header/>
<soapenv:Body>
<form:getStatistics>
<formular_id>FORM_ID</formular_id>
<form_attribute_id>ATTRIBUTE_ID</form_attribute_id>
</form:getStatistics>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/form">
<SOAP-ENV:Body>
<ns1:removeAttributeResponse>
<removeAttributeResult>true</removeAttributeResult>
</ns1:removeAttributeResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getConfiguration
Read configuration of the form
EvalancheFormConfig[] getConfiguration (int form_id)
Details
Parameter
- int form_id: ID of the form
Return value
- EvalancheFormConfig[] Configuration parameter of the form
Required rights
Show form
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:form="https://scnem.com/soap.php/soap/form">
<soapenv:Header/>
<soapenv:Body>
<form:getConfiguration>
<form_id>FORM_ID</form_id>
</form:getConfiguration>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/form">
<SOAP-ENV:Body>
<ns1:getConfigurationResponse>
<getConfigurationResult>
<unique_entry_criteria_id>1</unique_entry_criteria_id>
<block_duplicates/>
<do_not_reset_unsubscription/>
<permission_mode/>
<enable_post_address_validation/>
<success_url></success_url>
<emailing_id/>
<emailing_targetgroup_id></emailing_targetgroup_id>
<newsletter_bcc_recipient_email/>
<inquiry_emailing_id/>
<inquiry_send_on_change/>
<inquiry_recipient_emails/>
<form_language></form_language>
<enable_automated_entry_protection/>
<re_captcha_activated/>
<is_mobile_optimized></is_mobile_optimized>
<is_auto_submit_form/>
<validation_form_id/>
<auto_form_action_activated></auto_form_action_activated>
<form_api_state/>
<form_api_cors_domains/>
<external_trackingcode/>
</getConfigurationResult>
</ns1:getConfigurationResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
setConfiguration
Set configuration of a form
EvalancheFormConfig[] setConfiguration (int form_id, str[] configuration)
Details
Parameter
- int form_id: ID of the form
- str[] configuration: List of form options to configure
Return value
- EvalancheFormConfig[] Configuration parameter of the form
Required rights
Change form
Use
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:form="https://scnem.com/soap.php/soap/form">
<soapenv:Header/>
<soapenv:Body>
<form:setConfiguration>
<form_id>FORM_ID</form_id>
<configuration>
<!--You may enter the following 22 items in any order-->
<unique_entry_criteria_id></unique_entry_criteria_id>
<block_duplicates></block_duplicates>
<do_not_reset_unsubscription></do_not_reset_unsubscription>
<permission_mode></permission_mode>
<enable_post_address_validation></enable_post_address_validation>
<success_url></success_url>
<emailing_id></emailing_id>
<emailing_targetgroup_id></emailing_targetgroup_id>
<newsletter_bcc_recipient_email></newsletter_bcc_recipient_email>
<inquiry_emailing_id></inquiry_emailing_id>
<inquiry_send_on_change></inquiry_send_on_change>
<inquiry_recipient_emails></inquiry_recipient_emails>
<form_language></form_language>
<enable_automated_entry_protection></enable_automated_entry_protection>
<re_captcha_activated></re_captcha_activated>
<is_mobile_optimized></is_mobile_optimized>
<is_auto_submit_form></is_auto_submit_form>
<validation_form_id></validation_form_id>
<auto_form_action_activated></auto_form_action_activated>
<form_api_state></form_api_state>
<form_api_cors_domains></form_api_cors_domains>
<external_trackingcode></external_trackingcode>
</configuration>
<overwrite>1</overwrite>
</form:setConfiguration>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/form">
<SOAP-ENV:Body>
<ns1:getConfigurationResponse>
<getConfigurationResult>
<unique_entry_criteria_id>1</unique_entry_criteria_id>
<block_duplicates/>
<do_not_reset_unsubscription/>
<permission_mode/>
<enable_post_address_validation/>
<success_url></success_url>
<emailing_id/>
<emailing_targetgroup_id></emailing_targetgroup_id>
<newsletter_bcc_recipient_email/>
<inquiry_emailing_id/>
<inquiry_send_on_change/>
<inquiry_recipient_emails/>
<form_language></form_language>
<enable_automated_entry_protection/>
<re_captcha_activated/>
<is_mobile_optimized></is_mobile_optimized>
<is_auto_submit_form/>
<validation_form_id/>
<auto_form_action_activated></auto_form_action_activated>
<form_api_state/>
<form_api_cors_domains/>
<external_trackingcode/>
</getConfigurationResult>
</ns1:getConfigurationResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>