SOAP LeadPage – Evalanche Helpcenter

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

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

EvalancheResourceInformation: Object analogous to the getById method (query information about an object using the object ID)

Required rights

Creaate LeadPage

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>

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 LeadPage

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>LEADPAGE_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>

getAll

Lists all LeadPage 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 getById method (querying information about an object using the 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>

getByCategory

Lists all LeadPage resources within a folder.

ArrayOfEvalancheResourceInformation getByCategory (int mandator_id)

Details

Parameter

int category_id: Ordner ID

Return value

ArrayOfEvalancheResourceInformation Object array analogous to the getById method (querying information about an object using the 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

Get LeadPage information via ID

EvalancheResourceInformation getById (int resource_id)

Details

Parameter

int resource_id: ID of LeadPage

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 (querying information about an object using the 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

Reads the configuration of the specified lead page

LeadpageConfiguration getConfiguration (int resource_id)

Details

Parameter

int resource_id: ID of LeadPage

Return value

object: LeadpageConfiguration:
- string: inputfield_0
- string: inputfield_1
- string: inputfield_2
- string: inputfield_3
- string: inputfield_4
- string: inputfield_5
- string: inputfield_6
- string: inputfield_7
- string: inputfield_8
- string: inputfield_9
- string: textarea_0
- string: textarea_1
- string: textarea_2
- string: textarea_3
- string: textarea_4
- string: textarea_5
- string: textarea_6
- string: textarea_7
- string: textarea_8
- string: textarea_9
- string: htmlarea_0
- string: htmlarea_1
- string: htmlarea_2
- string: htmlarea_3
- string: htmlarea_4
- string: htmlarea_5
- string: htmlarea_6
- string: htmlarea_7
- string: htmlarea_8
- string: htmlarea_9
- string: macro_library

Required rights

Show LeadPage

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:getConfiguration>
 <leadpage_id>31310332</leadpage_id>
 </lead: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/leadpage">
 <SOAP-ENV:Body>
 <ns1:getConfigurationResponse>
 <getConfigurationResult>
 <inputfield_0>INPUTFIELD_0</inputfield_0>
 <inputfield_1>INPUTFIELD_1</inputfield_1>
 <inputfield_2>INPUTFIELD_2</inputfield_2>
 <inputfield_3>INPUTFIELD_3</inputfield_3>
 <inputfield_4>INPUTFIELD_4</inputfield_4>
 <inputfield_5>INPUTFIELD_5</inputfield_5>
 <inputfield_6>INPUTFIELD_6</inputfield_6>
 <inputfield_7>INPUTFIELD_7</inputfield_7>
 <inputfield_8>INPUTFIELD_8</inputfield_8>
 <inputfield_9>INPUTFIELD_9</inputfield_9>
 <textarea_0>TEXTAREA_0</textarea_0>
 <textarea_1>TEXTAREA_1</textarea_1>
 <textarea_2>TEXTAREA_2</textarea_2>
 <textarea_3>TEXTAREA_3</textarea_3>
 <textarea_4>TEXTAREA_4</textarea_4>
 <textarea_5>TEXTAREA_5</textarea_5>
 <textarea_6>TEXTAREA_6</textarea_6>
 <textarea_7>TEXTAREA_7</textarea_7>
 <textarea_8>TEXTAREA_8</textarea_8>
 <textarea_9>TEXTAREA_9</textarea_9>
 <htmlarea_0>HTMLAREA_0</htmlarea_0>
 <htmlarea_1>HTMLAREA_1</htmlarea_1>
 <htmlarea_2>HTMLAREA_2</htmlarea_2>
 <htmlarea_3>HTMLAREA_3</htmlarea_3>
 <htmlarea_4>HTMLAREA_4</htmlarea_4>
 <htmlarea_5>HTMLAREA_5</htmlarea_5>
 <htmlarea_6>HTMLAREA_6</htmlarea_6>
 <htmlarea_7>HTMLAREA_7</htmlarea_7>
 <htmlarea_8>HTMLAREA_8</htmlarea_8>
 <htmlarea_9>HTMLAREA_9</htmlarea_9>
 <macro_library>MACRO_LIBRARY</macro_library>
 </getConfigurationResult>
 </ns1:getConfigurationResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getContentContainerData

Reads the configuration of the specified lead page

getContentContainerDataResponse getContentContainerData (int resource_id)

Details

Parameter

int resource_id: ID of LeadPage

Return value

object: getContentContainerDataResponse:
- EvalancheHashMap: getContentContainerDataResult
  - ArrayOfEvalancheHashMapItem: items
    - EvalancheHashMapItem: item
      - string: key
      - string: value

Required rights

Show LeadPage

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:getContentContainerData>
 <resource_id>LEADPAGE_ID</resource_id>
 </lead:getContentContainerData>
 </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:getContentContainerDataResponse>
 <getContentContainerDataResult>
 <items>
 <item>
 <key>KEY</key>
 <value>VALUE</value>
 </item>
 <item>...</item>
 </items>
 </getContentContainerDataResult>
 </ns1:getContentContainerDataResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getDetails

Get detailed information about the LeadPage

EvalancheResourceInformation getDetails (int resource_id)

Details

Parameter

int resource_id: ID of LeadPage

Return value

object: EvalancheResourceInformation:
- string: url
- int: type_id
- int: category_id
- int: customer_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:getDetails>
 <leadpage_id>RESOURCE_ID</leadpage_id>
 </lead:getDetails>
 </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:getDetailsResponse>
 <getDetailsResult>
 <url>URL</url>
 <type_id>38</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>
 </getDetailsResult>
 </ns1:getDetailsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getResourceDefaultCategory

Provides information about the default folder of LeadPage 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>

getTypeIds

Lists information about the type IDs of the LeadPage

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 LeadPage to another folder

EvalancheResourceInformation move (int resource_id, int category_id)

Details

Parameter

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

Return value

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

Required rights

Manage LeadPage

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:move>
 <resource_id>LEADPAGE_ID</resource_id>
 <category_id>CATEGORY_ID</category_id>
 </lead: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/leadpage">
 <SOAP-ENV:Body>
 <ns1:moveResponse>
 <moveResult>
 <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>LEADPAGE_ID</id>
 <name>NAME</name>
 </moveResult>
 </ns1:moveResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

rename

Gives the LeadPage a different name

EvalancheResourceInformation rename (int resource_id, string name)

Details

Parameter

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

Return value

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

Required rights

Edit LeadPage

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:rename>
 <resource_id>LEADPAGE_ID</resource_id>
 <name>NAME</name>
 </lead: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/leadpage">
 <SOAP-ENV:Body>
 <ns1:renameResponse>
 <renameResult>
 <url>URL</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTUMER_ID</customer_id>
 <last_modified>1760363237</last_modified>
 <id>LEADPAGE_ID</id>
 <name>NAME</name>
 </renameResult>
 </ns1:renameResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

retrieveGlobalModuleConfiguration

Retrieves global module configurations

string retrieveGlobalModuleConfiguration (int resource_id)

Details

Parameter

int resource_id: ID of LeadPage

Return value

string: retrieveGlobalModuleConfigurationResult Global module configurations

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:retrieveGlobalModuleConfiguration>
 <resource_id>LEADPAGE_ID</resource_id>
 </lead:retrieveGlobalModuleConfiguration>
 </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:retrieveGlobalModuleConfigurationResponse>
 <retrieveGlobalModuleConfigurationResult>RETRIEVEGLOBALMODULECONFIGURATIONRESULT</retrieveGlobalModuleConfigurationResult>
 </ns1:retrieveGlobalModuleConfigurationResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

retrieveModuleConfiguration

Retrieves module configurations

string retrieveModuleConfiguration (int resource_id)

Details

Parameter

int resource_id: ID of LeadPage

Return value

string: retrieveModuleConfigurationResult Module configurations

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:retrieveModuleConfiguration>
 <resource_id>LEADPAGE_ID</resource_id>
 </lead:retrieveModuleConfiguration>
 </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:retrieveModuleConfigurationResponse>
 <retrieveModuleConfigurationResult>RETRIEVEMODULECONFIGURATIONRESULT</retrieveModuleConfigurationResult>
 </ns1:retrieveModuleConfigurationResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

retrieveModuleTypes

Retrieves module types

string retrieveModuleTypes (int resource_id)

Details

Parameter

int resource_id: ID of LeadPage

Return value

string: retrieveModuleTypesResult Module types

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:retrieveModuleTypes>
 <resource_id>LEADPAGE_ID</resource_id>
 </lead:retrieveModuleTypes>
 </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:retrieveModuleTypesResponse>
 <retrieveModuleTypesResult>RETRIEVEMODULETYPESRESULT</retrieveModuleTypesResult>
 </ns1:retrieveModuleTypesResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

runContentGeneration

Generate AI content for a LeadPage

EvalancheHashMap runContentGeneration (int leadpage_id)

Details

Parameter

int resource_id: ID of LeadPage

Return value

int: id AI generation job ID
int: status AI generation status ID
string: status_description Status description of AI generation

Required rights

Edit LeadPage

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:runContentGeneration>
 <resource_id>LEADPAGE_ID</resource_id>
 <variables>
 <items><!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 2 items in any order--><key>KEY</key>
 <value>VALUE</value>
 </item>
 </items>
 </variables>
 </lead:runContentGeneration>
 </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:runContentGenerationResponse>
 <runContentGenerationResult>
 <id>ID</id>
 <status>STATUS</status>
 <status_description>STATUS_DESCRIPTION</status_description>
 </runContentGenerationResult>
 </ns1:runContentGenerationResponse>
</SOAP-ENV:Body></SOAP-ENV:Envelope>

setConfiguration

Writes the configuration of the specified lead page

LeadpageConfiguration setConfiguration (int resource_id, LeadpageConfiguration configuration, bool overwrite)

Details

Parameter

int resource_id: ID of LeadPage
object: LeadpageConfiguration:
- string: inputfield_0
- string: inputfield_1
- string: inputfield_2
- string: inputfield_3
- string: inputfield_4
- string: inputfield_5
- string: inputfield_6
- string: inputfield_7
- string: inputfield_8
- string: inputfield_9
- string: textarea_0
- string: textarea_1
- string: textarea_2
- string: textarea_3
- string: textarea_4
- string: textarea_5
- string: textarea_6
- string: textarea_7
- string: textarea_8
- string: textarea_9
- string: htmlarea_0
- string: htmlarea_1
- string: htmlarea_2
- string: htmlarea_3
- string: htmlarea_4
- string: htmlarea_5
- string: htmlarea_6
- string: htmlarea_7
- string: htmlarea_8
- string: htmlarea_9
- string: macro_library
bool overwrite: True/False value for override

Return value

object: LeadpageConfiguration:
- string: inputfield_0
- string: inputfield_1
- string: inputfield_2
- string: inputfield_3
- string: inputfield_4
- string: inputfield_5
- string: inputfield_6
- string: inputfield_7
- string: inputfield_8
- string: inputfield_9
- string: textarea_0
- string: textarea_1
- string: textarea_2
- string: textarea_3
- string: textarea_4
- string: textarea_5
- string: textarea_6
- string: textarea_7
- string: textarea_8
- string: textarea_9
- string: htmlarea_0
- string: htmlarea_1
- string: htmlarea_2
- string: htmlarea_3
- string: htmlarea_4
- string: htmlarea_5
- string: htmlarea_6
- string: htmlarea_7
- string: htmlarea_8
- string: htmlarea_9
- string: macro_library

Required rights

Edit LeadPage

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:setConfiguration>
 <leadpage_id>LEADPAGE_ID</leadpage_id>
 <configuration>
 <!--You may enter the following 31 items in any order-->
 <inputfield_0>INPUTFIELD_0</inputfield_0>
 <inputfield_1>INPUTFIELD_1</inputfield_1>
 <inputfield_2>INPUTFIELD_2</inputfield_2>
 <inputfield_3>INPUTFIELD_3</inputfield_3>
 <inputfield_4>INPUTFIELD_4</inputfield_4>
 <inputfield_5>INPUTFIELD_5</inputfield_5>
 <inputfield_6>INPUTFIELD_6</inputfield_6>
 <inputfield_7>INPUTFIELD_7</inputfield_7>
 <inputfield_8>INPUTFIELD_8</inputfield_8>
 <inputfield_9>INPUTFIELD_9</inputfield_9>
 <textarea_0>TEXTAREA_0</textarea_0>
 <textarea_1>TEXTAREA_1</textarea_1>
 <textarea_2>TEXTAREA_2</textarea_2>
 <textarea_3>TEXTAREA_3</textarea_3>
 <textarea_4>TEXTAREA_4</textarea_4>
 <textarea_5>TEXTAREA_5</textarea_5>
 <textarea_6>TEXTAREA_6</textarea_6>
 <textarea_7>TEXTAREA_7</textarea_7>
 <textarea_8>TEXTAREA_8</textarea_8>
 <textarea_9>TEXTAREA_9</textarea_9>
 <htmlarea_0>HTMLAREA_0</htmlarea_0>
 <htmlarea_1>HTMLAREA_1</htmlarea_1>
 <htmlarea_2>HTMLAREA_2</htmlarea_2>
 <htmlarea_3>HTMLAREA_3</htmlarea_3>
 <htmlarea_4>HTMLAREA_4</htmlarea_4>
 <htmlarea_5>HTMLAREA_5</htmlarea_5>
 <htmlarea_6>HTMLAREA_6</htmlarea_6>
 <htmlarea_7>HTMLAREA_7</htmlarea_7>
 <htmlarea_8>HTMLAREA_8</htmlarea_8>
 <htmlarea_9>HTMLAREA_9</htmlarea_9>
 <macro_library>MACRO_LIBRARY</macro_library>
 </configuration>
 <overwrite>1</overwrite>
 </lead: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/leadpage">
 <SOAP-ENV:Body>
 <ns1:setConfigurationResponse>
 <setConfigurationResult>
 <inputfield_0>INPUTFIELD_0</inputfield_0>
 <inputfield_1>INPUTFIELD_1</inputfield_1>
 <inputfield_2>INPUTFIELD_2</inputfield_2>
 <inputfield_3>INPUTFIELD_3</inputfield_3>
 <inputfield_4>INPUTFIELD_4</inputfield_4>
 <inputfield_5>INPUTFIELD_5</inputfield_5>
 <inputfield_6>INPUTFIELD_6</inputfield_6>
 <inputfield_7>INPUTFIELD_7</inputfield_7>
 <inputfield_8>INPUTFIELD_8</inputfield_8>
 <inputfield_9>INPUTFIELD_9</inputfield_9>
 <textarea_0>TEXTAREA_0</textarea_0>
 <textarea_1>TEXTAREA_1</textarea_1>
 <textarea_2>TEXTAREA_2</textarea_2>
 <textarea_3>TEXTAREA_3</textarea_3>
 <textarea_4>TEXTAREA_4</textarea_4>
 <textarea_5>TEXTAREA_5</textarea_5>
 <textarea_6>TEXTAREA_6</textarea_6>
 <textarea_7>TEXTAREA_7</textarea_7>
 <textarea_8>TEXTAREA_8</textarea_8>
 <textarea_9>TEXTAREA_9</textarea_9>
 <htmlarea_0>HTMLAREA_0</htmlarea_0>
 <htmlarea_1>HTMLAREA_1</htmlarea_1>
 <htmlarea_2>HTMLAREA_2</htmlarea_2>
 <htmlarea_3>HTMLAREA_3</htmlarea_3>
 <htmlarea_4>HTMLAREA_4</htmlarea_4>
 <htmlarea_5>HTMLAREA_5</htmlarea_5>
 <htmlarea_6>HTMLAREA_6</htmlarea_6>
 <htmlarea_7>HTMLAREA_7</htmlarea_7>
 <htmlarea_8>HTMLAREA_8</htmlarea_8>
 <htmlarea_9>HTMLAREA_9</htmlarea_9>
 <macro_library>MACRO_LIBRARY</macro_library>
 </setConfigurationResult>
 </ns1:setConfigurationResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

setContentContainerData

Updates the LeadPage container

EvalancheResourceInformation setContentContainerData (int leadpage_id, EvalancheHashMap data)

Details

Parameter

int resource_id: ID of LeadPage
EvalancheHashMap data: Evalanche hashmap object
- ArrayOfEvalancheHashMapItem: items
  - EvalancheHashMapItem: item
    - string: key
    - string: value

Return value

EvalancheResourceInformation: setContainerDataResult
- string: url
- int: leadpage_id
- int: category_id
- int: customer_id
- int: last_modified
- int: id
- string: name

Required rights

Edit LeadPage

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:setContentContainerData>
 <resource_id>LEADPAGE_ID</resource_id>
 <data>
 <items>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 2 items in any order-->
 <key>KEY</key>
 <value>VALUE</value>
 </item>
 </items>
 </data>
 </lead:setContentContainerData>
 </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:setContentContainerDataResponse>
 <setContentContainerDataResult>
 <url>URL</url>
 <type_id>38</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>
 </setContentContainerDataResult>
 </ns1:setContentContainerDataResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

updateGlobalModuleConfiguration

Updates the global module configuration of the LeadPage

bool updateGlobalModuleConfiguration (int resource_id, string global_module_content)

Details

Parameter

int resource_id: ID of LeadPage
string global_module_content: Contents of the global module

Return value

bool: updateGlobalModuleConfigurationResult True/False value

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:updateGlobalModuleConfiguration>
 <resource_id>LEADPAGE_ID</resource_id>
 <global_module_content>GLOBAL_MODULE_CONTENT</global_module_content>
 </lead:updateGlobalModuleConfiguration>
 </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:updateGlobalModuleConfigurationResponse>
 <updateGlobalModuleConfigurationResult>true/false</updateGlobalModuleConfigurationResult>
 </ns1:updateGlobalModuleConfigurationResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

updateModuleConfiguration

Updates the module configuration of the LeadPage

bool updateModuleConfiguration (int resource_id, string module_content)

Details

Parameter

int resource_id: ID of LeadPage
string module_content: Contents of the module

Return value

bool: updateModuleConfigurationResult True/False value

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:updateModuleConfiguration>
 <resource_id>LEADPAGE_ID</resource_id>
 <module_content>MODULE_CONTENT</module_content>
 </lead:updateModuleConfiguration>
 </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:updateModuleConfigurationResponse>
 <updateModuleConfigurationResult>true/false</updateModuleConfigurationResult>
 </ns1:updateModuleConfigurationResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

updateModuleTypes

Updates the module type store of the LeadPage

bool updateModuleTypes (int resource_id, string module_content)

Details

Parameter

int resource_id: ID of LeadPage
string module_content: Contents of the module

Return value

bool: updateModuleConfigurationResult True/False value

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:updateModuleTypes>
 <resource_id>LEADPAGE_ID</resource_id>
 <module_type_content>MODULE_TYPE_CONTENT</module_type_content>
 </lead:updateModuleTypes>
 </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:updateModuleTypesResponse>
 <updateModuleTypesResult>true/false</updateModuleTypesResult>
 </ns1:updateModuleTypesResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Standard API (SOAP)

copy

Parameter

Return value

Required rights

Use

delete

Parameter

Return value

Required rights

Use

getAll

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

getContentContainerData

Parameter

Return value

Required rights

Use

getDetails

Parameter

Return value

Required rights

Use

getResourceDefaultCategory

Parameter

Return value

Required rights

Use

getTypeIds

Parameter

Return value

Required rights

Use

isAlive

Parameter

Return value

Required rights

Use

move

Parameter

Return value

Required rights

Use

rename

Parameter

Return value

Required rights

Use

retrieveGlobalModuleConfiguration

Parameter

Return value

Required rights

Use

retrieveModuleConfiguration

Parameter

Return value

Required rights