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>
Zu einer Objektklasse gehörende Typ Ids auslesen
Methode:
EvalancheResourceTypeInformation[] getTypeIds() Rückgabewert:
EvalancheResourceTypeInformation[]: Liste von EvalancheResourceTypeInformation Objekten
Diese Methode wird bei Namespaces benötigt, die mehr als einen Resourcentyp verwalten, wie z. B. in mailing.
Benötigte Rechte:
keine
Ein Objekt umbenennen
Methode:
EvalancheResourceTypeInformation[] rename(int resource_id, str name) Rückgabewert:
EvalancheResourceInformation
Diese Methode benennt eine Resource um.
Benötigte Rechte:
Resource verwalten
Den Standardordner einer Objektklasse auslesen
Methode:
EvalancheCategoryInformation getResourceDefaultCategory(int mandator_id)Rückgabewert:
EvalancheCategoryInformation: Objekt mit folgenden Attributen:
- int id: Id des Standardordners
- string name: Name des Standardordners
Benötigte Rechte:
keine
Informationen über ein Objekt mittels Objekt Id abfragen
Methode:
EvalancheResourceInformation getById(int resource_id)Parameter:
int resource_id: Id der Resource
Rückgabewert:
EvalancheResourceInformation: Objekt mit folgenden Attributen:
- int id: Id der Resource
- string name: Name der Resource
- string url: URL der Resource
- int type_id: Typ Id der Resource
- int category_id: Id des Ordners, in welcher die Resource gespeichert ist
- int customer_id: Id des Mandanten, in welchem die Resource gespeichert ist
Benötigte Rechte:
keine