Folgende SOAP-Methoden werden speziell für die Auswertung und Anlage von Kampagnen bereitgestellt.
getDetails
Details einer Kampagne auslesen
EvalancheResourceInformation getDetails (int[] profile_id_list, int resource_id)
Details
Parameter
- int resource_id: ID der Kampagne, deren Details abgefragt werden sollen
Rückgabewert
- EvalancheCampaignInformation: Objekt (SOAP) bzw. Array mit folgenden Attributen:
- int id: ID des abgefragten Kampagnen Objekts
- string name: Name des Kampagnen Objekts
- int date_start: Timestamp des im Kampagnen Objekt festgelegten Start-Datums
- int date_end: Timestamp des im Kampagnen Objekt festgelegten Ende-Datums
- string external_id: Externe ID, welche im Kampagnen Objekt festgelegt wurde
- int category_id: ID des Ordners, in dem sich das Kampagnen Objekt befindet
- string description: Beschreibungstext, welcher im Kampagnen Objekt festgelegt wurde
- int state: Status der Kampagne; 1=Aktiviert; 2=Pausiert;
- int profile_count: Anzahl der aktuell aktiven Profile in der Kampagne
Benötigte Rechte
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="https://scnem.com/soap.php/soap/campaign">
<soapenv:Header/>
<soapenv:Body>
<cam:getDetails>
<resource_id>CAMPAIGN_ID</resource_id>
</cam:getDetails>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/campaign">
<SOAP-ENV:Body>
<ns1:getDetailsResponse>
<getDetailsResult>
<id>CAMPAIGN_ID</id>
<name>CAMPAIGN_NAME</name>
<date_start>OPTIONAL_OBJEKT_STARTDATE</date_start>
<date_end>OPTIONAL_OBJEKT_ENDDATE</date_end>
<external_id>OPTIONAL_OBJEKT_EXT_ID</external_id>
<category_id>FOLDER_ID</category_id>
<description>OPTIONAL_OBJEKT_DESCRIPTION</description>
<state>ACTIVE_STATE 0/1</state>
<profile_count>PROFILE_COUNT</profile_count>
</getDetailsResult>
</ns1:getDetailsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
pushProfilesIntoCampaign
Profile in eine Kampagne bewegen
EvalancheResourceInformation pushProfilesIntoCampaign (int[] profile_id_list, int resource_id)
Details
Parameter
- int[] profile_id_list: Liste von Profil-IDs, welche in die Kampagne bewegt werden sollen
- int resource_id: ID der Kampagne in welche die Profile bewegt werden sollen
Rückgabewert
- EvalancheResourceInformation: True/False ob die Profile erfolgreich in die Kampagne bewegt wurden
Benötigte Rechte
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="https://scnem.com/soap.php/soap/campaign">
<soapenv:Header/>
<soapenv:Body>
<cam:pushProfilesIntoCampaign>
<profile_id_list>
<!--Zero or more repetitions:-->
<item>PROFILE_ID</item>
</profile_id_list>
<resource_id>CAMPAIGN_ID</resource_id>
</cam:pushProfilesIntoCampaign>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/campaign">
<SOAP-ENV:Body>
<ns1:pushProfilesIntoCampaignResponse>
<pushProfilesIntoCampaignResult>true/false</pushProfilesIntoCampaignResult>
</ns1:pushProfilesIntoCampaignResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
createConfigured
Kampagne konfiguriert anlegen
Diese Methode wird zur Zeit ausschließlich intern genutzt. Eine Dokumentation des JSON-Schemas erfolgt, wenn eine Finale Version des Schemas veröffentlicht wurde.
EvalancheResourceInformation createConfigured (string name, int schema_version, string configration, int category_id)
Details
Parameter
- string name: Name der neuen Kampagne
- int schema_version: Version des JSON-Schemas (aktuell: 7)
- string configuration: Kampagnen-Konfiguration im JSON-Schema
- int category_id: ID des Ordners
Rückgabewert
- EvalancheResourceInformation: Objekt analog zur Methode getById (Informationen über ein Objekt mittels Objekt Id abfragen)
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>
tbd
</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>
tbd
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getByStartDateRange
Kampagne nach Startdatum suchen
EvalancheResourceInformation getByStartDateRange (int from, int to)
Details
Parameter
- int from: Timestamp des Beginns des Zeitintervalls
- int to: Timestamp des Endes des Zeitintervalls
Rückgabewert
- EvalancheResourceInformation: Objekt analog zur Methode getById (Informationen über ein Objekt mittels Objekt Id abfragen)
Benötigte Rechte
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="https://scnem.com/soap.php/soap/campaign">
<soapenv:Header/>
<soapenv:Body>
<cam:getByStartDateRange>
<from>TIMESTAMP_FROM</from>
<to>TIMESTAMP_TO</to>
</cam:getByStartDateRange>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/campaign">
<SOAP-ENV:Body>
<ns1:getByStartDateRangeResponse>
<getByStartDateRangeResult>
<item>
<url>CAMPAIGN_URL</url>
<type_id>CAMPAIGN_TYPE_ID</type_id>
<category_id>FOLDER_ID</category_id>
<customer_id>MANDATOR_ID</customer_id>
<id>CAMPAIGN_ID</id>
<name>CAMPAIGN_NAME</name>
</item>
[...]
</getByStartDateRangeResult>
</ns1:getByStartDateRangeResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getByEndDateRange
Kampagne nach Enddatum suchen
EvalancheResourceInformation getByEndDateRange (int from, int to)
Details
Parameter
- int from: Timestamp des Beginns des Zeitintervalls
- int to: Timestamp des Endes des Zeitintervalls
Rückgabewert
- EvalancheResourceInformation: Objekt analog zur Methode getById (Informationen über ein Objekt mittels Objekt Id abfragen)
Benötigte Rechte
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="https://scnem.com/soap.php/soap/campaign">
<soapenv:Header/>
<soapenv:Body>
<cam:getByEndDateRange>
<from>TIMESTAMP_FROM</from>
<to>TIMESTAMP_TO</to>
</cam:getByEndDateRange>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/campaign">
<SOAP-ENV:Body>
<ns1:getByEndDateRangeResponse>
<getByEndDateRangeResult>
<item>
<url>CAMPAIGN_URL</url>
<type_id>CAMPAIGN_TYPE_ID</type_id>
<category_id>FOLDER_ID</category_id>
<customer_id>MANDATOR_ID</customer_id>
<id>CAMPAIGN_ID</id>
<name>CAMPAIGN_NAME</name>
</item>
[...]
</getByEndDateRangeResult>
</ns1:getByEndDateRangeResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>