im_GetNodeCharacDescr_Ad [dstore]

Inhaltsverzeichnis

im_GetNodeCharacDescr_Ad

im_GetNodeCharacDescr_Ad

Liefert alle Merkmal-Beschreibungen in der Sprache „LanguageID“ (oder in allen Sprachen außer der „Default-Sprache“ sowie der Sprache mit der ID „0“ („Sprachunabhängig“), falls „LanguageID“ „NULL“ ist) zurück.

Möchte man die Übersetzung(en) nur zu einem bestimmten Merkmal, ist „NodeCharacteristicID“ entsprechend anzugeben.

HTTP-Method	GET
HTTP-Auth	Optional
Alias	im_GetNodeCharacteristicDescriptions_Ad
Tags	[im, Get, Node, Characteristic, Descriptions, Ad]
Engine-Kategorie	item management
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
NodeCharacteristicID	NULL	ID eines Merkmals	smallint	3.5.12
LanguageID	NULL	ID einer Sprache, in der die übersetzte(n) Merkmal-Bezeichnung(en) ausgegeben werden soll	tinyint	3.5.0

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
SortNo⁵⁾	Wird nicht ausgegeben, sondern nur zur Sortierung verwendet. Bestimmt die Reihenfolge von „NodeCharacteristicID“ innerhalb aller Merkmale	smallint	3.5.0
NodeCharacteristicID	ID eines Merkmals	smallint	3.5.0
CharacteristicDescription	Seit 3.5.12 : Bezeichnung des Merkmals (in der Standardsprache). Vorher stand hier die übersetzte Bezeichnung. Die Übersetzung steht seit Version 3.5.12 in „TranslatedDesccription“.	varchar(100)	3.5.0
TranslatedDescription	Übersetzung der Merkmal-Bezeichnung in der Sprache „Language“	varchar(100)	3.5.12
LanguageID	ID einer Sprache, in der die übersetzte Merkmal-Bezeichnung „TranslatedDescription“ angegeben ist	tinyint	3.5.12
Language	Bezeichnung der Sprache „LanguageID“	varchar(50)	3.5.12
LanguageSymbol	Internationales Symbol der Sprache „LanguageID“	varchar(3)	3.5.12

Sortierung der Rückgabe

(parameterunabängige Sortierung)

SortNo (absteigend)
LanguageID (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁶⁾
-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 Response/EngineProcedure_v1_0.xsd validiert.

Historie

7.0.7	2015-01-29	Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
4.0.11	2004-03-31	1. Aufruf der Prozeduren „_mi_StartProcedure“ und „_mi_FinishProcedure“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
3.5.12	2001-10-17
3.5.0	2000-11-23	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:

im_GetNodeCharacDescr_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁷⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/im_GetNodeCharacDescr_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'),
	'im_GetNodeCharacDescr_Ad',
		array(
			// 'NodeCharacteristicID' => NULL,
			// '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="im_GetNodeCharacDescr_Ad">
			<Parameters>
				<!-- <Parameter Name="NodeCharacteristicID">NULL</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