engine:procedures:do_getglossary_ad
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
|
engine:procedures:do_getglossary_ad [20.11.2014 ] 127.0.0.1 Externe Bearbeitung |
engine:procedures:do_getglossary_ad [11.01.2016 ] |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| - | ===== do_GetGlossary_Ad ===== | ||
| - | |||
| - | Gibt die Glossareinträge zurück.\\ | ||
| - | |HTTP-Method|GET | | ||
| - | |HTTP-Auth|Optional | | ||
| - | |Engine-Kategorie|documentation | | ||
| - | |Engine-Typ|select data | | ||
| - | |Letzte Aktualisierung|7.0.3 (2013-12-13)| | ||
| - | |||
| - | ==== 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 ^ | ||
| - | |Keyword|NULL |Ist "Keyword" angegeben, wird nur der Glossareintrag geliefert, der zu "Keyword" hinterlegt wurde (wenn vorhanden).\\ |varchar(100)|7.0.3| | ||
| - | |OrderByLowercase|1 |"1" angeben, um das Ergebnis case-INsensitiv nach "Keyword" zu sortieren (bei "0" werden Groß- und Kleinbuchstaben beachtet).\\ |bit|7.0.3| | ||
| - | ==== Rückgabe ==== | ||
| - | |||
| - | === (parameterunabhängig) === | ||
| - | |||
| - | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| - | |//lower(Keyword)((Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.))//|Wird nicht zurückgegeben, sondern zur Sortierung benötigt. Enthält den Wert der Rückgabespalte "Keyword", aber komplett in Kleinbuchstaben ("lowercase" eben).\\ |varchar(100)|7.0.3 | | ||
| - | |Keyword|Der Schlüssel, zu dem der Glossareintrag gespeichert wurde\\ |varchar(100)|7.0.3 | | ||
| - | |Description|Die Beschreibung zu "Keyword"\\ |varchar(255)|7.0.3 | | ||
| - | |DetailedDescription|Eine detaillierte Beschreibung zu "Keyword"\\ |text|7.0.3 | | ||
| - | |||
| - | == Sortierungen der Rückgabe == | ||
| - | |||
| - | wenn OrderByLowercase = 0 | ||
| - | * Keyword (aufsteigend) | ||
| - | wenn OrderByLowercase = 1 | ||
| - | * lower(Keyword) (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| | ||
| - | |-502|Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)|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.3 |2013-12-13|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=do_GetGlossary_Ad|do_GetGlossary_Ad im Engine Playground öffnen]] | ||
| - | == cURL == | ||
| - | Unformatierte Ausgabe: | ||
| - | <code bash> | ||
| - | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/do_GetGlossary_Ad'</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/do_GetGlossary_Ad' | 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'), | ||
| - | 'do_GetGlossary_Ad', | ||
| - | array( | ||
| - | // 'Keyword' => NULL, | ||
| - | // 'OrderByLowercase' => 1 | ||
| - | ) | ||
| - | ); | ||
| - | |||
| - | $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="do_GetGlossary_Ad"> | ||
| - | <Parameters> | ||
| - | <!-- <Parameter Name="Keyword">NULL</Parameter> --> | ||
| - | <!-- <Parameter Name="OrderByLowercase">1</Parameter> --> | ||
| - | </Parameters> | ||
| - | </Procedure> | ||
| - | </Batch> | ||
| - | </ListOfBatches></code> | ||
engine/procedures/do_getglossary_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)