engine:procedures:fo_insertbinaryforposting_pu
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
| — |
engine:procedures:fo_insertbinaryforposting_pu [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== fo_InsertBinaryForPosting_Pu ===== | ||
| + | |||
| + | Fügt einem Foren-Beitrag ein Binärobjekt hinzu. Das "Binary" selbst ist der Prozedur über "tempdb.dbo.ImageData" zu übergeben.\\ | ||
| + | |||
| + | Selbstverständlich werden immer die Rechte, die die durch "PersonIdentificationValues", "PersonTypeID" und "UniqueID" identifizierte Person hat, für das Forum "ForumID" überprüft. Falls die Identifizierung fehlschlägt, werden die Rechte für die anonyme Person (mit der speziellen "PersonID = 0") gecheckt :\\ (i) Um Binärdaten zu einem beliebigen Posting hinzufügen zu dürfen, muß man entweder die Berechtigung "512" (bearbeiten aller Postings) oder "2048" (bearbeiten aller Postings ohne Änderung des Autors) haben.\\ (ii) Um Binärdaten zu eigenen Beiträgen (d.h. die ID der identifizierten Person entspricht der ID des Autors) hinzufügen zu dürfen, ist eines der folgenden Rechte erforderlich : | ||
| + | * "2" (antworten auf bestehendes Posting) | ||
| + | * "4" (eröffnen eines neuen Threads) | ||
| + | * "8" (bearbeiten eigener Postings) | ||
| + | |||
| + | |HTTP-Method|POST | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Tags|{{tag>[fo Insert Binary For Posting Pu]}}| | ||
| + | |Engine-Kategorie|forums | | ||
| + | |Engine-Typ|Daten-Änderung | | ||
| + | |Letzte Aktualisierung|6.5.3 (2013-03-18)| | ||
| + | |||
| + | ==== 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| | ||
| + | |__PostingID__| |ID eines Postings, zu dem ein Binärobjekt hinterlegt werden soll\\ |integer|3.5.0| | ||
| + | |__ContentType__| |Das Format des "Binaries" (z.B. "gif" oder "jpg").\\ |varchar(100)|3.5.0| | ||
| + | |__Filename__| |Dateiname des Binärobjektes\\ |varchar(100)|3.5.0| | ||
| + | |__Description__| |Beschreibung zum Binärobjekt\\ |varchar(255)|3.5.0| | ||
| + | |PostingBinaryIdentifier|NULL |Optional kann hier ein Wert angegeben werden, der das neue "Binary" EINDEUTIG (innerhalb aller "Binaries" zur "PostingID") referenziert\\ |varchar(100)|5.1.6| | ||
| + | |SeparatorInIdentVals|'¶' |Gibt an, durch welche Zeichen die Werte in "PersonIdentificationValues" getrennt sind\\ |varchar(4)|5.5.0| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | Die Prozedur hat keine Rückgaben. | ||
| + | ==== 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")) ^ | ||
| + | |-816|Der Beitrag besitzt bereits ein "Binary" mit dem angegebenen "PostingBinaryIdentifier"|nur direkt| | ||
| + | |-811|Keine Berechtigung Binärdaten in Postings einzufügen|nur direkt| | ||
| + | |-810|Keine Berechtigung Binärdaten in eigenes Posting einzufügen|nur direkt| | ||
| + | |-807|Es sind zu viele Binaries zu dem Posting vorhanden|nur direkt| | ||
| + | |-806|Filesize ist zu groß|nur direkt| | ||
| + | |-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.3 |2013-03-18|Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung\\ | | ||
| + | |5.5.0 |2008-01-07|1. Neuer Parameter "SeparatorInIdentVals"\\ 2. Ausgabe an die Standard-Ausgabe [via "print"] im Fehler-Fall "-500", die nähere Informationen über die Ursache enthält\\ 3. Bearbeitung des Quellcodes hinsichtlich neuer Konventionen\\ | | ||
| + | |5.1.6 |2006-09-14|1. Die Tabelle "PostingBinaries" hat zwei neue Spalten bekommen => entsprechende Änderungen\\ 2. Neuer Parameter "PostingBinaryIdentifier"\\ | | ||
| + | |5.1.0 |2006-02-08|1. Man darf jetzt auch ein "Binary" hinzufügen, wenn man über das Recht "bearbeiten aller Postings ohne Änderung des Autors" [ID 2048] verfügt\\ 2. Fehlender Hinweis in der Doku, welche Rechte benötigt werden\\ | | ||
| + | |3.5.21 |2002-08-06|\\ | | ||
| + | |3.5.6 |2001-04-17|\\ | | ||
| + | |3.5.1 |2000-12-20|\\ | | ||
| + | |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_InsertBinaryForPosting_Pu|fo_InsertBinaryForPosting_Pu im Engine Playground öffnen]] | ||
| + | == cURL == | ||
| + | Unformatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/fo_InsertBinaryForPosting_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<value>&PostingID=<value>&ContentType=<value>&Filename=<value>&Description=<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 POST 'http://<partner>-<project>.dstore.de/default/engine/fo_InsertBinaryForPosting_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<value>&PostingID=<value>&ContentType=<value>&Filename=<value>&Description=<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_InsertBinaryForPosting_Pu', | ||
| + | array( | ||
| + | 'PersonIdentificationValues' => '<value>', | ||
| + | 'PersonTypeID' => <value>, | ||
| + | 'UniqueID' => '<value>', | ||
| + | 'PostingID' => <value>, | ||
| + | 'ContentType' => '<value>', | ||
| + | 'Filename' => '<value>', | ||
| + | 'Description' => '<value>', | ||
| + | // 'PostingBinaryIdentifier' => NULL, | ||
| + | // '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_InsertBinaryForPosting_Pu"> | ||
| + | <Parameters> | ||
| + | <Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter> | ||
| + | <Parameter Name="PersonTypeID"><!-- tinyint value --></Parameter> | ||
| + | <Parameter Name="UniqueID"><!-- varchar value --></Parameter> | ||
| + | <Parameter Name="PostingID"><!-- integer value --></Parameter> | ||
| + | <Parameter Name="ContentType"><!-- varchar value --></Parameter> | ||
| + | <Parameter Name="Filename"><!-- varchar value --></Parameter> | ||
| + | <Parameter Name="Description"><!-- varchar value --></Parameter> | ||
| + | <!-- <Parameter Name="PostingBinaryIdentifier">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> --> | ||
| + | </Parameters> | ||
| + | </Procedure> | ||
| + | </Batch> | ||
| + | </ListOfBatches></code> | ||
engine/procedures/fo_insertbinaryforposting_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)