mi_GetRegions [dstore]

Inhaltsverzeichnis

mi_GetRegions

mi_GetRegions

Liefert alle im „dStore“ hinterlegten Regionen, in denen Länder („Countries“) eingeordnet werden können (siehe mi_ModifyCountriesInRegions_Ad).

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[mi, Get, Regions]
Engine-Kategorie	miscellaneous
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	3.5.0 (2000-11-23)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
RegionID	NULL	ID einer Region. Optionaler Parameter zur Einschränkung auf den Datensatz einer bestimmten Region.	smallint	3.5.0

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
RegionID	ID einer Region, in die Länder („Countries“) zusammengefaßt werden können	smallint	3.5.0
Region	Bezeichnung der Region „RegionID“	varchar(100)	3.5.0

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Die Prozedur hat keine Fehlercodes.

XML-Schema

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

Historie

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:

mi_GetRegions im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetRegions' | 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_GetRegions',
		array(
			// 'RegionID' => 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="mi_GetRegions">
			<Parameters>
				<!-- <Parameter Name="RegionID">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

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

Benutzer-Werkzeuge

Webseiten-Werkzeuge