engine:procedures:co_getcommunityforums_pu
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
|
engine:procedures:co_getcommunityforums_pu [11.01.2016 ] |
engine:procedures:co_getcommunityforums_pu [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== co_GetCommunityForums_Pu ===== | ||
| + | |||
| + | Gibt die Foren einer Community zurück; es wird ebenfalls ausgegeben, welche Rechte das identifizierte Mitglied auf das jeweilige Forum besitzt.\\ | ||
| + | |||
| + | Seit dieser Version ist es erlaubt, keine Identifizierungsdaten ("PersonIdentificationValues = NULL") anzugeben. Es werden dann die Rechte des anonymen Nutzers ("PersonID = 0") ermittelt.\\ | ||
| + | |HTTP-Method|GET | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Tags|{{tag>[co Get Community Forums Pu]}}| | ||
| + | |Engine-Kategorie|communities | | ||
| + | |Engine-Typ|Daten-Ermittlung | | ||
| + | |Letzte Aktualisierung|6.5.4 (2013-04-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 ^ | ||
| + | |__CommunityID__| |ID einer Community\\ |smallint|3.5.4| | ||
| + | |__UniqueID__| |Eindeutige ID eines Besuchers, die dem zu identifizierenden Mitglied aktuell zugeordnet ist. Falls die Identifizierungsdaten zur Person in "SessionManagement" (zu dieser "UniqueID") gespeichert sind, darf "PersonIdentificationValues" auch "NULL" sein.\\ |varchar(50)|3.5.4| | ||
| + | |__PersonIdentificationValues__| |Liste von Werten, die das Mitglied identifizieren. Diese Werte müssen Eigenschaften zu den Merkmal-IDs sein, die in "PersonTypeSettings" zur "PersonTypeID" der "CommunityID" zum Schlüssel "PersonIdentificationIDs" hinterlegt sind.\\ |varchar(255)|3.5.4| | ||
| + | |SeparatorInIdentVals|'¶' |Gibt an, durch welche Zeichenkette die Werte in "PersonIdentificationValues" getrennt sind\\ |varchar(4)|5.5.0| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | === (parameterunabhängig) === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |//SortNo((Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.))//|Wird nicht ausgegeben, sondern nur zur Sortierung der Rückgabemenge verwendet ! Bestimmt die Reihenfolge des Forums "ForumID" innerhalb aller Foren, die der Community "CommunityID" zugeordnet sind\\ |smallint|3.5.8 | | ||
| + | |CommunityID|ID einer Community\\ |smallint|3.5.4 | | ||
| + | |CommunityName|Name der Community "CommunityID"\\ |varchar(100)|3.5.4 | | ||
| + | |ForumID|ID eines Forums, das der Community "CommunityID" zugeordnet ist\\ |smallint|3.5.4 | | ||
| + | |ForumName|Name des Forums "ForumID"\\ |varchar(100)|3.5.4 | | ||
| + | |LanguageID|ID einer Sprache, in der die Beiträge des Forums sind\\ |tinyint|3.5.4 | | ||
| + | |AccessLevel|Zugriffsrechte des identifizierten Mitglieds auf das Forum "ForumID" - enthält eine Summe von "AccessLevelID"s (siehe [[dstoreproc>fo_GetForumAccessLevels]])\\ |smallint|3.5.7 | | ||
| + | |||
| + | == Sortierung der Rückgabe == | ||
| + | |||
| + | (parameterunabängige Sortierung) | ||
| + | * SortNo (absteigend) | ||
| + | |||
| + | ==== Output-Parameter ==== | ||
| + | |||
| + | |CommunityMemberID|Ausgabeparameter für die ID des identifizierten Mitglieds| | ||
| + | ==== Mögliche Return-Codes ==== | ||
| + | |||
| + | ^Code ^Beschreibung ^Quelle ((direkt meint "von der Prozedur selber" und indirekt meint "von intern aufgerufenen Unterprozeduren")) ^ | ||
| + | |-781|Fehlender oder falscher Eintrag in CommunitySettings|nur indirekt| | ||
| + | |-780|Fehlender oder falscher Eintrag in CommunityMemberSettings|nur indirekt| | ||
| + | |-774|Login vorübergehend gesperrt|nur indirekt| | ||
| + | |-773|Login gesperrt|nur indirekt| | ||
| + | |-772|User ist nicht angemeldet|nur indirekt| | ||
| + | |-771|Der Sweeper ist nicht gestartet|nur indirekt| | ||
| + | |-770|Login zur Zeit nicht möglich|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|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 ==== | ||
| + | |||
| + | |6.5.4 |2013-04-29|Datentyp des Parameters "SeparatorInIdentVals" wg. UTF-8 Unterstützung auf "varchar[4]" erweitert\\ | | ||
| + | |5.5.0 |2008-01-07|1. Neue Parameter "CommunityMemberID" und "SeparatorInIdentVals"\\ 2. Ausgabe via "print" im Fehler-Fall "-500" (mit Informationen über die Ursache)\\ 3. Bearbeitung des Quellcodes hinsichtlich neuer Konventionen\\ 4. Diverse interne Änderungen\\ | | ||
| + | |3.5.20 |2002-07-22|\\ | | ||
| + | |3.5.19 |2002-06-17|\\ | | ||
| + | |3.5.11 |2001-09-06|\\ | | ||
| + | |3.5.7 |2001-05-04|\\ | | ||
| + | |3.5.5 |2001-03-30|\\ | | ||
| + | |3.5.4 |2001-03-11|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=co_GetCommunityForums_Pu|co_GetCommunityForums_Pu im Engine Playground öffnen]] | ||
| + | == cURL == | ||
| + | Unformatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/co_GetCommunityForums_Pu?CommunityID=<value>&UniqueID=<value>&PersonIdentificationValues=<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/co_GetCommunityForums_Pu?CommunityID=<value>&UniqueID=<value>&PersonIdentificationValues=<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'), | ||
| + | 'co_GetCommunityForums_Pu', | ||
| + | array( | ||
| + | 'CommunityID' => <value>, | ||
| + | 'UniqueID' => '<value>', | ||
| + | 'PersonIdentificationValues' => '<value>', | ||
| + | // 'SeparatorInIdentVals' => '¶' | ||
| + | ) | ||
| + | ); | ||
| + | |||
| + | $service->execute($request); | ||
| + | |||
| + | $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); | ||
| + | $ResultSet = $xml_result->getRowsAsArray(); | ||
| + | |||
| + | $OutputParams = $xml_result->getOutputParametersAsArray();</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="co_GetCommunityForums_Pu"> | ||
| + | <Parameters> | ||
| + | <Parameter Name="CommunityID"><!-- smallint value --></Parameter> | ||
| + | <Parameter Name="UniqueID"><!-- varchar value --></Parameter> | ||
| + | <Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter> | ||
| + | <!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> --> | ||
| + | </Parameters> | ||
| + | </Procedure> | ||
| + | </Batch> | ||
| + | </ListOfBatches></code> | ||
engine/procedures/co_getcommunityforums_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)