Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
— |
engine:procedures:mi_getlocales [11.01.2016 ] (aktuell) |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
+ | ===== mi_GetLocales ===== | ||
+ | |||
+ | Gibt den Inhalt der Tabelle "Locales" zurück, in der "Land-Sprache-Kombinationen" (die sogenannten "locales") gespeichert sind.\\ | ||
+ | |HTTP-Method|GET | | ||
+ | |HTTP-Auth|Optional | | ||
+ | |Tags|{{tag>[mi Get Locales]}}| | ||
+ | |Engine-Kategorie|miscellaneous | | ||
+ | |Engine-Typ|Daten-Ermittlung | | ||
+ | |Letzte Aktualisierung|5.5.2 (2008-10-21)| | ||
+ | |||
+ | ==== 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 "locales" für dieses Land ausgegeben zu bekommen.\\ |smallint|5.5.2| | ||
+ | |LanguageID|NULL |ID einer Sprache. Optionaler Parameter, um nur die "locales" dieser Sprache zurückzubekommen.\\ |tinyint|5.5.2| | ||
+ | |GetNamesInLanguageID|2 |ID einer Sprache. Falls angegeben, wird versucht, in der Rückgabemenge die Übersetzung der Bezeichnung des Landes und der Sprache (deren Kombination ein "locale" darstellt) zu ermitteln (s. Spalten "...InGivenLanguage"). Default-Wert steht für "Englisch".\\ |tinyint|5.5.2| | ||
+ | ==== Rückgabe ==== | ||
+ | |||
+ | === (parameterunabhängig) === | ||
+ | |||
+ | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
+ | |LocaleID|ID eines "locale"-Eintrags - der einfach die Zuordnung eines Landes (-> "CountryID") zu einer Sprache (-> "LanguageID") darstellt\\ |smallint|5.5.2 | | ||
+ | |CountryID|ID eines Landes\\ |smallint|5.5.2 | | ||
+ | |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)|5.5.2 | | ||
+ | |CountryDescription|Bezeichnung des Landes "CountryID" (in der "DefaultLanguageID")\\ |varchar(100)|5.5.2 | | ||
+ | |CountryDescrInGivenLanguage|Bezeichnung des Landes "CountryID" in der durch "GetNamesInLanguageID" angegebenen Sprache. Falls "NULL" für besagten Parameter angegeben wurde, wird hier immer "NULL" zurückgegeben !\\ |varchar(100)|5.5.2 | | ||
+ | |CountryDescrInLocaleLanguage|Bezeichnung des Landes "CountryID" in der Sprache "LanguageID", also quasi der "locale"-Sprache\\ |varchar(100)|5.5.2 | | ||
+ | |LanguageID|ID einer Sprache, die zusammen mit "CountryID" einen "locale"-Eintrag darstellt\\ |tinyint|5.5.2 | | ||
+ | |LanguageSymbol|Internationales Symbol der Sprache "LanguageID". Bei Neu-Installationen ab Version 5.5.2 sind die Werte gemäß "ISO 639-1". An diesen Standard sollte man sich halten bzw. die Werte bei bestehenden Installationen anpassen !\\ |varchar(3)|5.5.2 | | ||
+ | |Language|Bezeichnung der Sprache (in der "DefaultLanguageID")\\ |varchar(50)|5.5.2 | | ||
+ | |LanguageInGivenLanguage|Bezeichnung der Sprache "LanguageID" in der durch "GetNamesInLanguageID" angegebenen Sprache. Falls "NULL" für besagten Parameter angegeben wurde, wird hier immer "NULL" zurückgegeben !\\ |varchar(50)|5.5.2 | | ||
+ | |LanguageInLocaleLanguage|Bezeichnung der Sprache "LanguageID" in der Sprache "LanguageID" selbst\\ |varchar(50)|5.5.2 | | ||
+ | |||
+ | == Sortierung der Rückgabe == | ||
+ | |||
+ | (parameterunabängige Sortierung) | ||
+ | * CountryDescription (aufsteigend) | ||
+ | * Language (aufsteigend) | ||
+ | |||
+ | ==== 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.5.2 |2008-10-21|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_GetLocales|mi_GetLocales im Engine Playground öffnen]] | ||
+ | == cURL == | ||
+ | Unformatierte Ausgabe: | ||
+ | <code bash> | ||
+ | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/mi_GetLocales'</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_GetLocales' | 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_GetLocales', | ||
+ | array( | ||
+ | // 'CountryID' => NULL, | ||
+ | // 'LanguageID' => NULL, | ||
+ | // 'GetNamesInLanguageID' => 2 | ||
+ | ) | ||
+ | ); | ||
+ | |||
+ | $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_GetLocales"> | ||
+ | <Parameters> | ||
+ | <!-- <Parameter Name="CountryID">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="LanguageID">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="GetNamesInLanguageID">2</Parameter> --> | ||
+ | </Parameters> | ||
+ | </Procedure> | ||
+ | </Batch> | ||
+ | </ListOfBatches></code> | ||