Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:im_getcorrespondingvalues_ad

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:im_getcorrespondingvalues_ad [11.01.2016 ]
engine:procedures:im_getcorrespondingvalues_ad [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== im_GetCorrespondingValues_Ad =====
 +
 +Gibt Zuordnungen von "​korrespondierenden"​ (im Sinne von "​einander entsprechenden"​) Eigenschaften aus.\\ ​
 +
 +Anmerkungen zu korrespondierenden Eigenschaften:​\\ 1. Die Zuordnung ist "​symmetrisch"​ (d.h. x~y => y~x)\\ 2. Zwei korrespondierende Eigenschaften müssen IMMER zu VERSCHIEDENEN Merkmalen gehören !\\ 3. Die Zuordnung ist "​transitiv"​ (x~y, y~z => x~z)\\ ​
 +|HTTP-Method|GET |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[im Get Corresponding Values 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 ^
 +|__GetCorrValsForValueID__| |ID einer Eigenschaft,​ den Artikel-Elemente haben können. Falls angegeben werden nur die zu dieser Eigenschaft korrespondierenden Eigenschaften ermittelt.\\ |integer|5.1.3|
 +|GetCorrValsForValsOfCharacID|NULL |ID eines Artikel-Merkmals. Wird nur beachtet, wenn "​GetCorrValsForValueID"​ "​NULL"​ ist ! Falls angegeben, werden die korrespondierenden Eigenschaften zu allen Eigenschaften dieses Merkmals ermittelt.\\ |smallint|5.1.3|
 +==== Rückgabe ====
 +
 +=== (parameterunabhängig) ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|ValueID|ID der Eigenschaft "​Value"​\\ |integer|5.1.3 |
 +|Value|Eine Eigenschaft,​ den Artikel-Elemente haben können\\ |varchar(1000)|5.1.3 |
 +|CorrespondingValueID|ID der Eigenschaft "​CorrespondingValue"​\\ |integer|5.1.3 |
 +|CorrespondingValue|Eigenschaft,​ die zur Eigenschaft "​Value"​ korrespondiert\\ |varchar(1000)|5.1.3 |
 +|CorrespondingCharacID|ID des Merkmals zu dem "​CorrespondingValue"​ gehört\\ |smallint|5.1.3 |
 +|CorrespondingCharacDescription|Bezeichnung des Merkmals "​CorrespondingCharacID"​\\ |varchar(100)|5.1.3 |
 +
 +== Sortierung der Rückgabe ==
 +
 +(parameterunabängige Sortierung)
 +  * Value (aufsteigend)
 +  * CorrespondingCharacID (aufsteigend)
 +  * CorrespondingValue (aufsteigend)
 +
 +==== 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|
 +==== 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.1 |2013-08-07|1. Interne Anpassungen [u.a. Quellcode an den aktuellen Standard]\\ 2. Datentyp-Erweiterung der Rückgabespalten "​Value"​ und "​CorrespondingValue"​\\ 3. Fehler : In einem "​-500"​-Fehlerfall wurde zusätzlich eine [leere Ergebnismenge] zurückgegeben\\ ​ |
 +|5.1.3 |2006-07-27|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_GetCorrespondingValues_Ad|im_GetCorrespondingValues_Ad im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​im_GetCorrespondingValues_Ad?​GetCorrValsForValueID=<​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/​im_GetCorrespondingValues_Ad?​GetCorrValsForValueID=<​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_GetCorrespondingValues_Ad',​
 + array(
 + '​GetCorrValsForValueID'​ => <​value>,​
 + // '​GetCorrValsForValsOfCharacID'​ => 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="​im_GetCorrespondingValues_Ad">​
 + <​Parameters>​
 + <​Parameter Name="​GetCorrValsForValueID"><​!-- integer value --></​Parameter>​
 + <!-- <​Parameter Name="​GetCorrValsForValsOfCharacID">​NULL</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/im_getcorrespondingvalues_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)