Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:fo_modifypostingbinary_pu

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:fo_modifypostingbinary_pu [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== fo_ModifyPostingBinary_Pu =====
 +
 +Ändert bestimmte Einstellungen eines "​Binaries"​ zu einem Forum-Beitrag.\\ ​
 +
 +Ändern kann man derzeit die "​Description"​ und die "​SortNo"​ eines "​Posting-Binaries"​.\\ ​
 +
 +Selbstverständlich werden immer die Rechte, die die durch "​PersonIdentificationValues",​ "​PersonTypeID"​ und "​UniqueID"​ identifizierte Person hat, für das Forum von "​PostingID"​ überprüft. Falls die Identifizierung fehlschlägt,​ werden die Rechte für die anonyme Person (mit der speziellen "​PersonID = 0") gecheckt.\\ ​
 +
 +Folgende Rechte werden benötigt :\\ 
 +
 +Um Binärdaten zu einem Posting bearbeiten zu dürfen, muß man entweder die Berechtigung "​8"​ (bearbeiten eigener Postings) oder "​512"​ (bearbeiten aller Postings) oder "​2048"​ (bearbeiten aller Postings ohne Änderung des Autors) haben.\\ ​
 +|HTTP-Method|POST |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[fo Modify Posting Binary 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)|5.1.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|5.1.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)|5.1.0|
 +|__PostingID__| |ID eines Beitrags, zu dem das "​SortNoOfBinaryToModify"​-te "​Binary"​ modifiziert werden soll\\ |integer|5.1.0|
 +|__SortNoOfBinaryToModify__| |Pro Beitrag kann es mehrere "​Binaries"​ geben, die durch eine "​SortNo"​ eindeutig referenziert werden. In diesem Parameter gibt man daher an, welches "​Binary"​ zur "​PostingID"​ geändert werden soll.\\ |tinyint|5.1.0|
 +|__NewDescription__| |Die "​Description"​ des "​Binaries"​ wird durch den hier angegebenen Wert ersetzt - "​NULL"​ ist ebenfalls erlaubt (somit wird die Beschreibung quasi gelöscht)\\ |varchar(255)|5.1.0|
 +|MoveSortNo|0 |Da die "​SortNo"​ pro "​PostingID"​ EINDEUTIG ein "​Binary"​ identifiziert,​ kann man nur eine RELATIVE Änderung angeben. "​-2"​für diesen Parameter bedeutet z.B., daß die aktuelle "​SortNo"​ (nämlich "​SortNoOfBinaryToModify"​) um "​2"​ erniedrigt wird.\\ |smallint|5.1.0|
 +|PostingBinaryIdentifier|NULL |Wert, der das "​Binary"​ EINDEUTIG referenziert. Bei "​NULL"​ wird dieser Wert NICHT geändert, bei Angaben von %%''​%% wird er gelöscht.\\ |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|
 +|-808|Keine Berechtigung zum Abschließen eines Postings|nur direkt|
 +|-804|Keine Berechtigung zum Bearbeiten des Postings|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|Neuer Parameter "​PostingBinaryIdentifier"​\\ ​ |
 +|5.1.2 |2006-06-26|Fehler : Bei Änderung der "​SortNo"​ bekamen ALLE "​Binaries",​ deren "​SortNo"​ aufgrund der Änderung korrigiert werden mußte, "​NewDescription"​ als "​Description"​ zugewiesen !\\  |
 +|5.1.0 |2006-02-08|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_ModifyPostingBinary_Pu|fo_ModifyPostingBinary_Pu im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X POST  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​fo_ModifyPostingBinary_Pu?​PersonIdentificationValues=<​value>&​PersonTypeID=<​value>&​UniqueID=<​value>&​PostingID=<​value>&​SortNoOfBinaryToModify=<​value>&​NewDescription=<​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_ModifyPostingBinary_Pu?​PersonIdentificationValues=<​value>&​PersonTypeID=<​value>&​UniqueID=<​value>&​PostingID=<​value>&​SortNoOfBinaryToModify=<​value>&​NewDescription=<​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_ModifyPostingBinary_Pu',​
 + array(
 + '​PersonIdentificationValues'​ => '<​value>',​
 + '​PersonTypeID'​ => <​value>,​
 + '​UniqueID'​ => '<​value>',​
 + '​PostingID'​ => <​value>,​
 + '​SortNoOfBinaryToModify'​ => <​value>,​
 + '​NewDescription'​ => '<​value>',​
 + // '​MoveSortNo'​ => 0,
 + // '​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_ModifyPostingBinary_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="​SortNoOfBinaryToModify"><​!-- tinyint value --></​Parameter>​
 + <​Parameter Name="​NewDescription"><​!-- varchar value --></​Parameter>​
 + <!-- <​Parameter Name="​MoveSortNo">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​PostingBinaryIdentifier">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​SeparatorInIdentVals">'​¶'</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/fo_modifypostingbinary_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)