Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
engine:procedures:im_modifynodecharacsincat_ad [11.01.2016 ] |
engine:procedures:im_modifynodecharacsincat_ad [11.01.2016 ] (aktuell) |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
+ | ===== im_ModifyNodeCharacsInCat_Ad ===== | ||
+ | |||
+ | Diese Prozedur dient der Einordnung von Merkmalen (für Artikel-Elemente) in Kategorien.\\ | ||
+ | |||
+ | Allgemeiner Hinweis :\\ Einer Kategorie können MAXIMAL 256 Merkmale zugeordnet sein\\ | ||
+ | |||
+ | |||
+ | |||
+ | Anmerkungen zum Parameter "MoveSortNo" :\\ | ||
+ | |||
+ | 1. Ein positiver Wert bedeutet, daß die interne "SortNo" (die die Reihenfolge bestimmt) um den Wert "MoveSortNo" ERHÖHT wird, d.h. das Merkmal "rückt nach unten". Ein negativer Wert ERNIEDRIGT die "SortNo" entsprechend, d.h. das Merkmal "steigt nach oben".\\ | ||
+ | |||
+ | 2. Würde der Wert von "MoveSortNo" dazu führen, daß die neue "SortNo" kleiner als "0" oder größer als die bisherige größte "SortNo" aller Merkmale (die "NodeCharacCategoryID" zugeordnet sind) wäre, gibt es keinen Fehler, sondern die "SortNo" wird dann auf "0" gesetzt bzw. so geändert, daß "NodeCharacteristicID" die größte "SortNo" innerhalb aller Merkmale in der Kategorie ("NodeCharacCategoryID") besitzt.\\ | ||
+ | |HTTP-Method|POST | | ||
+ | |HTTP-Auth|Optional | | ||
+ | |Alias|im_ModifyNodeCharacteristicsInCategories_Ad | | ||
+ | |Tags|{{tag>[im Modify Node Characteristics In Categories Ad]}}| | ||
+ | |Engine-Kategorie|configurations | | ||
+ | |Engine-Typ|Daten-Änderung | | ||
+ | |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 ^ | ||
+ | |__NodeCharacCategoryID__| |ID einer Kategorie für Artikel-Merkmale. Falls "NodeCharacteristicID" dieser Kategorie noch nicht zugeordnet ist, wird eine Zuordnung erstellt. (Das Merkmal wird dann in der Kategorie ganz "nach unten" eingeordnet.)\\ |smallint|5.1.9| | ||
+ | |__NodeCharacteristicID__| |ID eines Merkmals. Falls es schon der Kategorie "NodeCharacCategoryID" zugeordnet ist, wird je nach "RemoveNodeCharIDFromCategory" entweder die Reihenfolge geändert (-> "MoveSortNo") oder die Zuordnung gelöscht. Ansonsten wird eine Zuordnung erstellt.\\ |smallint|5.1.9| | ||
+ | |MoveSortNo|NULL |Wird nur beachtet, wenn die Zurodnung schon besteht ! Die "SortNo" (bestimmt die Reihenfolge aller Merkmale innerhalb "NodeCharacCategoryID") wird relativ um diesen Wert geändert.\\ |smallint|5.1.9| | ||
+ | |RemoveNodeCharIDFromCategory|0 |Falls die Zuordnung von "NodeCharacteristicID" zu "NodeCharacCategoryID" schon besteht, entscheidet dieser Wert darüber, ob die Zuordnung gelöscht wird ("1") oder ob die Reihenfolge ("MoveSortNo" entsprechend relativ) geändert wird ("0")\\ |bit|5.1.9| | ||
+ | ==== Rückgabe ==== | ||
+ | |||
+ | Die Prozedur hat keine Rückgaben. | ||
+ | ==== 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| | ||
+ | |-500|Falsche Parameter|direkt und indirekt| | ||
+ | |-293|Einer Kategorie können maximal 256 Merkmale zugeordnet werden|nur direkt| | ||
+ | ==== 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]\\ | | ||
+ | |5.1.9 |2007-01-26|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_ModifyNodeCharacsInCat_Ad|im_ModifyNodeCharacsInCat_Ad im Engine Playground öffnen]] | ||
+ | == cURL == | ||
+ | Unformatierte Ausgabe: | ||
+ | <code bash> | ||
+ | curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/im_ModifyNodeCharacsInCat_Ad?NodeCharacCategoryID=<value>&NodeCharacteristicID=<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_ModifyNodeCharacsInCat_Ad?NodeCharacCategoryID=<value>&NodeCharacteristicID=<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_ModifyNodeCharacsInCat_Ad', | ||
+ | array( | ||
+ | 'NodeCharacCategoryID' => <value>, | ||
+ | 'NodeCharacteristicID' => <value>, | ||
+ | // 'MoveSortNo' => NULL, | ||
+ | // 'RemoveNodeCharIDFromCategory' => 0 | ||
+ | ) | ||
+ | ); | ||
+ | |||
+ | $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_ModifyNodeCharacsInCat_Ad"> | ||
+ | <Parameters> | ||
+ | <Parameter Name="NodeCharacCategoryID"><!-- smallint value --></Parameter> | ||
+ | <Parameter Name="NodeCharacteristicID"><!-- smallint value --></Parameter> | ||
+ | <!-- <Parameter Name="MoveSortNo">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="RemoveNodeCharIDFromCategory">0</Parameter> --> | ||
+ | </Parameters> | ||
+ | </Procedure> | ||
+ | </Batch> | ||
+ | </ListOfBatches></code> | ||