engine:procedures:fo_getforums_pu
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
|
engine:procedures:fo_getforums_pu [11.01.2016 ] |
engine:procedures:fo_getforums_pu [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== fo_GetForums_Pu ===== | ||
| + | |||
| + | Gibt für eine Person eine Liste der Foren aus, auf die sie (mindestens) lesenden Zugriff besitzt. Falls die Identifizierung fehlschlägt oder in "UniqueID" der Wert "defaultUniqueID" angegeben wird, werden die Foren ausgegeben, auf die die anonyme Person ("PersonID = 0") Zugriff hat.\\ | ||
| + | |||
| + | Hinweis : Es werden (seit Version 4.0.4) maximal 255 Datensätze zurückgegeben !\\ | ||
| + | |HTTP-Method|GET | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Tags|{{tag>[fo Get Forums Pu]}}| | ||
| + | |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 ^ | ||
| + | |__PersonIdentificationValues__| |Liste von Werten, die den Forum-Teilnehmer identifizieren. Diese Werte müssen Eigenschaften zu den Merkmal-IDs sein, die in "PersonTypeSettings" zur "PersonTypeID" zum Schlüssel "PersonIdentificationIDs" hinterlegt sind.\\ |varchar(255)|3.5.0| | ||
| + | |__PersonTypeID__| |ID des Personen-Typs dem der zu identifizierende Forum-Teilnehmer angehört. Dieser muß bei einer Identifizierung immer mit angegeben werden, da die Merkmale zur Identifizierung pro Personentyp variieren können.\\ |tinyint|3.5.0| | ||
| + | |__UniqueID__| |Eindeutige ID eines Besuchers, die dem zu identifizierenden Forum-Teilnehmer aktuell zugeordnet ist. Falls die Identifizierungsdaten zur Person in "SessionManagement" (zur "UniqueID") gespeichert sind, darf "PersonIdentificationValues" "NULL" sein.\\ |varchar(50)|3.5.0| | ||
| + | |ForumID|NULL |ID eines Forums. Wird "NULL" angegeben, gibt die Prozedur alle Foren zurück, auf die die identifizierte Person (mindestens) lesenden Zugriff hat (bzw. alle Foren für die als Sprache "LanguageID" definiert ist).\\ |smallint|3.5.0| | ||
| + | |LanguageID|NULL |ID einer Sprache. Optionale Filterung der Foren nach einer Sprache, in der die Beiträge verfaßt sind (oder verfaßt sein sollten...).\\ |tinyint|3.5.0| | ||
| + | |ForumCategoryIDList|NULL |Liste (durch '¶' getrennt) von "ForumCategoryID"s (Forum-Kategorien). Falls angegeben, werden nur Foren berücksichtigt, die wenigstens einer der hier angegebenen Kategorien zugeordnet sind\\ |varchar(255)|4.0.4| | ||
| + | |GetCategoryInformation|0 |"1" angeben, um in der Rückgabemenge zusätzliche Informationen bzgl. Forum-Kategorien zu erhalten\\ |bit|4.0.4| | ||
| + | |SeparatorInIdentVals|'¶' |Gibt an, durch welche Zeichen die Werte in "PersonIdentificationValues" getrennt sind\\ |varchar(4)|5.5.0| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | === wenn GetCategoryInformation = 0 === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |ForumID|ID eines vorhandenen Forums (bzw. gleich der "ForumID"), auf das die identifizierte Person (mindestens) lesenden Zugriff hat\\ |smallint|3.5.0 | | ||
| + | |ForumName|Name des Forums "ForumID"\\ |varchar(100)|3.5.0 | | ||
| + | |LanguageID|ID einer Sprache, die für das Forum "ForumID" hinterlegt ist. Sie gibt an, in welcher Sprache die Beiträge dieses Forums verfaßt sind (bzw. verfaßt sein sollten...).\\ |tinyint|3.5.0 | | ||
| + | |Language|Bezeichnung der Sprache "LanguageID"\\ |varchar(50)|3.5.0 | | ||
| + | |||
| + | == Sortierung der Rückgabe == | ||
| + | |||
| + | (parameterunabängige Sortierung) | ||
| + | * ForumID (aufsteigend) | ||
| + | |||
| + | === wenn GetCategoryInformation = 1 === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |ForumID|ID eines vorhandenen Forums (bzw. gleich der "ForumID"), auf das die identifizierte Person (mindestens) lesenden Zugriff hat\\ |smallint|4.0.4 | | ||
| + | |ForumName|Name des Forums "ForumID"\\ |varchar(100)|4.0.4 | | ||
| + | |LanguageID|ID einer Sprache, die für das Forum "ForumID" hinterlegt ist. Sie gibt an, in welcher Sprache die Beiträge dieses Forums verfaßt sind (bzw. verfaßt sein sollten...).\\ |tinyint|4.0.4 | | ||
| + | |Language|Bezeichnung der Sprache "LanguageID"\\ |varchar(50)|4.0.4 | | ||
| + | |ForumCategoryID|ID einer Forum-Kategorie, der "ForumID" zugeordnet ist. Wurde "ForumCategoryIDList" angegeben, steht hier "NULL" oder eine übergebene ID. (Hinweis : Ein Forum kann theoretisch in mehreren Kategorien sein !)\\ |smallint|4.0.4 | | ||
| + | |SortNo|Bestimmt die Reihenfolge von "ForumID" innerhalb aller Foren, die "ForumCategoryID" zugeordnet sind\\ |tinyint|4.0.4 | | ||
| + | |CategoryDescription|Bezeichnung der Kategorie "ForumCategoryID"\\ |varchar(100)|4.0.4 | | ||
| + | |PredecessorCategoryID|ID einer Forum-Kategorie, die "ForumCategoryID" übergeordnet ist. Es kann hier der gleiche Wert wie "ForumCategoryID" stehen, dann handelt es sich um eine sogenannte "Hauptkategorie" (der keine Kategorie übergeordnet ist).\\ |smallint|4.0.4 | | ||
| + | |||
| + | == Sortierung der Rückgabe == | ||
| + | |||
| + | (parameterunabängige Sortierung) | ||
| + | * PredecessorCategoryID (aufsteigend) | ||
| + | * SortNo (aufsteigend) | ||
| + | * ForumID (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")) ^ | ||
| + | |-801|Kein lesender Zugriff auf das Forum|nur direkt| | ||
| + | |-800|Kein Zugriff auf das Forum|nur indirekt| | ||
| + | |-660|Identifikation fehlgeschlagen|nur indirekt| | ||
| + | |-621|Fehlender oder falscher Eintrag in PersonTypeSettings|nur indirekt| | ||
| + | |-602|Zur defaultUniqueID ("VisitorID = -2") können keinerlei Daten gespeichert oder verändert werden|nur indirekt| | ||
| + | |-599|Lizenz ist ungültig oder abgelaufen|nur indirekt| | ||
| + | |-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| | ||
| + | |-550|Fehlender oder falscher Eintrag in Settings|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|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|"Start-/Finish-Procedure"-Logik eingebaut, s. Ticket #3670\\ | | ||
| + | |6.5.3 |2013-03-18|Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung\\ | | ||
| + | |6.5.0 |2012-09-17|Holger Wies : Wird in "UniqueID" die "DefaultUniqueID" angegeben, wird nun [ohne Aufruf von\\ [[dstoreproc>pm_CheckPersonIdentity_Pu]]] der Aufrufer als "anonyme Person" ["PersonID = 0"] identifiziert\\ | | ||
| + | |5.5.0 |2008-01-07|1. Neuer Parameter "SeparatorInIdentVals"\\ 2. Bearbeitung des Quellcodes hinsichtlich neuer Konventionen\\ | | ||
| + | |5.1.4 |2006-08-14|1. Konsequente Fehlerbehandlung\\ 2. Explizites "ORDER BY" eingefügt, um die Sortierung der Rückgabemenge zu garantieren\\ | | ||
| + | |4.0.13 |2004-05-18|Interner Fehler, falls "ForumCategoryIDList" angegeben wurde => es gab immer ein leeres Ergebnis\\ | | ||
| + | |4.0.4 |2003-08-26|1. Diverse interne Änderungen\\ 2. Neue Parameter "ForumCategoryIDList" und "GetCategoryInformation"\\ | | ||
| + | |4.0.0 |2003-04-03|Falls eine "ForumID" angegeben wurde, war die Rückgabespalte für die "ForumID" nicht benannt !\\ | | ||
| + | |3.5.22 |2002-08-30|\\ | | ||
| + | |3.5.21 |2002-08-06|\\ | | ||
| + | |3.5.19 |2002-06-17|\\ | | ||
| + | |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=fo_GetForums_Pu|fo_GetForums_Pu im Engine Playground öffnen]] | ||
| + | == cURL == | ||
| + | Unformatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/fo_GetForums_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<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_GetForums_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<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_GetForums_Pu', | ||
| + | array( | ||
| + | 'PersonIdentificationValues' => '<value>', | ||
| + | 'PersonTypeID' => <value>, | ||
| + | 'UniqueID' => '<value>', | ||
| + | // 'ForumID' => NULL, | ||
| + | // 'LanguageID' => NULL, | ||
| + | // 'ForumCategoryIDList' => NULL, | ||
| + | // 'GetCategoryInformation' => 0, | ||
| + | // 'SeparatorInIdentVals' => '¶' | ||
| + | ) | ||
| + | ); | ||
| + | |||
| + | $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_GetForums_Pu"> | ||
| + | <Parameters> | ||
| + | <Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter> | ||
| + | <Parameter Name="PersonTypeID"><!-- tinyint value --></Parameter> | ||
| + | <Parameter Name="UniqueID"><!-- varchar value --></Parameter> | ||
| + | <!-- <Parameter Name="ForumID">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="LanguageID">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="ForumCategoryIDList">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="GetCategoryInformation">0</Parameter> --> | ||
| + | <!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> --> | ||
| + | </Parameters> | ||
| + | </Procedure> | ||
| + | </Batch> | ||
| + | </ListOfBatches></code> | ||
engine/procedures/fo_getforums_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)