do_GetGlossary_Ad [dstore]

Inhaltsverzeichnis

do_GetGlossary_Ad

do_GetGlossary_Ad

Gibt die Glossareinträge zurück.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[do, Get, Glossary, Ad]
Engine-Kategorie	documentation
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.8 (2015-08-21)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	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
LanguageID	NULL	ID einer (dStore-)Sprache (mögliche Werte : s. do_GetdStoreLanguages_Ad). Falls angegeben, werden die „Description“-Rückgabespalten in der entsprechenden Sprache ermittelt (wenn nicht möglich, bekommt man immer die deutsche Doku).	tinyint	7.0.8

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
lower(Keyword)⁵⁾	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“. Falls „LanguageID“ angegeben wurde (und ungleich „1“ - für Deutsch - ist) UND auch eine Übersetzung vorhanden ist, dann ist der Wert in der entsprechenden Sprache.	varchar(255)	7.0.3
DetailedDescription	Eine detaillierte Beschreibung zu „Keyword“. Falls „LanguageID“ angegeben wurde (und ungleich „1“ - für Deutsch - ist) UND auch eine Übersetzung vorhanden ist, dann ist der Wert in der entsprechenden Sprache.	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 ⁶⁾
-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	direkt und indirekt

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

7.0.8	2015-08-21	Neuer Parameter „LanguageID“
7.0.7	2015-01-29	Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
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:

do_GetGlossary_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/do_GetGlossary_Ad'

Mit xmllint ⁷⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/do_GetGlossary_Ad' | xmllint --format -

dStore_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,
			// 'LanguageID' => NULL
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();

engine/execute

XML zur Ausführung mit der Methode engine/execute, z.B. per

curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>'

<?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> -->
				<!-- <Parameter Name="LanguageID">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.

⁶⁾

direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“

⁷⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Inhaltsverzeichnis