Folgende SOAP-Methoden werden speziell für die Interaktion mit Containern bereitgestellt.
copy
Erstellt eine Kopie der durch die resource_id angegebenen Ressource
EvalancheResourceInformation copy (int resource_id, int category_id)Details: copy
create
Container erstellen
EvalancheResourceInformation create (int container_preset_id, string name, EvalancheHashMap data, int category_id)
Details
Parameter
- int container_preset_id: ID des Containertypen, der verwendet werden soll
- string name: Name des Containers
- EvalancheHashMap data: EvalancheHashMap mit den Daten des Containers
- int category_id: ID des Ordners, in welchem der Container erstellt werden soll
Rückgabewert
- EvalancheResourceInformation: Objekt analog zur Methode getById (Informationen über ein Objekt mittels Objekt ID abfragen)
Benötigte Rechte
Container erzeugen
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/container">
<soapenv:Header/>
<soapenv:Body>
<con:create>
<container_preset_id>CONTAINER_PRESET_ID</container_preset_id>
<name>CONTAINER_NAME</name>
<data>
<items>
<!--Zero or more repetitions:-->
<item>
<!--You may enter the following 2 items in any order-->
<key>ATTRIBUTE_NAME</key>
<value>ATTRIBUTE_CONTENT</value>
</item>
</items>
</data>
<category_id>FOLDER_ID</category_id>
</con: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/container">
<SOAP-ENV:Body>
<ns1:createResponse>
<createResult>
<url>CONTAINER_URL</url>
<type_id>CONTAINER_TYPE_ID</type_id>
<category_id>FOLDER_ID</category_id>
<customer_id>MANDATOR_ID</customer_id>
<id>CONTAINER_ID</id>
<name>CONTAINER_NAME</name>
</createResult>
</ns1:createResponse>
</SOAP-ENV:Body>
</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
getByCategory
Gibt alle Objekte eines Ordners aus.
ArrayOfEvalancheResourceInformation getByCategory (int category_id)Details: getByCategory
getByContainerTypeId
Container nach Container-Typ-ID abrufen
EvalancheHashMap getByContainerTypeId(int container_type_id)Details
Parameter
- int container_type_id: ID des zu suchenden Containertyps
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
Container 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>
<con:getByContainerTypeId>
<container_type_id>CONTAINER_TYPE_ID</container_type_id>
</con:getByContainerTypeId>
</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:getByContainerTypeIdResponse>
<getByContainerTypeIdResult>
<items>
<item>
<key>ATTRIBUTE_NAME</key>
<value>ATTRIBUTE_VALUE</value>
</item>
[...]
</items>
</getByContainerTypeIdResult>
</ns1:getByContainerTypeIdResponse>
</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
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
Container auslesen
EvalancheHashMap getData (int container_id)
Details
Parameter
- int container_id: ID des Containers
Rückgabewert
- EvalancheHashMap: EvalancheHashMap mit den Daten des Containers
Benötigte Rechte
Container anzeigen
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/container">
<soapenv:Header/>
<soapenv:Body>
<con:getData>
<container_id>CONTAINER_ID</container_id>
</con: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/container">
<SOAP-ENV:Body>
<ns1:getDataResponse>
<getDataResult>
<items>
<item>
<key>ATTRIBUTE_NAME</key>
<value>ATTRIBUTE_CONTENT</value>
</item>
[...]
</getDataResult>
</ns1:getDataResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
getDetails
Details eines Containers abfragen
EvalancheContainerInformation getDetails(int container_id)Details
Parameter
- int container_id: Id des Containers
Rückgabewert
- EvalancheContainerInformation: Objekt (SOAP) bzw. Array mit folgenden Attributen:
- int container_type_id: Id des Containertyps
- string url: URL des Containers
- 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 Containers
- string name: Name des Containers
Benötigte Rechte
Container 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>
<container:getDetails>
<container_id>CONTAINER_ID</container_id>
</container: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>
<container_type_id>CONTAINER_TYPE_ID</container_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>
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
update
Container aktualisieren
EvalancheResourceInformation update (int container_id, EvalancheHashMap data)
Details
Parameter
- int container_id: ID des Containers
- EvalancheHashMap data: EvalancheHashMap mit den Daten des Containers
Rückgabewert
- EvalancheResourceInformation: Objekt analog zur Methode getById (Informationen über ein Objekt mittels Objekt ID abfragen)
Benötigte Rechte
Container verändern
Verwendung
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="https://scnem.com/soap.php/soap/container">
<soapenv:Header/>
<soapenv:Body>
<con:update>
<container_id>CONTAINER_ID</container_id>
<data>
<items>
<!--Zero or more repetitions:-->
<item>
<!--You may enter the following 2 items in any order-->
<key>ATTRIBUTE_NAME</key>
<value>ATTRIBUTE_CONTENT</value>
</item>
</items>
</data>
</con:update>
</soapenv:Body>
</soapenv:Envelope><SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://scnem.com/soap.php/soap/container">
<SOAP-ENV:Body>
<ns1:updateResponse>
<updateResult>
<url>CONTAINER_URL</url>
<type_id>CONTAINER_TYPE_ID</type_id>
<category_id>FOLDER_ID</category_id>
<customer_id>MANDATOR_ID</customer_id>
<id>CONTAINER_ID</id>
<name>CONTAINER_NAME</name>
</updateResult>
</ns1:updateResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>