Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
— |
engine:procedures:co_modifybinarycategories_ad [11.01.2016 ] (aktuell) |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
+ | ===== co_ModifyBinaryCategories_Ad ===== | ||
+ | |||
+ | Prozedur zur Verwaltung von Kategorien von Binärobjekten in einer Community\\ | ||
+ | |HTTP-Method|POST | | ||
+ | |HTTP-Auth|Optional | | ||
+ | |Tags|{{tag>[co Modify Binary Categories Ad]}}| | ||
+ | |Engine-Kategorie|configurations | | ||
+ | |Engine-Typ|Daten-Änderung | | ||
+ | |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 ^ | ||
+ | |CommunityBinaryCategoryID|NULL |ID einer Kategorie von Binärobjekten in der Community (z.B. für den "Steckbrief" eines Mitglieds), die geändert oder gelöscht (je nach "DeleteBinaryCategory") werden soll - wird "NULL" übergeben, legt die Prozedur eine neue Kategorie an.\\ |smallint|3.5.0| | ||
+ | |__CommunityID__| |ID einer Community\\ |smallint|3.5.0| | ||
+ | |__CommunityBinaryCategory__| |Bezeichnung der Kategorie\\ |varchar(100)|3.5.0| | ||
+ | |__SortNo__| |Bestimmt die Reihenfolge der Kategorie "CommunityBinaryCategoryID" innerhalb aller Kategorien der Community "CommunityID"\\ |smallint|3.5.0| | ||
+ | |AccessLevel|1 |Summe der "AccessLevelID"s, die den (lesenden und schreibenden) Zugriff auf die Binärobjekte eines anderen Community-Mitglieds innerhalb dieser Kategorie regeln (siehe auch [[dstoreproc>co_GetBinaryCategories_Ad]] und [[dstoreproc>co_GetBinaryCatAccessLevels]])\\ |smallint|3.5.0| | ||
+ | |BinaryQuotaInKB|5120 |Maximaler Speicherplatz in KiloBytes, den ein Mitglied mit "Binaries" innerhalb dieser Kategorie belegen darf. Gespeichert wird der Wert in "CommunitySettings" zum Schlüssel "sys_BinaryQuotaInKB_<CommunityBinaryCategoryID>".\\ |integer|3.5.0| | ||
+ | |MaxNumberOfBinaries|100 |Maximale Anzahl von Binärobjekten, die ein Mitglied mit "Binaries" innerhalb dieser Kategorie belegen darf. Gespeichert wird der Wert in "CommunitySettings" zum Schlüssel "sys_MaxNumberOfBinaries_<CommunityBinaryCategoryID>".\\ |smallint|3.5.0| | ||
+ | |DeleteBinaryCategory|0 |Nur relevant, wenn eine "CommunityBinaryCategoryID" angegeben wird.\\ "0" : Ändern der vorhandenen Kategorie\\ "1" : Löschen der Kategorie\\ |bit|3.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")) ^ | ||
+ | |-781|Fehlender oder falscher Eintrag in CommunitySettings|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| | ||
+ | |-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 ==== | ||
+ | |||
+ | |7.0.7 |2015-01-29|Interne Änderung : Datentyp-Erweiterung des "ReferenceKey" [für "_mi_StartProcedure"-Aufruf]\\ | | ||
+ | |6.5.4 |2013-04-29|Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung\\ | | ||
+ | |4.0.10 |2004-03-15|1. Aufruf der Prozeduren "_mi_StartProcedure", "_mi_FinishProcedure" und "_mi_ChooseParamValueSeperator" \\ 2. Ausführen von "set transaction isolation level 1" und "set rowcount 0" zu Beginn der Prozedur\\ | | ||
+ | |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_ModifyBinaryCategories_Ad|co_ModifyBinaryCategories_Ad im Engine Playground öffnen]] | ||
+ | == cURL == | ||
+ | Unformatierte Ausgabe: | ||
+ | <code bash> | ||
+ | curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/co_ModifyBinaryCategories_Ad?CommunityID=<value>&CommunityBinaryCategory=<value>&SortNo=<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/co_ModifyBinaryCategories_Ad?CommunityID=<value>&CommunityBinaryCategory=<value>&SortNo=<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_ModifyBinaryCategories_Ad', | ||
+ | array( | ||
+ | 'CommunityID' => <value>, | ||
+ | 'CommunityBinaryCategory' => '<value>', | ||
+ | 'SortNo' => <value>, | ||
+ | // 'CommunityBinaryCategoryID' => NULL, | ||
+ | // 'AccessLevel' => 1, | ||
+ | // 'BinaryQuotaInKB' => 5120, | ||
+ | // 'MaxNumberOfBinaries' => 100, | ||
+ | // 'DeleteBinaryCategory' => 0 | ||
+ | ) | ||
+ | ); | ||
+ | |||
+ | $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="co_ModifyBinaryCategories_Ad"> | ||
+ | <Parameters> | ||
+ | <Parameter Name="CommunityID"><!-- smallint value --></Parameter> | ||
+ | <Parameter Name="CommunityBinaryCategory"><!-- varchar value --></Parameter> | ||
+ | <Parameter Name="SortNo"><!-- smallint value --></Parameter> | ||
+ | <!-- <Parameter Name="CommunityBinaryCategoryID">NULL</Parameter> --> | ||
+ | <!-- <Parameter Name="AccessLevel">1</Parameter> --> | ||
+ | <!-- <Parameter Name="BinaryQuotaInKB">5120</Parameter> --> | ||
+ | <!-- <Parameter Name="MaxNumberOfBinaries">100</Parameter> --> | ||
+ | <!-- <Parameter Name="DeleteBinaryCategory">0</Parameter> --> | ||
+ | </Parameters> | ||
+ | </Procedure> | ||
+ | </Batch> | ||
+ | </ListOfBatches></code> | ||