Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
— |
engine:procedures:co_getlostpasswordquestion_pu [11.01.2016 ] (aktuell) |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
+ | ===== co_GetLostPasswordQuestion_Pu ===== | ||
+ | |||
+ | Gibt die Frage zurück, die gestellt werden soll, wenn ein Community-Mitglied sein Paßwort vergessen hat. Dabei handelt es sich um die Eigenschaft zu dem in "CommunitySettings" zum Schlüssel "QuestionCharacterisicID" angegebenen Merkmal.\\ | ||
+ | |||
+ | Anmerkung : Eine evtl. konfigurierte Zugriffsbeschränkung (s. [[dstoreproc>pm_GetPChAccRestrForUsers_Ad]]) für das Identifizierungs-Merkmal ("Nickname"-Merkmal) oder für das "Frage"-Merkmal wird bewußt NICHT beachtet (denn das widerspräche ja der gewünschten Funktionalität dieser Prozedur).\\ | ||
+ | |HTTP-Method|GET | | ||
+ | |HTTP-Auth|Optional | | ||
+ | |Tags|{{tag>[co Get Lost Password Question Pu]}}| | ||
+ | |Engine-Kategorie|communities | | ||
+ | |Engine-Typ|Daten-Ermittlung | | ||
+ | |Letzte Aktualisierung|6.5.4 (2013-04-29)| | ||
+ | |||
+ | ==== Parameter ==== | ||
+ | |||
+ | |__CommunityID__| |ID einer Community\\ |smallint|3.5.0| | ||
+ | |__Nickname__| |"Nickname" des Mitglieds, das sein Paßwort vergessen hat. Mitglieder werden innerhalb der Community durch den "Nickname" eindeutig identifiziert. Die ID des zugehörigen Merkmals steht in "CommunitySettings" (zum Schlüssel "IdentifyingCharacteristicID").\\ |varchar(100)|3.5.0| | ||
+ | |CaseSensitive|0 |Ist der "Nickname" genau oder bis auf Groß- und Kleinschreibung richtig angegeben ? (Hintergrund für diesen Parameter ist eine höhere Performance beim Identifizierungsvorgang, wenn case-sensitiv gesucht werden kann !)\\ |bit|3.5.8| | ||
+ | ==== Rückgabe ==== | ||
+ | |||
+ | === (parameterunabhängig) === | ||
+ | |||
+ | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
+ | |Question|Enthält die Frage, auf die das Mitglied "Nickname" die richtige Antwort angeben muß, um sein Paßwort genannt zu bekommen. Dabei handelt es sich um die Eigenschaft zum Merkmal "QuestionCharacteristicID" aus "CommunitySettings".\\ |varchar(100)|3.5.0 | | ||
+ | |Nickname_CaseSensitive|Hier steht der übergebene "Nickname", falls "CaseSensitive = 1" übergeben wurde, ansonsten der hinsichtlich Groß- und Kleinschreibung korrigierte "Nickname"\\ |varchar(100)|4.0.0 | | ||
+ | ==== Output-Parameter ==== | ||
+ | |||
+ | |Question|In Version 3.5.2 entfernt !| | ||
+ | ==== 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| | ||
+ | |-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.5.4 |2013-04-29|1. Hinweis in der Doku, daß bewusst NICHT eine evtl. konfigurierte Zugriffsbeschränkung für das "Nickname"- oder das "Frage"-Merkmal beachtet wird (widerspräche der gewünschten Funktionalität)\\ 2. Anpassungen des Quellcodes an den aktuellen Standard\\ | | ||
+ | |4.0.0 |2003-04-03|1. Die Logik von "CaseSensitive" war vertauscht !\\ 2. Neue Rückgabespalte "Nickname_CaseSensitive"\\ | | ||
+ | |3.5.8 |2001-05-19|\\ | | ||
+ | |3.5.2 |2001-01-28|\\ | | ||
+ | |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=co_GetLostPasswordQuestion_Pu|co_GetLostPasswordQuestion_Pu im Engine Playground öffnen]] | ||
+ | == cURL == | ||
+ | Unformatierte Ausgabe: | ||
+ | <code bash> | ||
+ | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/co_GetLostPasswordQuestion_Pu?CommunityID=<value>&Nickname=<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_GetLostPasswordQuestion_Pu?CommunityID=<value>&Nickname=<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_GetLostPasswordQuestion_Pu', | ||
+ | array( | ||
+ | 'CommunityID' => <value>, | ||
+ | 'Nickname' => '<value>', | ||
+ | // 'CaseSensitive' => 0 | ||
+ | ) | ||
+ | ); | ||
+ | |||
+ | $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_GetLostPasswordQuestion_Pu"> | ||
+ | <Parameters> | ||
+ | <Parameter Name="CommunityID"><!-- smallint value --></Parameter> | ||
+ | <Parameter Name="Nickname"><!-- varchar value --></Parameter> | ||
+ | <!-- <Parameter Name="CaseSensitive">0</Parameter> --> | ||
+ | </Parameters> | ||
+ | </Procedure> | ||
+ | </Batch> | ||
+ | </ListOfBatches></code> | ||