SOAP Mailing – Evalanche Helpcenter

Folgende SOAP-Methoden werden speziell für die Interaktion mit eMailings bereitgestellt.

copy

Erstellt eine Kopie der durch die resource_id angegebenen Ressource

EvalancheResourceInformation copy (int resource_id, int category_id)

Details: copy

delete

Löscht die Ressource.

bool delete (int resource_id)

Details: delete

getAll

Listet alle Ressourcen innerhalb eines Mandanten auf.

ArrayOfEvalancheResourceInformation getAll (int mandator_id)

Details: getAll

getByCategory

Gibt alle Objekte eines Ordners aus.

ArrayOfEvalancheResourceInformation getByCategory (int category_id)

Details: getByCategory

getByExternalId

Gibt alle Objekte mit gegebener EXTERNAL_ID aus.

ArrayOfEvalancheResourceInformation[] getByExternalId (string external_id)

Details: getByExternalId

getById

Sucht ein Objekt anhand einer ID.

EvalancheHashMap getById(int resource_id)

Details: getById

getByModificationDate

Eine Resource über das Änderungsdatum abfragen

EvalancheResourceInformation getByModificationDate (int start_date, int end_date, int mandator_id)

Details: getByModificationDate

getByTypeId

Holen Sie sich alle Ressourcen innerhalb dieses Namespace mit der angegebenen Ressourcentyp-ID (siehe Methode getTypeIds).

ArrayOfEvalancheResourceInformation getByTypeId (int type_id, int mandator_id)

Details: getByTypeId

getJobInformation

Informationen zu einem laufenden Hintergrundjob abrufen.

getJobInformationResponse getJobInformation (string job_Id)

Details

Parameter

string job_id: Id des Hintergrundjobs

Rückgabewert

EvalancheJobHandle: Ein Objekt des Typs EvalancheJobHandle mit folgenden Attributen:
- string id: Die ID des Hintergrundjobs
- int status: Der Status des Hintergrundjobs mit den möglichen Werten:
  - 0: Warteschlange
  - 1: In Bearbeitung
  - 2: Fertig
  - 3: Temporärer Fehler (Bearbeitung wird wiederholt)
  - 4: Fehler
string status_description: Beschreibung des Status
namespace: Namespace, unter welchem der Hintergrundjob gestartet wurde.
string method: Name der Methode, welchen den Hintergrundjob gestartet hat.
int resource_id: ID der Resource, für welche der Hintergrundjob gestartet wurde.
int result_chunks: Anzahl der gefundenen Ergebnisblöcke. Dieser Wert ist nur im Status 2 ungleich 0

Benötigte Rechte

Zielgruppe ansehen und Profile exportieren

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getJobInformation>
 <job_id>JOB_ID</job_id>
 </mail:getJobInformation>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getJobInformationResponse>
 <getJobInformationResult>
 <id>JOB_ID</id>
 <status>JOB_STATUS</status>
 <status_description>JOB_DESCRIPTION</status_description>
 <namespace>NAMESPACE</namespace>
 <method>METHOD</method>
 <resource_id>RESOURCE_ID</resource_id>
 <result_chunks>RESULT_CHUNKS</result_chunks>
 </getJobInformationResult>
 </ns1:getJobInformationResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>

Siehe auch:

Hintergrundjobs

getJobState

Ruft den Status eines generischen Hintergrundjobs ab.

EvalancheResourceInformation getJobState (str job_id)

Details: getJobState

getResultCursor

Gibt den Cursor für die aktuelle Ergebnismenge zurück.

getResultCursorResponse getResultCursor (string job_Id)

Details

Parameter

string job_id: Id des Hintergrundjobs

Rückgabewert

string getResultCursorResult: Der Rückgabewert der Methode

Benötigte Rechte

Zielgruppe ansehen und Profile exportieren

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getResultCursor>
 <job_id>JOB_ID</job_id>
 </mail:getResultCursor>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getResultCursorResponse>
 <getResultCursorResult>
 <CursorResult>CURSORRESULT</CursorResult>
 </getResultCursorResult>
 </ns1:getResultCursorResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>

Siehe auch:

Hintergrundjobs

getResourceDefaultCategory

Liefert Informationen über den Standardordner von Objekten

getResourceDefaultCategoryResponse getResourceDefaultCategory (int customer_id)

Details: getResourceDefaultCategory

getTypeIds

Zu einer Objektklasse gehörende Typ Ids auslesen

ArrayOfEvalancheResourceInformation getTypeIds ()

Details: getTypeIds

get

Liefert die Liste der Empfänger:

getRecipientsProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Öffner:

getImpressionProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Mehrfachöffner:

getMultipleImpressionProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Klicker:

getClickProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Mehrfachklicker:

getMultipleClickProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Profile, die einen Soft- oder Hardbounce generiert haben:

getBounceProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Profile, die einen Hardbounce generiert haben:

getHardbounceProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Profile, die einen Softbounce generiert haben:

getSoftbounceProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Profile, welche sich im Mailing abgemeldet haben:

getUnsubscriptionProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Profile, welche irgendeinen Artikel im Mailing geklickt haben:

getAllArticleImpressionProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Profile, welche irgendeinen Link im Mailing geklickt haben:

getAllLinkClickProfiles (int mailing_id, string[] attribute_names)

Liefert die Liste der Klicker für einen bestimmten Artikel:

getArticleImpressionProfiles (int mailing_id, int article_id, string[] attribute_names)

Liefert die Liste der Klicker für einen bestimmten Link:

getLinkClickProfiles (int mailing_id, int link_id, string[] attribute_names)

Details

Parameter

int mailing_id: Id des Mailings, für welche die Empfängerdaten angefordert werden sollen
int article_id: ( nur bei getArticleImpressionProfiles): Id des Artikels, für den die Klicker zurückgeliefert werden sollen
int link_id: ( nur bei (getLinkClickProfiles): Id des Links, für den die Klicker zurückgeliefert werden sollen
string[] attribute_names: Liste von Poolattribut Namen, welche im Ergebnis zurückgeliefert werden sollen

Rückgabewert

EvalancheJobResult: Informationen zum Hintergrundjob, analog zum Export aller Profile eines Pools bzw. unter Arbeiten mit Hintergrundjobs

Benötigte Rechte

eMailing anzeigen und Profile exportieren

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getRecipientsProfiles>
 <mailing_id>MAILING_ID</mailing_id>
 <attribute_names>
 <!--Zero or more repetitions:-->
 <item>ATTRIBUTE_NAME</item>
 </attribute_names>
 </mail:getRecipientsProfiles>
 </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/mailing">
 <SOAP-ENV:Body>
 <ns1:getRecipientsProfilesResponse>
 <getRecipientsProfilesResult>
 <id>JOB_ID</id>
 <status>JOB_STATUS</status>
 <status_description>JOB_DESCRIPTION</status_description>
 <namespace>NAMESPACE</namespace>
 <method>METHOD</method>
 <resource_id>RESOURCE_ID</resource_id>
 <result_chunks>RESULT_CHUNKS</result_chunks>
 </getRecipientsProfilesResult>
 </ns1:getRecipientsProfilesResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>

Siehe auch:

Hintergrund Job

getContentGenerationVariables

Holt die AI-Variablen für die Contenterstellung in einem eMailing

EvalancheHashMap getContentGenerationVariables (int mailing_id)

Details

Parameter

int resource_id: ID des eMailings

Rückgabewert

Name: Name der AI-Variable
Default_Value: Standardwert der AI-Variable
Label: Beschriftung der AI-Variable
Help_Text:: Hilfe-Text der AI-Variable

Benötigte Rechte

eMailing bearbeiten

Verwendung

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

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getContentGenerationVariablesResponse>
 <getContentGenerationVariablesResult>
 <item>
 <name>NAME</name>
 <default_value>DEFAULT_VALUE</default_value>
 <label>LABEL</label>
 <help_text>HELPTEXT</help_text>
 </item> 
 <item>
 …
 </item>
 </getContentGenerationVariablesResult>
 </ns1:getContentGenerationVariablesResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

isAlive

Testet, ob die API verfügbar ist und die verwendeten Anmeldeinformationen gültig sind. Die Eigenschaft `random_message` des Ergebnisses hat absolut keine Relevanz, da die Werte zufällig von http://whatthecommit.com übernommen werden.

isAliveResponse isAlive ()

Details: isAlive

move

Verschiebt das Objekt in einen anderen Ordner

EvalancheResourceInformation move (int resource_id, int category_id)

Details: move

rename

Gibt dem Objekt einen anderen Namen

EvalancheResourceInformation rename (int resource_id, string name)

Details: rename

runContentGeneration

AI-Content für ein eMailing generieren

EvalancheHashMap runContentGenerationData (int mailing_id)

Details

Parameter

int resource_id: ID des eMailings

Rückgabewert

id: Job-id der AI-Generierung
status: Status-id der AI-Generierung
status_description: Status-Beschreibung der AI-Generierung

Benötigte Rechte

eMailing bearbeiten

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem4.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:runContentGeneration>
 <resource_id>MAILING_ID</resource_id>
 <variables>
 <items>
 </items>
 </variables>
 </mail:runContentGeneration>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem4.com/soap.php/soap/mailing">
<SOAP-ENV:Body>
 <ns1:runContentGenerationResponse>
 <runContentGenerationResult>
 <id>JOB_ID</id>
 <status>STATUS</status>
 <status_description>STATUS_DESCRIPTION</status_description>
 </runContentGenerationResult>
 </ns1:runContentGenerationResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getContentContainerData

ContentContainer eines eMailings auslesen

EvalancheHashMap getContentContainerData (int mailing_id)

Details

Parameter

int resource_id: ID des eMailings

Rückgabewert

EvalancheHashMap: EvalancheHashMap mit den Daten des eMailings

Benötigte Rechte

Container anzeigen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailing">
<soapenv:Header/>
<soapenv:Body>
<mail:getContentContainerData>
<resource_id>MAILING_ID</resource_id>
</mail:getContentContainerData>
</soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailing">
<SOAP-ENV:Body>
<ns1:getContentContainerDataResponse>
<getContentContainerDataResult>
<items>
<item>
<key>CONTAINER_FIELD_NAME</key>
<value>CONTAINER_FIELD_CONTENT</value>
</item>
</items>
</getContentContainerDataResult>
</ns1:getContentContainerDataResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

setContentContainerData

ContentContainer eines eMailings aktualisieren

EvalancheResourceInformation setContentContainerData (int mailing_id, EvalancheHashMap data)

Details

Parameter

int resource_id: ID des eMailings
EvalancheHashMap data: EvalancheHashMap mit den Daten des Containers

Rückgabewert

EvalancheResourceInformation: Objekt analog zur Methode getContentContainerData (Informationen über ein Objekt mittels Objekt ID abfragen)

Benötigte Rechte

Container verändern

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailing">
<soapenv:Header/>
<soapenv:Body>
<mail:setContentContainerData>
<resource_id>MAILING_ID</resource_id>
<data>
<items>
<!--Zero or more repetitions:-->
<item>
<!--You may enter the following 2 items in any order-->
<key>CONTAINER_FIELD_NAME</key>
<value>CONTAINER_FIELD_CONTENT</value>
</item>
</items>
</data>
</mail:setContentContainerData>
</soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailing">
<SOAP-ENV:Body>
<ns1:setContentContainerDataResponse>
<setContentContainerDataResult>
<url>MAILING_URL</url>
<type_id>MAILING_TYPE_ID</type_id>
<category_id>CATEGORY_ID</category_id>
<customer_id>CUSTOMER_ID</customer_id>
<id>MAILING_ID</id>
<name>MAILING_NAME</name>
</setContentContainerDataResult>
</ns1:setContentContainerDataResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>

getDetails

Details einer Versendung abfragen

EvalancheMailingInformation getDetails(int mailing_id)

Details

Parameter

int mailing_id: Id der Versendung

Rückgabewert

EvalancheMailingInformation: Objekt (SOAP) bzw. Array mit folgenden Attributen:
int timestamp: Zeitstempel des Mailings
int recipients: Anzahl der Empfänger
bool sent: true, wenn das Mailing vollständig versandt wurde
string preview_url: URL auf die Vorschau der Versendung
string report_url: URL auf die Statistikseite der Versendung
string admin_url: URL auf die Verwaltungsseite der Versendung
string subject: Standardbetreffzeile der Versendung
int targetgroup_id: Id der Zielgruppe, an welche das Mailing versandt wurde
int send_start_time: Unix Timestamp des Versandstarts
int send_end time: Unix Timestamp des Versandendes

Benötigte Rechte

eMailing anzeigen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getDetails>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:getDetails>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getDetailsResponse>
 <getDetailsResult>
 <timestamp>TIMESTAMP</timestamp>
 <recipients>RECIPIENTS</recipients>
 <sent>true/false</sent>
 <preview_url xsi:nil="true"/>
 <report_url>REPORT_URL</report_url>
 <admin_url>OBJECT_URL</admin_url>
 <subject>SUBJECT</subject>
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <send_start_time>TIMESTAMP_START_TIME</send_start_time>
 <send_end_time>TIMESTAMP_END_TIME</send_end_time>
 <url>EXTERNAL_REPORT_URL</url>
 <type_id>MAILING_TYPE_ID</type_id>
 <category_id>FOLDER_ID</category_id>
 <customer_id>MANDATOR_ID</customer_id>
 <id>MAILING_ID</id>
 <name>MAILING_NAME</name>
 </getDetailsResult>
 </ns1:getDetailsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getImpressions

Öffnungen/Impressions einer Versendung abfragen

EvalancheMailingImpression[] getImpressions(int mailing_id, int start_timestamp = 0, int end_timestamp = 0)

Details

Parameter

int mailing_id: Id der Versendung
int start_timestamp = 0: UTC Unix Timestamp, ab inklusive welcher Zeit Trackingdaten berücksichtigt werden sollen
int end_timestamp = 0: UTC Unix Timestamp, bis inklusive welcher Zeit Trackingdaten berücksichtigt werden sollen

Rückgabewert

EvalancheMailingImpression[]: Liste von Objekten mit folgenden Attributen:
- int id: Eindeutige Id des Tracking Datensatzes
- int profile_id: Id des Users, der die Aktion durchgeführt hat
- int timestamp: UTC Unix Timestamp der Aktion

Benötigte Rechte

eMailing anzeigen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getImpressions>
 <mailing_id>MAILING_ID</mailing_id>
 <start_timestamp>START_TIMESTAMP</start_timestamp>
 <end_timestamp>END_TIMESTAMP</end_timestamp>
 </mail:getImpressions>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getImpressionsResponse>
 <getImpressionsResult>
 <item>
 <id>IMPRESSION_ID</id>
 <profile_id>PROFILE_ID</profile_id>
 <timestamp>IMPRESSION_TIMESTAMP</timestamp>
 </item>
[...]
 </getImpressionsResult>
 </ns1:getImpressionsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getClicks

Klicks einer Versendung abfragen

EvalancheMailingClick[] getClicks(int mailing_id, int start_timestamp = 0, int end_timestamp = 0)

Details

Parameter

int mailing_id: Id der Versendung
int start_timestamp = 0: UTC Unix Timestamp, ab inklusive welcher Zeit Trackingdaten berücksichtigt werden sollen
int end_timestamp = 0: UTC Unix Timestamp, bis inklusive welcher Zeit Trackingdaten berücksichtigt werden sollen

Rückgabewert

- EvalancheMailingClick[]: Liste von Objekten mit folgenden Attributen:
  - - int id: Eindeutige Id des Tracking Datensatzes
    - int profile_id: Id des Users, der die Aktion durchgeführt hat
    - int timestamp: UTC Unix Timestamp der Aktion
    - int link_id: Id des Links für welchen ein Klick aufgezeichnet wurde. Wird hier der Wert -1 zurückgeliefert, ist die parent_id zu betrachten
    - int link_type_id: Format der Resource, in welcher der User die Aktion durchgeführt hat.
      Folgende Werte sind möglich:
      0: Unbekannt
      1: Online Ansicht eines Newsletters
      2: PDF Ansicht eines Artikels bzw. Newsletters
      3: Text Ansicht des Newsletters
      4: Web/Mobile Ansicht des Newsletters
      5: Landingpage eines Artikels
      6: Klick auf Landingpage Link
      7: LeadPage Öffnung
      11: XSL-FO Ansicht eines Artikels bzw. Newsletters
      12: Anzeige des RSS Feeds eines Newsletters
      19: Newsletter Öffnung
      20: Externer Link
      21: Anzeige des ATOM Feeds eines Newsletters
      22: Aufruf Vorlesedienst für einen Artikel bzw. Einen Newsletter
      23: Abruf der Artikel bzw. Newsletter Daten durch den Vorlesedienst
      24: Aufruf Vorlesedienst für einen Newsletter Podcast
      25: Abruf der Podcast Daten durch den Vorlesedienst
      40: Artikel in Facebook geteilt
      41: Artikel in Google Bookmarks geteilt
      42: Artikel in MySpace geteilt
      43: Artikel in del.icio.us geteilt
      44: Artikel in Twitter geteilt
      45: Artikel in Xing geteilt
      46: Artikel in LinkedIn geteilt
      47: Artikel in Google+ geteilt
      50: Klick auf in Facebook geteilten Artikel
      51: Klick auf in Google Bookmarks geteilten Artikel
      52: Klick auf in MySpace geteilten Artikel
      53: Klick auf in del.icio.us geteilten Artikel
      54: Klick auf in Twitter geteilten Artikel
      55: Klick auf in Xing geteilten Artikel
      59: Klick auf in LinkedId geteilten Artikel
      60: Klick auf in Google+ geteilten Artikel
    - int parent_id: Id der Resource, in welcher der Link geklickt wurde, entweder die Mailing Id oder die oder die Id der Artikelreferenz.

Erklärung zu ``link_id`` und ``parent_id``:

Die link_id hat nur dann einen Wert größer oder gleich 0, wenn es sich um einen “normalen” Link handelt. Klicks auf z. B. Landingpage-Links, PDF-Generierung, Voice, etc. haben immer eine link_id link_id gleich -1.

In diesem Fall muss die parent_id zur genaueren Betrachtung herangezogen werden:

Ist die parent_id gleich der übergebenen mailing_id, fand der Klick im Mailing statt bzw. wurde das Mailing im Format von link_type_id dargestellt. Dies kann z. B. ein Klick auf Vorlesen oder die PDF-Generierung im Mailings selbst erfolgt sein.
Ist die parent_id ungleich der übergebenen mailing_id, bezog sich der Klick auf die Artikelreferenz mit der Id gleich der parent_id, z. B. durch einen Klick auf einen Sharing-Link des Artikels.

Benötigte Rechte

eMailing anzeigen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getClicks>
 <mailing_id>MAILING_ID</mailing_id>
 <start_timestamp>START_TIMESTAMP</start_timestamp>
 <end_timestamp>END_TIMESTAMP</end_timestamp>
 </mail:getClicks>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getClicksResponse>
 <getClicksResult>
 <item>
 <id>TRACKING_ID</id>
 <profile_id>PROFILE_ID</profile_id>
 <timestamp>TRACKING_TIMESTAMP</timestamp>
 <link_id>LINK_ID</link_id>
 <link_type_id>LINK_TYPE_ID</link_type_id>
 <parent_id>PARENT_ID</parent_id>
 </item>
[...]
 </getClicksResult>
 </ns1:getClicksResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getStatistics

Kumulierte Statistiken einer Versendung abfragen

EvalancheMailingStatistics getStatistics(int mailing_id)

Details

Parameter

int mailing_id: Id der Versendung

Rückgabewert

EvalancheMailingStatistics: Objekt (SOAP) bzw. Array mit folgenden Attributen:
int addressees: Anzahl der Adressaten
int recipients: Anzahl der Empfänger
int duplicates: Anzahl der durch den Dublettencheck ignorierten Profile
int blacklisted: Anzahl der durch Blacklisting ignorierten Profile
int robinsonlisted: Anzahl der durch die Robinsonliste ignorierten Profile
int hardbounces: Anzahl der Hardbounces
int softbounces: Anzahl der Softbounces
int unsubscribes: Anzahl der Abmeldungen
int impressions: Anzahl der Öffnungen
int unique_impressions: Anzahl der Öffner
int clicks: Anzahl der Klicks
int unique_clicks: Anzahl der eindeutigen Klicks
EvalancheMediaStatistics media: Objekt (SOAP) bzw. Array mit folgenden Attributen:
- string name: Name des Mediums
- int clicks: Anzahl der Klicks
- int unique_clicks: Anzahl der Klicker
EvalancheArticleStatistics articles: Objekt (SOAP) bzw. Array mit folgenden Attributen:
- int id: Id des Artikels
- string name: Name des Artikels
- int clicks: Anzahl der Klicks
- int unique_clicks: Anzahl der Klicker
EvalancheLinkStatistics links: Objekt (SOAP) bzw. Array mit folgenden Attributen:
- int id: Id des Links
- string name: URL des Links
- int clicks: Anzahl der Klicks
- int unique_clicks: Anzahl der Klicker
- string url: URL des Links

Benötigte Rechte

eMailing anzeigen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getStatistics>
 <mailing_id>MAILING_ID</mailing_id>
 </mail: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/mailing">
 <SOAP-ENV:Body>
 <ns1:getStatisticsResponse>
 <getStatisticsResult>
 <addressees>ADRESS_COUNT</addressees>
 <recipients>RECIPIENTS_COUNT</recipients>
 <duplicates>DUPLICATES_COUNT</duplicates>
 <blacklisted>BLACKLISTED_COUNT</blacklisted>
 <robinsonlisted>ROBINSONLISTED_COUNT</robinsonlisted>
 <hardbounces>HARDBOUNCE_COUNT</hardbounces>
 <softbounces>SOFTBOUNCE_COUNT</softbounces>
 <unsubscribes>UNSUBSCRIPTIONS_COUNT</unsubscribes>
 <impressions>IMPRESSIONS_COUNT</impressions>
 <unique_impressions>UNIQUE_IMPRESSIONS_COUNT</unique_impressions>
 <clicks>CLICKS_COUNT</clicks>
 <unique_clicks>UNIQUE_CLICKS_COUNT</unique_clicks>
 <media>
 <item>
 <name>MEDIA_NAME</name>
 <clicks>MEDIA_CLICKS</clicks>
 <unique_clicks>MEDIA_UNIQUE_CLICKS</unique_clicks>
 </item>
[...]
 </media>
 <articles>
 <item>
 <id>ARTICLE_UNIQUE_ID</id>
 <name>ARTICLE_NAME</name>
 <clicks>ARTICLE_CLICKS</clicks>
 <unique_clicks>ARTICLE_UNIQUE_CLICKS</unique_clicks>
 </item>
[...]
 </articles>
 <links>
 <item>
 <id>LINK_ID</id>
 <name>LINK_NAME</name>
 <clicks>LINK_CLICKS</clicks>
 <unique_clicks>LINK_UNIQUE_CLICKS</unique_clicks>
 <url>LINK_URL</url>
 </item>
[...]
 </links>
 </getStatisticsResult>
 </ns1:getStatisticsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getArticleStatistics

Detaillierte Artikelstatistiken einer Versendung abfragen

ArticleStats[] getArticleStatistics(int mailing_id)

Details

Parameter

int mailing_id: Id der Versendung

Rückgabewert

ArticleStats[]: Liste von Objekten mit folgenden Attributen:
- int id: Id des Artikels
- int reference_id: Id der Artikelreferenz (Bindeglied zwischen Artikel und Versendung)
- string name: Name des Artikels
- ArticleFormatStats overall: Statistiken des Artikel über alle Ausgabeformate
- ArticleFormatStats landingpage: Statistik der Landinpage Klicks des Artikels
- ArticleFormatStats print: Statistik der PDF/Print Klicks des Artikels
- ArticleFormatStats voice: Statistik der Voice Klicks des Artikels
- ArticleFormatStats social_sharing: Statistik der Share to Social Klicks des Artikels
- Objekte vom Typ ArticleFormatStats besitzen folgende Attribute:
  - int clicks: Anzahl der Klicks auf das entsprechende Format des Artikels
  - int unique_clicks: Anzahl der eindeutigen Klicks auf das entsprechende Format des Artikels
  - float clickrate: Klickrate des entsprechenden Formats des Artikels
  - float clickrate_relative: Relative Klickrate des entsprechenden Formats des Artikels
  - float multiple_clickrate: Mehrfachklickrate des entsprechenden Formats des Artikels
  - float multiple_clickrate_relative: Relative Mehrfachklickrate des entsprechenden Formats des Artikels
- ArticleLinkStats[] links: Liste von Objekten mit folgenden Attributen:
  - int id: Link Id
  - string url: Link Url
  - string name: Name des Links
  - int clicks: Anzahl der Klicks auf diesen Link
  - int unique_clicks: Anzahl der eindeutigen Klicks auf diesen Link

Benötigte Rechte

keine

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getArticleStatistics>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:getArticleStatistics>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getArticleStatisticsResponse>
 <getArticleStatisticsResult>
 <item>
 <id>23838448</id>
 <reference_id>8617177</reference_id>
 <name>Die wunderbare Kraft der Sonnenblume</name>
 <overall>
 <clicks>OVERALL_CLICKS</clicks>
 <unique_clicks>OVERALL_UNIQUE_CLICKS</unique_clicks>
 <clickrate>OVERALL_CLICKRATE</clickrate>
 <clickrate_relative>OVERALL_CLICKRATE_RELATIVE</clickrate_relative>
 <multiple_clickrate>OVERALL_CLICKRATE_MULTIPLE</multiple_clickrate>
 <multiple_clickrate_relative>OVERALL_MULTIPLE_CLICKRATE_RELATIVE</multiple_clickrate_relative>
 </overall>
 <landingpage>
[...]
 </landingpage>
 <print>
[...]
 </print>
 <voice>
[...]
 </voice>
 <social_sharing>
[...]
 </social_sharing>
 <links/>
 </item>
 </getArticleStatisticsResult>
 </ns1:getArticleStatisticsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getStatus

Status der Empfängerprofile auslesen

EvalancheProfileMailingStatus[] getStatus(int mailing_id, int timeframe, string[] profile_attributes)

Details

Parameter

int mailing_id: Id der Versendung
int timeframe: Sekunden ab jetzt in der Vergangenheit, ab welcher Statusänderungen abgefragt werden sollen.
string[] profile_attributes: Liste von Profilattributen, welche im Ergebnis zurückgeliefert werden sollen. Wird ein leeres Array übergeben, werden keine Profildaten zurückgeliefert

Rückgabewert

EvalancheProfileMailingStatus[]: Liste von Objekten (SOAP) bzw. Arrays mit folgenden Attributen:
- int profile_id: Id des Profils
- int newsletter_id: Id der Versendung
- int last_status_change: Unix Timestamp des Zeitpunkts der letzten Statusänderung beim betreffenden Profil
- int status: Versendungsstatus des betreffenden Profils
- string preview_url: Personalisierte Mailingvorschau
- string profile_data: Array mit den Attributnamen als Key und dem Attributwert als Value

Benötigte Rechte

eMailing anzeigen

Der Versendungsstatus bedeutet:

0 = Warteschlange
1 = Versand erfolgreich
2 = Hardbounce
3 = Softbounce

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getStatus>
 <mailing_id>MAILING_ID</mailing_id>
 <timeframe>TIMEFRAME_IN_SECONDS</timeframe>
 <profile_attributes>
 <!--Zero or more repetitions:-->
 <item>PROFILE_ATTRIBUTE</item>
 </profile_attributes>
 </mail:getStatus>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getStatusResponse>
 <getStatusResult>
 <item>
 <profile_id>PROFILE_ID</profile_id>
 <newsletter_id>MAILING_ID</newsletter_id>
 <last_status_change>TIMESTAMP_LAST_STATUS_CHANGED</last_status_change>
 <status>STATUS</status>
 <preview_url>INDIVIDUAL_PREVIEW_URL</preview_url>
 <profile_data>
 <items>
 <item>
 <key>PROFILE_ATTRIBUTE_NAME</key>
 <value>PROFILE_ATTRIBTUE_VALUE</value>
 </item>
[...]
 </items>
 </profile_data>
 </item>
 </getStatusResult>
 </ns1:getStatusResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getSubjects

Betreffzeilen eines Mailings auslesen

EvalancheMailingSubject getSubjects(int mailing_id)

Details

Parameter

int mailing_id: Id des Mailings

Rückgabewert

EvalancheMailingSubject[]: Liste von Objekten mit folgenden Attributen:
- int targetgroup_id: Id der Zielgruppe für die Betreffzeile. Die Id 0 repräsentiert die Standardbetreffzeile
- Die Betreffzeile Zeitstempel des Mailings

Benötigte Rechte

eMailing anzeigen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getSubjects>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:getSubjects>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getSubjectsResponse>
 <getSubjectsResult>
 <item>
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <subjectline>SUBJECT</subjectline>
 </item>
[...]
 </getSubjectsResult>
 </ns1:getSubjectsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

setSubjects

Betreffzeilen eines Mailings setzen

bool setSubjects (int mailing_id, EvalancheMailingSubject[] subjects)

Details

Parameter

int mailing_id: Id des Mailings
EvalancheMailingSubject[] subjects: Analog zum Rückgabewert unter Betreffzeilen eines Mailings auslesen. Zwingend erforderlich ist eine Konfiguration mit der Zielgruppen Id 0.

Rückgabewert

bool: true im Erfolgsfall

Benötigte Rechte

eMailing verändern

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:setSubjects>
 <mailing_id>MAILING_ID</mailing_id>
 <subjects>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 2 items in any order-->
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <subjectline>SUBJECT_VALUE</subjectline>
 </item>
[...]
 </subjects>
 </mail:setSubjects>
 </soapenv:Body>
</soapenv:Envelope>

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

getClientStatistics

Client-Statistik eines Mailings auslesen

bool getClientStatistics (int mailing_id)

Details

Parameter

int mailing_id: Id des Mailings

Rückgabewert

ClientStatistics: Objekt (SOAP) bzw. Array mit folgenden Attributen:
- mail_clients: Array mit folgenden Attributen:
  - item: Array mit folgenden Attributen:
    - string description: Beschreibung des eMail-Clients
    - int count: Anzahl der Profile, welche mit diesem eMail-Client getrackt wurden

browsers: Array mit folgenden Attributen:
- item: Array mit folgenden Attributen:
  - string description: Beschreibung des Browsers
  - int count: Anzahl der Profile, welche mit diesem Browser getrackt wurden

devices: Array mit folgenden Attributen:
- item: Array mit folgenden Attributen:
  - string description: Beschreibung des Endgerätes
  - int count: Anzahl der Profile, welche mit diesem Endgerät getrackt wurden

Benötigte Rechte

eMailing anzeigen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getClientStatistics>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:getClientStatistics>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getClientStatisticsResponse>
 <getClientStatisticsResult>
 <mail_clients>
 <item>
 <description>MAIL_CLIENT_DESCRIPTION</description>
 <count>COUNT</count>
 </item>
[...]
 </mail_clients>
 <browsers>
 <item>
 <description>BROWSER_DESCRIPTION</description>
 <version>BROWSER_VERSION</version>
 <count>COUNT</count>
 </item>
[...]
 </browsers>
 <devices>
 <item>
 <description>DEVICE_DESCRIPTION</description>
 <count>COUNT</count>
 </item>
[...]
 </devices>
 </getClientStatisticsResult>
 </ns1:getClientStatisticsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getConfiguration

Konfiguration eines Mailings auslesen

EvalancheMailingConfiguration getConfiguration(int mailing_id)

Details

Parameter

int mailing_id: Id des Mailings

Rückgabewert

EvalancheMailingConfiguration Objekt mit folgenden Attributen:
- string external_trackingcode: Wert des Feldes Externer Trackingcode
- string campaign_id: Wert des Feldes Kampagnen Id
- string externalxml_url: Wert des Feldes URL auf externes XML
- string salutation_female: Wert des Feldes Individualisierte Anrede: Frau
- string salutation_male: Wert des Feldes Individualisierte Anrede: Herr
- string salutation_company: Wert des Feldes Individualisierte Anrede: Firma
- string salutation_family: Wert des Feldes Individualisierte Anrede: Familie
- string salutation_other: Wert des Feldes Individualisierte Anrede: Keine Angabe
- string sender_email: Wert des Feldes Absenderadresse
- string sender_name: Wert des Feldes Absender
- string reply_email: Wert des Feldes Antwortadresse
- string reply_name: Wert des Feldes Antwort an
- string grant_url: Wert des Feldes Bestätigungs-URL bei Eintragungen
- string revoke_url: Wert des Feldes Bestätigungs-URL bei Austragungen
- string inputfield_0: Wert des Feldes INPUTFIELD 0
- string inputfield_1: Wert des Feldes INPUTFIELD 1
- string inputfield_2: Wert des Feldes INPUTFIELD 2
- string inputfield_3: Wert des Feldes INPUTFIELD 3
- string inputfield_4: Wert des Feldes INPUTFIELD 4
- string inputfield_5: Wert des Feldes INPUTFIELD 5
- string inputfield_6: Wert des Feldes INPUTFIELD 6
- string inputfield_7: Wert des Feldes INPUTFIELD 7
- string inputfield_8: Wert des Feldes INPUTFIELD 8
- string inputfield_9: Wert des Feldes INPUTFIELD 9
- string textarea_0: Wert des Feldes TEXTAREA 0
- string textarea_1: Wert des Feldes TEXTAREA 1
- string textarea_2: Wert des Feldes TEXTAREA 2
- string textarea_3: Wert des Feldes TEXTAREA 3
- string textarea_4: Wert des Feldes TEXTAREA 4
- string textarea_5: Wert des Feldes TEXTAREA 5
- string textarea_6: Wert des Feldes TEXTAREA 6
- string textarea_7: Wert des Feldes TEXTAREA 7
- string textarea_8: Wert des Feldes TEXTAREA 8
- string textarea_9: Wert des Feldes TEXTAREA 9
- string htmlarea_0: Wert des Feldes HTMLAREA 0 - Valides XHTML ist zwingend erforderlich!
- string htmlarea_1: Wert des Feldes HTMLAREA 1 - Valides XHTML ist zwingend erforderlich!
- string htmlarea_2: Wert des Feldes HTMLAREA 2 - Valides XHTML ist zwingend erforderlich!
- string htmlarea_3: Wert des Feldes HTMLAREA 3 - Valides XHTML ist zwingend erforderlich!
- string htmlarea_4: Wert des Feldes HTMLAREA 4 - Valides XHTML ist zwingend erforderlich!
- string htmlarea_5: Wert des Feldes HTMLAREA 5 - Valides XHTML ist zwingend erforderlich!
- string htmlarea_6: Wert des Feldes HTMLAREA 6 - Valides XHTML ist zwingend erforderlich!
- string htmlarea_7: Wert des Feldes HTMLAREA 7 - Valides XHTML ist zwingend erforderlich!
- string htmlarea_8: Wert des Feldes HTMLAREA 8 - Valides XHTML ist zwingend erforderlich!
- string htmlarea_9: Wert des Feldes HTMLAREA 9 - Valides XHTML ist zwingend erforderlich!

Benötigte Rechte

eMailing anzeigen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getConfiguration>
 <mailing_id>MAILING_ID</mailing_id>
 </mail: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/mailing">
 <SOAP-ENV:Body>
 <ns1:getConfigurationResponse>
 <getConfigurationResult>
 <external_trackingcode/>
 <campaign_id/>
 <externalxml_url/>
 <salutation_female/>
 <salutation_male/>
 <salutation_company/>
 <salutation_family/>
 <salutation_other/>
 <sender_email/>
 <sender_name/>
 <reply_name/>
 <reply_email/>
 <grant_url/>
 <revoke_url/>
 <inputfield_0/>
 <inputfield_1/>
 <inputfield_2/>
 <inputfield_3/>
 <inputfield_4/>
 <inputfield_5/>
 <inputfield_6/>
 <inputfield_7/>
 <inputfield_8/>
 <inputfield_9/>
 <textarea_0/>
 <textarea_1/>
 <textarea_2/>
 <textarea_3/>
 <textarea_4/>
 <textarea_5/>
 <textarea_6/>
 <textarea_7/>
 <textarea_8/>
 <textarea_9/>
 <htmlarea_0/>
 <htmlarea_1/>
 <htmlarea_2/>
 <htmlarea_3/>
 <htmlarea_4/>
 <htmlarea_5/>
 <htmlarea_6/>
 <htmlarea_7/>
 <htmlarea_8/>
 <htmlarea_9/>
 </getConfigurationResult>
 </ns1:getConfigurationResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

setConfiguration

Konfiguration eines Mailings setzen

bool setConfiguration(int mailing_id, EvalancheMailingConfiguration configuration)

Details

Parameter

int mailing_id: Id des Mailings
EvalancheMailingConfiguration: Objekt analog zum Rückgabewert unter Konfiguration eines Mailings auslesen

Rückgabewert

bool: true im Erfolgsfall

Benötigte Rechte

eMailing verändern

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:setConfiguration>
 <mailing_id>22852985</mailing_id>
 <configuration>
 <!--You may enter the following 44 items in any order-->
 <external_trackingcode>EXTERNAL_TRACKINGCODE</external_trackingcode>
 <campaign_id>CAMPAIGN_ID</campaign_id>
 <externalxml_url>EXTERNALXML_URL</externalxml_url>
 <salutation_female>SALUTATION_FEMALE</salutation_female>
 <salutation_male>SALUTATION_MALE</salutation_male>
 <salutation_company>SALUTATION_COMPANY</salutation_company>
 <salutation_family>SALUTATION_FAMILY</salutation_family>
 <salutation_other>SALUTATION_OTHER</salutation_other>
 <sender_email>SENDER_EMAIL</sender_email>
 <sender_name>SENDER_NAME</sender_name>
 <reply_name>REPLY_NAME</reply_name>
 <reply_email>REPLY_EMAIL</reply_email>
 <grant_url>GRANT_REDIRECT_URL</grant_url>
 <revoke_url>REVOKE_REDIRECT_URL</revoke_url>
 <inputfield_0>?</inputfield_0>
 <inputfield_1>?</inputfield_1>
 <inputfield_2>?</inputfield_2>
 <inputfield_3>?</inputfield_3>
 <inputfield_4>?</inputfield_4>
 <inputfield_5>?</inputfield_5>
 <inputfield_6>?</inputfield_6>
 <inputfield_7>?</inputfield_7>
 <inputfield_8>?</inputfield_8>
 <inputfield_9>?</inputfield_9>
 <textarea_0>?</textarea_0>
 <textarea_1>?</textarea_1>
 <textarea_2>?</textarea_2>
 <textarea_3>?</textarea_3>
 <textarea_4>?</textarea_4>
 <textarea_5>?</textarea_5>
 <textarea_6>?</textarea_6>
 <textarea_7>?</textarea_7>
 <textarea_8>?</textarea_8>
 <textarea_9>?</textarea_9>
 <htmlarea_0>?</htmlarea_0>
 <htmlarea_1>?</htmlarea_1>
 <htmlarea_2>?</htmlarea_2>
 <htmlarea_3>?</htmlarea_3>
 <htmlarea_4>?</htmlarea_4>
 <htmlarea_5>?</htmlarea_5>
 <htmlarea_6>?</htmlarea_6>
 <htmlarea_7>?</htmlarea_7>
 <htmlarea_8>?</htmlarea_8>
 <htmlarea_9>?</htmlarea_9>
 </configuration>
 <overwrite>?</overwrite>
 </mail: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/mailing">
 <SOAP-ENV:Body>
 <ns1:setConfigurationResponse>
 <setConfigurationResult>
 <external_trackingcode>EXTERNAL_TRACKINGCODE</external_trackingcode>
 <campaign_id>CAMPAIGN_ID</campaign_id>
 <externalxml_url>EXTERNALXML_URL</externalxml_url>
 <salutation_female>SALUTATION_FEMALE</salutation_female>
 <salutation_male>SALUTATION_MALE</salutation_male>
 <salutation_company>SALUTATION_COMPANY</salutation_company>
 <salutation_family>SALUTATION_FAMILY</salutation_family>
 <salutation_other>SALUTATION_OTHER</salutation_other>
 <sender_email>SENDER_EMAIL</sender_email>
 <sender_name>SENDER_NAME</sender_name>
 <reply_name>REPLY_NAME</reply_name>
 <reply_email>REPLY_EMAIL</reply_email>
 <grant_url>GRANT_REDIRECT_URL</grant_url>
 <revoke_url>REVOKE_REDIRECT_URL</revoke_url>
 <inputfield_0>?</inputfield_0>
 <inputfield_1>?</inputfield_1>
 <inputfield_2>?</inputfield_2>
 <inputfield_3>?</inputfield_3>
 <inputfield_4>?</inputfield_4>
 <inputfield_5>?</inputfield_5>
 <inputfield_6>?</inputfield_6>
 <inputfield_7>?</inputfield_7>
 <inputfield_8>?</inputfield_8>
 <inputfield_9>?</inputfield_9>
 <textarea_0>?</textarea_0>
 <textarea_1>?</textarea_1>
 <textarea_2>?</textarea_2>
 <textarea_3>?</textarea_3>
 <textarea_4>?</textarea_4>
 <textarea_5>?</textarea_5>
 <textarea_6>?</textarea_6>
 <textarea_7>?</textarea_7>
 <textarea_8>?</textarea_8>
 <textarea_9>?</textarea_9>
 <htmlarea_0>?</htmlarea_0>
 <htmlarea_1>?</htmlarea_1>
 <htmlarea_2>?</htmlarea_2>
 <htmlarea_3>?</htmlarea_3>
 <htmlarea_4>?</htmlarea_4>
 <htmlarea_5>?</htmlarea_5>
 <htmlarea_6>?</htmlarea_6>
 <htmlarea_7>?</htmlarea_7>
 <htmlarea_8>?</htmlarea_8>
 <htmlarea_9>?</htmlarea_9>
 </setConfigurationResult>
 </ns1:setConfigurationResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getSendableDrafts

Versandfertige Mailingentwürfe auslesen

EvalancheResourceInformation[] getSendableDrafts(bool unsent)

Details

Parameter

bool unsent: Wenn true übergeben wird, werden nur Entwürfe zurückgeliefert, die noch nicht versendet wurden

Rückgabewert

EvalancheResourceInformation[]: Liste von Objekten analog zur Methode getById (Informationen über ein Objekt mittels Objekt Id abfragen)

Benötigte Rechte

keine

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getSendableDrafts>
 <unsent>0/1</unsent>
 </mail:getSendableDrafts>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getSendableDraftsResponse>
 <getSendableDraftsResult>
 <item>
 <url>SENDABLE_MAILING_URL</url>
 <type_id>MAILING_TYPE_ID</type_id>
 <category_id>FOLDER_ID</category_id>
 <customer_id>MANDATOR</customer_id>
 <id>MAILING_ID</id>
 <name>MAILING_NAME</name>
 </item>
[...]
 </getSendableDraftsResult>
 </ns1:getSendableDraftsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getSendableDraftsByMandatorId

Versandfertige Mailingentwürfe aus einem Mandanten auslesen

EvalancheResourceInformation[] getSendableDraftsByMandatorId(int mandator_id, bool unsent)

Details

Parameter

int mandator_id: Die Id des Mandanten aus dem Entwürfe gesucht werden sollen bool unsent: Wenn true übergeben wird, werden nur Entwürfe zurückgeliefert, die noch nicht versendet wurden

Rückgabewert

EvalancheResourceInformation[]: Liste von Objekten analog zur Methode getById (Informationen über ein Objekt mittels Objekt Id abfragen)

Benötigte Rechte

keine

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getSendableDraftsByMandatorId>
 <mandator_id>MANDATOR_ID</mandator_id>
 <unsent>0/1</unsent>
 </mail:getSendableDraftsByMandatorId>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getSendableDraftsByMandatorIdResponse>
 <getSendableDraftsByMandatorIdResult>
 <item>
 <url>SENDABLE_MAILING_URL</url>
 <type_id>MAILING_TYPE_ID</type_id>
 <category_id>FOLDER_ID</category_id>
 <customer_id>MANDATOR</customer_id>
 <id>MAILING_ID</id>
 <name>MAILING_NAME</name>
 </item>
[...]
 </getSendableDraftsByMandatorIdResult>
 </ns1:getSendableDraftsByMandatorIdResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

createDraft

Ein Mailing aus einer Vorlage erstellen

EvalancheResourceInformation createDraft(string name, int template_id, int category_id, int type_id)

Details

Parameter

string name: Name des anzulegenden Mailings
int template_id: Id der zu verwendenden Vorlage
int category_id: Id des Ordners, in welchem das Mailing angelegt werden soll
int type_id (optional): Id des eMailing-Types
- 66 - reguläres eMailing - Default
- 69 - Event eMailing
- 76 - Trigger eMailing

Rückgabewert

EvalancheResourceInformation: Objekt analog zur Methode getById (Informationen über ein Objekt mittels Objekt Id abfragen)

Benötigte Rechte

eMailing erzeugen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:createDraft>
 <name>MAILING_NAME</name>
 <template_id>TEMPLATE_ID</template_id>
 <category_id>CATEGORY_ID</category_id>
<!-- optional parameter type_id -->
<type_id>TYPE_ID</type_id>
 </mail:createDraft>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:createDraftResponse>
 <createDraftResult>
 <url>MAILING_URL</url>
 <type_id>MAILING_TYPE_URL</type_id>
 <category_id>FOLDER_ID</category_id>
 <customer_id>MANDATOR_ID</customer_id>
 <id>MAILING_ID</id>
 <name>MAILING_NAME</name>
 </createDraftResult>
 </ns1:createDraftResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

addArticles

Artikel zu einem Mailing hinzufügen und bestehende Artikel aktualisieren

MailingArticle[] addArticles(int mailing_id, MailingArticle[] articles)

Details

Parameter

int mailing_id: Id des Mailings, in welchem die Artikel aktualisiert bzw. eingefügt werden sollen
MailingArticle[] articles: Liste von Objekten analog zum Rückgabewert beim Artikel eines Mailings auslesen. Ob eine Aktualisierung oder Neuanlage durchgeführt wird, wird über das Attribut MailingArticle:id eines Artikels gesteuert. Wird hier eine gültige Artikelreferenz Id übergeben, wird der entsprechende Artikel aktualisiert. Wird 0 übergeben wird der Artikel eingefügt.

Rückgabewert

Liste von Objekten analog zum Rückgabewert beim Artikel eines Mailings auslesen - nach dem Einfügen bzw. Aktualisieren der Artikel

Benötigte Rechte

eMailing verändern

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:addArticles>
 <mailing_id>MAILING_ID</mailing_id>
 <articles>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 10 items in any order-->
 <id>0</id>
 <article_id>ARTICLE_ID</article_id>
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <html_preset_id>HTML_PRESET_ID</html_preset_id>
 <text_preset_id>TEXT_PRESET_ID</text_preset_id>
 <landingpage_preset_id>LANDINGPAGE_PRESET_ID</landingpage_preset_id>
 <pdf_preset_id>PDF_PRESET_ID</pdf_preset_id>
 <mobile_preset_id>MOBILE_PRESET_ID</mobile_preset_id>
 <sort_pos>SORT_POS</sort_pos>
 <slot>SLOT</slot>
 </item>
 </articles>
 </mail:addArticles>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:addArticlesResponse>
 <addArticlesResult>
 <item>
 <id>UNIQUE_ARTICLE_ID</id>
 <article_id>ARTICLE_ID</article_id>
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <html_preset_id>HTML_PRESET_ID</html_preset_id>
 <text_preset_id>TEXT_PRESET_ID</text_preset_id>
 <landingpage_preset_id>LANDINGPAGE_PRESET_ID</landingpage_preset_id>
 <pdf_preset_id>PDF_PRESET_ID</pdf_preset_id>
 <mobile_preset_id>MOBILE_PRESET_ID</mobile_preset_id>
 <sort_pos>SORT_POS</sort_pos>
 <slot>SLOT</slot>
 </item>
 </addArticlesResult>
 </ns1:addArticlesResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getArticles

Artikel eines Mailings auslesen

MailingArticle[] getArticles(int mailing_id)

Details

Parameter

int mailing_id: Id des Mailings, aus welchem die Artikel ausgelesen werden sollen

Rückgabewert

MailingArticle[]: Liste von Objekten mit folgenden Attributen:
- int id: Id der Artikelreferenz (Verbindung zwischen eigentlichem Artikel und Mailing)
- int article_id: Id des Artikelobjektes
- int targetgroup_id: Id der Zielgruppe, für ausschließlich welche der Artikel angezeigt werden soll
- int sortpos: Position des Artikels innerhalb seines Slots beginnend bei 0
- int slot: Numer des Slots, in dem sich der Artikel befindet beginnend bei 0
- int html_preset_id: Id der zugewiesenen Artikelvorlage für die eMail (HTML) Darstellung. Die Id 0 bedeutet, dass die entsprechende Standard-Artikelvorlage verwendet wird
- int landingpage_preset_id: Id der zugewiesenen Artikelvorlage für die Landingpage Darstellung. Die Id 0 bedeutet, dass die entsprechende Standard-Artikelvorlage verwendet wird
- int text_preset_id: Id der zugewiesenen Artikelvorlage für die Text Darstellung. Die Id 0 bedeutet, dass die entsprechende Standard-Artikelvorlage verwendet wird
- int pdf_preset_id: Id der zugewiesenen Artikelvorlage für die PDF Darstellung. Die Id 0 bedeutet, dass die entsprechende Standard-Artikelvorlage verwendet wird
- int mobile_preset_id: Id der zugewiesenen Artikelvorlage für die mobile bzw. Web Darstellung. Die Id 0 bedeutet, dass die entsprechende Standard-Artikelvorlage verwendet wird

Benötigte Rechte

eMailing anzeigen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getArticles>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:getArticles>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:getArticlesResponse>
 <getArticlesResult>
 <item>
 <id>UNIQUE_ARTICLE_ID</id>
 <article_id>ARTICLE_ID</article_id>
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <html_preset_id>HTML_PRESET_ID</html_preset_id>
 <text_preset_id>TEXT_PRESET_ID</text_preset_id>
 <landingpage_preset_id>LANDINGPAGE_PRESET_ID</landingpage_preset_id>
 <pdf_preset_id>PDF_PRESET_ID</pdf_preset_id>
 <mobile_preset_id>MOBILE_PRESET_ID</mobile_preset_id>
 <sort_pos>SORT_POS</sort_pos>
 <slot>SLOT</slot>
 </item>
 </getArticlesResult>
 </ns1:getArticlesResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

removeAllArticles

Alle Artikel eines Mailings entfernen

bool removeAllArticles(int mailing_id)

Details

Parameter

int mailing_id: Id des Mailings, aus welchem die Artikel entfernt werden sollen. Die Artikelobjekte als solche werden nicht verändert

Rückgabewert

bool: Im Erfolgsfall true

Benötigte Rechte

eMailing verändern

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:removeAllArticles>
 <mailing_id>MAILING_ID</mailing_id>
 </mail:removeAllArticles>
 </soapenv:Body>
</soapenv:Envelope>

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

removeArticles

Bestimmte Artikel eines Mailings entfernen

MailingArticle[] removeArticles(int mailing_id, int[] reference_ids)

Details

Parameter

int mailing_id: Id des Mailings, aus welchem die Artikel entfernt werden sollen. Die Artikelobjekte als solche werden nicht verändert
int[] reference_ids: Liste von Artikelreferenz-Ids der zu entfernenden Artikel. Die Ids können durch die Methode getArticles ermittelt werden ( MailingArticle:id)

Rückgabewert

MailingArticle[] Liste von Objekten analog zum Rückgabewert beim Artikel eines Mailings auslesen - nach dem Entfernen der angegebenen Artikel. true

Benötigte Rechte

eMailing verändern

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:removeArticles>
 <mailing_id>MAILING_ID</mailing_id>
 <reference_ids>
 <!--Zero or more repetitions:-->
 <item>UNIQUE_ARTICLE_ID</item>
 </reference_ids>
 </mail:removeArticles>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:removeArticlesResponse>
 <removeArticlesResult>
<!-- list of articles still used in mailing -->
 <item>
 <id>UNIQUE_ARTICLE_ID</id>
 <article_id>ARTICLE_ID</article_id>
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <html_preset_id>HTML_PRESET_ID</html_preset_id>
 <text_preset_id>TEXT_PRESET_ID</text_preset_id>
 <landingpage_preset_id>LANDINGPAGE_PRESET_ID</landingpage_preset_id>
 <pdf_preset_id>PDF_PRESET_ID</pdf_preset_id>
 <mobile_preset_id>MOBILE_PRESET_ID</mobile_preset_id>
 <sort_pos>SORT_POS</sort_pos>
 <slot>SLOT</slot>
 </item>
[...]
 </removeArticlesResult>
 </ns1:removeArticlesResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

sendToTargetgroup

Ein Mailing an eine Zielgruppe versenden

EvalancheMailingInformation sendToTargetgroup(int mailing_id, int targetgroup_id, int send_time, int speed)

Details

Parameter

int mailing_id: Id des zu versendenden Mailingentwurfes
int targetgroup_id: Id der Zielgruppe
int send_time: Unix Timestamp des Versandzeitpunktes (UTC). Liegt dieser in der Vergangenheit, startet der Versand sofort
int speed: Versandgeschwindigkeit in Mails/Stunde. Ist dieser Wert 0, wird keine Drosselung vorgenommen

Rückgabewert

EvalancheMailingInformation: Objekt analog zur Methode getDetails (Details einer Versendung abfragen)

Benötigte Rechte

eMailing verwalten

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:sendToTargetgroup>
 <mailing_id>MAILING_ID</mailing_id>
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <send_time>TIMESTAMP_SEND_TIME</send_time>
 <speed>SENDSPEED</speed>
 </mail:sendToTargetgroup>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:sendToTargetgroupResponse>
 <sendToTargetgroupResult>
 <timestamp>TIMESTAMP</timestamp>
 <recipients>RECIPIENTS</recipients>
 <sent>SENT</sent>
 <preview_url xsi:nil="true"/>
 <report_url>REPORT_URL</report_url>
 <admin_url>OBJECT_URL</admin_url>
 <subject>SUBJECT</subject>
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <send_start_time>SEND_START_TIME</send_start_time>
 <send_end_time>SEND_END_TIME</send_end_time>
 <url>PREVIEW_URL</url>
 <type_id>MAILING_TYPE_ID</type_id>
 <category_id>FOLDER_ID</category_id>
 <customer_id>MANDATOR_ID</customer_id>
 <id>MAILING_ID</id>
 <name>MAILING_NAME</name>
 </sendToTargetgroupResult>
 </ns1:sendToTargetgroupResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

sendToProfiles

Ein Mailing an einzelne Profile senden (Triggermailing wird empfohlen)

int[] sendToProfiles(int mailing_id, int[] profile_ids)

Details

Parameter

int mailing_id: Id des Mailings int[] profile_ids: Liste von Profil Ids

Rückgabewert

int[]: Liste mit den Ids der Profile, an die der Versand erfolgreich war

Benötigte Rechte

eMailing verwalten

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:sendToProfiles>
 <mailing_id>MAILING_ID</mailing_id>
 <profile_ids>
 <!--Zero or more repetitions:-->
 <item>PROFILE_ID</item>
 </profile_ids>
 </mail:sendToProfiles>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:sendToProfilesResponse>
 <sendToProfilesResult>
 <item>PROFILE_ID</item>
 </sendToProfilesResult>
 </ns1:sendToProfilesResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

retrieveGlobalModuleConfiguration

Ruft globale Modulkonfigurationen ab

retrieveGlobalModuleConfigurationResponse retrieveGlobalModuleConfiguration (int resource_id)

Details

Parameter

int resource_id: ID des Mailings

Rückgabewert

object: retrieveGlobalModuleConfigurationResponse
- string: retrieveGlobalModuleConfigurationResult

Benötigte Rechte

keine Objektrechte benötigt

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mail="https://scnem.com/soap.php/soap/mailing">
  <soapenv:Header />
  <soapenv:Body>
  <mail:retrieveGlobalModuleConfiguration>
  <resource_id>MAILING_ID</resource_id>
  </mail: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/mailing">
  <SOAP-ENV:Body>
  <retrieveGlobalModuleConfigurationResult>{"modules":[]}</retrieveGlobalModuleConfigurationResult>
  </ns1:retrieveGlobalModuleConfigurationResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

retrieveModuleConfiguration

Ruft Modulkonfigurationen ab

retrieveModuleConfigurationResponse retrieveModuleConfiguration (int resource_id)

Details

Parameter

int resource_id: ID des Mailings

Rückgabewert

object: retrieveModuleConfigurationResponse
- string: retrieveModuleConfigurationResult

Benötigte Rechte

keine Objektrechte benötigt

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mail="https://scnem.com/soap.php/soap/mailing">
  <soapenv:Header />
  <soapenv:Body>
  <mail:retrieveModuleConfiguration>
  <resource_id>MAILING_ID</resource_id>
  </mail: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/mailing">
  <SOAP-ENV:Body>
  <ns1:retrieveModuleConfigurationResponse>
  <retrieveModuleConfigurationResult>{"dropareas":[]}</retrieveModuleConfigurationResult>
  </ns1:retrieveModuleConfigurationResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

retrieveModuleTypes

Ruft Modultypen ab

retrieveModuleTypesResponse retrieveModuleTypes (int resource_id)

Details

Parameter

int resource_id: ID des Mailings

Rückgabewert

object: retrieveModuleTypesResponse
- string: retrieveModuleTypesResult

Benötigte Rechte

keine Objektrechte benötigt

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mail="https://scnem.com/soap.php/soap/mailing">
  <soapenv:Header />
  <soapenv:Body>
  <mail:retrieveModuleTypes>
  <resource_id>MAILING_ID</resource_id>
  </mail: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/mailing">
  <SOAP-ENV:Body>
  <ns1:retrieveModuleTypesResponse>
  <retrieveModuleTypesResult>{"module_types":[],"categories":[]}</retrieveModuleTypesResult>
  </ns1:retrieveModuleTypesResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

setResultCursor

Setzt den Cursor für die Ergebnismenge, die beim nächsten Aufruf von getResults zurückgegeben wird.

boolean setResultCursor (string job_Id, int cursor)

Details

Parameter

string job_id: Id des Hintergrundjobs
int Cursor: die Stelle an der der Cursor gesetzt werden soll

Rückgabewert

boolean setSubjectsResult: Boolscher Rückgabewert der Methode

Benötigte Rechte

Zielgruppe ansehen und Profile exportieren

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:setResultCursor>
 <job_id>JOB_ID</job_id>
 <cursor>CURSOR</cursor>
 </mail:setResultCursor>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
 <SOAP-ENV:Body>
 <ns1:setResultCursorResponse>
 <setResultCursorResult>
 <CursorResult>CURSORRESULT</CursorResult>
 </setResultCursorResult>
 </ns1:setResultCursorResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>

Siehe auch:

Hintergrundjobs

updateGlobalModuleConfiguration

Aktualisiert globale Modulkonfigurationen

updateGlobalModuleConfigurationResponse updateGlobalModuleConfiguration (int resource_id, string global_module_content)

Details

Parameter

int resource_id: ID des Mailings
string global_module_content: Inhalt des globalen Moduls

Rückgabewert

object: updateGlobalModuleConfigurationResponse
- bool: updateGlobalModuleConfigurationResult liefert im Erfolgsfall true zurück

Benötigte Rechte

keine Objektrechte benötigt

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mail="https://scnem.com/soap.php/soap/mailing">
  <soapenv:Header />
  <soapenv:Body>
  <mail:updateGlobalModuleConfiguration>
  <resource_id>MAILING_ID</resource_id>
  <global_module_content>CONTENT</global_module_content>
  </mail: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/mailing">
  <SOAP-ENV:Body>
  <ns1:updateGlobalModuleConfigurationResponse>
  <updateGlobalModuleConfigurationResult>true</updateGlobalModuleConfigurationResult>
  </ns1:updateGlobalModuleConfigurationResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

updateModuleConfiguration

Aktualisiert Modulkonfigurationen

updateModuleConfigurationResponse updateModuleConfiguration (int resource_id, string module_content)

Details

Parameter

int resource_id: ID des Mailings
string global_module_content: Inhalt des Moduls

Rückgabewert

object: updateModuleConfigurationResponse
- bool: updateModuleConfigurationResult liefert im Erfolgsfall true zurück

Benötigte Rechte

keine Objektrechte benötigt

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mail="https://scnem.com/soap.php/soap/mailing">
  <soapenv:Header />
  <soapenv:Body>
  <mail:updateModuleConfiguration>
  <resource_id>MAILING_ID</resource_id>
  <module_content>CONTENT</module_content>
  </mail: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/mailing">
  <SOAP-ENV:Body>
  <ns1:updateModuleConfigurationResponse>
  <updateModuleConfigurationResult>true</updateModuleConfigurationResult>
  </ns1:updateModuleConfigurationResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

updateModuleTypes

Aktualisiert Modultypenspeicher

updateModuleTypesResponse updateModuleTypes (int resource_id, string module_type_content)

Details

Parameter

int resource_id: ID des Mailings
string module_type_content: Inhalt des Modultypenspeicher

Rückgabewert

object: updateModuleTypesResponse
- bool: updateModuleTypesResult liefert im Erfolgsfall true zurück

Benötigte Rechte

keine Objektrechte benötigt

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:mail="https://scnem.com/soap.php/soap/mailing">
  <soapenv:Header />
  <soapenv:Body>
  <mail:updateModuleTypes>
  <resource_id>MAILING_ID</resource_id>
  <module_type_content>?</module_type_content>
  </mail: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/mailing">
  <SOAP-ENV:Body>
  <ns1:updateModuleTypesResponse>
  <updateModuleTypesResult>true</updateModuleTypesResult>
  </ns1:updateModuleTypesResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Arbeiten mit Hintergrundjobs

Exporte von Zielgruppen und Pools werden aufgrund der Laufzeit und Datenmenge als asynchrone Hintergrundjobs durchgeführt. Das Result wird dabei in Chunks mit jeweils 1000 Profilen ausgeliefert. Das Result steht für 28 Tage zur Verfügung. Ein Beispielhaftes Script zum Export aller Profile eines Pools in PHP könnte wie folgt aussehen:


<?php

[...]

$job_info = $client->getByPool($pool_id, array('PROFILEID', 'FIRSTNAME', 'NAME', 'EMAIL', 'P1341395547'));
var_dump($job_info);

while($job_info->status < 2 || $job_info->status == 3) { // Status prüfen, solange der Job in der Warteschleife, in Bearbeitung oder temporär fehlerhaft ist
        $job_info = $client->getJobInformation($job_info->id);
        var_dump($job_info);
        sleep(5);
}

if($job_info->status == 2) { // Job ist erledigt
        $result = $client->getResults($job_info->id); // erstes Resultset abholen
        var_dump($result);

        while($result->chunks_left > 0) { // weitere Resultsets abholen, falls vorhanden
                $result = $client->getResults($job_info->id);
                var_dump($result);
        }
} else {
        // Der Job konnte nicht erfolgreich ausgeführt werden
}

Standard API (SOAP)

copy

delete

getAll

getByCategory

getByExternalId

getById

getByModificationDate

getByTypeId

getJobInformation

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

Siehe auch:

getJobState

getResultCursor

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

Siehe auch:

getResourceDefaultCategory

getTypeIds

get

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

Siehe auch:

getContentGenerationVariables

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

isAlive

move

rename

runContentGeneration

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getContentContainerData

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

setContentContainerData

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getDetails

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getImpressions

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getClicks

Parameter

Rückgabewert

Erklärung zu ``link_id`` und ``parent_id``:

Benötigte Rechte

Verwendung

getStatistics

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getArticleStatistics

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getStatus