Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:ac_getactionstatusvalues_ad

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:ac_getactionstatusvalues_ad [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== ac_GetActionStatusValues_Ad =====
 +
 +Ermittelt die (pro "​CommandID"​) definierten Status-Werte für "​Actions"​ aus der Tabelle "​ActionStatusValues"​.\\ ​
 +|HTTP-Method|GET |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[ac Get Action Status Values Ad]}}|
 +|Engine-Kategorie|actions |
 +|Engine-Typ|Daten-Ermittlung |
 +|Letzte Aktualisierung|7.0.7 (2015-01-29)|
 +
 +==== 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 ^
 +|CommandID|NULL |ID eines Kommandos (bzw. Programms) mit dem "​Actions"​ abgearbeitet werden können (mögliche Werte : s. [[dstoreproc>​ac_GetCommands_Ad]]). Falls angegeben, werden nur mögliche Status ermittelt, den "​Actions"​ zu diesem Kommando annehmen können.\\ |smallint|5.5.1|
 +|StatusCategoryID|NULL |ID einer Status-Kategorie. Falls angegeben, werden nur die (möglichen) Status beachtet, die dieser Kategorie zugeordnet sind.\\ |tinyint|5.5.1|
 +==== Rückgabe ====
 +
 +=== (parameterunabhängig) ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|CommandID|ID des Kommandos (bzw. Programms), mit dem die "​Action"​ abgearbeitet werden soll.\\ Hinweis : Der Wert "​-1"​ steht für "​beliebiges Kommando",​ bedeutet also quasi : "gilt für alle Kommandos"​.\\ |smallint|5.5.1 |
 +|Status|Ein möglicher Wert, den eine "​Action"​ zur "​CommandID"​ (bzw. zu einem beliebigen Kommando, falls "​CommandID = -1" ist) als Status annehmen kann\\ |integer|5.5.1 |
 +|StatusDescription|Kurz-Beschreibung des "​Status"​\\ |varchar(50)|5.5.1 |
 +|DetailedDescription|Ausführliche Beschreibung des "​Status"​\\ |varchar(255)|5.5.1 |
 +|StatusCategoryID|ID einer Status-Kategorie,​ der "​Status"​ zugeordnet ist\\ |tinyint|5.5.1 |
 +|CategorySortNo|Bestimmt die Reihenfolge von "​StatusCategoryID"​ innerhalb aller Status-Kategorien\\ |tinyint|5.5.1 |
 +|CategoryDescription|Bezeichnung der Kategorie "​StatusCategoryID"​\\ |varchar(100)|5.5.1 |
 +|SortNo|Bestimmt die Reihenfolge von "​Status"​ innerhalb aller Status der Kategorie "​StatusCategoryID"​\\ |smallint|5.5.1 |
 +
 +== Sortierung der Rückgabe ==
 +
 +(parameterunabängige Sortierung)
 +  * CommandID (aufsteigend)
 +  * CategorySortNo (aufsteigend)
 +  * SortNo (aufsteigend)
 +
 +==== 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"​)) ^
 +|-569|Der Benutzer hat kein Ausführungsrecht für die Prozedur|nur indirekt|
 +|-567|Die Prozedur darf z. Zt. nicht ausgeführt werden|nur indirekt|
 +|-566|Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werden|nur indirekt|
 +|-535|Das Datum liegt nicht in der Vergangenheit|nur indirekt|
 +|-530|Der Wert ist nicht konvertierbar|nur indirekt|
 +|-510|Der Benutzer ist nicht registriert|nur indirekt|
 +|-504|Es ist ein Problem aufgetreten,​ das nicht gelöst werden kann, Prozedur wird daher abgebrochen|nur indirekt|
 +|-500|Falsche Parameter|nur indirekt|
 +==== 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 ====
 +
 +|7.0.7 |2015-01-29|Interne Änderung : Datentyp-Erweiterung des "​ReferenceKey"​ [für "​_mi_StartProcedure"​-Aufruf]\\ ​ |
 +|5.5.1 |2008-07-29|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=ac_GetActionStatusValues_Ad|ac_GetActionStatusValues_Ad im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​ac_GetActionStatusValues_Ad'</​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/​ac_GetActionStatusValues_Ad'​ | 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'​),​
 + '​ac_GetActionStatusValues_Ad',​
 + array(
 + // '​CommandID'​ => NULL,
 + // '​StatusCategoryID'​ => 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="​ac_GetActionStatusValues_Ad">​
 + <​Parameters>​
 + <!-- <​Parameter Name="​CommandID">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​StatusCategoryID">​NULL</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/ac_getactionstatusvalues_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)