Folgende SOAP-Methoden werden speziell für die Interaktion mit Formularen bereitgestellt.
create
Formular anlegen
EvalancheResourceInformation create (int pool_id, string name)
Details
Parameter
- int pool_id: ID des zu verwendenden Pools
- string name: Name des Formulars
Rückgabewert
- EvalancheResourceInformation: Objekt analog zur Methode getById (Informationen über ein Objekt mittels Objekt ID abfragen)
Benötigte Rechte
Formular erstellen
Verwendung
<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
Individualvorlage aktualisieren
EvalancheResourceInformation updateTemplate (int form_id, string template)
Details
Parameter
- int form_id: ID des Formulars
- string template: Template als wohlgeformter XML-String, UTF-8 kodiert
Rückgabewert
- EvalancheResourceInformation: Objekt analog zur Methode getById (Informationen über ein Objekt mittels Objekt ID abfragen)
Benötigte Rechte
keine
Verwendung
<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
Attributoption hinzufügen
bool addAttributeOption (int form_id, int option_id)
Details
Parameter
- int form_id: ID des Formulars
- int option_id: ID der Pool Attribut Option
Rückgabewert
- bool: true im Erfolgsfall
Benötigte Rechte
keine
Verwendung
<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
Attributoption entfernen
bool removeAttributeOption (int form_id, int option_id)
Details
Parameter
- int form_id: ID des Formulars
- int option_id: ID der Pool Attribut Option
Rückgabewert
- bool: true im Erfolgsfall
Benötigte Rechte
keine
Verwendung
<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
Einen Formular Alias erstellen
EvalancheResourceInformation createAlias (int form_id, string name, int category_id)
Details
Parameter
- int form_id: ID des Formulars
- string name: Name des Formular Alias
- int category_id: ID des Ordners, in welchem der Alias erstellt werden soll
Rückgabewert
- EvalancheResourceInformation: Objekt analog zur Methode getById (Informationen über ein Objekt mittels Objekt ID abfragen)
Benötigte Rechte
keine
Verwendung
<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
Formular Aliases zu einem bestimmten Formular auslesen
EvalancheResourceInformation[] getAliases (int form_id)
Details
Parameter
- int form_id: ID des Formulars
Rückgabewert
- EvalancheResourceInformation[]: Liste von Objekten analog zur Methode getById (Informationen über ein Objekt mittels Objekt ID abfragen)
Benötigte Rechte
keine
Verwendung
<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
Formular eines Aliases auslesen
EvalancheResourceInformation getFormByAlias (int form_id)
Details
Parameter
- int form_id: ID des Formulars
Rückgabewert
- EvalancheResourceInformation: Objekt analog zur Methode getById (Informationen über ein Objekt mittels Objekt ID abfragen)
Benötigte Rechte
keine
Verwendung
<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
Formularstatistik auslesen
EvalancheFormStatistics[] getStatistics (int form_id, bool with_aliases)
Details
Parameter
- int form_id: ID des Formulars
- bool with_aliases: Wenn dieser Parameter true ist, werden zusätzlich die Statistiken aller Aliase des Formulars zurückgeliefert
Rückgabewert
- EvalancheFormStatistics[]: Liste von Objekten mit folgenden Attributen:
- int id: ID des Formulars bzw. des Formular Alias
- string name: Name des Formulars bzw. des Formular Alias
- bool is_alias: true, wenn es sich um einen Formular Alias handelt
- int impressions: Anzahl der Page Impressions bzw. Öffnungen
- int succeeded: Anzahl der erfolgreichen Eintragungen
- int identity_errors: Anzahl der Identitätsfehler (bei Login Formularen)
- int duplication_errors: Anzahl der verhinderten doppelten Eintragungen
- int validation_errors: Anzahl der Validierungsfehler
- int mandatory_errors: Anzahl der Pflichtfeldverletzungen
Benötigte Rechte
keine
Verwendung
<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
Felder aus Formular entfernen
EvalancheFormStatistics[] removeAttribute (int form_id, int attribute_id)
Details
Parameter
- int form_id: ID des Formulars
- int form_attribute_id: ID des zu entfernenden Attribute-Feldes. Die Attribute-ID entspricht nicht der Pool-Attribute-ID. Die Attribute-ID wird als Response auf das Hinzufügen eines Attributes zurückgeliefert.
Rückgabewert
- bool: true im Erfolgsfall
Benötigte Rechte
keine
Verwendung
<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
Konfiguration des Formulars auslesen
EvalancheFormConfig[] getConfiguration (int form_id)
Details
Parameter
- int form_id: ID des Formulars
Rückgabewert
- EvalancheFormConfig[] Konfigurations-Paramenter des Formulars
Benötigte Rechte
Formular anzeigen
Verwendung
<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
Konfiguration eines Formulars setzen
EvalancheFormConfig[] setConfiguration (int form_id, str[] configuration)
Details
Parameter
- int form_id: ID des Formulars
- str[] configuration: Liste der zu konfigurierenden Formular-Optionen
Rückgabewert
- EvalancheFormConfig[] Konfigurations-Paramenter des Formulars
Benötigte Rechte
Formular verändern
Verwendung
<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>