SOAP Profile – Evalanche Helpcenter

Folgende SOAP-Methoden werden speziell für den Import, Export und die Manipulation von Profilen bereitgestellt.

Die wichtigste Methode "massUpdate()" erlaubt es große Datenmengen mit einem Aufruf zu synchroniseren. Dabei lässt sich neben dem Eindeutigkeitskriterium auch konfigurieren, ob noch nicht existierende Datensätze angelegt oder ignoriert werden sollen.

create

Legt ein neues Profil im angegebenen Pool an.

int Profile::create(int pool_id, EvalancheHashMap data)

Details

Parameter

int pool_id: Die ID des Pools, in welchem das Profil angelegt werden soll
EvalancheHashMap data: EvalancheHachMap mit den Daten des Profils

Rückgabewert

int profile_id: Die ID des neu angelegten Profils

Benötigte Rechte

Profilliste ansehen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:create>
 <pool_id>POOL_ID</pool_id>
 <data>
 <items>
 <item>
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_CONTENT</value>
 </item>
[...]
 </items>
 </data>
 </prof:create>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:createResponse>
 <createResult>PROFILE_ID</createResult>
 </ns1:createResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

delete

Löscht ein Profil anhand einer Profil-ID.

bool Profile::delete(int[] profile_id)

Details

Parameter

int[] profile_id: Eine Liste der IDs der zu löschenden Profile

Rückgabewert

bool: true im Erfolgsfall

Benötigte Rechte

Profile löschen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:delete>
 <profile_ids>
 <!--Zero or more repetitions:-->
 <item>PROFILE_ID</item>
 </profile_ids>
 </prof:delete>
 </soapenv:Body>
</soapenv:Envelope>

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

revokePermission

Widerruft die Permission eines Profils und trägt das Profil aus.

int Profile::revokePermission(int profile_id)

Details

Parameter

int profile_id: Die ID des Profils, welches ausgetragen werden soll

Rückgabewert

bool: true im Erfolgsfall

Benötigte Rechte

Profilliste ansehen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:revokePermission>
 <profile_id>PROFILE_ID</profile_id>
 </prof:revokePermission>
 </soapenv:Body>
</soapenv:Envelope>

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

revokeTracking

Widerruft die Trackingeinwilligung eines Profils.

int Profile::revokeTracking(int profile_id)

Details

Parameter

int profile_id: Die ID des Profils, dessen Trackingeinwilligun widerrufen werden soll

Rückgabewert

bool: true im Erfolgsfall

Benötigte Rechte

Profilliste ansehen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:revokeTracking>
 <profile_id>PROFILE_ID</profile_id>
 </prof:revokeTracking>
 </soapenv:Body>
</soapenv:Envelope>

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

grantPermission

Bestätigt die Permission eines Profils zu Double-Opt-In anhand einer Profil-ID.

bool Profile::grantPermission(int[] profile_id)

Details

Parameter

int[] profile_id: Eine Liste der IDs der zu bestätigenden Profile

Rückgabewert

bool: true im Erfolgsfall

Benötigte Rechte

Profilliste ansehen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:grantPermission>
 <profile_id>PROFILE_ID</profile_id>
 </prof:grantPermission>
 </soapenv:Body>
</soapenv:Envelope>

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

getById

Sucht ein Profil anhand einer Profil-ID.

EvalancheHashMap Profile::getById(string profile_id)

Details

Parameter

string profile_id: ID oder UID des zu suchenden Profils

Rückgabewert

EvalancheHashMap data: EvalancheHashMap mit den Daten des Profils

Benötigte Rechte

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>
 <prof:getById>
 <profile_id>PROFILE_ID</profile_id>
 </prof:getById>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getByIdResponse>
 <getByIdResult>
 <items>
 <item>
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
[...]
 </items>
 </getByIdResult>
 </ns1:getByIdResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getByKey

Sucht ein Profil anhand eines bestimmten Attributwertes.

EvalancheHashMap[] Profile::getByKey(int pool_id, string key, string value, string[] pool_attribute_list)

Details

Parameter

int pool_id: ID des Pools in dem gesucht werden soll
string key: Name des Poolattributes, welches der Schlüssel für die Suche ist, z.B.: EMAIL
string value: Zu suchender Wert, z.B.: mustermann@example.com
string[] pool_attribute_list: Liste mit Namen der Poolattribute, die im Ergebnis zurückgeliefert werden sollen (Pflicht)

Rückgabewert

EvalancheHashMap data: EvalancheHashMap mit den Daten der Profile

Benötigte Rechte

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>
 <prof:getByKey>
 <pool_id>POOL_ID</pool_id>
 <key>KEY_ATTRIBUTE</key>
 <value>KEY_ATTRIBUTE_VALUE</value>
 <pool_attribute_list>
 <!--One or more repetitions:-->
 <item>ATTRIBUTE_NAME</item>
[...]
 </pool_attribute_list>
 </prof:getByKey>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getByKeyResponse>
 <getByKeyResult>
 <item>
 <items>
 <item>
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
[...]
 </items>
 </item>
[...]
 </getByKeyResult>
 </ns1:getByKeyResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getBounces

Exportiert alle Hardbounces eines Mandanten, die innerhalb eines Zeitintervalls aufgetreten sind.

ProfileBounceStatus[] Profile::getBounces(int pool_id, int start_time, int end_time, string[] pool_attribute_list)

Details

Parameter

int pool_id: ID des Pools in dessen Mandanten gesucht werden soll
int start_time: UTC Unix Timestamp der Zeit ab (einschließlich) welcher Bounces zurückgeliefert werden sollen
int end_time: UTC Unix Timestamp der Zeit, bis zu (einschließlich) welcher Bounces zurückgeliefert werden sollen. Wird hier 0 übergeben, wird die aktuelle Zeit herangezogen
string[] pool_attribute_list: Optionale Liste mit Namen der Poolattribute, die im Ergebnis zurückgeliefert werden sollen

Rückgabewert

ProfileBounceStatus[]: Liste von Objekten mit folgenden Attributen:
- int profile_id: ID des betreffenden Profiles
- int mailing_id: ID des Mailings, in welchem der Bounce auftrat
- int status: Bounce Status. Mögliche Werte sind:
  - 3: Softbounce
  - 2: Hardbounce
- int timestamp: UTC Unix Timestamp des Zeitpunktes, zu welchem der Bounce auftrat
- EvalancheHashMap profile_data: EvalancheHashMap mit den Daten des betreffenden Profils

Benötigte Rechte

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>
 <prof:getBounces>
 <pool_id>POOL_ID</pool_id>
 <start_time>TIMESTAMP_START_TIME</start_time>
 <end_time>TIMESTAMP_END_TIME</end_time>
 <pool_attribute_list>
 <!--Zero or more repetitions:-->
 <item>ATTRIBUTE_NAME</item>
[...]
 </pool_attribute_list>
 </prof:getBounces>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getBouncesResponse>
 <getBouncesResult>
 <item>
 <items>
 <item>
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
[...]
 </items>
 </item>
[...]
 </getBouncesResult>
 </ns1:getBouncesResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getModifiedProfiles

Exportiert alle geänderten Profile eines Pools, die innerhalb eines Zeitintervalls aufgetreten sind.

EvalancheHashMap[] Profile::getModifiedProfiles(int pool_id, string[] attributes, int start_time, int end_time = 0)

Details

Parameter

int pool_id: ID des abzufragenden Pools
string[] attributes: Liste von Poolattribut Namen, deren Werte für gefundene Profile zurückgeliefert werden sollen
int start_time: UTC Unix Timestamp der Zeit ab (einschließlich) welcher geänderte Profile zurückgeliefert werden sollen
int end_time: UTC Unix Timestamp der Zeit bis zu (einschließlich) welcher geänderte Profile zurückgeliefert werden sollen

Rückgabewert

EvalancheHashMap[]: Liste von `EvalancheHashMap`_ mit den Daten der betreffenden Profile

Benötigte Rechte

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>
 <prof:getModifiedProfiles>
 <pool_id>Pool_id</pool_id>
 <attributes>
 <!--Zero or more repetitions:-->
 <item>ATTRIBUTE_NAME</item>
 </attributes>
 <start_time>TIMESTAMP_START_TIME</start_time>
 <end_time>TIMESTAMP_END_TIME</end_time>
 </prof:getModifiedProfiles>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getModifiedProfilesResponse>
 <getModifiedProfilesResult>
 <item>
 <items>
 <item>
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
[...]
 </items>
 </item>
[...]
 </getModifiedProfilesResult>
 </ns1:getModifiedProfilesResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getUnsubscriptions

Exportiert alle Abmeldungen eines Pools, die innerhalb eines Zeitintervalls aufgetreten sind.

EvalancheHashMap[] Profile::getUnsubscriptions(int pool_id, int start_time, int end_time, string[] attributes)

Details

Parameter

int pool_id: ID des abzufragenden Pools
int start_time: UTC Unix Timestamp der Zeit ab (einschließlich) welcher Abmeldungen zurückgeliefert werden sollen
int end_time: UTC Unix Timestamp der Zeit bis zu (einschließlich) welcher Abmeldungen zurückgeliefert werden sollen. Wird hier 0 übergeben, wird die aktuelle Zeit herangezogen.
string[] attributes: Optionales Array von Strings mit Namen von Pool Attributen. welche im Result zurückgeliefert werden sollen

Rückgabewert

EvalancheHashMap[]: Liste von `EvalancheHashMap`_ mit den Daten der betreffenden Profile

Benötigte Rechte

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>
 <prof:getUnsubscriptions>
 <pool_id>POOL_ID</pool_id>
 <start_time>TIMESTAMP_START_TIME</start_time>
 <end_time>TIMESTAMP_END_TIME</end_time>
 <pool_attribute_list>
 <!--Zero or more repetitions:-->
 <item>ATTRIBUTE_NAME</item>
 </pool_attribute_list>
 </prof:getUnsubscriptions>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getUnsubscriptionsResponse>
 <getUnsubscriptionsResult>
 <item>
 <items>
 <item>
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
[...]
 </items>
 </item>
[...]
 </getUnsubscriptionsResult>
 </ns1:getUnsubscriptionsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getGrantedPermissions

Exportiert alle Profile eines Pools, die innerhalb eines Zeitintervalls einen Double-Opt-In bestätigt haben.

EvalancheHashMap[] Profile::getGrantedPermissions(int pool_id, string[] attributes, int start_time, int end_time)

Details

Parameter

int pool_id: ID des abzufragenden Pools
string[] attributes: Optionales Array von Strings mit Namen von Pool Attributen. welche im Result zurückgeliefert werden sollen
int start_time: UTC Unix Timestamp der Zeit ab (einschließlich) welcher Double-Opt-In Bestätigungen zurückgeliefert werden sollen
int end_time: UTC Unix Timestamp der Zeit bis zu (einschließlich) welcher Double-Opt-In Bestätigungen zurückgeliefert werden sollen. Wird hier 0 übergeben, wird die aktuelle Zeit herangezogen.

Rückgabewert

EvalancheHashMap[]: Liste von `EvalancheHashMap`_ mit den Daten der betreffenden Profile

Benötigte Rechte

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>
 <prof:getGrantedPermissions>
 <pool_id>POOL_ID</pool_id>
 <attributes>
 <!--Zero or more repetitions:-->
 <item>ATTRIBUTE_NAME</item>
 </attributes>
 <start_time>TIMESTAMP_START_TIME</start_time>
 <end_time>TIMESTAMP_END_TIME</end_time>
 </prof:getGrantedPermissions>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getGrantedPermissionsResponse>
 <getGrantedPermissionsResult>
 <item>
 <items>
 <item>
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
[...]
 </items>
 </item>
[...]
 </getGrantedPermissionsResult>
 </ns1:getGrantedPermissionsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getByTargetGroup

Exportiert alle Profile einer Zielgruppe.

EvalancheJobHandle[] Profile::getByTargetGroup(int targetgroup_id, string[] pool_attributes_list)

Details

Parameter

int targetgroup_id: ID der abzufragenden Zielgruppe
string[] pool_attribute_list: Liste der Attributnamen, die im Ergebnis zurückgeliefert werden sollen (Pflicht)

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öglcihen 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, hier immer profile
string method: Name der Methode, welchen den Hintergrundjob gestartet hat, hier immer getByTargetGroup
int resource_id: ID der Resource, für welche der Hintergrundjob gestartet wurde, hier immer die targetgroup_id
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>
 <prof:getByTargetGroup>
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 <pool_attribute_list>
 <!--One or more repetitions:-->
 <item>ATTRIBUTE_NAME</item>
 </pool_attribute_list>
 </prof:getByTargetGroup>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getByTargetGroupResponse>
 <getByTargetGroupResult>
 <id>JOB_ID</id>
 <status>JOB_STATUS</status>
 <status_description>JOB_STATUS_DESCRIPTION</status_description>
 <namespace>JOB_NAMESPACE</namespace>
 <method>JOB_METHOD</method>
 <resource_id>TARGETGROUP_ID</resource_id>
 <result_chunks>COUNT_RESULT_CHUNKS</result_chunks>
 </getByTargetGroupResult>
 </ns1:getByTargetGroupResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Siehe auch:

Hintergrundjobs

getByPool

Exportiert alle Profile eines Pools.

EvalancheJobHandle[] Profile::getByPool(int pool_id, string[] pool_attributes_list)

Details

Parameter

int pool_id: ID des abzufragenden Pools
string[] pool_attribute_list: Liste der Attributnamen, die im Ergebnis zurückgeliefert werden sollen (Pflicht)

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, hier immer profile
string method: Name der Methode, welchen den Hintergrundjob gestartet hat, hier immer getByPool
int resource_id: ID der Resource, für welche der Hintergrundjob gestartet wurde, hier immer die pool_id
int result_chunks: Anzahl der gefundenen Ergebnisblöcke. Dieser Wert ist nur im Status 2 ungleich 0

Benötigte Rechte

Pool 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>
 <prof:getByPool>
 <pool_id>22852889</pool_id>
 <pool_attribute_list>
 <!--One or more repetitions:-->
 <item>EMAIL</item>
 <item>SID</item>
 </pool_attribute_list>
 </prof:getByPool>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getByPoolResponse>
 <getByPoolResult>
 <id>JOB_ID</id>
 <status>JOB_STATUS</status>
 <status_description>JOB_STATUS_DESCRIPTION</status_description>
 <namespace>JOB_NAMESPACE</namespace>
 <method>JOB_METHOD</method>
 <resource_id>TARGETGROUP_ID</resource_id>
 <result_chunks>COUNT_RESULT_CHUNKS</result_chunks>
 </getByPoolResult>
 </ns1:getByPoolResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Siehe auch:

Hintergrundjobs

isInTargetgroups

Prüft, ob sich ein Profil in einer bestimmten Zielgruppe befindet.

EvalancheTargetgroupMembership[] Profile::isInTargetgroups(int profile_id, int[] targetgroup_ids)

Details

Parameter

int profile_id: ID des abzufragenden Profils
int[] targetgroup_ids: Liste von Zielgruppen Ids, die geprüft werden sollen

Rückgabewert

EvalancheTargetgroupMembership[]: Liste von EvalancheTargetgroupMembership Objekten mit folgenden Attributen:
- int profile_id: Die ID des geprüften Profils
- int targetgroup_id: ID der Zielgruppe, in welcher sich das Profil befindet

Benötigte Rechte

Profilliste ansehen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:isInTargetgroups>
 <profile_id>PROFILE_ID</profile_id>
 <targetgroup_ids>
 <!--Zero or more repetitions:-->
 <item>TARGETGROUP_ID</item>
 </targetgroup_ids>
 </prof:isInTargetgroups>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:isInTargetgroupsResponse>
 <isInTargetgroupsResult>
 <item>
 <profile_id>PROFILE_ID</profile_id>
 <targetgroup_id>TARGETGROUP_ID</targetgroup_id>
 </item>
[...]
 </isInTargetgroupsResult>
 </ns1:isInTargetgroupsResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

tagWithOption

Setzt eine Mehrfachselektions-Option bei Profilen, die anhand eines Keys gesucht werden.

bool Profile::tagWithOption(int pool_attribute_option_id, string[] values, string key, bool set_profile_edit_date)

Details

Parameter

int pool_attribute_option_id: ID der Attributoption, welche gesetzt werden soll
string[] values: Liste von Strings mit Werten, nach denen gesucht werden soll
string key: Name des Poolattributes, in welchem nach values gesucht werden soll
bool set_profile_edit_date: Wird hier true angegeben, wird das Änderungsdatum für alle betroffenen Profile aktualisiert

Rückgabewert

bool: true im Erfolgsfall

Benötigte Rechte

Profilliste ansehen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:tagWithOption>
 <pool_attribute_option_id>ATTRIBUTE_OPTION_ID</pool_attribute_option_id>
 <values>
 <!--Zero or more repetitions:-->
 <item>SEARCH_ATTRIBUTE_VALUES</item>
 </values>
 <key>SEARCH_ATTRIBUTE</key>
 <set_profile_edit_date_and_fire_update_event>SET_CHANGE_DATE 1/0</set_profile_edit_date_and_fire_update_event>
 </prof:tagWithOption>
 </soapenv:Body>
</soapenv:Envelope>

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

untagWithOption

Entfernt eine Mehrfachselektions-Option bei Profilen, die anhand eines Keys gesucht werden.

bool Profile::untagWithOption(int pool_attribute_option_id, string[] values, string key, bool set_profile_edit_date)

Details

Parameter

int pool_attribute_option_id: ID der Attributoption, welche entfernt werden soll
string[] values: Liste von Strings mit Werten, nach denen gesucht werden soll
string key: Name des Poolattributes, in welchem nach values gesucht werden soll
bool set_profile_edit_date: Wird hier true angegeben, wird das Änderungsdatum für alle betroffenen Profile aktualisiert

Rückgabewert

bool: true im Erfolgsfall

Benötigte Rechte

Profilliste ansehen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:untagWithOption>
 <pool_attribute_option_id>ATTRIBUTE_OPTION_ID</pool_attribute_option_id>
 <values>
 <!--Zero or more repetitions:-->
 <item>SEARCH_ATTRIBUTE_VALUE</item>
 </values>
 <key>SEARCH_ATTRIBUTE_KEY</key>
 <set_profile_edit_date_and_fire_update_event>SET_CHANGE_DATE 1/0</set_profile_edit_date_and_fire_update_event>
 </prof:untagWithOption>
 </soapenv:Body>
</soapenv:Envelope>

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

updateById

Aktualisiert ein Profil anhand der Profil-ID. Mehrfachselektionen werden exakt wie angegeben gesetzt, bestehende Werte im Profil überschrieben.

bool Profile::updateById(int profile_id, EvalancheHashMap data)

Details

Parameter

int profile_id: ID des Profils, welches aktualisiert werden soll
EvalancheHashMap data: EvalancheHashMap mit den Daten des Profils

Rückgabewert

bool: true im Erfolgsfall

Benötigte Rechte

Profilliste ansehen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:updateById>
 <profile_id>PROFILE_ID</profile_id>
 <data>
 <items>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 2 items in any order-->
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
 </items>
 </data>
 </prof:updateById>
 </soapenv:Body>
</soapenv:Envelope>

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

mergeById

Aktualisiert ein Profil anhand der Profil-ID. Mehrfachselektionen werden zusammengeführt, übergebene Optionen werden mit bestehenden Optionen kombiniert.

bool Profile::mergeById(int profile_id, EvalancheHashMap data)

Details

Parameter

int profile_id: ID des Profils, welches aktualisiert werden soll
EvalancheHashMap data: EvalancheHashMap mit den Daten des Profils

Rückgabewert

bool: true im Erfolgsfall

Benötigte Rechte

Profilliste ansehen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:mergeById>
 <profile_id>PROFILE_ID</profile_id>
 <data>
 <items>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 2 items in any order-->
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
 </items>
 </data>
 </prof:mergeById>
 </soapenv:Body>
</soapenv:Envelope>

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

updateByKey

Aktualisiert ein Profil anhand eines Attributes. Mehrfachselektionen werden exakt wie angegeben gesetzt, bestehende Werte im Profil überschrieben.

bool Profile::updateByKey(int pool_id, string key, string value, EvalancheHashMap data)

Details

Parameter

int pool_id: ID des Pools, in welchem gesucht werden soll
string key: Name des Poolattributes, in welchem gesucht werden soll
string value: Wert, nach welchem in key gesucht werden soll
EvalancheHashMap data: EvalancheHashMap mit den Daten des Profils

Rückgabewert

bool: true im Erfolgsfall

Benötigte Rechte

Profilliste ansehen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:updateByKey>
 <pool_id>POOL_ID</pool_id>
 <key>SEARCH_ATTRIBUTE_NAME</key>
 <value>SEARCH_ATTRIBUTE_VALUE</value>
 <data>
 <items>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 2 items in any order-->
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
 </items>
 </data>
 </prof:updateByKey>
 </soapenv:Body>
</soapenv:Envelope>

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

mergeByKey

Aktualisiert ein Profil anhand eines Attributes. Mehrfachselektionen werden zusammengeführt, übergebene Optionen werden mit bestehenden Optionen kombiniert.

bool Profile::mergeByKey(int pool_id, string key, string value, EvalancheHashMap data)

Details

Parameter

int pool_id: ID des Pools, in welchem gesucht werden soll
string key: Name des Poolattributes, in welchem gesucht werden soll
string value: Wert, nach welchem in key gesucht werden soll
EvalancheHashMap data: EvalancheHashMap mit den Daten des Profils

Rückgabewert

bool: true im Erfolgsfall

Benötigte Rechte

Profilliste ansehen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:mergeByKey>
 <pool_id>POOL_ID</pool_id>
 <key>SEARCH_ATTRIBUTE_NAME</key>
 <value>SEARCH_ATTRIBUTE_VALUE</value>
 <data>
 <items>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 2 items in any order-->
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
 </items>
 </data>
 </prof:mergeByKey>
 </soapenv:Body>
</soapenv:Envelope>

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

updateByTargetGroup

Aktualisiert die Profile einer Zielgruppe. Mehrfachselektionen werden exakt wie angegeben gesetzt, bestehende Werte im Profil überschrieben.

bool Profile::updateByTargetGroup(int targetgroup_id, EvalancheHashMap data)

Details

Parameter

int targetgroup_id: ID der Zielgruppe, in welcher Profil aktualisiert werden sollen
EvalancheHashMap data: EvalancheHashMap mit den Daten des Profils

Rückgabewert

bool: true im Erfolgsfall

Benötigte Rechte

Profilliste ansehen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:updateByTargetGroup>
 <target_group_id>TARGETGROUP_ID</target_group_id>
 <data>
 <items>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 2 items in any order-->
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
 </items>
 </data>
 </prof:updateByTargetGroup>
 </soapenv:Body>
</soapenv:Envelope>

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

mergeByTargetGroup

Aktualisiert die Profile einer Zielgruppe. Mehrfachselektionen werden zusammengeführt, übergebene Optionen werden mit bestehenden Optionen kombiniert.

bool Profile::mergeByTargetGroup(int targetgroup_id, EvalancheHashMap data)

Details

Parameter

int targetgroup_id: ID der Zielgruppe, in welcher Profil aktualisiert werden sollen
EvalancheHashMap data: EvalancheHashMap mit den Daten des Profils

Rückgabewert

bool: true im Erfolgsfall

Benötigte Rechte

Profilliste ansehen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:mergeByTargetGroup>
 <target_group_id>TARGETGROUP_ID</target_group_id>
 <data>
 <items>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 2 items in any order-->
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
 </items>
 </data>
 </prof:mergeByTargetGroup>
 </soapenv:Body>
</soapenv:Envelope>

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

updateByPool

Aktualisiert die Profile eines Pools. Mehrfachselektionen werden exakt wie angegeben gesetzt, bestehende Werte im Profil überschrieben.

bool Profile::updateByPool(int pool_id, EvalancheHashMap data)

Details

Parameter

int pool_id: ID der Zielgruppe, in welcher Profil aktualisiert werden sollen
EvalancheHashMap data: EvalancheHashMap mit den Daten des Profils

Rückgabewert

bool: true im Erfolgsfall

Benötigte Rechte

Profilliste ansehen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:updateByPool>
 <pool_id>POOL_ID</pool_id>
 <data>
 <items>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 2 items in any order-->
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
 </items>
 </data>
 </prof:updateByPool>
 </soapenv:Body>
</soapenv:Envelope>

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

mergeByPool

Aktualisiert die Profile eines Pools. Mehrfachselektionen werden zusammengeführt, übergebene Optionen werden mit bestehenden Optionen kombiniert.

bool Profile::mergeByPool(int pool_id, EvalancheHashMap data)

Details

Parameter

int pool_id: ID der Zielgruppe, in welcher Profil aktualisiert werden sollen
EvalancheHashMap data: EvalancheHashMap mit den Daten des Profils

Rückgabewert

bool: true im Erfolgsfall

Benötigte Rechte

Profilliste ansehen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:mergeByPool>
 <pool_id>POOL_ID</pool_id>
 <data>
 <items>
 <!--Zero or more repetitions:-->
 <item>
 <!--You may enter the following 2 items in any order-->
 <key>ATTRIBUTE_NAME</key>
 <value>ATTRIBUTE_VALUE</value>
 </item>
 </items>
 </data>
 </prof:mergeByPool>
 </soapenv:Body>
</soapenv:Envelope>

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

massUpdate

Importiert oder aktualisiert eine Liste von Profilen eines Pools. Mehrfachselektionen können optional zusammengeführt werden, wobei übergebene Optionen mit bestehenden Optionen kombiniert werden.

MassUpdateResult Profile::massUpdate(int pool_id, string key_attribute_name, string[] attributes, string[][] data, bool merge, bool ignore_missing)

Details

Parameter

int pool_id: ID der Zielgruppe, in welcher Profil aktualisiert werden sollen
string key_attribute_name: Name des Pool-Attributes, anhand dessen überprüft werden soll, ob ein Profil bereits besteht. Wird ein leerer String übergeben, erfolgt grundsätzlich eine Neuanlage der Profile. Ist die Profile-ID als Eindeutigkeits-Kriterium gewählt, muss für neue Profile eine nicht vergebene Profil-ID (zum Beispiel "1") in den Daten angegeben werden.
string[] attributes: Liste von Pool-Attribut-Namen, welche für den Import bzw. das Update herangezogen werden sollen. Sofern key_attribute_name nicht leer ist, muss dieser ebenfalls hier angeführt sein
string[][] data: Liste von Listen von Profildaten. Jeder Eintrag der ersten Dimension der Liste repräsentiert ein anzulegendes bzw. zu aktualisierendes Profil. Die Werte der Liste der zweiten Dimension müssen exakt in der Reihenfolge übergeben werden, in der die Namen der Attribute unter attributes angegeben sind
bool merge: Legt fest, ob Werte von Mehrfachselektionsfeldern zusammengeführt oder durch die Daten aus dem Request überschrieben werden sollen
bool ignore_missing: Legt fest, ob Profile, die nicht bereits im Pool existieren, ignoriert oder neu angelegt werden sollen

Rückgabewert

MassUpdateResult: Objekt mit folgenden Attributen:
- EvalancheHashMap updated: Liste von EvalancheHashMapItems, bei denen das Attribut key die Profil-ID des aktualisierten Profils, das Attribut value den Wert des Feldes aus key_attribute_name enthält
- EvalancheHashMap created: Liste von EvalancheHashMapItems, bei denen das Attribut key die Profil-ID des neu angelegten Profils, das Attribut value den Wert des Feldes aus key_attribute_name enthält
- string[] ignored: Liste von Werten von key_attribute_name, bei denen die entsprechenden Profile nicht geupdated wurden. Dieser Fall kann bei einem Update eines Profils mit unveränderten Daten eintreten, bzw. wenn ignore_missing == true und kein Profil über key_attribute_name gefunden wurde
- int[] error: Liste von Datensatznummern aus data beginnend bei 0, bei denen ein Fehler aufgetreten ist

Benötigte Rechte

Profile importieren

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
   <soapenv:Header/>
   <soapenv:Body>
      <prof:massUpdate>
         <pool_id>POOL_ID</pool_id>
         <key_attribute_name>EXTERNALID</key_attribute_name>
         <attributes>
            <!--Zero or more repetitions:-->
            <item>EXTERNALID</item>
            <item>EMAIL</item>
            <item>FIRSTNAME</item>
            <item>NAME</item>
            <item>SALUTATION</item>
         </attributes>
         <data>
            <!--Zero or more repetitions:-->
            <item>
               <!--Zero or more repetitions:-->
               <item>47-11</item>
               <item>julien.bashir@example.com</item>
               <item>Julien</item>
               <item>Bashir</item>
               <item>1</item>
            </item>
            <item>
               <!--Zero or more repetitions:-->
               <item>47-12</item>
               <item>william.picard@example.com</item>
               <item>William</item>
               <item>Picard</item>
               <item>2</item>
            </item>
            <item>
               <!--Zero or more repetitions:-->
               <item>48-11</item>
               <item>benjamin.sisko@example.com</item>
               <item>Benjamin</item>
               <item>Sisko</item>
               <item>2</item>
            </item>
            <item>
               <!--Zero or more repetitions:-->
               <item>48-11</item>
               <item>benjamin.sisko@example.com</item>
               <item>Benjamin</item>
               <item>Sisko</item>
            </item>
         </data>
         <merge>true</merge>
         <ignore_missing>false</ignore_missing>
      </prof:massUpdate>
   </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
   <SOAP-ENV:Body>
      <ns1:massUpdateResponse>
         <massUpdateResult>
            <updated>
               <items>
                  <item>
                     <key>5718855</key>
                     <value>47-11</value>
                  </item>
               </items>
            </updated>
            <created>
               <items>
                  <item>
                     <key>5718856</key>
                     <value>47-13</value>
                  </item>
               </items>
            </created>
            <ignored>
               <item>47-12</item>
            </ignored>
            <error>
                <item>3</item>
            </error>
         </massUpdateResult>
      </ns1:massUpdateResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getMailingStatus

Fragt den Mailingstatus für ein Profil ab.

EvalancheProfileMailingStatus2[] Profile::getMailingStatus(int profile_id, int mailing_id)

Details

Parameter

int profile_id: ID des Profiles, für welches der Status abgefragt werden soll
int mailing_id: ID des Mailings, für das der Status abgefragt werden soll. Wird als ID 0 übergeben, werden alle Mailings überprüft, welche an das Profil geschickt wurden

Rückgabewert

EvalancheProfileMailingStatus2: Ein Objekt des Typs EvalancheJobResult mit folgenden Attributen:
- int profile_id: ID des angefragten Profils
- int newsletter_id: ID der angefragten Versendung
- int last_status_change: Unix Timestamp (UTF-8) der letzten Statusänderung des Profils in Bezug auf das Mailing
- int status: Aktueller Status des Profils in Bezug auf das Mailing
- string preview_url: Personalisierter Vorschau URL des Mailings
- EvalancheHashMap profile_data: Bei dieser Methode immer leer

Benötigte Rechte

Profilliste ansehen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:getMailingStatus>
 <profile_id>PROFILE_ID</profile_id>
 <mailing_id>MAILING_ID</mailing_id>
 </prof:getMailingStatus>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getMailingStatusResponse>
 <getMailingStatusResult>
 <item>
 <profile_id>PROFILE_ID</profile_id>
 <newsletter_id>MAILING_ID</newsletter_id>
 <last_status_change>TIMESTAMP_LAST_STATUS_CHANGE</last_status_change>
 <status>STATUS 1/0</status>
 <preview_url>PREVIEW_URL</preview_url>
 <profile_data>
 <items/>
 </profile_data>
 </item>
 </getMailingStatusResult>
 </ns1:getMailingStatusResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getTrackingHistory

Historie eines Profiles abfragen

EvalancheMailingTrackingHistory[] getTrackingHistory(int profile_id, int from = 0, int to = 0)

Details

Parameter

int profile_id: Id des Profiles
int from = 0: UTC Unix Timestamp, ab inklusive welcher Zeit Trackingdaten berücksichtigt werden sollen
int to = 0: UTC Unix Timestamp, bis inklusive welcher Zeit Trackingdaten berücksichtigt werden sollen

Rückgabewert

EvalancheMailingTrackingHistory[]: Liste von Objekten mit folgenden Attributen:
- int id: Eindeutige Id des Tracking Datensatzes
- int resource_id: Eindeutige Id des getrackten Objekts
- string resource_name: Name des getrackten Objekts
- int resource_type_id: Eindeutige Id des getrackten Objekt-Types
- int sub_resource_id: Eindeutige Id des beteiligten Objekts (z.b. Artikel innerhalb eines eMailings)
- string sub_resource_name: Name des beteiligten Objekts
- int sub_resource_type_id: Art des beteiligten Objekts
- string sub_url: Beteiligte direkte URL
- int profile_id: Eindeutige Id des getrackten Profils
- int type: Art des Trackings
- int timestamp: Unix Timestamp des Trackings
- string referrer_domain: Beteiligte Domain

Benötigte Rechte

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:getTrackingHistory>
 <profile_id>PROFILE_ID</profile_id>
 <from>TIMESTAMP_FROM</from>
 <to>TIMESTAMP_TO</to>
 </prof:getTrackingHistory>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getTrackingHistoryResponse>
 <getTrackingHistoryResult>
 <item>
 <id>TRACKING_ID</id>
 <resource_id>RESOURCE_ID</resource_id>
 <resource_name>RESOURCE_NAME</resource_name>
 <resource_type_id>RESOURCE_TYPE_ID</resource_type_id>
 <sub_resource_id>SUB_RESOURCE_ID</sub_resource_id>
 <sub_resource_name>SUB_RESOURCE_NAME</sub_resource_name>
 <sub_resource_type_id>SUB_RESOURCE_TYPE_ID</sub_resource_type_id>
 <sub_url>SUB_URL</sub_url>
 <profile_id>PROFILE_ID</profile_id>
 <type>TRACKING_TYPE_ID</type>
 <timestamp>TRACKING_TIMESTAMP</timestamp>
 <referrer_domain>REFERRER_DOMAIN</referrer_domain>
 </item>
 </getTrackingHistoryResult>
 </ns1:getTrackingHistoryResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getScores

Fragt den Scoring-Wert eines Profils ab.

ProfileGroupScore[] Profile::getScores(int profile_id)

Details

Parameter

int profile_id: ID des Profiles, für welches der Status abgefragt werden soll

Rückgabewert

ProfileGroupScore[]: Eine Liste von Objekten mit folgenden Attributen:
- int profile_id: ID des angefragten Profils
- int group_id: ID der Scoring-Gruppe
- string group_name: Name der Scoring-Gruppe
- int activity_score: Summe aller Activity Scores des Profils bezogen auf die o. a. Scoring-Gruppe
- int profile_score: Summe aller Profile Scores des Profils bezogen auf die o. a. Scoring-Gruppe

Benötigte Rechte

keine

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:getScores>
 <profile_id>PROFILE_ID</profile_id>
 </prof:getScores>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getScoresResponse>
 <getScoresResult>
 <item>
 <profile_id>PROFILE_ID</profile_id>
 <group_id>SCORING_GROUP_ID</group_id>
 <group_name>SCORING_GROUP_NAME</group_name>
 <activity_score>ACTIVITY_SCORE</activity_score>
 <profile_score>PROFILE_SCORE</profile_score>
 </item>
[...]
 </getScoresResult>
 </ns1:getScoresResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getActivityScoringHistory

Fragt detailierte Scoring-Werte eines Profils ab.

ProfileActivityScore[] Profile::getActivityScoringHistory(int profile_id, int scoring_group_id = 0, int scoring_type_id = 0, int resource_id = 0, int start_timestamp = 0, int end_timestamp = 0)

Details

Parameter

int profile_id: ID des Profils, für welches die Scoring-Historie abgefragt werden soll
int scoring_group_id: ID der Scoring-Gruppe, für welche die Scoring-Historie für das Profil abgefragt werden soll. Wird hier 0 übergeben wird keine Einschränkung vorgenommen
int scoring_type_id: ID des Scoring-Typs, für welchen die Scoring-Historie für das Profil abgefragt werden soll. Wird hier 0 übergeben wird keine Einschränkung vorgenommen
int resource_id: ID der Resource, für welche die Scoring-Historie für das Profil abgefragt werden soll. Wird hier 0 übergeben wird keine Einschränkung vorgenommen
int start_timestamp = 0: Unix Timestamp (UTC) des Zeitpunktes, ab einschließlich welchem die Scoring-Historie für das Profil zurückgegeben werden soll.
int end_timestamp = 0: Unix Timestamp (UTC) des Zeitpunktes, bis einschließlich welchem die Scoring-Historie für das Profil zurückgegeben werden soll. Wird hier 0 übergeben, wird die aktuelle Zeit herangezogen

Rückgabewert

ProfileGroupScore[]: Eine Liste von Objekten mit folgenden Attributen:
- int id: ID des Scoring-Eintrages
- int scoring_group_id: ID der Scoring-Gruppe
- int scoring_type_id: ID des Scoring-Typs
- int timestamp: Unix Timestamp (UTC) des Eintrages
- int value: Wert (Score) des Eintrages
- int resource_id: ID der Resource, für welchen der Eintrag erzeugt wurde

Werte von scoring_type_id

ID	Description
1	eMailing Öffnung
2	eMailing Klick
3	Formular Öffnung
4	Formular Eintragung
5	Formular Klick
6	eMailing Klick auf Social Sharing
7	eMailing Klick auf Vorschau
8	eMailing Klick auf PDF
9	Leadpage Öffnung
11	SmartLink Klick
12	eMailing Abmeldung
13	Artikel Öffnung
14	Artikel Klick
15	Artikel Klick auf Social Sharing
16	Artikel Klick auf Vorschau
17	Artikel Klick auf PDF
18	eMailing Klick auf Online-Version
19	eMailing Klick auf Web/Mobile Version
20	Webservice-Aufruf
21	WebTouchPoint Aufruf

Benötigte Rechte

Scoring auswerten

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:getActivityScoringHistory>
 <profile_id>PROFILE_ID</profile_id>
 <scoring_group_id>SCORING_GROUP_ID</scoring_group_id>
 <scoring_type_id>SCORING_TYPE_ID</scoring_type_id>
 <resource_id>RESOURCE_ID (FILTER)</resource_id>
 <start_timestamp>TIMESTAMP_START_TIME</start_timestamp>
 <end_timestamp>TIMESTAMP_END_TIME</end_timestamp>
 </prof:getActivityScoringHistory>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
 <SOAP-ENV:Body>
 <ns1:getActivityScoringHistoryResponse>
 <getActivityScoringHistoryResult>
 <item>
 <id>SCORING_ENTRY_ID</id>
 <scoring_group_id>SCORING_GROUP_ID</scoring_group_id>
 <scoring_type_id>SCORING_TYPE_ID</scoring_type_id>
 <timestamp>SCORING_ENTRY_TIMESTAMP</timestamp>
 <value>ACTIVITY_SCORING_POINTS</value>
 <resource_id>SCORING_ENTRY_RESOURCE</resource_id>
 </item>
 </getActivityScoringHistoryResult>
 </ns1:getActivityScoringHistoryResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

addScore

Vergibt Scoring-Werte.

bool Profile::addScore(int profile_id, int scoring_group_id, int score = 0, string name = '')

Details

Parameter

int profile_id: ID des Profils, für welches der Score-Wert geschrieben werden soll
int scoring_group_id: ID der Scoring-Gruppe, welcher der Score-Wert zugeordnet werden soll
int score: Positiver oder negativer Score-Wert. Wird 0 übergeben, wird der konfigurierte Default-Score verwendet
string name: Optionale Beschreibung des Score-Wertes. Wird hier ein leerer String übergeben, wird der konfigurierte Default-Name verwendet

Rückgabewert

bool: true im Erfolgsfall

Benötigte Rechte

keine

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
 <soapenv:Header/>
 <soapenv:Body>
 <prof:addScore>
 <profile_id>PROFILE_ID</profile_id>
 <scoring_group_id>SCORING_GROUP_ID</scoring_group_id>
 <score>SCORING_POINTS</score>
 <name>SCORING_DESCRIPTION</name>
 </prof:addScore>
 </soapenv:Body>
</soapenv:Envelope>

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

hasMilestone

Fragt ab, ob ein Milestone einem Profil zugeordnet wurde.

bool Profile::hasMilestone(int profile_id, int milestone_id, int from, int to)

Details

Parameter

int profile_id: ID des Profils, welches geprüft werden soll
int milestone_id: ID des Mileston, welcher geprüft werden soll
int from: Timestamp nach dem der Milestone dem Profile zugeordnet wurde.
int to: Timestamp bis zu dem der Milestone dem Profil zugeordnet wurde.

Rückgabewert

bool: true im Erfolgsfall

Benötigte Rechte

Milestone anzeigen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
<soapenv:Header/>
<soapenv:Body>
<prof:hasMilestone>
<profile_id>PROFILE_ID</profile_id>
<milestone_id>MILESTONE_ID</milestone_id>
<from>TIMESTAMP</from>
<to>TIMESTAMP</to>
</prof:hasMilestone>
</soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
<SOAP-ENV:Body>
<ns1:hasMilestoneResponse>
<hasMilestoneResult>TRUE</hasMilestoneResult>
</ns1:hasMilestoneResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

setMilestone

Weißt einen Milestone einem Profil zu.

bool Profile::setMilestone(int profile_id, int milestone_id)

Details

Parameter

int profile_id: ID des Profils, dem der Milestone zugewiesen werden soll
int milestone_id: ID des Milestone, der dem Profil zugewiesen werden soll

Rückgabewert

bool: true im Erfolgsfall

Benötigte Rechte

Milestone verwalten

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
<soapenv:Header/>
<soapenv:Body>
<prof:setMilestone>
<profile_id>338973228</profile_id>
<milestone_id>24493252</milestone_id>
</prof:setMilestone>
</soapenv:Body>
</soapenv:Envelope>

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

getByMilestone

Fragt alle Profile ab, welche einem Milestone zugewiesen sind.

bool Profile::getByMilestone(int milestone_id, string[] pool_attributes_list, int from, int to)

Details

Parameter

int milestone_id: ID des Milestone, dessen Profile ausgelesen werden sollen.
string[] pool_attribute_list: Liste der Attributnamen, die im Ergebnis zurückgeliefert werden sollen (Pflicht)
int from: Timestamp ab dem das Profil dem Milestone zugeordnet wurde.
int to: Timestamp bis wann das Profile dem Milestone spätestens zugeordnet wurde.

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öglcihen 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, hier immer profile
string method: Name der Methode, welchen den Hintergrundjob gestartet hat, hier immer getByPool
int resource_id: ID der Resource, für welche der Hintergrundjob gestartet wurde, hier immer die pool_id
int result_chunks: Anzahl der gefundenen Ergebnisblöcke. Dieser Wert ist nur im Status 2 ungleich 0

Benötigte Rechte

Milestone verwalten

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prof="https://scnem.com/soap.php/soap/profile">
<soapenv:Header/>
<soapenv:Body>
<prof:getByMilestone>
<milestone_id>MILESTONE_ID</milestone_id>
<pool_attribute_list>
<!--One or more repetitions:-->
<item>ATTRIBUTE</item>
</pool_attribute_list>
<from>TIMESTAMP</from>
<to>TEIMSTAMP</to>
</prof:getByMilestone>
</soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/profile">
<SOAP-ENV:Body>
<ns1:getByMilestoneResponse>
<getByMilestoneResult>
<id>JOB_ID</id>
<status>STATUS</status>
<status_description>DESCRIPTION</status_description>
<namespace>profile</namespace>
<method>getByMilestone</method>
<resource_id>RESOURCE_ID</resource_id>
<result_chunks>CHUNK_COUNT</result_chunks>
</getByMilestoneResult>
</ns1:getByMilestoneResponse>
</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('ID', '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)

create

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

delete

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

revokePermission

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

revokeTracking

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

grantPermission

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getById

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getByKey

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getBounces

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getModifiedProfiles

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getUnsubscriptions

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getGrantedPermissions

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getByTargetGroup

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

Siehe auch:

getByPool

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

Siehe auch:

isInTargetgroups

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

tagWithOption

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

untagWithOption

Parameter