engine:procedures:fo_getpostingsofoneperson_ad
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
| — |
engine:procedures:fo_getpostingsofoneperson_ad [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== fo_GetPostingsOfOnePerson_Ad ===== | ||
| + | |||
| + | Liefert Foren-Beiträge einer bestimmten Person zurück.\\ | ||
| + | |HTTP-Method|GET | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Tags|{{tag>[fo Get Postings Of One Person 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 ^ | ||
| + | |__PersonID__| |ID einer Person, zu der man sich Foren-Beiträge ausgeben lassen möchte\\ |integer|3.5.8| | ||
| + | |ForumID|NULL |ID eines Forums. Wenn angegeben, werden nur Beiträge von "PersonID" in diesem Forum ermittelt.\\ |smallint|3.5.8| | ||
| + | |FromDate|NULL |Falls angegeben, werden nur Beiträge berücksichtigt, die NACH diesem Datum verfaßt wurden\\ |datetime|3.5.8| | ||
| + | |ToDate|NULL |Falls angegeben, werden nur Beiträge berücksichtigt, die VOR diesem Datum verfaßt wurden\\ |datetime|3.5.8| | ||
| + | |IncludeBodies|1 |Gibt an, ob in der Rückgabemenge auch der "Body" (d.h. der Beitrag selbst) des jeweiligen Postings ausgegeben werden soll\\ |bit|3.5.8| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | === (parameterunabhängig) === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |ForumID|ID eines Forums, in dem der Beitrag "PostingID" verfaßt wurde\\ |smallint|3.5.8 | | ||
| + | |ForumName|Name des Forums "ForumID"\\ |varchar(100)|3.5.8 | | ||
| + | |PostingID|ID eines Beitrags, der von "PersonID" geschrieben wurde\\ |integer|3.5.8 | | ||
| + | |PostDate|Datum des Beitrags "PostingID"\\ |datetime|3.5.8 | | ||
| + | |PostDate_char|"PostDate" als String im Format : "15.03.2001 20:48:13"\\ |varchar(19)|3.5.8 | | ||
| + | |ReplyToPostingID|ID des Postings, auf das "PostingID" eine Antwort darstellt. Falls gleich "PostingID", handelt es sich um einen Haupt-Beitrag, sprich "MainPosting"\\ |integer|3.5.8 | | ||
| + | |MainPostingID|ID des Haupt-Beitrages zu "PostingID" (also sozusagen das Wurzel-Element des gesamten "Threads" zu dem "PostingID" gehört)\\ |integer|3.5.8 | | ||
| + | |Visible|Sichtbarkeits-Status des Postings "PostingID" - mögliche Werte : siehe [[dstoreproc>fo_GetPostingVisibilities]]\\ |tinyint|3.5.8 | | ||
| + | |Author|Name des Verfassers ("PersonID") des Beitrags "PostingID", also die Eigenschaft(en) des Autors "PersonID" zu der (den) Merkmal-ID(s), die in "ForumSettings" zum Schlüssel "CharacteristicIDsForAuthor_<PersonTypeID von PersonID>" hinterlegt ist (sind)\\ |varchar(100)|3.5.8 | | ||
| + | |EMailOfAuthor|eMail des Verfassers "Author"\\ |varchar(100)|3.5.8 | | ||
| + | |Subject|Der Titel des Beitrags "PostingID"\\ |varchar(255)|3.5.8 | | ||
| + | |Body|Der Beitrag selbst - immer "NULL" falls "IncludeBodies = 0" oder wenn "SmallBody" NICHT "NULL" ist\\ |text|3.5.8 | | ||
| + | |SmallBody|Hier erscheint der Beitrag selbst, falls er weniger als 256 Zeichen enthält UND "UseSmallBody" in "ForumSettings" auf "1" gesetzt UND "IncludeBodies = 1" ist. D.h. mindestens EINE der Rückgabespalten "SmallBody" und "Body" ist IMMER "NULL".\\ |varchar(255)|3.5.17 | | ||
| + | |||
| + | == Sortierung der Rückgabe == | ||
| + | |||
| + | (parameterunabängige Sortierung) | ||
| + | * ForumID (aufsteigend) | ||
| + | * PostDate (absteigend) | ||
| + | |||
| + | ==== 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]\\ | | ||
| + | |4.0.10 |2004-03-15|1. Aufruf der Prozeduren "_mi_StartProcedure" und "_mi_FinishProcedure"\\ 2. Ausführen von "set transaction isolation level 1" und "set rowcount 0" zu Beginn der Prozedur\\ | | ||
| + | |3.5.17 |2002-05-02|\\ | | ||
| + | |3.5.10 |2001-07-14|\\ | | ||
| + | |3.5.8 |2001-05-19|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_GetPostingsOfOnePerson_Ad|fo_GetPostingsOfOnePerson_Ad im Engine Playground öffnen]] | ||
| + | == cURL == | ||
| + | Unformatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/fo_GetPostingsOfOnePerson_Ad?PersonID=<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_GetPostingsOfOnePerson_Ad?PersonID=<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_GetPostingsOfOnePerson_Ad', | ||
| + | array( | ||
| + | 'PersonID' => <value>, | ||
| + | // 'ForumID' => NULL, | ||
| + | // 'FromDate' => NULL, | ||
| + | // 'ToDate' => NULL, | ||
| + | // 'IncludeBodies' => 1 | ||
| + | ) | ||
| + | ); | ||
| + | |||
| + | $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_GetPostingsOfOnePerson_Ad"> | ||
| + | <Parameters> | ||
| + | <Parameter Name="PersonID"><!-- integer value --></Parameter> | ||
| + | <!-- <Parameter Name="ForumID">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="FromDate">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="ToDate">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="IncludeBodies">1</Parameter> --> | ||
| + | </Parameters> | ||
| + | </Procedure> | ||
| + | </Batch> | ||
| + | </ListOfBatches></code> | ||
engine/procedures/fo_getpostingsofoneperson_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)