Folgende SOAP-Methoden werden speziell für die Auswertung und Anlage von Kampagnen bereitgestellt.
activate
Kampagne aktivieren
EvalancheResourceInformation activate (int workflow_id)Details
Parameter
- int workflow_id: Id der zu aktivierenden Kampagne
Rückgabewert
- bool: true wenn die Aktivierung erfolgreich stattgefunden hat.
Benötigte Rechte
Kampagne verändern
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="https://core-staging.dev.broem/soap.php/soap/campaign">
<soapenv:Header/>
<soapenv:Body>
<cam:activate>
<workflow_id>WORKFLOW_ID</workflow_id>
</cam:activate>
</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/campaign">
<SOAP-ENV:Body>
<ns1:activateResponse>
<activateResult>
<state_change_successful>true</state_change_successful>
<errors/>
</activateResult>
</ns1:activateResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
copy
Erstellt eine Kopie der durch die resource_id angegebenen Ressource
EvalancheResourceInformation copy (int resource_id, int category_id)Details: copy
create
legt ein neues Objekt an
EvalancheResourceInformation create (string name, int category_id)Details
Parameter
- string name: Name des neuen Objektes
- 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
Objekt erzeugen
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:create>
<name>NAME</name>
<category_id>ORDNER_ID</category_id>
</cam: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/campaign">
<SOAP-ENV:Body>
<ns1:createResponse>
<createResult>
<url>OBJEKT_URL</url>
<type_id>TYPE_ID</type_id>
<category_id>ORDNER_ID</category_id>
<customer_id>MANDANTEN_ID</customer_id>
<id>OBJEKT_ID</id>
<name>NAME</name>
</createResult>
</ns1:createResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>
createConfigured - DEPRECATED
Kampagne konfiguriert anlegen (Diese Methode ist veraltet. Stattdessen sollte unbedingt die Methode "create" genutzt werden um eine Kampagne anzulegen.)
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>
deactivate
Kampagne deaktivieren
EvalancheResourceInformation deactivate (int workflow_id)Details
Parameter
- int workflow_id: Id der zu deaktivierenden Kampagne
Rückgabewert
- bool: true wenn die Deaktivierung erfolgreich stattgefunden hat.
Benötigte Rechte
Kampagne verändern
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="https://core-staging.dev.broem/soap.php/soap/campaign">
<soapenv:Header/>
<soapenv:Body>
<cam:deactivate>
<workflow_id>WORKFLOW_ID</workflow_id>
</cam:deactivate>
</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/campaign">
<SOAP-ENV:Body>
<ns1:deactivateResponse>
<deactivateResult>
<state_change_successful>true</state_change_successful>
<errors/>
</deactivateResult>
</ns1:deactivateResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
delete
Löscht die Ressource.
bool delete (int resource_id)Details: delete
export
Gibt die Konfiguration einer Kampagne als JSON-String zurück.
bool export (int workflow_id)Details
Parameter
- int workflow_id: ID der Kampagne, die exportiert werden soll
Rückgabewert
- bool: true bei erfolgreichem Export
Benötigte Rechte
Objekt verwalten
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
<soapenv:Header />
<soapenv:Body>
<cam:export>
<workflow_id>OBJEKT_ID</workflow_id>
</cam:export>
</soapenv:Body>
</soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/leadpage">
<SOAP-ENV:Body>
<ns1:exportResponse>
<exportResult>true</exportResult>
</ns1:exportResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
generateConfiguration
Generiert eine Konfiguration einer Kampagne
EvalancheResourceInformation generateConfiguration (int workflow_id, str prompt)Details
Parameter
- int workflow_id: die Kampagnen Id
- str prompt: der Prompt kann z.B. über getConfiguration gezogen werden
Rückgabewert
- str id: die Id der Konfiguration
-
int status: liefert den Status der Kampagne zurück, 0 für deaktiviert.
Hinweis: Bei aktivierten Kampagnen kann keine Konfiguration generiert werden! - str status_description: die Statusmeldung
Benötigte Rechte
Kampagne anzeigen
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="https://core-staging.dev.broem/soap.php/soap/campaign">
<soapenv:Header/>
<soapenv:Body>
<cam:generateConfiguration>
<workflow_id>WORKFLOW_ID</workflow_id>
<prompt>PROMPT</prompt>
</cam:generateConfiguration>
</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/campaign">
<SOAP-ENV:Body>
<ns1:generateConfigurationResponse>
<generateConfigurationResult>
<id>ID</id>
<status>0</status>
<status_description>STATUS_DESCRIPTION</status_description>
</generateConfigurationResult>
</ns1:generateConfigurationResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
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
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
Kampagne anzeigen
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>
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
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
Kampagne anzeigen
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>
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
getConfiguration
Konfiguration einer Kampagne abfragen
EvalancheResourceInformation getConfiguration (int workflow_id, str config_version)Details
Parameter
- int workflow_id: Id der Kampagne
- str config_version: Id der Konfigurations-Version. Die ID der Konfigurations-Version kann via getConfigurationVersions abgefragt werden.
Rückgabewert
- str config_version: Id der Konfigurations-Version. Die ID der Konfigurations-Version kann via getConfigurationVersions abgefragt werden.
- str configuration: JSON-String der Kampagnen-Konfiguration.
Benötigte Rechte
Kampagne Anzeigen
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="https://core-staging.dev.broem/soap.php/soap/campaign">
<soapenv:Header/>
<soapenv:Body>
<cam:getConfiguration>
<workflow_id>WORKFLOW_ID</workflow_id>
<config_version>CONFIG_VERSION</config_version>
</cam:getConfiguration>
</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/campaign">
<SOAP-ENV:Body>
<ns1:getConfigurationResponse>
<getConfigurationResult>
<config_version>CONFIG_VERSION</config_version>
<configuration>CONFIGURATION</configuration>
</getConfigurationResult>
</ns1:getConfigurationResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getConfigurationVersions
Konfigurations-Versionen einer Kampagne abfragen
EvalancheResourceInformation getConfigurationVersions (int workflow_id)Details
Parameter
- int workflow_id: Id der Kampagne
Rückgabewert
- Liste von Konfigurationen mit folgenden Eigenschaften:
- str config_version: Id der Konfigurations-Version. Die ID der Konfigurations-Version kann via getConfigurationVersions abgefragt werden.
- int create_date: Timestamp der Erstellung dieser Konfigurations-Version.
- bool latest: true, wenn es sich um die letzte Konfigurations-Version handelt.
Benötigte Rechte
Kampagne Anzeigen
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="https://core-staging.dev.broem/soap.php/soap/campaign">
<soapenv:Header/>
<soapenv:Body>
<cam:getConfigurationVersions>
<workflow_id>WORKFLOW_ID</workflow_id>
</cam:getConfigurationVersions>
</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/campaign">
<SOAP-ENV:Body>
<ns1:getConfigurationVersionsResponse>
<getConfigurationVersionsResult>
<item>
<config_version>CONFIG_VERSION</config_version>
<create_date>CREATE_DATE</create_date>
<latest>LATEST</latest>
</item>
[...]
</getConfigurationVersionsResult>
</ns1:getConfigurationVersionsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
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
Kampagne anzeigen
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>
getJobState
Ruft den Status eines generischen Hintergrundjobs ab.
EvalancheResourceInformation getJobState (str job_id)Details: getJobState
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
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
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
Kampagne anzeigen
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>
rename
Gibt dem Objekt einen anderen Namen
EvalancheResourceInformation rename (int resource_id, string name)Details: rename
setConfiguration
Kampagnen Konfiguration aktualisieren
EvalancheResourceInformation setConfiguration (int workflow_id, str config_version, str configuration)Details
Parameter
- int workflow_id: Id der Kampagne
- str config_version: Id der letzten bekannten Konfigurations-Version. Die ID der Konfigurations-Version kann via getConfigurationVersions abgefragt werden. Die letzte Konfigurations-Version ist mit dem Parameter "latest" = true versehen.
- str configuration: Kampagnen-Konfigurations in json-Format.
Rückgabewert
- str config_version: Id der Konfigurations-Version. Die ID der Konfigurations-Version kann via getConfigurationVersions abgefragt werden.
- str configuration: JSON-String der Kampagnen-Konfiguration.
Benötigte Rechte
Kampagne Anzeigen
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="https://core-staging.dev.broem/soap.php/soap/campaign">
<soapenv:Header/>
<soapenv:Body>
<cam:setConfiguration>
<workflow_id>WORKFLOW_ID</workflow_id>
<config_version>CONFIG_VERSION</config_version>
</cam:setConfiguration>
</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/campaign">
<SOAP-ENV:Body>
<ns1:setConfigurationResponse>
<setConfigurationResult>
<config_version>CONFIG_VERSION</config_version>
<configuration>CONFIGURATION</configuration>
</setConfigurationResult>
</ns1:setConfigurationResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>