Folgende SOAP-Methoden werden speziell für die Interaktion mit Artikeln bereitgestellt.
copy
Erstellt eine Kopie der durch die resource_id angegebenen Ressource
EvalancheResourceInformation copy (int resource_id, int category_id)Details: copy
create
Artikel erstellen
EvalancheResourceInformation create (int article_preset_id, string name, EvalancheHashMap data, int category_id)Details
Parameter
- int article_preset_id: ID des Artikeltypen, der verwendet werden soll
- string name: Name des Artikels
- EvalancheHashMap data: EvalancheHashMap mit den Daten des Artikels
- int category_id: ID des Ordners, in welchem der Artikel erstellt werden soll
Rückgabewert
- EvalancheResourceInformation: Objekt analog zur Methode getById (Informationen über ein Objekt mittels Objekt ID abfragen)
Benötigte Rechte
Artikel erzeugen
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:create>
<article_preset_id>ARTICLE_PRESET_ID</article_preset_id>
<name>NAME</name>
<data>
<items>
<!--Zero or more repetitions:-->
<item>
<!--You may enter the following 2 items in any order-->
<key>ARTICLE_FIELD_NAME</key>
<value>CONTENT</value>
</item>
</items>
</data>
<category_id>FOLDER_ID</category_id>
</art:create>
</soapenv:Body>
</soapenv:Envelope></soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/article">
<SOAP-ENV:Body>
<ns1:createResponse>
<createResult>
<url>ARTICLE_URL</url>
<type_id>TYPE_ID</type_id>
<category_id>FOLDER_ID</category_id>
<customer_id>MANDATOR_ID</customer_id>
<id>ARTICLE_ID</id>
<name>ARTICLE_NAME</name>
</createResult>
</ns1:createResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>
delete
Löscht die Ressource.
bool delete (int resource_id)Details: delete
getAll
Listet alle Ressourcen innerhalb eines Mandanten auf.
ArrayOfEvalancheResourceInformation getAll (int mandator_id)Details: getAll
getByArticleTypeId
Gibt alle Artikel eines Artikeltyps aus.
ArrayOfEvalancheResourceInformation[] getByArticleTypeId(int article_type_id)Details
Parameter
- int article_type_id: Id des Artikeltyps
Rückgabewert
-
ArrayOfEvalancheResourceInformation[]: Liste von Objekten mit folgenden Attributen:
- string url: URL des Artikels
- int type_id: Type-Id des Artikels
- int category_id: Ordner-Id des Artikels
- int customer_id:Mandanten-Id des Artikels
- int id: Id des Artikels
- string name: Name des Artikels
Benötigte Rechte
Artikel 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>
<article:getByArticleTypeId>
<article_type_id>ARTICLE_TYPE_ID</article_type_id>
</article:getByArticleTypeId>
</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:getByArticleTypeIdResponse>
<getByArticleTypeIdResult>
<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>
</getByArticleTypeIdResult>
</ns1:getByArticleTypeIdResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>
getByCategory
Gibt alle Objekte eines Ordners aus.
ArrayOfEvalancheResourceInformation getByCategory (int category_id)Details: getByCategory
getByExternalId
Gibt alle Objekte mit gegebener EXTERNAL_ID aus.
ArrayOfEvalancheResourceInformation[] getByExternalId (string external_id)Details: getByExternalId
getById
Sucht ein Objekt anhand einer ID.
EvalancheHashMap getById(int resource_id)Details: getById
getByModificationDate
Eine Resource über das Änderungsdatum abfragen
EvalancheResourceInformation getByModificationDate (int start_date, int end_date, int mandator_id)Details
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: getByTypeId
getData
Artikeldaten auslesen
EvalancheHashMap Artikel::getData(int article_id)Details
Parameter
- int article_id: ID des Artikels
Rückgabewert
- EvalancheHashMap: EvalancheHashMap mit den Daten des Artikels
Benötigte Rechte
Artikel anzeigen
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:getData>
<article_id>ARTICLE_ID</article_id>
</art:getData>
</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:getDataResponse>
<getDataResult>
<items>
<item>
<key>ARTICLE_FIELD_NAME</key>
<value>CONTENT</value>
</item>
<item>
<key>ARTICLE_FIELD_NAME</key>
<value>CONTENT</value>
</item>
[...]
</items>
</getDataResult>
</ns1:getDataResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getDetails
Details eines Objektes abfragen
EvalancheArticleInformation getDetails(int object_id)Details
Parameter
- int object_id: Id des Objektes
Rückgabewert
- EvalancheArticleInformation: Objekt (SOAP) bzw. Array mit folgenden Attributen:
- int article_type_id: Id des Artikeltyps
- string url: URL des Artikels
- int type_id: Type Id
- int category_id: Id des Ordners
- int customer_id: Mandanten Id
- int last_modified: Zeitstempel der letzten Änderung
- int id: Id des Artikels
- string name: Name des Artikels
Benötigte Rechte
Artikel anzeigen
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mail="https://scnem.com/soap.php/soap/mailing">
<soapenv:Header/>
<soapenv:Body>
<article:getDetails>
<article_id>ARTICLE_ID</article_id>
</article:getDetails>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="https://scnem.com/soap.php/soap/mailing">
<SOAP-ENV:Body>
<ns1:getDetailsResponse>
<getDetailsResult>
<article_type_id>ARTICLE_TYPE_ID</article_type_id>
<url>URL</url>
<type_id>TYPE_ID</type_id>
<category_id>CATEGORY_ID</category_id>
<customer_id>CUSTOMER_ID</customer_id>
<report_url>REPORT_URL</report_url>
<last_modified>LAST MODIFIED</last_modified>
<id>ID</id>
<name>NAME</name>
</getDetailsResult>
</ns1:getDetailsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getIndividualization
Artikelindividualisierung abfragen
EvalancheResourceInformation getIndividualization (int article_id)Details
Parameter
- int article_id: ID des Artikels
Rückgabewert
- bool has_fallback: Wenn true, wird der abgefrage Artikel selber angezeigt, falls keine Individualisierungszielgruppe zutrifft.
- EvalancheHashMap data: HashMap mit article_id und targetgroup_ids der individualisierten Artikel
Benötigte Rechte
Artikel anzeigen
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:getIndividualization>
<article_id>ARTICLE_ID</article_id>
</art:getIndividualization>
</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:getIndividualizationResponse>
<getIndividualizationResult>
<has_fallback>BOOL</has_fallback>
<individualization_items>
<item>
<article_id>ARTICLE_ID</article_id>
<targetgroup_id>TARGETGROUP_ID</targetgroup_id>
</item>
[...]
</individualization_items>
</getIndividualizationResult>
</ns1:getIndividualizationResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
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
rename
Gibt dem Objekt einen anderen Namen
EvalancheResourceInformation rename (int resource_id, string name)Details: rename
setIndividualization
Artikelindividualisierung aktualisieren
EvalancheResourceInformation setIndividualization (int article_id, EvalancheHashMap configuration)Details
Parameter
- int article_id: ID des Artikels
- EvalancheHashMap configuration: EvalancheHashMap mit den Daten der Artikelindividualisierung
Rückgabewert
- bool: True, wenn Konfiguration erfolgreich aktualisiert wurde.
Benötigte Rechte
Artikel verändern
Verwendung
ARTICLE_IDARTICLE_ID<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:setIndividualizationResponse>
<setIndividualizationResult>BOOL</setIndividualizationResult>
</ns1:setIndividualizationResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
update
Artikel aktualisieren
EvalancheResourceInformation update (int article_id, EvalancheHashMap data)Details
Parameter
- int article_id: ID des Artikels
- EvalancheHashMap data: EvalancheHashMap mit den Daten des Artikels
Rückgabewert
- EvalancheResourceInformation: Objekt analog zur Methode getById (Informationen über ein Objekt mittels Objekt ID abfragen)
Benötigte Rechte
Artikel verändern
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:update>
<article_id>ARTICLE_ID</article_id>
<data>
<items>
<!--Zero or more repetitions:-->
<item>
<!--You may enter the following 2 items in any order-->
<key>ARTICLE_FIELD_NAME</key>
<value>CONTENT</value>
</item>
</items>
</data>
</art:update>
</soapenv:Body>
</soapenv:Envelope></soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/article">
<SOAP-ENV:Body>
<ns1:updateResponse>
<updateResult>
<url>ARTICLE_URL</url>
<type_id>ARTICLE_TYPE</type_id>
<category_id>FOLDER_ID</category_id>
<customer_id>MANDATOR_ID</customer_id>
<id>ARTICLE_ID</id>
<name>ARTICLE_NAME</name>
</updateResult>
</ns1:updateResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope></SOAP-ENV:Envelope>