Evalanche API Explorer

campaign

24 Methoden verfügbar

POST create

Creates a new campaign object within the given category.

Rückgabewert

EvalancheResourceInformation

Feld	Typ
url	string
type_id	int
category_id	int
customer_id	int
last_modified	int
id	int
name	string

name (string) *

category_id (int)

PHP Implementierung anzeigen

<?php
/**
 * Creates a new campaign object within the given category.
 * Service: campaign
 * @return EvalancheResourceInformation
 *         Felder:
 *           - url (string)
 *           - type_id (int)
 *           - category_id (int)
 *           - customer_id (int)
 *           - last_modified (int)
 *           - id (int)
 *           - name (string)
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'name' => '', // string (required)
        'category_id' => 0, // int
    ];
    
    $result = $client->create($params);
    
    // Rückgabewert: EvalancheResourceInformation
    // $result->url (string)
    // $result->type_id (int)
    // $result->category_id (int)
    // $result->customer_id (int)
    // $result->last_modified (int)
    // $result->id (int)
    // $result->name (string)
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:create xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <name></name> <!-- string, required -->
            <category_id>0</category_id> <!-- int, optional -->
        </tns:create>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#create"
Authorization: Basic {base64(username:password)}

POST createConfigured

Creates a new campaign object within the given category, using the given configuration.

Rückgabewert

EvalancheResourceInformation

Feld	Typ
url	string
type_id	int
category_id	int
customer_id	int
last_modified	int
id	int
name	string

name (string) *

schema_version (anyType) *

configuration (anyType) *

category_id (anyType)

PHP Implementierung anzeigen

<?php
/**
 * Creates a new campaign object within the given category, using the given configuration.
 * Service: campaign
 * @return EvalancheResourceInformation
 *         Felder:
 *           - url (string)
 *           - type_id (int)
 *           - category_id (int)
 *           - customer_id (int)
 *           - last_modified (int)
 *           - id (int)
 *           - name (string)
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'name' => '', // string (required)
        'schema_version' => '', // anyType (required)
        'configuration' => '', // anyType (required)
        'category_id' => '', // anyType
    ];
    
    $result = $client->createConfigured($params);
    
    // Rückgabewert: EvalancheResourceInformation
    // $result->url (string)
    // $result->type_id (int)
    // $result->category_id (int)
    // $result->customer_id (int)
    // $result->last_modified (int)
    // $result->id (int)
    // $result->name (string)
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:createConfigured xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <name></name> <!-- string, required -->
            <schema_version></schema_version> <!-- anyType, required -->
            <configuration></configuration> <!-- anyType, required -->
            <category_id></category_id> <!-- anyType, optional -->
        </tns:createConfigured>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#createConfigured"
Authorization: Basic {base64(username:password)}

POST getDetails

Returns the details of a campaign

Rückgabewert

WorkflowDetail

Feld	Typ
id	int
name	string
date_start	int
date_end	int
external_id	string
category_id	int
description	string
state	int
profile_count	int

resource_id (int) *

PHP Implementierung anzeigen

<?php
/**
 * Returns the details of a campaign
 * Service: campaign
 * @return WorkflowDetail
 *         Felder:
 *           - id (int)
 *           - name (string)
 *           - date_start (int)
 *           - date_end (int)
 *           - external_id (string)
 *           - category_id (int)
 *           - description (string)
 *           - state (int)
 *           - profile_count (int)
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'resource_id' => 0, // int (required)
    ];
    
    $result = $client->getDetails($params);
    
    // Rückgabewert: WorkflowDetail
    // $result->id (int)
    // $result->name (string)
    // $result->date_start (int)
    // $result->date_end (int)
    // $result->external_id (string)
    // $result->category_id (int)
    // $result->description (string)
    // $result->state (int)
    // $result->profile_count (int)
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:getDetails xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <resource_id>0</resource_id> <!-- int, required -->
        </tns:getDetails>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#getDetails"
Authorization: Basic {base64(username:password)}

POST pushProfilesIntoCampaign

Push profiles into a specific campaign

Rückgabewert

boolean

profile_id_list (tns:ArrayOfInt) *

resource_id (int) *

PHP Implementierung anzeigen

<?php
/**
 * Push profiles into a specific campaign
 * Service: campaign
 * @return boolean
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'profile_id_list' => '', // tns:ArrayOfInt (required)
        'resource_id' => 0, // int (required)
    ];
    
    $result = $client->pushProfilesIntoCampaign($params);
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:pushProfilesIntoCampaign xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <profile_id_list></profile_id_list> <!-- tns:ArrayOfInt, required -->
            <resource_id>0</resource_id> <!-- int, required -->
        </tns:pushProfilesIntoCampaign>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#pushProfilesIntoCampaign"
Authorization: Basic {base64(username:password)}

POST getByStartDateRange

getByStartDateRange

Rückgabewert

ArrayOfEvalancheResourceInformation

Feld	Typ
item	EvalancheResourceInformation

from (int) *

to (int) *

PHP Implementierung anzeigen

<?php
/**
 * getByStartDateRange
 * Service: campaign
 * @return ArrayOfEvalancheResourceInformation
 *         Felder:
 *           - item (EvalancheResourceInformation)
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'from' => 0, // int (required)
        'to' => 0, // int (required)
    ];
    
    $result = $client->getByStartDateRange($params);
    
    // Rückgabewert: ArrayOfEvalancheResourceInformation
    // $result->item (EvalancheResourceInformation)
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:getByStartDateRange xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <from>0</from> <!-- int, required -->
            <to>0</to> <!-- int, required -->
        </tns:getByStartDateRange>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#getByStartDateRange"
Authorization: Basic {base64(username:password)}

POST getByEndDateRange

getByEndDateRange

Rückgabewert

ArrayOfEvalancheResourceInformation

Feld	Typ
item	EvalancheResourceInformation

from (int) *

to (int) *

PHP Implementierung anzeigen

<?php
/**
 * getByEndDateRange
 * Service: campaign
 * @return ArrayOfEvalancheResourceInformation
 *         Felder:
 *           - item (EvalancheResourceInformation)
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'from' => 0, // int (required)
        'to' => 0, // int (required)
    ];
    
    $result = $client->getByEndDateRange($params);
    
    // Rückgabewert: ArrayOfEvalancheResourceInformation
    // $result->item (EvalancheResourceInformation)
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:getByEndDateRange xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <from>0</from> <!-- int, required -->
            <to>0</to> <!-- int, required -->
        </tns:getByEndDateRange>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#getByEndDateRange"
Authorization: Basic {base64(username:password)}

POST export

Returns the configuration of a campaign as JSON string.

Rückgabewert

string

workflow_id (int) *

PHP Implementierung anzeigen

<?php
/**
 * Returns the configuration of a campaign as JSON string.
 * Service: campaign
 * @return string
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'workflow_id' => 0, // int (required)
    ];
    
    $result = $client->export($params);
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:export xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <workflow_id>0</workflow_id> <!-- int, required -->
        </tns:export>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#export"
Authorization: Basic {base64(username:password)}

POST getConfiguration

Returns the configuration of a campaign as JSON string.

Rückgabewert

WorkflowConfigurationResult

Feld	Typ
config_version	string
configuration	string

workflow_id (int) *

config_version (string)

PHP Implementierung anzeigen

<?php
/**
 * Returns the configuration of a campaign as JSON string.
 * Service: campaign
 * @return WorkflowConfigurationResult
 *         Felder:
 *           - config_version (string)
 *           - configuration (string)
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'workflow_id' => 0, // int (required)
        'config_version' => '', // string
    ];
    
    $result = $client->getConfiguration($params);
    
    // Rückgabewert: WorkflowConfigurationResult
    // $result->config_version (string)
    // $result->configuration (string)
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:getConfiguration xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <workflow_id>0</workflow_id> <!-- int, required -->
            <config_version></config_version> <!-- string, optional -->
        </tns:getConfiguration>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#getConfiguration"
Authorization: Basic {base64(username:password)}

POST getConfigurationVersions

Returns a list containing all existing config version of the workflow

Rückgabewert

ArrayOfWorkflowConfigVersion

Feld	Typ
item	WorkflowConfigVersion

workflow_id (int) *

PHP Implementierung anzeigen

<?php
/**
 * Returns a list containing all existing config version of the workflow
 * Service: campaign
 * @return ArrayOfWorkflowConfigVersion
 *         Felder:
 *           - item (WorkflowConfigVersion)
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'workflow_id' => 0, // int (required)
    ];
    
    $result = $client->getConfigurationVersions($params);
    
    // Rückgabewert: ArrayOfWorkflowConfigVersion
    // $result->item (WorkflowConfigVersion)
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:getConfigurationVersions xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <workflow_id>0</workflow_id> <!-- int, required -->
        </tns:getConfigurationVersions>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#getConfigurationVersions"
Authorization: Basic {base64(username:password)}

POST deactivate

deactivate

Rückgabewert

WorkflowStateChangeResult

Feld	Typ
state_change_successful	boolean
errors	ArrayOfWorkflowStateChangeResultError

workflow_id (int) *

PHP Implementierung anzeigen

<?php
/**
 * deactivate
 * Service: campaign
 * @return WorkflowStateChangeResult
 *         Felder:
 *           - state_change_successful (boolean)
 *           - errors (ArrayOfWorkflowStateChangeResultError)
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'workflow_id' => 0, // int (required)
    ];
    
    $result = $client->deactivate($params);
    
    // Rückgabewert: WorkflowStateChangeResult
    // $result->state_change_successful (boolean)
    // $result->errors (ArrayOfWorkflowStateChangeResultError)
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:deactivate xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <workflow_id>0</workflow_id> <!-- int, required -->
        </tns:deactivate>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#deactivate"
Authorization: Basic {base64(username:password)}

POST activate

activate

Rückgabewert

WorkflowStateChangeResult

Feld	Typ
state_change_successful	boolean
errors	ArrayOfWorkflowStateChangeResultError

workflow_id (int) *

PHP Implementierung anzeigen

<?php
/**
 * activate
 * Service: campaign
 * @return WorkflowStateChangeResult
 *         Felder:
 *           - state_change_successful (boolean)
 *           - errors (ArrayOfWorkflowStateChangeResultError)
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'workflow_id' => 0, // int (required)
    ];
    
    $result = $client->activate($params);
    
    // Rückgabewert: WorkflowStateChangeResult
    // $result->state_change_successful (boolean)
    // $result->errors (ArrayOfWorkflowStateChangeResultError)
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:activate xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <workflow_id>0</workflow_id> <!-- int, required -->
        </tns:activate>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#activate"
Authorization: Basic {base64(username:password)}

POST setConfiguration

Sets the configuration of a campaign

Rückgabewert

string

workflow_id (int) *

config_version (string) *

configuration (string) *

PHP Implementierung anzeigen

<?php
/**
 * Sets the configuration of a campaign
 * Service: campaign
 * @return string
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'workflow_id' => 0, // int (required)
        'config_version' => '', // string (required)
        'configuration' => '', // string (required)
    ];
    
    $result = $client->setConfiguration($params);
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:setConfiguration xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <workflow_id>0</workflow_id> <!-- int, required -->
            <config_version></config_version> <!-- string, required -->
            <configuration></configuration> <!-- string, required -->
        </tns:setConfiguration>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#setConfiguration"
Authorization: Basic {base64(username:password)}

POST isAlive

Test if the API is available and used credentials are valid. The result's property `random_message` has absolutely *no* relevance as the values are randomly taken from http://whatthecommit.com

Rückgabewert

IsAliveResult

Feld	Typ
status	string
random_message	string

isAliveResult (tns:IsAliveResult) *

PHP Implementierung anzeigen

<?php
/**
 * Test if the API is available and used credentials are valid. The result's property `random_message` has absolutely *no* relevance as the values are randomly taken from http://whatthecommit.com
 * Service: campaign
 * @return IsAliveResult
 *         Felder:
 *           - status (string)
 *           - random_message (string)
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'isAliveResult' => '', // tns:IsAliveResult (required)
    ];
    
    $result = $client->isAlive($params);
    
    // Rückgabewert: IsAliveResult
    // $result->status (string)
    // $result->random_message (string)
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:isAlive xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <isAliveResult></isAliveResult> <!-- tns:IsAliveResult, required -->
        </tns:isAlive>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#isAlive"
Authorization: Basic {base64(username:password)}

POST getTypeIds

Get information about the namespace's resource type ids

Rückgabewert

ArrayOfEvalancheResourceTypeInformation

Feld	Typ
item	EvalancheResourceTypeInformation

item (tns:EvalancheResourceTypeInformation) *

PHP Implementierung anzeigen

<?php
/**
 * Get information about the namespace's resource type ids
 * Service: campaign
 * @return ArrayOfEvalancheResourceTypeInformation
 *         Felder:
 *           - item (EvalancheResourceTypeInformation)
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'item' => '', // tns:EvalancheResourceTypeInformation (required)
    ];
    
    $result = $client->getTypeIds($params);
    
    // Rückgabewert: ArrayOfEvalancheResourceTypeInformation
    // $result->item (EvalancheResourceTypeInformation)
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:getTypeIds xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <item></item> <!-- tns:EvalancheResourceTypeInformation, required -->
        </tns:getTypeIds>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#getTypeIds"
Authorization: Basic {base64(username:password)}

POST getById

Get resource information for resource with id $resource_id

Rückgabewert

EvalancheResourceInformation

Feld	Typ
url	string
type_id	int
category_id	int
customer_id	int
last_modified	int
id	int
name	string

resource_id (int) *

PHP Implementierung anzeigen

<?php
/**
 * Get resource information for resource with id $resource_id
 * Service: campaign
 * @return EvalancheResourceInformation
 *         Felder:
 *           - url (string)
 *           - type_id (int)
 *           - category_id (int)
 *           - customer_id (int)
 *           - last_modified (int)
 *           - id (int)
 *           - name (string)
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'resource_id' => 0, // int (required)
    ];
    
    $result = $client->getById($params);
    
    // Rückgabewert: EvalancheResourceInformation
    // $result->url (string)
    // $result->type_id (int)
    // $result->category_id (int)
    // $result->customer_id (int)
    // $result->last_modified (int)
    // $result->id (int)
    // $result->name (string)
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:getById xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <resource_id>0</resource_id> <!-- int, required -->
        </tns:getById>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#getById"
Authorization: Basic {base64(username:password)}

POST getByCategory

Get resources by category id

Rückgabewert

ArrayOfEvalancheResourceInformation

Feld	Typ
item	EvalancheResourceInformation

category_id (int) *

PHP Implementierung anzeigen

<?php
/**
 * Get resources by category id
 * Service: campaign
 * @return ArrayOfEvalancheResourceInformation
 *         Felder:
 *           - item (EvalancheResourceInformation)
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'category_id' => 0, // int (required)
    ];
    
    $result = $client->getByCategory($params);
    
    // Rückgabewert: ArrayOfEvalancheResourceInformation
    // $result->item (EvalancheResourceInformation)
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:getByCategory xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <category_id>0</category_id> <!-- int, required -->
        </tns:getByCategory>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#getByCategory"
Authorization: Basic {base64(username:password)}

POST getAll

Get all resources of this namespace's type

Rückgabewert

ArrayOfEvalancheResourceInformation

Feld	Typ
item	EvalancheResourceInformation

mandator_id (int)

PHP Implementierung anzeigen

<?php
/**
 * Get all resources of this namespace's type
 * Service: campaign
 * @return ArrayOfEvalancheResourceInformation
 *         Felder:
 *           - item (EvalancheResourceInformation)
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'mandator_id' => 0, // int
    ];
    
    $result = $client->getAll($params);
    
    // Rückgabewert: ArrayOfEvalancheResourceInformation
    // $result->item (EvalancheResourceInformation)
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:getAll xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <mandator_id>0</mandator_id> <!-- int, optional -->
        </tns:getAll>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#getAll"
Authorization: Basic {base64(username:password)}

POST getResourceDefaultCategory

Get information about this namespace's default category

Rückgabewert

EvalancheCategoryInformation

Feld	Typ
id	int
name	string
parent_id	int

customer_id (int)

PHP Implementierung anzeigen

<?php
/**
 * Get information about this namespace's default category
 * Service: campaign
 * @return EvalancheCategoryInformation
 *         Felder:
 *           - id (int)
 *           - name (string)
 *           - parent_id (int)
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'customer_id' => 0, // int
    ];
    
    $result = $client->getResourceDefaultCategory($params);
    
    // Rückgabewert: EvalancheCategoryInformation
    // $result->id (int)
    // $result->name (string)
    // $result->parent_id (int)
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:getResourceDefaultCategory xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <customer_id>0</customer_id> <!-- int, optional -->
        </tns:getResourceDefaultCategory>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#getResourceDefaultCategory"
Authorization: Basic {base64(username:password)}

POST getByTypeId

Get all resources within this namespace with the given resource type id (see method getTypeIds)

Rückgabewert

ArrayOfEvalancheResourceInformation

Feld	Typ
item	EvalancheResourceInformation

type_id (int) *

mandator_id (int)

PHP Implementierung anzeigen

<?php
/**
 * Get all resources within this namespace with the given resource type id (see method getTypeIds)
 * Service: campaign
 * @return ArrayOfEvalancheResourceInformation
 *         Felder:
 *           - item (EvalancheResourceInformation)
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'type_id' => 0, // int (required)
        'mandator_id' => 0, // int
    ];
    
    $result = $client->getByTypeId($params);
    
    // Rückgabewert: ArrayOfEvalancheResourceInformation
    // $result->item (EvalancheResourceInformation)
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:getByTypeId xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <type_id>0</type_id> <!-- int, required -->
            <mandator_id>0</mandator_id> <!-- int, optional -->
        </tns:getByTypeId>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#getByTypeId"
Authorization: Basic {base64(username:password)}

POST getByExternalId

Get resource information for resource by external id

Rückgabewert

EvalancheResourceInformation

Feld	Typ
url	string
type_id	int
category_id	int
customer_id	int
last_modified	int
id	int
name	string

external_id (string) *

PHP Implementierung anzeigen

<?php
/**
 * Get resource information for resource by external id
 * Service: campaign
 * @return EvalancheResourceInformation
 *         Felder:
 *           - url (string)
 *           - type_id (int)
 *           - category_id (int)
 *           - customer_id (int)
 *           - last_modified (int)
 *           - id (int)
 *           - name (string)
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'external_id' => '', // string (required)
    ];
    
    $result = $client->getByExternalId($params);
    
    // Rückgabewert: EvalancheResourceInformation
    // $result->url (string)
    // $result->type_id (int)
    // $result->category_id (int)
    // $result->customer_id (int)
    // $result->last_modified (int)
    // $result->id (int)
    // $result->name (string)
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:getByExternalId xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <external_id></external_id> <!-- string, required -->
        </tns:getByExternalId>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#getByExternalId"
Authorization: Basic {base64(username:password)}

POST copy

Creates a copy of the resource specified by the $resource_id

Rückgabewert

EvalancheResourceInformation

Feld	Typ
url	string
type_id	int
category_id	int
customer_id	int
last_modified	int
id	int
name	string

resource_id (int) *

category_id (int)

PHP Implementierung anzeigen

<?php
/**
 * Creates a copy of the resource specified by the $resource_id
 * Service: campaign
 * @return EvalancheResourceInformation
 *         Felder:
 *           - url (string)
 *           - type_id (int)
 *           - category_id (int)
 *           - customer_id (int)
 *           - last_modified (int)
 *           - id (int)
 *           - name (string)
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'resource_id' => 0, // int (required)
        'category_id' => 0, // int
    ];
    
    $result = $client->copy($params);
    
    // Rückgabewert: EvalancheResourceInformation
    // $result->url (string)
    // $result->type_id (int)
    // $result->category_id (int)
    // $result->customer_id (int)
    // $result->last_modified (int)
    // $result->id (int)
    // $result->name (string)
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:copy xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <resource_id>0</resource_id> <!-- int, required -->
            <category_id>0</category_id> <!-- int, optional -->
        </tns:copy>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#copy"
Authorization: Basic {base64(username:password)}

POST move

Moves the resource specified by the $resource_id to another category

Rückgabewert

EvalancheResourceInformation

Feld	Typ
url	string
type_id	int
category_id	int
customer_id	int
last_modified	int
id	int
name	string

resource_id (int) *

category_id (int) *

PHP Implementierung anzeigen

<?php
/**
 * Moves the resource specified by the $resource_id to another category
 * Service: campaign
 * @return EvalancheResourceInformation
 *         Felder:
 *           - url (string)
 *           - type_id (int)
 *           - category_id (int)
 *           - customer_id (int)
 *           - last_modified (int)
 *           - id (int)
 *           - name (string)
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'resource_id' => 0, // int (required)
        'category_id' => 0, // int (required)
    ];
    
    $result = $client->move($params);
    
    // Rückgabewert: EvalancheResourceInformation
    // $result->url (string)
    // $result->type_id (int)
    // $result->category_id (int)
    // $result->customer_id (int)
    // $result->last_modified (int)
    // $result->id (int)
    // $result->name (string)
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:move xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <resource_id>0</resource_id> <!-- int, required -->
            <category_id>0</category_id> <!-- int, required -->
        </tns:move>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#move"
Authorization: Basic {base64(username:password)}

POST delete

Deletes the resource

Rückgabewert

boolean

resource_id (int) *

PHP Implementierung anzeigen

<?php
/**
 * Deletes the resource
 * Service: campaign
 * @return boolean
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'resource_id' => 0, // int (required)
    ];
    
    $result = $client->delete($params);
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:delete xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <resource_id>0</resource_id> <!-- int, required -->
        </tns:delete>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#delete"
Authorization: Basic {base64(username:password)}

POST rename

Renames the resource

Rückgabewert

EvalancheResourceInformation

Feld	Typ
url	string
type_id	int
category_id	int
customer_id	int
last_modified	int
id	int
name	string

resource_id (int) *

name (string) *

PHP Implementierung anzeigen

<?php
/**
 * Renames the resource
 * Service: campaign
 * @return EvalancheResourceInformation
 *         Felder:
 *           - url (string)
 *           - type_id (int)
 *           - category_id (int)
 *           - customer_id (int)
 *           - last_modified (int)
 *           - id (int)
 *           - name (string)
 */

$wsdlUrl = 'https://scnem.com/soap.php/wsdl/campaign';
$username = 'DEIN_USERNAME';
$password = 'DEIN_PASSWORD';

$options = [
    'login'      => $username,
    'password'   => $password,
    'trace'      => true,
    'exceptions' => true,
];

try {
    $client = new SoapClient($wsdlUrl, $options);
    
    // Parameter
    $params = [
        'resource_id' => 0, // int (required)
        'name' => '', // string (required)
    ];
    
    $result = $client->rename($params);
    
    // Rückgabewert: EvalancheResourceInformation
    // $result->url (string)
    // $result->type_id (int)
    // $result->category_id (int)
    // $result->customer_id (int)
    // $result->last_modified (int)
    // $result->id (int)
    // $result->name (string)
    
    print_r($result);
    
} catch (SoapFault $e) {
    echo 'SOAP Fehler: ' . $e->getMessage();
}

XML SOAP Request anzeigen

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP-ENV:Body>
        <tns:rename xmlns:tns="https://scnem.com/soap.php/wsdl/campaign">
            <resource_id>0</resource_id> <!-- int, required -->
            <name></name> <!-- string, required -->
        </tns:rename>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

HTTP Header:
Content-Type: text/xml; charset=utf-8
SOAPAction: "https://scnem.com/soap.php/wsdl/campaign#rename"
Authorization: Basic {base64(username:password)}