SOAP Pool-Data-Miner – Evalanche Helpcenter

WIP
Folgende SOAP-Methoden werden speziell für die Interaktion mit Pool-Data-Miner-Objekten bereitgestellt.

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 customer_id
- int: last_modified
- int: resource_id
- string: name

Benötigte Rechte

Pool-Data-Miner erzeugen

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/pooldataminer">
 <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/pooldataminer">
 <SOAP-ENV:Body>
 <ns1:copyResponse>
 <copyResult>
 <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

Pool-Data-Miner verwalten

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:lead="https://scnem.com/soap.php/soap/pooldataminer">
 <soapenv:Header />
 <soapenv:Body>
 <lead:delete>
 <resource_id>RESOURCE_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/pooldataminer">
 <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/pooldataminer">
 <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/pooldataminer">
 <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

Listet alle Ressourcen innerhalb eines Ordners auf.

ArrayOfEvalancheResourceInformation getByCategory (int mandator_id)

Details

Parameter

int category_id: Ordner ID

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/pooldataminer">
 <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/pooldataminer">
 <SOAP-ENV:Body>
 <ns1:getAllResponse>
 <getAllResult>
 <item>
 <url>https://scnem.com/a.php?sid=xxxxxx,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>

getByExternalId

Gibt alle Objekte mit gegebener EXTERNAL_ID aus.

ArrayOfEvalancheResourceInformation[] getByExternalId (string external_id)

Details: getByExternalId

getById

Ressourceinformationen über die ID abrufen

EvalancheResourceInformation getById (int resource_id)

Details

Parameter

int resource_id: ID des Pool-Data-Miners

Rückgabewert

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

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/pooldataminer">
 <soapenv:Header />
 <soapenv:Body>
 <lead:getById>
 <resource_id>RESOURCE_ID</resource_id>
 </lead: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/pooldataminer">
 <SOAP-ENV:Body>
 <ns1:getByIdResponse>
 <getByIdResult>
 <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>
 </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: 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

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/pooldataminer">
 <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/pooldataminer">
 <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>

getResourceDefaultCategory

Liefert Informationen über den Standardordner von Pool-Data-Miner-Objekten

getResourceDefaultCategoryResponse getResourceDefaultCategory (int customer_id)

Details

Parameter

int customer_id: Customer ID

Rückgabewert

EvalancheCategoryInformation
- int: ID
- string: NAME
- int: PARENT_ID

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/pooldataminer">
 <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/pooldataminer">
 <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

Listet Informationen über die Type-IDs von Pool-Data-Miner-Objekten

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/pooldataminer">
 <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/pooldataminer">
 <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/pooldataminer">
 <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/pooldataminer">
 <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 Pool-Data-Miner-Objekt in einen anderen Ordner

EvalancheResourceInformation move (int resource_id, int category_id)

Details

Parameter

int resource_id: ID der zu verschiebenden Datei
int category_id: ID des Zielordners

Rückgabewert

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

Benötigte Rechte

Pool-Data-Miner verwalten

Verwendung

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:file="https://scnem.com/soap.php/soap/pooldataminer">
 <soapenv:Header />
 <soapenv:Body>
 <file:move>
 <resource_id>RESOURCE_ID</resource_id>
 <category_id>CATEGORY_ID</category_id>
 </file: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/pooldataminer">
 <SOAP-ENV:Body>
 <ns1:moveResponse>
 <moveResult>
 <url>URL</url>
 <type_id>9</type_id>
 <category_id>CATEGORY_ID</category_id>
 <customer_id>CUSTUMER_ID</customer_id>
 <last_modified>LAST_MODIFIED</last_modified>
 <id>ID</id>
 <name>NAME</name>
 </moveResult>
 </ns1:moveResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

rename

Gibt dem Pool-Data-Miner-Objekt einen anderen Namen

EvalancheResourceInformation rename (int resource_id, string name)

Details

Parameter

int resource_id: ID des Pool-Data-Miner-Objektes, das umbenannt werden soll
string name: neuer Name des Pool-Data-Miner-Objektes,

Rückgabewert

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

Benötigte Rechte

Pool-Data-Miner verändern

Verwendung

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

getById

Parameter

Rückgabewert

Benötigte Rechte

Verwendung

getByModificationDate

getByTypeId

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