engine:procedures:fo_getpredvalsforcharacs_ad
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
| — |
engine:procedures:fo_getpredvalsforcharacs_ad [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== fo_GetPredValsForCharacs_Ad ===== | ||
| + | |||
| + | Gibt alle vordefinierten Werte eines Posting-Merkmals zurück.\\ | ||
| + | |||
| + | Hintergrund : Zu Forum-Beiträgen können Eigenschaften hinterlegt werden. Diese Eigenschaften gehören immer zu sogenannten Merkmalen (die quasi die Eigenschaften charakterisieren). Bestimmte Merkmale zeichnen sich dadurch aus, daß die Beiträge nur Eigenschaften zugewiesen bekommen können, die in einer Liste von vordefinierten Werten vorkommen.\\ | ||
| + | |||
| + | Anmerkung zur Sortierung der Ergebnismenge :\\ Es wird immer "alphanumerisch" nach "Value" sortiert, es sei denn, es handelt es sich um Datumsangaben.\\ | ||
| + | |HTTP-Method|GET | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Alias|fo_GetPredefinedValuesForPostingCharacteristics_Ad | | ||
| + | |Tags|{{tag>[fo Get Predefined Values For Posting Characteristics Ad]}}| | ||
| + | |Engine-Kategorie|forums | | ||
| + | |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 ^ | ||
| + | |__PostingCharacteristicID__| |ID des Posting-Merkmals, zu dem die vordefinierten Werte zurückgegeben werden sollen. Ist für das angegebene Merkmal nicht "PredefinedValues = 1" konfiguriert (s. Rückgabemenge von [[dstoreproc>pm_GetPostingCharacs_Ad]]), liefert die Prozedur "-500" !\\ |smallint|4.0.16| | ||
| + | |DateFormat|'german' |Bestimmt das Format der Ausgabe von Datums-Werten. Falls "german" oder "germany" (Groß- und Kleinschreibung wird nicht beachtet) übergeben wird, sind Datums-Eigenschaften im Format "Tag-Monat-Jahr", sonst "Monat-Tag-Jahr".\\ |varchar(10)|4.0.16| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | === (parameterunabhängig) === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |Value|Vordefinierter Wert zum Merkmal "PostingCharacteristicID"\\ |varchar(250)|4.0.16 | | ||
| + | |ValueInInternalFormat|Immer "NULL", es sei denn, "Value" ist ein Datums-Wert und es wurde (durch "DateFormat") eine Ausgabe im Format "Tag-Monat-Jahr" gewünscht. (Hintergrund sind Änderungen von vordefinierten Werten durch [[dstoreproc>fo_ModifyPredValsForCharacs_Ad]].)\\ |varchar(250)|4.0.16 | | ||
| + | |||
| + | == Sortierung der Rückgabe == | ||
| + | |||
| + | (parameterunabängige Sortierung) | ||
| + | * Value (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| | ||
| + | |-502|Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)|nur indirekt| | ||
| + | |-500|Falsche Parameter|direkt und 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]\\ | | ||
| + | |6.5.3 |2013-03-18|Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung\\ | | ||
| + | |4.0.16 |2004-08-31|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=fo_GetPredValsForCharacs_Ad|fo_GetPredValsForCharacs_Ad im Engine Playground öffnen]] | ||
| + | == cURL == | ||
| + | Unformatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/fo_GetPredValsForCharacs_Ad?PostingCharacteristicID=<value>'</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/fo_GetPredValsForCharacs_Ad?PostingCharacteristicID=<value>' | 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'), | ||
| + | 'fo_GetPredValsForCharacs_Ad', | ||
| + | array( | ||
| + | 'PostingCharacteristicID' => <value>, | ||
| + | // 'DateFormat' => 'german' | ||
| + | ) | ||
| + | ); | ||
| + | |||
| + | $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="fo_GetPredValsForCharacs_Ad"> | ||
| + | <Parameters> | ||
| + | <Parameter Name="PostingCharacteristicID"><!-- smallint value --></Parameter> | ||
| + | <!-- <Parameter Name="DateFormat">'german'</Parameter> --> | ||
| + | </Parameters> | ||
| + | </Procedure> | ||
| + | </Batch> | ||
| + | </ListOfBatches></code> | ||
engine/procedures/fo_getpredvalsforcharacs_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)