engine:procedures:im_checkconditionsfortnids_ad
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
|
engine:procedures:im_checkconditionsfortnids_ad [11.01.2016 ] |
engine:procedures:im_checkconditionsfortnids_ad [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== im_CheckConditionsForTNIDs_Ad ===== | ||
| + | |||
| + | Wir überprüfen für eine gegebene Menge von Elementen im Artikelbaum ("TreeNodeID"s), ob sie eine (oder auch eine Menge von) Bedingung(en) erfüllen.\\ Anmerkung : Den Aufbau einer "(Artikel-)Bedingung" entnehme man der Doku von [[dstoreproc>im_GetItemConditions_Ad]].\\ | ||
| + | |||
| + | Anmerkung zum Parameter "TreeNodeIDList" :\\ Der Grund für die Beschränkung auf maximal 1930 Bytes in "TreeNodeIDList" liegt in der Beschränkung hinsichtlich der Rückgabe-Spalte "TNIDsFulfillingCondition". Diese Beschränkung wiederum besteht aufgrund der Tatsache, daß wir in einem Datensatz maximal soviele Bytes zurückgeben können, wie in die kleinst mögliche ASE-page passen, was also maximal 2K, sprich 2048 Byte, entspricht. Abzüglich "overhead" und Speicher für andere Rückgabespalten (und ein kleiner Puffer für evtl. in der Zukunft neu hinzukommende Spalten) verbleiben somit 1930 Byte.\\ | ||
| + | |HTTP-Method|POST | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Alias|im_CheckConditionsForTreeNodeIDs_Ad | | ||
| + | |Tags|{{tag>[im Check Conditions For Tree Node Ds Ad]}}| | ||
| + | |Engine-Kategorie|item management | | ||
| + | |Engine-Typ|Daten-Ermittlung | | ||
| + | |Letzte Aktualisierung|7.0.7 (2015-01-29)| | ||
| + | |||
| + | ==== Parameter ==== | ||
| + | |||
| + | ^Name ((Pflichtparameter sind unterstrichen)) ^Standard-Wert ^Beschreibung ((siehe [[webservice:engine_parameterconventions|Parameter-Konventionen engine/<Prozedur-Name>]])) ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |__TreeNodeIDList__| |Eine Liste von IDs (durch "," getrennt) von Elementen im Artikelbaum ("TreeNodeID"s), für die geprüft werden soll, ob sie die in "ItemConditionIDs" angegebene(n) Bedingun(en) erfüllen\\ |varchar(1930)|6.0.6| | ||
| + | |__ItemConditionIDs__| |Liste von (Artikel-)Bedingungen (mögliche Werte : s. [[dstoreproc>im_GetItemConditions_Ad]]) - die IDs sind durch "," voneinander zu trennen\\ |varchar(255)|6.0.6| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | === (parameterunabhängig) === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |ItemConditionID|ID eines der in "ItemConditionIDs" angegebenen Bedingungen. Anmerkung : Es wird garantiert für JEDE in "ItemConditionIDs" angegebene Bedingung ein Datensatz geliefert !\\ |integer|6.0.6 | | ||
| + | |TNIDsFulfillingCondition|Die IDs aus "TreeNodeIDList" (durch "," getrennt), die "ItemConditionID" erfüllen. "NULL" bedeutet, daß KEINE der "TreeNodeID"s die Bedingung erfüllt.\\ |varchar(1930)|6.0.6 | | ||
| + | ==== Output-Parameter ==== | ||
| + | |||
| + | Die Prozedur hat keine Output-Parameter.==== Mögliche Return-Codes ==== | ||
| + | |||
| + | ^Code ^Beschreibung ^Quelle ((direkt meint "von der Prozedur selber" und indirekt meint "von intern aufgerufenen Unterprozeduren")) ^ | ||
| + | |-569|Der Benutzer hat kein Ausführungsrecht für die Prozedur|nur indirekt| | ||
| + | |-567|Die Prozedur darf z. Zt. nicht ausgeführt werden|nur indirekt| | ||
| + | |-566|Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werden|nur indirekt| | ||
| + | |-535|Das Datum liegt nicht in der Vergangenheit|nur indirekt| | ||
| + | |-530|Der Wert ist nicht konvertierbar|nur indirekt| | ||
| + | |-510|Der Benutzer ist nicht registriert|nur indirekt| | ||
| + | |-504|Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochen|nur indirekt| | ||
| + | |-502|Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)|nur indirekt| | ||
| + | |-500|Falsche Parameter|direkt und indirekt| | ||
| + | ==== XML-Schema ==== | ||
| + | |||
| + | Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema [[http://resources.dstore.de/xsd/webservice_SmartGate/Response/EngineProcedure_v1_0.xsd|Response/EngineProcedure_v1_0.xsd]] validiert. | ||
| + | ==== Historie ==== | ||
| + | |||
| + | |7.0.7 |2015-01-29|Interne Änderung : Datentyp-Erweiterung des "ReferenceKey" [für "_mi_StartProcedure"-Aufruf]\\ | | ||
| + | |6.5.3 |2013-03-18|Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung\\ | | ||
| + | |6.0.6 |2012-03-01|Erstmalig in dieser Version erstellt\\ | | ||
| + | |||
| + | ==== Code-Snippets ==== | ||
| + | |||
| + | == Engine Playground == | ||
| + | Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist: | ||
| + | * [[http://playground.dstore.de/index.php?proc=im_CheckConditionsForTNIDs_Ad|im_CheckConditionsForTNIDs_Ad im Engine Playground öffnen]] | ||
| + | == cURL == | ||
| + | Unformatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/im_CheckConditionsForTNIDs_Ad?TreeNodeIDList=<value>&ItemConditionIDs=<value>'</code>Mit xmllint ((I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org)) formatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/im_CheckConditionsForTNIDs_Ad?TreeNodeIDList=<value>&ItemConditionIDs=<value>' | xmllint --format -</code>== dStore_php == | ||
| + | <code php> | ||
| + | use dStore_php\WebService; | ||
| + | |||
| + | $service = new WebService\Service( WebService\Scheme::HTTP,'<partner>-<project>.dstore.de', 80); | ||
| + | |||
| + | $request = new WebService\Requests\Engine\Procedure\Request( | ||
| + | new WebService\Requests\AccessData('default'), | ||
| + | 'im_CheckConditionsForTNIDs_Ad', | ||
| + | array( | ||
| + | 'TreeNodeIDList' => '<value>', | ||
| + | 'ItemConditionIDs' => '<value>' | ||
| + | ) | ||
| + | ); | ||
| + | |||
| + | $service->execute($request); | ||
| + | |||
| + | $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); | ||
| + | $ResultSet = $xml_result->getRowsAsArray(); | ||
| + | |||
| + | </code> | ||
| + | == engine/execute == | ||
| + | XML zur Ausführung mit der Methode [[:webservice:engine:execute|engine/execute]], z.B. per | ||
| + | curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>' | ||
| + | |||
| + | <code xml> | ||
| + | <?xml version="1.0" encoding="UTF-8"?> | ||
| + | <ListOfBatches> | ||
| + | <Batch No="0"> | ||
| + | <Procedure Name="im_CheckConditionsForTNIDs_Ad"> | ||
| + | <Parameters> | ||
| + | <Parameter Name="TreeNodeIDList"><!-- varchar value --></Parameter> | ||
| + | <Parameter Name="ItemConditionIDs"><!-- varchar value --></Parameter> | ||
| + | </Parameters> | ||
| + | </Procedure> | ||
| + | </Batch> | ||
| + | </ListOfBatches></code> | ||
engine/procedures/im_checkconditionsfortnids_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)