Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:mi_getcountries

mi_GetCountries

Liefert die im „dStore“ registrierten Länder zurück - diese werden z.B. für die Ermittlung von Versand- und Zahlungsart (also im „Order Manangement“) benötigt.

HTTP-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategoriemiscellaneous
Engine-TypDaten-Ermittlung
Letzte Aktualisierung5.1.2 (2006-06-26)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
CountryIDNULL ID eines Landes. Optionaler Parameter, um nur die Daten eines einzigen Landes ausgegeben zu bekommen.
smallint3.5.0
RegionIDNULL ID einer Region. Falls angegeben, werden nur die Länder zurückgegeben, die dieser Region zugeordnet sind.
smallint3.5.0
LanguageIDNULL ID einer Sprache, in der die Ausgabe der Länder-Bezeichnungen (Rückgabespalte „CountryDescription“) erfolgen soll - ansonsten wird die „Default“-Bezeichnung (aus „Countries“) genommen
tinyint3.5.0

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
CountryIDID eines Landes
smallint3.5.0
CountryDescriptionBezeichnung des Landes „CountryID“ in der durch „LanguageID“ angegebenen Sprache bzw. die „Default“-Bezeichnung (aus „Countries“)
varchar(100)3.5.0
CountryCodeInternationales Symbol des Landes „CountryID“. Bei Neu-Installationen ab Version 5.5.2 sind die Werte gemäß „ISO 3166-1 alpha-2“. An diesen Standard sollte man sich halten bzw. die Werte bei bestehenden Installationen anpassen !
varchar(3)3.5.0
SortNoBestimmt die Sortier-Reihenfolge von „CountryID“ innerhalb aller Länder
smallint3.5.0
RegionIDID einer Region, die dem Land zugeordnet wurde
smallint3.5.0
RegionBezeichnung der Region „RegionID“
varchar(100)3.5.0
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • SortNo (absteigend)

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

5.1.2 2006-06-261. Die Sortierung der Rückgabemenge ist im ASE 15 ohne explizites „ORDER BY“ nicht gewährleistet, daher mußten intern in dieser Prozedure entsprechende Änderungen vorgenommen werden
2. Konsequente Fehlerbehandlung
3.5.0 2000-11-23Erstmalig 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:

cURL

Unformatierte Ausgabe:

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

Mit xmllint 5) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetCountries' | 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_GetCountries',
		array(
			// 'CountryID' => NULL,
			// 'RegionID' => 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="mi_GetCountries">
			<Parameters>
				<!-- <Parameter Name="CountryID">NULL</Parameter> -->
				<!-- <Parameter Name="RegionID">NULL</Parameter> -->
				<!-- <Parameter Name="LanguageID">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/mi_getcountries.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)