Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:im_getnodecharacteristics_pu

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:im_getnodecharacteristics_pu [11.01.2016 ]
engine:procedures:im_getnodecharacteristics_pu [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== im_GetNodeCharacteristics_Pu =====
 +
 +Gibt im "​dStore"​ definierte Merkmale zurück, zu denen Artikel-Elemente Eigenschaften besitzen können.\\ ​
 +|HTTP-Method|GET |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[im Get Node Characteristics Pu]}}|
 +|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 ^
 +|NodeCharacteristicID|NULL |ID eines Merkmals, nach der das Ergebnis eingeschränkt werden soll - falls "​NULL"​ angegeben ist, werden ALLE Merkmale ermittelt\\ |smallint|5.1.2|
 +|LanguageIDForCharacDescript|NULL |ID einer Sprache. Falls angegeben, wird versucht für die Merkmal-Bezeichnung (s. Rückgabespalte "​CharacteristicDescription"​) eine Übersetzung in dieser Sprache zu finden.\\ |tinyint|5.1.2|
 +|NodeCharacCategoryID|NULL |Wird nur beachtet, wenn "​NodeCharacteristicID = NULL" ist ! ID einer Kategorie (mögliche Werte : s. [[dstoreproc>​im_GetNodeCharacCategories_Ad]]). Falls angegeben, werden nur die Merkmale ermittelt, die dieser Kategorie zugeordnet sind.\\ |smallint|7.0.2|
 +|OrderBySortNo|0 |Bestimmt, wie die Rückgabemenge sortiert ist :\\ - "​0"​ : aufsteigend nach "​CharacteristicDescription"​\\ - "​1"​ : absteigend nach "​SortNo"​\\ |bit|7.0.2|
 +==== Rückgabe ====
 +
 +=== (parameterunabhängig) ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|NodeCharacteristicID|ID eines Merkmals, zu dem Artikel-Elemente Eigenschaften haben können\\ |smallint|5.1.2 |
 +|CharacteristicDescription|Bezeichnung des Merkmals "​NodeCharacteristicID"​ in der durch "​LanguageIDForCharacDescript"​ angegebenen Sprache bzw. (falls keine Übersetzung vorhanden ist oder für den Parameter "​NULL"​ angegeben wurde) in der Standardsprache\\ |varchar(100)|5.1.2 |
 +|ValueLanguageID|ID einer Sprache, in der alle Eigenschaften des Merkmals "​NodeCharacteristicID"​ angegeben sind\\ |tinyint|5.1.2 |
 +|UnitID|ID einer Einheit, in der alle Eigenschaften des Merkmals "​NodeCharacteristicID"​ sind\\ |tinyint|5.1.2 |
 +|PredefinedValues|Hat das Merkmal "​NodeCharacteristicID"​ nur vordefinierte Werte ("​0"​ : Nein, "​1"​ : Ja) ?\\ |bit|5.1.2 |
 +|SortNo|Bestimmt die Reihenfolge des Merkmals "​NodeCharacteristicID"​ innerhalb aller Merkmale\\ |smallint|5.1.2 |
 +|FieldTypeID|ID eines "​Feld-Typs",​ von dem alle Eigenschaften des Merkmals "​NodeCharacteristicID"​ sein müssen (z.B. "Text mit maximal 20 Zeichen"​)\\ |tinyint|5.1.2 |
 +|Recursive|Handelt es sich um ein rekursives Merkmal ? Rekursive Merkmale sind immer vordefiniert und haben als Eigenschaften "​NodeCharacteristicID"​s. (Beispiel ist der "​Verkaufspreis"​)\\ |bit|5.1.2 |
 +
 +== Sortierungen der Rückgabe ==
 +
 +wenn OrderBySortNo = 0
 +  * CharacteristicDescription (aufsteigend)
 +wenn OrderBySortNo = 1
 +  * SortNo (absteigend)
 +
 +==== 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"​)) ^
 +|-621|Fehlender oder falscher Eintrag in PersonTypeSettings|nur indirekt|
 +|-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|
 +|-550|Fehlender oder falscher Eintrag in Settings|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|nur 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|"​Start-/​Finish-Procedure"​-Logik eingebaut, s. Ticket #​3670\\ ​ |
 +|7.0.2 |2013-08-29|1. Neue Parameter "​NodeCharacCategoryID"​ und "​OrderBySortNo"​\\ 2. Anpassungen des Quellcodes an den aktuellen Standard\\ ​ |
 +|5.1.2 |2006-06-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_GetNodeCharacteristics_Pu|im_GetNodeCharacteristics_Pu im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​im_GetNodeCharacteristics_Pu'</​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 GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​im_GetNodeCharacteristics_Pu'​ | 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_GetNodeCharacteristics_Pu',​
 + array(
 + // '​NodeCharacteristicID'​ => NULL,
 + // '​LanguageIDForCharacDescript'​ => NULL,
 + // '​NodeCharacCategoryID'​ => NULL,
 + // '​OrderBySortNo'​ => 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_GetNodeCharacteristics_Pu">​
 + <​Parameters>​
 + <!-- <​Parameter Name="​NodeCharacteristicID">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​LanguageIDForCharacDescript">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​NodeCharacCategoryID">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​OrderBySortNo">​0</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/im_getnodecharacteristics_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)