engine:procedures:mi_getunits
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
| — |
engine:procedures:mi_getunits [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== mi_GetUnits ===== | ||
| + | |||
| + | Gibt im "dStore" definierte Einheiten zurück.\\ | ||
| + | |HTTP-Method|GET | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Tags|{{tag>[mi Get Units]}}| | ||
| + | |Engine-Kategorie|miscellaneous | | ||
| + | |Engine-Typ|Daten-Ermittlung | | ||
| + | |Letzte Aktualisierung|6.0.2 (2011-06-08)| | ||
| + | |||
| + | ==== 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 ^ | ||
| + | |UnitCategoryID|1 |Wird nur beachtet, wenn für "UnitID" "NULL" übergeben wurde ! Falls angegeben, werden nur Einheiten, die der hierdurch angegebenen Kategorie angehören, zurückgegeben. "NULL" angeben, um sich alle Einheiten ermitteln zu lassen.\\ |tinyint|3.5.0| | ||
| + | |UnitID|NULL |ID einer Einheit. Wenn angegeben, wird nur der Datensatz der entsprechenden Einheit angezeigt\\ |tinyint|3.5.0| | ||
| + | |Active|1 |Einheiten bzgl. "Active"-Status filtern :\\ "NULL" : Keine Filterung\\ "0" : Nur inaktive Einheiten\\ "1" : Nur aktive Einheiten\\ "2" : Nur für Administratoren sichtbare Einheiten\\ Aufrufer "publicuser" darf nur "1" angeben !\\ |tinyint|3.5.20| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | === (parameterunabhängig) === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |UnitID|ID einer Einheit, die im "dStore" definiert ist\\ |tinyint|3.5.0 | | ||
| + | |UnitSymbol|Symbol (im Regelfall der ISO-Code) für die Einheit "UnitID"\\ |varchar(10)|3.5.0 | | ||
| + | |UnitDescription|Bezeichnung der Einheit "UnitID"\\ |varchar(80)|3.5.0 | | ||
| + | |Active|"0" : "UnitID" wird nicht mehr verwendet, muß aber noch gespeichert werden, da abhängige Datensätze (wie Aufträge) existieren (z.B. die Währung "DEM")\\ "1" : "UnitID" ist aktiv, wird also verwendet\\ "2" : "UnitID" ist nur für Administratoren sichtbar\\ |tinyint|3.5.20 | | ||
| + | ==== Output-Parameter ==== | ||
| + | |||
| + | Die Prozedur hat keine Output-Parameter.==== Mögliche Return-Codes ==== | ||
| + | |||
| + | ^Code ^Beschreibung ^Quelle ((direkt meint "von der Prozedur selber" und indirekt meint "von intern aufgerufenen Unterprozeduren")) ^ | ||
| + | |-500|Falsche Parameter|nur direkt| | ||
| + | ==== 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 ==== | ||
| + | |||
| + | |6.0.2 |2011-06-08|1. Bei Angabe von "UnitCategoryID = NULL" und "UnitID = NULL" werden nun ALLE Units zurück gegeben\\ 2. Auch "Active" kann nun mit "NULL" angegeben werden, wenn man nicht der "publicuser" ist,\\ 3. Diverse Überarbeitungen am Code und der Dokumentation\\ | | ||
| + | |3.5.20 |2002-07-22|\\ | | ||
| + | |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_GetUnits|mi_GetUnits im Engine Playground öffnen]] | ||
| + | == cURL == | ||
| + | Unformatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/mi_GetUnits'</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_GetUnits' | 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_GetUnits', | ||
| + | array( | ||
| + | // 'UnitCategoryID' => 1, | ||
| + | // 'UnitID' => NULL, | ||
| + | // 'Active' => 1 | ||
| + | ) | ||
| + | ); | ||
| + | |||
| + | $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_GetUnits"> | ||
| + | <Parameters> | ||
| + | <!-- <Parameter Name="UnitCategoryID">1</Parameter> --> | ||
| + | <!-- <Parameter Name="UnitID">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="Active">1</Parameter> --> | ||
| + | </Parameters> | ||
| + | </Procedure> | ||
| + | </Batch> | ||
| + | </ListOfBatches></code> | ||
engine/procedures/mi_getunits.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)