mi_GetApplications_Ad [dstore]

Inhaltsverzeichnis

mi_GetApplications_Ad

mi_GetApplications_Ad

Gibt registrierte „dStore“-Anwendungen aus.

Darunter sind jegliche Arten von Anwendungen zu verstehen, die auf dem „dStore“ basieren. Für den dStore selbst hat die Registrierung von solchen Anwendungen keine Bedeutung; hierdurch wird aber jeder Anwendung die Möglichkeit gegeben, benutzerabhängige Einstellungen zu speichern (s. mi_ModifyAppSettings_Ad und mi_ModifyAppPartSettings_Ad).

Anmerkung zum Parameter „SearchForAppNameWithLike“ :
Ist „1“ angegeben, d.h. soll mit dem „LIKE“-Operator gesucht werden, kann „ApplicationName“ die in T-SQL erlaubten „wildcards“ („%“ für eine beliebige Zeichenkette, „_“ für ein beliebiges Zeichen) enthalten.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[mi, Get, Applications, Ad]
Engine-Kategorie	basics
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
ApplicationID	NULL	ID einer registrierten „dStore“-Anwendung, zu der der Datensatz ausgegeben werden soll. Falls „NULL“ angegeben ist, werden die „ApplicationName“ entsprechenden Datensätze ausgegeben (bzw. alle registrierten dStore-Anwendungen).	smallint	4.0.8
ApplicationName	NULL	Wird nur beachtet, wenn „ApplicationID = NULL“ ist ! Je nach „SearchForAppNameWithLike“ wird die Anwendung ausgegeben, die genauso heißt („=“-Operator) oder aber die Anwendungen, die so „ähnlich“ heißen („LIKE“-Operator).	varchar(100)	4.0.8
SearchForAppNameWithLike	0	Wird nur beachtet, wenn „ApplicationID = NULL“ ist ! „0“ : Den Datensatz ausgeben, für den „ApplicationName = ApplicationName“ gilt „1“ : Die Datensätze ausgeben, für die „ApplicationName LIKE ApplicationName“ gilt	bit	4.0.8

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
ApplicationID	ID einer registrierten „dStore“-Anwendung	smallint	4.0.8
ApplicationName	Bezeichnung/Name der Anwendung	varchar(100)	4.0.8

Sortierung der Rückgabe

(parameterunabängige Sortierung)

ApplicationName (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	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]
6.5.3	2013-03-18	Anpassungen an den aktuellen Quellcode-Standard, u.a. wg. UTF8-Unterstützung
5.1.5	2006-08-29	Explizites „ORDER BY“ eingefügt, um die Sortierung der Rückgabemenge zu garantieren
4.0.9	2004-03-03	1. Verwendung von „_mi_ChooseParamValueSeperator“ als Vorbereitung von „_mi_StartProcedure“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
4.0.8	2004-02-20	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:

mi_GetApplications_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetApplications_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'),
	'mi_GetApplications_Ad',
		array(
			// 'ApplicationID' => NULL,
			// 'ApplicationName' => NULL,
			// 'SearchForAppNameWithLike' => 0
		)
);
 
$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="mi_GetApplications_Ad">
			<Parameters>
				<!-- <Parameter Name="ApplicationID">NULL</Parameter> -->
				<!-- <Parameter Name="ApplicationName">NULL</Parameter> -->
				<!-- <Parameter Name="SearchForAppNameWithLike">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

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