SOAP API Allgemeine Methoden – Evalanche Helpcenter

copy

Erstellt eine Kopie der durch die resource_id angegebenen Ressource

EvalancheResourceInformation copy (int resource_id, int category_id)

Details

Parameter

int resource_id: ID der zu kopierenden Ressource
int category_id: ID des Ordners

Rückgabewert

object: EvalancheResourceInformation:
- string: url
- int: type_id
- int: category_id
- int: last_modified
- int: resource_id
- string: name

Benötigte Rechte

<Objekt> erzeugen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:copy>
 <resource_id>RESOURCE_ID</resource_id>
 <category_id>CATEGORY_ID</category_id>
 </lead:copy>
 </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:copyResponse>
 <copyResultv
 <url>URL</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTUMER_ID</customer_id>
 <last_modified>LAST_MODIFIED</last_modified>
 <id>RESOURCE_ID</id>
 <name>NAME</name>
 </copyResult>
 </ns1:copyResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

delete

Löscht die Ressource.

bool delete (int resource_id)

Details

Parameter

int resource_id: ID der zu löschenden Ressource

Rückgabewert

bool: true bei erfolgreicher Löschung

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>
 <lead:delete>
 <resource_id>OBJEKT_ID</resource_id>
 </lead: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/leadpage">
 <SOAP-ENV:Body>
 <ns1:deleteResponse>
 <deleteResult>true</deleteResult>
 </ns1:deleteResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getAll

Listet alle Ressourcen innerhalb eines Mandanten auf.

ArrayOfEvalancheResourceInformation getAll (int mandator_id)

Details

Parameter

int mandator_id: ID des Mandanten

Rückgabewert

ArrayOfEvalancheResourceInformation Objekt-Array analog zur Methode getById (Informationen über ein Objekt mittels Objekt ID abfragen)

Benötigte Rechte

keine Objektrechte benötigt

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:getAll>
 <mandator_id>MANDATOR_ID</mandator_id>
 </lead:getAll>
 </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:getAllResponse>
 <getAllResult>
 <item>
 <url>URL</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTUMER_ID</customer_id>
 <last_modified>LAST_MODIFIED</last_modified>
 <id>RESOURCE_ID</id>
 <name>NAME</name>
 </item>
 <item>
 ... </item>
 </getAllResult>
 </ns1:getAllResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getByCategory

Gibt alle Objekte eines Ordners aus.

ArrayOfEvalancheResourceInformation[] getByCategory(int category_id)

Details

Parameter

int category_id: Id des Ordners

Rückgabewert

ArrayOfEvalancheResourceInformation[]: Liste von Objekten mit folgenden Attributen:
- string url: URL der Mailings-Vorlage
- int type_id: Type-ID der Objekte
- int category_id: Ordner-ID der Objekte
- int customer_id:Mandanten-ID der Objekte
- int id: ID der Objekte
- string name: Name des Objektes

Benötigte Rechte

Objekt anzeigen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getByCategory>
 <category_id>CATEGORY_ID</category_id>
 </mail:getByCategory>
 </soapenv:Body>
</soapenv:Envelope></soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://core-staging.dev.broem/soap.php/soap/mailingtemplate">
 <SOAP-ENV:Body>
 <ns1:getByCategoryResponse>
 <getByCategoryResult>
 <item>
 <url>OBJEKT_URL</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTOMER_ID</customer_id>
 <id>OBJEKT_ID</id>
 <name>OBJEKT_NAME</name>
 </item>
 </getByCategoryResult>
 </ns1:getByCategoryResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>

getByExternalId

Gibt alle Objekte mit gegebener EXTERNAL_ID aus.

ArrayOfEvalancheResourceInformation[] getByExternalId (string external_id)

Details

Parameter

string external_id: EXTERNAL_ID der Objekte

Rückgabewert

EvalancheMailingTemplates[]: Liste von Objekten mit folgenden Attributen:
- string url: URL der Objekte
- int type_id: Type-ID der Objekte
- int category_id: Ordner-ID der Objekte
- int customer_id: ID der Objekte
- int id: ID der Objekte
- string name: Name der Objekte

Benötigte Rechte

Objekt anzeigen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://core-staging.dev.broem/soap.php/soap/mailingtemplate">
 <soapenv:Header/>
 <soapenv:Body>
 <mail:getByExternalId>
 <external_id>EXTERNAL_ID</external_id>
 </mail:getByExternalId>
 </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/mailingtemplate">
 <SOAP-ENV:Body>
 <ns1:getByExternalIdResponse>
 <getByExternalIdResult>
 <item>
 <url>URL</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTOMER_ID</customer_id>
 <id>MAILING_TEMPLATE_ID</id>
 <name>OBJECT_NAME</name>
 </item>
 </getByExternalIdResult>
 </ns1:getByExternalIdResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>

getById

Sucht ein Objekt anhand einer ID.

EvalancheHashMap getById(int resource_id)

Details

Parameter

int resource_id: ID des zu suchenden Objektes

Rückgabewert

EvalancheHashMap data: EvalancheHashMap mit den Daten des Objektes

Benötigte Rechte

Objekt 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:getById>
 <resource_id>RESOURCE_ID</resource_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>

getByModificationDate

Eine Resource über das Änderungsdatum abfragen

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

Details

Parameter

int start_date: Startdatum
int end_date: Enddatum
int mandator_id: ID des Mandanten

Rückgabewert

item Liste von Objekten mit folgenden Attributen:.
- String url: Integrations-URL der Ressource
- int type_id: Type-ID der Ressource
- int category_id: Ordner-ID der Ressource
- int customer_id: Customer-ID der Ressource
- unix-timestamp last_modified: letztes Änderungsdatum der Resource
- int id: Objekt-ID der Ressource
- String name: Name der Ressource

Benötigte Rechte

keine

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:art="https://scnem.com/soap.php/soap/article">
 <soapenv:Header />
 <soapenv:Body>
 <art:getByModificationDate>
 <start_date>STARTDATE</start_date>
 <end_date>ENDDATE</end_date>
 <mandator_id>MANDATOR_ID</mandator_id>
 </art:getByModificationDate>
 </soapenv:Body>
</soapenv:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/article">
<SOAP-ENV:Body>
 <ns1:getByModificationDateResponse>
 <getByModificationDateResult>
 <item>
 <url>URL</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTOMER_ID</customer_id>
 <last_modified>CHANGE_DATE</last_modified>
 <id>ID</id>
 <name>NAME</name>
 </item>
 <item>
 ...
 </item>
 </getByModificationDateResult>
 </ns1:getByModificationDateResponse>
 </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

Parameter

int type_id: Type ID
int mandator_id: ID des Mandanten

Rückgabewert

ArrayOfEvalancheResourceInformation Objekt-Array analog zur Methode getById (Informationen über ein Objekt mittels Objekt ID abfragen)

Benötigte Rechte

keine Objektrechte benötigt

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:getByCategory>
 <category_id>CATEGORY_ID</category_id>
 </lead:getByCategory>
</soapenv:Body>

<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:getAllResponse>
 <getAllResult>
 <item>
 <url>https://scnem.com/a.php?sid=h5ent.2kd5bgg,f=7</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTUMER_ID</customer_id>
 <last_modified>LAST_MODIFIED</last_modified>
 <id>RESOURCE_ID</id>
 <name>NAME</name>
 </item>
 <item>
 ... </item>
 </getAllResult>
 </ns1:getAllResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getJobState

Ruft den Status eines generischen Hintergrundjobs ab.

EvalancheResourceInformation getJobState (str job_id)

Details

Parameter

str job_id: die Id kann z.B. über getConfiguration gezogen werden

Rückgabewert

str id: die Id des Hintergrundjobs
int status: liefert den Status der des Hintergrundjobs zurück
str status_description: die Statusmeldung

Benötigte Rechte

Objekt 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:getJobState>
  <job_id>JOB_ID</job_id>
 </cam:getJobState>
</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:getJobStateResponse>
 <getJobStateResult>
  <id>ID</id>
  <status>0</status>
  <status_description>STATUS_DESCRIPTION</status_description>
 </getJobStateResult>
</ns1:getJobState>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getResourceDefaultCategory

Liefert Informationen über den Standardordner von Objekten

getResourceDefaultCategoryResponse getResourceDefaultCategory (int customer_id)

Details

Parameter

int customer_id: Customer ID

Rückgabewert

EvalancheCategoryInformation
- int: ID, ID des Standardordners
- string: NAME, Name des Standardordners
- int: PARENT_ID, ID des übergeordneten Ordners

Benötigte Rechte

keine Objektrechte benötigt

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:getResourceDefaultCategory>
 <customer_id>CUSTUMER_ID</customer_id>
 </lead:getResourceDefaultCategory>
 </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:getResourceDefaultCategoryResponse>
 <getResourceDefaultCategoryResult>
 <id>ID</id>
 <name>NAME</name>
 <parent_id>PARENT_ID</parent_id>
 </getResourceDefaultCategoryResult>
 </ns1:getResourceDefaultCategoryResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

getTypeIds

Zu einer Objektklasse gehörende Typ Ids auslesen

ArrayOfEvalancheResourceInformation getTypeIds ()

Details

Parameter

Rückgabewert

ArrayOfEvalancheResourceTypeInformation
- EvalancheResourceTypeInformation: ITEM
  - int: ID
  - string: DESCRIPTION

Benötigte Rechte

keine Objektrechte benötigt

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:getTypeIds />
 </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:getTypeIdsResponse>
 <getTypeIdsResult>
 <item>
 <id>ID</id>
 <description>DESCRIPTION</description>
 </item>
 </getTypeIdsResult>
 </ns1:getTypeIdsResponse>
 </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

Parameter

Rückgabewert

isAliveResponse
- IsAliveResult: IsAliveResult
  - string: STATUS
  - string: RANDOM_MESSAGE

Benötigte Rechte

keine Objektrechte benötigt

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:isAlive />
 </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:isAliveResponse>
 <isAliveResult>
 <status>STATUS</status>
 <random_message>RANDOM_MESSAGE</random_message>
 </isAliveResult>
 </ns1:isAliveResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

move

Verschiebt das Objekt in einen anderen Ordner

EvalancheResourceInformation move (int resource_id, int category_id)

Details

Parameter

int resource_id: ID des zu verschiebenden Obejktes
int category_id: ID des Zielordners

Rückgabewert

EvalancheResourceInformation:
- string: URL
- int: TYPE_ID
- int: CATEGORY_ID
- int: CUSTUMER_ID
- int: LAST_MODIFIED
- int: RESOURCE_ID
- string: NAME

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>
 <lead:move>
 <resource_id>RESOURCE_ID</resource_id>
 <category_id>CATEGORY_ID</category_id>
 </lead:move>
 </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:moveResponse>
 <moveResult>
 <url>URL</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTUMER_ID</customer_id>
 <last_modified>LAST_MODIFIED</last_modified>
 <resource_id>RESOURCE_ID</resource_id>
 <name>NAME</name>
 </moveResult>
 </ns1:moveResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

rename

Gibt dem Objekt einen anderen Namen

EvalancheResourceInformation rename (int resource_id, string name)

Details

Parameter

int resource_id: ID ders Objektes, das umbenannt werden soll
string name: neuer Name des Objektes

Rückgabewert

EvalancheResourceInformation:
- string: URL
- int: TYPE_ID
- int: CATEGORY_ID
- int: CUSTUMER_ID
- int: LAST_MODIFIED
- int: RESOURCE_ID
- string: NAME

Benötigte Rechte

LeadPage verändern

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/leadpage">
 <soapenv:Header />
 <soapenv:Body>
 <lead:rename>
 <resource_id>RESOURCE_ID</resource_id>
 <name>NAME</name>
 </lead:rename>
 </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:renameResponse>
 <renameResult>
 <url>URL</url>
 <type_id>TYPE_ID</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTUMER_ID</customer_id>
 <last_modified>1760363237</last_modified>
 <resource_id>RESOURCE_ID</resource_id>
 <name>NAME</name>
 </renameResult>
 </ns1:renameResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Standard API (SOAP)

copy

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

delete

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getAll

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getByCategory

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getByExternalId

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getById

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getByModificationDate

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getByTypeId

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getJobState

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getResourceDefaultCategory

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getTypeIds

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

isAlive

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

move

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

rename

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

Verwandte Beiträge