engine:procedures:mi_getcountries
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
|
engine:procedures:mi_getcountries [11.01.2016 ] |
engine:procedures:mi_getcountries [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== 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-Method|GET | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Tags|{{tag>[mi Get Countries]}}| | ||
| + | |Engine-Kategorie|miscellaneous | | ||
| + | |Engine-Typ|Daten-Ermittlung | | ||
| + | |Letzte Aktualisierung|5.1.2 (2006-06-26)| | ||
| + | |||
| + | ==== Parameter ==== | ||
| + | |||
| + | ^Name ((Pflichtparameter sind unterstrichen)) ^Standard-Wert ^Beschreibung ((siehe [[webservice:engine_parameterconventions|Parameter-Konventionen engine/<Prozedur-Name>]])) ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |CountryID|NULL |ID eines Landes. Optionaler Parameter, um nur die Daten eines einzigen Landes ausgegeben zu bekommen.\\ |smallint|3.5.0| | ||
| + | |RegionID|NULL |ID einer Region. Falls angegeben, werden nur die Länder zurückgegeben, die dieser Region zugeordnet sind.\\ |smallint|3.5.0| | ||
| + | |LanguageID|NULL |ID einer Sprache, in der die Ausgabe der Länder-Bezeichnungen (Rückgabespalte "CountryDescription") erfolgen soll - ansonsten wird die "Default"-Bezeichnung (aus "Countries") genommen\\ |tinyint|3.5.0| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | === (parameterunabhängig) === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |CountryID|ID eines Landes\\ |smallint|3.5.0 | | ||
| + | |CountryDescription|Bezeichnung des Landes "CountryID" in der durch "LanguageID" angegebenen Sprache bzw. die "Default"-Bezeichnung (aus "Countries")\\ |varchar(100)|3.5.0 | | ||
| + | |CountryCode|Internationales 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 | | ||
| + | |SortNo|Bestimmt die Sortier-Reihenfolge von "CountryID" innerhalb aller Länder\\ |smallint|3.5.0 | | ||
| + | |RegionID|ID einer Region, die dem Land zugeordnet wurde\\ |smallint|3.5.0 | | ||
| + | |Region|Bezeichnung 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 [[http://resources.dstore.de/xsd/webservice_SmartGate/Response/EngineProcedure_v1_0.xsd|Response/EngineProcedure_v1_0.xsd]] validiert. | ||
| + | ==== Historie ==== | ||
| + | |||
| + | |5.1.2 |2006-06-26|1. 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-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: | ||
| + | * [[http://playground.dstore.de/index.php?proc=mi_GetCountries|mi_GetCountries im Engine Playground öffnen]] | ||
| + | == cURL == | ||
| + | Unformatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/mi_GetCountries'</code>Mit xmllint ((I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org)) formatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/mi_GetCountries' | xmllint --format -</code>== dStore_php == | ||
| + | <code 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(); | ||
| + | |||
| + | </code> | ||
| + | == engine/execute == | ||
| + | XML zur Ausführung mit der Methode [[:webservice:engine:execute|engine/execute]], z.B. per | ||
| + | curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>' | ||
| + | |||
| + | <code xml> | ||
| + | <?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></code> | ||
engine/procedures/mi_getcountries.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)