SOAP Form/form alias – Evalanche Helpcenter

The following SOAP methods are provided specifically for interacting with forms.

addAttribute

Add attribute

int addAttribute (int form_id, int pool_attribute_id)

Details

Parameter

int form_id: ID of form
int pool_attribute_id: ID of pool attribute

Return value

int addAttributeResult

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:addAttribute>
 <form_id>FORM_ID</form_id>
 <pool_attribute_id>POOL_ATTRIBUTE_ID</pool_attribute_id>
 </form:addAttribute>
 </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:addAttributeResponse>
 <addAttributeResult>ADD_ATTRIBUTE_RESULT</addAttributeResult> </ns1:addAttributeResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

addAttributeOption

Add attribute option

bool addAttributeOption (int form_id, int option_id)

Details

Parameter

int form_id: ID of form
int option_id: ID of pool attribute option

Return value

bool: true in case of success

Required rights

no object rights required

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>

copy

Creates a copy of the resource specified by resource_id

EvalancheResourceInformation copy (int resource_id, int category_id)

Details

Parameter

int resource_id: ID of the resource to be copied
int category_id: ID of folder

Return value

object: EvalancheResourceInformation:
- string: url
- int: type_id
- int: category_id
- int: last_modified
- int: resource_id
- string: name

Required rights

Create form

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:copy>
 <resource_id>RESOURCE_ID</resource_id>
 <category_id>CATEGORY_ID</category_id>
 </lead:copy>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
 <SOAP-ENV:Body>
 <ns1:copyResponse>
 <copyResultv
 <url>URL</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTUMER_ID</customer_id>
 <last_modified>LAST_MODIFIED</last_modified>
 <id>RESOURCE_ID</id>
 <name>NAME</name>
 </copyResult>
 </ns1:copyResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

create

Create a form

EvalancheResourceInformation create (int pool_id, string name)

Details

Parameter

int pool_id: ID of the pool
string name: Name of the form

Return value

object: EvalancheResourceInformation:
- string: url
- int: type_id
- int: category_id
- int: last_modified
- int: resource_id
- string: name

Required rights

Create form

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>

createAlias

Create a form alias

EvalancheResourceInformation createAlias (int form_id, string name, int category_id)

Details

Parameter

int form_id: ID of form
string name: Name of form alias
int category_id: ID of the folder in which the alias should be created

Return value

object: EvalancheResourceInformation:
- string: url
- int: type_id
- int: category_id
- int: last_modified
- int: resource_id
- string: name

Required rights

no object rights required

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>

delete

Deletes the resource.

bool delete (int resource_id)

Details

Parameter

int resource_id: ID of the resource to be deleted

Return value

bool: true if deletion was successful

Required rights

Manage form

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:delete>
 <resource_id>FORM_ID</resource_id>
 </lead:delete>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
 <SOAP-ENV:Body>
 <ns1:deleteResponse>
 <deleteResult>true</deleteResult>
 </ns1:deleteResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getAliases

Read form aliases for a specific form

EvalancheResourceInformation[] getAliases (int form_id)

Details

Parameter

int form_id: ID of form

Return value

object: EvalancheResourceInformation:
- string: url
- int: type_id
- int: category_id
- int: last_modified
- int: resource_id
- string: name

Required rights

no object rights required

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>

getAll

Lists all form resources within a client.

ArrayOfEvalancheResourceInformation getAll (int mandator_id)

Details

Parameter

int mandator_id: ID of client

Return value

ArrayOfEvalancheResourceInformation Object array analogous to the method getById (For more information about an object, see Object ID)

Required rights

No object rights required

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:getAll>
 <mandator_id>MANDATOR_ID</mandator_id>
 </lead:getAll>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
 <SOAP-ENV:Body>
 <ns1:getAllResponse>
 <getAllResult>
 <item>
 <url>https://scnem.com/a.php?sid=h5ent.2kd5bgg,f=7</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTUMER_ID</customer_id>
 <last_modified>LAST_MODIFIED</last_modified>
 <id>RESOURCE_ID</id>
 <name>NAME</name>
 </item>
 <item>
 ... </item>
 </getAllResult>
 </ns1:getAllResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getAttributes

Add attribute option

int getAttributes (long form_id)

Details

Parameter

long form_id: ID of form

Return value

int getAttributesResult
- EvalancheFormAttribute: item
  - long: id
  - long: pool_attribute_id
  - string: widget
  - ArrayOfString: possible_widgets
    - string: item
  - string: label
  - bool: mandatory
  - int: order_x
  - int: order_y
  - string: validation_error_text
  - string: default_value_priority
  - bool: only_shown_when_empty
  - bool: write_protected
  - bool: has_options
  - ArrayOfEvalancheFormAttributeOption: options
    - EvalancheFormAttributeOption: item
      - long: id
      - long: pool_attribute_option_id
      - int: order_y
      - string: value
  - string: default

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:getAttributes>
 <form_id>FORM_ID</form_id>
 </form:getAttributes>
 </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:getAttributesResponse>
 <getAttributesResult>
 <item>
 <id>ID</id>
 <pool_attribute_id>POOL_ATTRIBUTE_ID</pool_attribute_id>
 <widget>TEXT_TRIMMED</widget>
 <possible_widgets>
 <item>TEXT_TRIMMED</item>
 <item>READONLY</item>
 </possible_widgets>
 <label>LABEL</label>
 <mandatory>false</mandatory>
 <order_x>0</order_x>
 <order_y>0</order_y>
 <validation_error_text>VALIDATION_ERROR_TEXT</validation_error_text>
 <default_value_priority>PROFILE</default_value_priority>
 <only_shown_when_empty>false</only_shown_when_empty>
 <write_protected>false</write_protected>
 <has_options>false</has_options>
 <options />
 <default />
 </item>
 </getAttributesResult>
 </ns1:getAttributesResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getByCategory

Lists all form resources within a folder.

ArrayOfEvalancheResourceInformation getByCategory (int mandator_id)

Details

Parameter

int category_id: ID of folder

Return value

ArrayOfEvalancheResourceInformation Object array analogous to the getById method (more information about an object under Object ID)

Required rights

no object rights required

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:getByCategory>
 <category_id>CATEGORY_ID</category_id>
 </lead:getByCategory>
</soapenv:Body>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
 <SOAP-ENV:Body>
 <ns1:getAllResponse>
 <getAllResult>
 <item>
 <url>https://scnem.com/a.php?sid=h5ent.2kd5bgg,f=7</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTUMER_ID</customer_id>
 <last_modified>LAST_MODIFIED</last_modified>
 <id>RESOURCE_ID</id>
 <name>NAME</name>
 </item>
 <item>
 ... </item>
 </getAllResult>
 </ns1:getAllResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getById

Retrieve form information via ID

EvalancheResourceInformation getById (int resource_id)

Details

Parameter

int resource_id: ID of form

Return value

object: EvalancheResourceInformation:
- string: url
- int: type_id
- int: category_id
- int: last_modified
- int: resource_id
- string: name

Required rights

no object rights required

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:getById>
 <resource_id>RESOURCE_ID</resource_id>
 </lead:getById>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
 <SOAP-ENV:Body>
 <ns1:getByIdResponse>
 <getByIdResult>
 <url>URL</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTUMER_ID</customer_id>
 <last_modified>LAST_MODIFIED</last_modified>
 <id>RESOURCE_ID</id>
 <name>NAME</name>
 </getByIdResult>
 </ns1:getByIdResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getByTypeId

Retrieve all resources within this namespace with the specified resource type ID (see the getTypeIds method).

ArrayOfEvalancheResourceInformation getByTypeId (int type_id, int mandator_id)

Details

Parameter

int type_id: Type ID
int mandator_id: ID of client

Return value

ArrayOfEvalancheResourceInformation Object array analogous to the getById method (more information about an object under Object ID )

Required rights

no object rights required

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:getByCategory>
 <category_id>CATEGORY_ID</category_id>
 </lead:getByCategory>
</soapenv:Body>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
 <SOAP-ENV:Body>
 <ns1:getAllResponse>
 <getAllResult>
 <item>
 <url>https://scnem.com/a.php?sid=h5ent.2kd5bgg,f=7</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTUMER_ID</customer_id>
 <last_modified>LAST_MODIFIED</last_modified>
 <id>RESOURCE_ID</id>
 <name>NAME</name>
 </item>
 <item>
 ... </item>
 </getAllResult>
 </ns1:getAllResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getConfiguration

Read the form configuration

EvalancheFormConfig[] getConfiguration (int form_id)

Details

Parameter

int form_id: ID of form

Return value

EvalancheFormConfig[] Form configuration parameters

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>

getFormByAlias

Read form of an alias

EvalancheResourceInformation getFormByAlias (int form_id)

Details

Parameter

int form_id: ID of form

Return value

object: EvalancheResourceInformation:
- string: url
- int: type_id
- int: category_id
- int: last_modified
- int: resource_id
- string: name

Required rights

no object rights required

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>

getResourceDefaultCategory

Provides information about the default folder of form objects

getResourceDefaultCategoryResponse getResourceDefaultCategory (int customer_id)

Details

Parameter

int customer_id: Customer ID

Return value

EvalancheCategoryInformation
- int: ID
- string: NAME
- int: PARENT_ID

Required rights

no object rights required

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:getResourceDefaultCategory>
 <customer_id>CUSTUMER_ID</customer_id>
 </lead:getResourceDefaultCategory>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
 <SOAP-ENV:Body>
 <ns1:getResourceDefaultCategoryResponse>
 <getResourceDefaultCategoryResult>
 <id>ID</id>
 <name>NAME</name>
 <parent_id>PARENT_ID</parent_id>
 </getResourceDefaultCategoryResult>
 </ns1:getResourceDefaultCategoryResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getStatistics

Get form statistics

EvalancheFormStatistics[] getStatistics (int form_id, bool with_aliases)

Details

Parameter

int form_id: ID of 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 (on login forms)
int duplication_errors: Number of duplicate entries prevented
int validation_errors: Number of validation errors
int mandatory_errors: Number of mandatory field violations

Required rights

no object rights required

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>

getTypeIds

Lists information about the type IDs of forms

ArrayOfEvalancheResourceInformation getTypeIds ()

Details

Parameter

Return value

ArrayOfEvalancheResourceTypeInformation
- EvalancheResourceTypeInformation: ITEM
  - int: ID
  - string: DESCRIPTION

Required rights

no object rights required

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:getTypeIds />
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
 <SOAP-ENV:Body>
 <ns1:getTypeIdsResponse>
 <getTypeIdsResult>
 <item>
 <id>ID</id>
 <description>DESCRIPTION</description>
 </item>
 </getTypeIdsResult>
 </ns1:getTypeIdsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

isAlive

Tests whether the API is available and the credentials used are valid. The `random_message` property of the result is completely irrelevant, since the values are randomly taken from http://whatthecommit.com.

isAliveResponse isAlive ()

Details

Parameter

Return value

isAliveResponse
- IsAliveResult: IsAliveResult
  - string: STATUS
  - string: RANDOM_MESSAGE

Required rights

no object rights required

Use

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:isAlive />
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
 <SOAP-ENV:Body>
 <ns1:isAliveResponse>
 <isAliveResult>
 <status>STATUS</status>
 <random_message>RANDOM_MESSAGE</random_message>
 </isAliveResult>
 </ns1:isAliveResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

move

Moves the form to another folder

EvalancheResourceInformation move (int resource_id, int category_id)

Details

Parameter

int resource_id: ID of the form to be moved
int category_id: ID of the target folder

Return value

EvalancheResourceInformation:
- string: URL
- int: TYPE_ID
- int: CATEGORY_ID
- int: CUSTUMER_ID
- int: LAST_MODIFIED
- int: FORM_ID
- string: NAME

Required rights

Manage 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:move>
 <resource_id>RESOURCE_ID</resource_id>
 <category_id>CATEGORY_ID</category_id>
 </form:move>
 </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:moveResponse>
 <moveResult>
 <url>URL</url>
 <type_id>9</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTUMER_ID</customer_id>
 <last_modified>LAST_MODIFIED</last_modified>
 <id>ID</id>
 <name>NAME</name>
 </moveResult>
 </ns1:moveResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

removeAttribute

Remove fields from form

EvalancheFormStatistics[] removeAttribute (int form_id, int attribute_id)

Details

Parameter

int form_id: ID of form
int form_attribute_id: ID of the attribute field to be removed. The attribute ID does not match the pool attribute ID. The attribute ID is returned as a response to adding an attribute.

Return value

bool: true if successful

Required rights

no object rights required

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>

removeAttributeOption

Remove attribute option

bool removeAttributeOption (int form_id, int option_id)

Details

Parameter

int form_id: ID of form
int option_id: ID of pool attribute option

Return value

bool: true if successful

Required rights

no object rights required

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>

rename

Gives the form a different name

EvalancheResourceInformation rename (int resource_id, string name)

Details

Parameter

int resource_id: ID of the form to be renamed
string name: new name of the form

Return value

EvalancheResourceInformation:
- string: URL
- int: TYPE_ID
- int: CATEGORY_ID
- int: CUSTUMER_ID
- int: LAST_MODIFIED
- int: FORM_ID
- string: NAME

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:rename>
 <resource_id>RESOURCE_ID</resource_id>
 <name>NAME</name>
 </form:rename>
 </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:renameResponse>
 <renameResult>
 <url>URL</url>
 <type_id>9</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTUMER_ID</customer_id>
 <last_modified>LAST_MODIFIED</last_modified>
 <id>ID</id>
 <name>NAME</name>
 </renameResult>
 </ns1:renameResponse>
 </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 form
str[] configuration: List of form options to configure

Return value

EvalancheFormConfig[] Form configuration parameters

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>

toggleHtmlTemplateMode

The method turns the custom template of a form on or off.

EvalancheResourceInformation toggleHtmlTemplateMode (int form_id, bool enabled)

Details

Parameter

int form_id: ID of form
bool enabled: If this parameter is true, the form's custom template is activated.

Return value

object: EvalancheResourceInformation:
- string: url
- int: type_id
- int: category_id
- int: last_modified
- int: resource_id
- string: name

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:toggleHtmlTemplateMode>
 <form_id>FORM_ID</form_id>
 <enabled>true</enabled>
 </form:toggleHtmlTemplateMode>
 </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:toggleHtmlTemplateModeResponse>
 <toggleHtmlTemplateModeResult>true</toggleHtmlTemplateModeResult>
 </ns1:toggleHtmlTemplateModeResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

updateAttribute

Updates the configuration of a form's attribute (see also getAttributes)

EvalancheFormAttribute updateAttribute (long form_id, long form_attribute_id, EvalancheFormAttributeUpdate configuration)

Details

Parameter

long form_id: ID of form
long form_attribute_id: ID of the form attribute
EvalancheFormAttributeUpdate configuration:
- string: widget
- string: label
- bool: mandatory
- int: order_x
- int order_y
- string: validation_error_text
- string: default_value_priority
- bool: only_shown_when_empty
- bool: write_protected
- string: default

Return value

EvalancheFormAttribute:
- long: ID
- long: POOL_ATTRIBUTE_ID
- string: WIDGET
- ArrayOfString: POSSIBLE_WIDGET
  - string: item
- string: LABEL
- bool: MANDATORY
- int: ORDER_X
- int: ORDER_Y
- string: VALIDATION_ERROR_TEXT
- string: DEFAULT_VALUE_PRIORITY
- bool: ONLY_SHOWN_WHEN_EMPTY
- bool: WRITE_PROTECTED
- bool: HAS_OPTIONS
- ArrayOfEvalancheForm_AttributeOption: OPTIONS
  - EvalancheFormAttributeOption: item
    - long: ID
    - long: POOL_ATTRIBUTE_OPTION_ID
    - int: ORDER_Y
    - string: VALUE
- string: default

Required rights

Chenge 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:updateAttribute>
 <form_id>FORM_ID</form_id>
 <form_attribute_id>FORM_ATTRIBUTE_ID</form_attribute_id>
 <configuration>
 <!--You may enter the following 10 items in any order-->
 <widget>WIDGET</widget>
 <label>LABEL</label>
 <mandatory>TRUE/FALSE</mandatory>
 <order_x>ORDER_X</order_x>
 <order_y>ORDER_Y</order_y>
 <validation_error_text>VALIDATION_ERROR_TEXT</validation_error_text>
 <default_value_priority>PROFILE</default_value_priority>
 <only_shown_when_empty>TRUE/FALSE</only_shown_when_empty>
 <write_protected>TRUE/FALSE</write_protected>
 <default>DEFAULT</default>
 </configuration>
 </form:updateAttribute>
 </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:updateAttributeResponse>
 <updateAttributeResult>
 <id>FORM_ATTRIBUTE_ID</id>
 <pool_attribute_id>POOL_ATTRIBUTE_ID</pool_attribute_id>
 <widget>WIDGET</widget>
 <possible_widgets>
 <item>POSSIBLE_WIDGET</item>
 <item>POSSIBLE_WIDGET</item>
 </possible_widgets>
 <label>LABEL</label>
 <mandatory>TRUE/FALSE<< /mandatory>
 <order_x>ORDER_X</order_x>
 <order_y>ORDER_Y</order_y>
 <validation_error_text>VALIDATION_ERROR_TEXT</validation_error_text>
 <default_value_priority>PROFILE</default_value_priority>
 <only_shown_when_empty>TRUE/FALSE</only_shown_when_empty>
 <write_protected>TRUE/FALSE<< /write_protected>
 <has_options>TRUE/FALSE</has_options>
 <options>
 <item>
 <id>ID</id>
 <pool_attribute_option_id>POOL_ATTRIBUTE_OPTION_ID</pool_attribute_option_id>
 <order_y>ORDER_Y</order_y>
 <value>VALUE</value>
 </item>
 <item>
 ...
 </item>
 </options>
 <default>DEFAULT</default>
 </updateAttributeResult>
 </ns1:updateAttributeResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

updateAttributeOptionOrder

Updates the sort order of a form attribute (see also getAttributes)

EvalancheFormAttribute updateAttributeOptionOrder (long form_id, long form_attribute_id, ArrayOfLong form_attribute_option_ids)

Details

Parameter

long form_id: ID of form
long form_attribute_id: ID of the form attribute
ArrayOfLong form_atrribute_option_ids:
- long: item

Return value

EvalancheFormAttribute:
- long: ID
- long: POOL_ATTRIBUTE_ID
- string: WIDGET
- ArrayOfString: POSSIBLE_WIDGET
  - string: item
- string: LABEL
- bool: MANDATORY
- int: ORDER_X
- int: ORDER_Y
- string: VALIDATION_ERROR_TEXT
- string: DEFAULT_VALUE_PRIORITY
- bool: ONLY_SHOWN_WHEN_EMPTY
- bool: WRITE_PROTECTED
- bool: HAS_OPTIONS
- ArrayOfEvalancheForm_AttributeOption: OPTIONS
  - EvalancheFormAttributeOption: item
    - long: ID
    - long: POOL_ATTRIBUTE_OPTION_ID
    - int: ORDER_Y
    - string: VALUE
- string: default

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:updateAttributeOptionOrder>
 <form_id>FORM_ID</form_id>
 <form_attribute_id>FORM_ATTRIBUTE_ID</form_attribute_id>
 <form_attribute_option_ids>
 <!--Zero or more repetitions:-->
 <item>5</item>
 </form_attribute_option_ids>
 </form:updateAttributeOptionOrder>
 </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:updateAttributeOptionOrderResponse>
 <updateAttributeOptionOrderResult>
 <id>FORM_ATTRIBUTE_ID</id>
 <pool_attribute_id>POOL_ATTRIBUTE_ID</pool_attribute_id>
 <widget>RADIOBUTTONS</widget>
 <possible_widgets>
 <item>DROPDOWN_WITHNULL</item>
 <item>DROPDOWN</item>
 <item>RADIOBUTTONS_WITHNULL</item>
 <item>RADIOBUTTONS</item>
 <item>READONLY</item>
 <item>DROPDOWN_HIDDEN</item>
 <item>DROPDOWN_ASTEXT</item>
 </possible_widgets>
 <label>LABEL</label>
 <mandatory>TRUE/FALSE</mandatory>
 <order_x>ORDER_X</order_x>
 <order_y>ORDER_Y</order_y>
 <validation_error_text>VALIDATION_ERROR_TEXT</validation_error_text>
 <default_value_priority>PROFILE</default_value_priority>
 <only_shown_when_empty>TRUE/FALSE</only_shown_when_empty>
 <write_protected>TRUE/FALSE</write_protected>
 <has_options>TRUE/FALSE</has_options>
 <options>
 <item>
 <id>ID</id>
 <pool_attribute_option_id>POOL_ATTRIBUTE_OPTION_ID</pool_attribute_option_id>
 <order_y>ORDER_Y</order_y>
 <value>VALUE</value>
 </item>
 <item>
 ...
 </item>
 </options>
 <default>DEFAULT</default>
 </updateAttributeOptionOrderResult>
 </ns1:updateAttributeOptionOrderResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

updateTemplate

Update and activate individual template

EvalancheResourceInformation updateTemplate (int form_id, string template)

Details

Parameter

int form_id: ID of form
string template: Template as a well-formed XML string, UTF-8 encoded

Return value

object: EvalancheResourceInformation:
- string: url
- int: type_id
- int: category_id
- int: last_modified
- int: resource_id
- string: name

Required rights

no object rights required

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>

Standard API (SOAP)

addAttribute

Parameter

Return value

Required rights

Use

addAttributeOption

Parameter

Return value

Required rights

Use

copy

Parameter

Return value

Required rights

Use

create

Parameter

Return value

Required rights

Use

createAlias

Parameter

Return value

Required rights

Use

delete

Parameter

Return value

Required rights

Use

getAliases

Parameter

Return value

Required rights

Use

getAll

Parameter

Return value

Required rights

Use

getAttributes

Parameter

Return value

Required rights

Use

getByCategory

Parameter

Return value

Required rights

Use

getById

Parameter

Return value

Required rights

Use

getByTypeId

Parameter

Return value

Required rights

Use

getConfiguration

Parameter

Return value

Required rights

Use

getFormByAlias

Parameter

Return value

Required rights

Use

getResourceDefaultCategory

Parameter

Return value

Required rights

Use

getStatistics

Parameter

Return value

Required rights