Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:mi_getsearchitemlacks_ad

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:mi_getsearchitemlacks_ad [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== mi_GetSearchItemLacks_Ad =====
 +
 +Gibt aus der Tabelle "​SearchItemLacks"​ Suchbegriffe zurück, die in einer Suche verwendet wurden, wobei diese Suche jedoch kein Ergebnis lieferte.\\ ​
 +
 +Anmerkung :\\ Zur Zeit wird die Tabelle "​SearchItemLacks"​ nur von den Prozeduren [[dstoreproc>​im_SearchProductTreeNodes_Ad]] und "​..._Pu"​ verwendet und entsprechend gefüllt; allerdings ist die Tabelle prinzipiell für jegliche Suchen geeignet, die sich auf Suchbegriffe für bestimmte MERKMALE stützen - wie z.B. eine Suche nach Eigenschaften von Personen (derzeit noch nicht im "​public"​-Bereich implementiert). Daher gibt es auch den Parameter "​TableID"​.\\ ​
 +|HTTP-Method|GET |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[mi Get Search Item Lacks Ad]}}|
 +|Engine-Kategorie|miscellaneous |
 +|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 ^
 +|__TableID__| |ID der Tabelle auf die sich die Suche bezogen hat. Mögliche Werte : siehe Aufruf "exec mi_GetTabsRefInOtherTabs_Ad UsedInSearchItemLacks = 1", Rückgabespalte "​TableID"​.\\ |tinyint|3.5.20|
 +|__CharacteristicID__| |ID eines Merkmals, zu dem Eigenschaften in der durch "​TableID"​ symbolisierten Tabelle existieren und zu dem die Suchbegriffe ausgegeben werden sollen, die kein Suchergebnis lieferten\\ |smallint|3.5.20|
 +|__SearchValue__| |Ein Suchbegriff,​ nachdem gefiltert werden soll ("​NULL"​ um keine Einschränkung vorzunehmen)\\ |varchar(600)|3.5.20|
 +|__MinimalRequestCounter__| |Für jeden Suchbegriff,​ der kein Suchergebnis lieferte, wird festgehalten,​ wie oft er verwendet wurde. Dieser Parameter schränkt nun die Rückgabemenge auf die Suchbegriffe ein, die wenigstens so oft verwendet wurden.\\ |integer|3.5.20|
 +|rowcount|200 |Beschränkung der Anzahl Datensätze in der Rückgabemenge (muß ">= 1" sein)\\ |smallint|3.5.20|
 +|MaxRequestCounter|NULL |Für jeden Suchbegriff,​ der kein Suchergebnis lieferte, wird festgehalten,​ wie oft er verwendet wurde. Dieser Parameter schränkt nun die Rückgabemenge auf die Suchbegriffe ein, die maximal so oft verwendet wurden.\\ |integer|6.0.0|
 +==== Rückgabe ====
 +
 +=== (parameterunabhängig) ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|CharacteristicID|ID eines Merkmals (zu dem in der durch "​TableID"​ symbolisierten Tabelle Eigenschaften hinterlegt sind), in dem nach "​SearchValue"​ erfolglos gesucht wurde\\ |smallint|3.5.20 |
 +|SearchValue|Ein Suchbegriff,​ der zu einem leeren Suchergebnis führte\\ |varchar(600)|3.5.20 |
 +|RequestCounter|So oft wurde "​SearchValue"​ verwendet\\ |integer|3.5.20 |
 +
 +== Sortierung der Rückgabe ==
 +
 +(parameterunabängige Sortierung)
 +  * RequestCounter (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"​)) ^
 +|-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|
 +|-501|Der Parameter "​TableID"​ und/oder der Parameter "​TableKeyID"​ ist ungültig|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]\\ ​ |
 +|7.0.2 |2013-08-29|1. Datentyp-Erweiterung des Parameters "​SearchValue"​ [von "​100"​ auf "​600"​]\\ 2. Doku-Anpassung bzgl. der Rückgabespalte "​SearchValue"​ : Aufgrund entsprechender Änderung an der Tabelle\\ "​SearchItemLacks"​ ist der Datentyp von "​100"​ auf "​600"​ erweitert\\ ​ |
 +|6.5.3 |2013-03-18|Interne Anpassungen wg. UTF8-Unterstützung\\ ​ |
 +|6.0.1 |2010-07-20|Holger Wies : Workaround für "set rowcount"​-Bug [siehe Doku im Quelltext]\\ ​ |
 +|6.0.0 |2010-03-26|1. Neuer Parameter "​MaxRequestCounter",​ Quellcode-Anpassungen an den aktuellen Standard\\ 2. Zahlreiche interne Optimierungen\\ 3. Überprüfung,​ ob "​CharacteristicID"​ zur "​TableID"​ paßt\\ => Neukodierung der Prozedur\\ ​ |
 +|4.0.14 |2004-06-03|1. Aufruf der Prozeduren "​_mi_StartProcedure",​ "​_mi_FinishProcedure"​ und "​_mi_ChooseParamValueSeperator"​ \\ 2. Ausführen von "set transaction isolation level 1" und "set rowcount 0" zu Beginn der Prozedur\\ ​ |
 +|4.0.6 |2003-11-14|1. Änderung der Doku bzgl. des Parameters "​TableID"​\\ 2. Änderung des Checks bzgl. "​TableID"​\\ 3. Doku der Rückgabemenge fehlte\\ 4. Fehler bzgl. Rückgabespalte "​CharacteristicID"​ [falscher Wert und Spalte war nicht benannt]\\ ​ |
 +|4.0.3 |2003-07-10|1. Änderung bzgl. "​TableID"​ : "​2"​ statt "​1"​ für "​NodeCharacteristicValues"​ !\\ 2. Es gab immer "​-500",​ wenn "​CharacteristicID = NULL" angegeben wurde\\ ​ |
 +|3.5.20 |2002-07-22|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=mi_GetSearchItemLacks_Ad|mi_GetSearchItemLacks_Ad im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​mi_GetSearchItemLacks_Ad?​TableID=<​value>&​CharacteristicID=<​value>&​SearchValue=<​value>&​MinimalRequestCounter=<​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 GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​mi_GetSearchItemLacks_Ad?​TableID=<​value>&​CharacteristicID=<​value>&​SearchValue=<​value>&​MinimalRequestCounter=<​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'​),​
 + '​mi_GetSearchItemLacks_Ad',​
 + array(
 + '​TableID'​ => <​value>,​
 + '​CharacteristicID'​ => <​value>,​
 + '​SearchValue'​ => '<​value>',​
 + '​MinimalRequestCounter'​ => <​value>,​
 + // '​rowcount'​ => 200,
 + // '​MaxRequestCounter'​ => NULL
 + )
 +);
 +
 +$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="​mi_GetSearchItemLacks_Ad">​
 + <​Parameters>​
 + <​Parameter Name="​TableID"><​!-- tinyint value --></​Parameter>​
 + <​Parameter Name="​CharacteristicID"><​!-- smallint value --></​Parameter>​
 + <​Parameter Name="​SearchValue"><​!-- varchar value --></​Parameter>​
 + <​Parameter Name="​MinimalRequestCounter"><​!-- integer value --></​Parameter>​
 + <!-- <​Parameter Name="​rowcount">​200</​Parameter>​ -->
 + <!-- <​Parameter Name="​MaxRequestCounter">​NULL</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/mi_getsearchitemlacks_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)