engine:procedures:co_getbinquotainformation_pu
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
| — |
engine:procedures:co_getbinquotainformation_pu [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== co_GetBinQuotaInformation_Pu ===== | ||
| + | |||
| + | Gibt Informationen über die Quota von Binärobjekten eines Community-Mitglieds aus.\\ | ||
| + | |||
| + | Es gibt derzeit nur zwei Informationen, nämlich wieviele "Binaries" ein Mitglied ablegen darf und wieviel Speicher alle Binaries zusammen maximal belegen dürfen. Diese Angaben beziehen sich jeweils immer auf eine Kategorie von Binärobjekten in der Community, d.h. die Schlüssel (siehe Spalte "KeyVariable" in der Rückgabemenge) aus den "Settings"-Tabellen ("CommunitySettings" und "CommunityMemberSettings") haben die Form "sys..._<CommunityBinaryCategoryID>".\\ | ||
| + | |HTTP-Method|GET | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Alias|co_GetBinaryQuotaInformation_Pu | | ||
| + | |Tags|{{tag>[co Get Binary Quota Information Pu]}}| | ||
| + | |Engine-Kategorie|communities | | ||
| + | |Engine-Typ|Daten-Ermittlung | | ||
| + | |Letzte Aktualisierung|4.0.12 (2004-04-30)| | ||
| + | |||
| + | ==== 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 ^ | ||
| + | |__CommunityID__| |ID einer Community\\ |smallint|4.0.12| | ||
| + | |__CommunityMemberID__| |ID eines Mitglieds der Community "CommunityID"\\ |integer|4.0.12| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | === (parameterunabhängig) === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |SourceTable|Name der Tabelle, in der der Eintrag "KeyVariable" - "Value" gefunden wurde. Derzeit kommen zwei Tabellen in Frage:\\ * "CommunitySettings"\\ * "CommunityMemberSettings"\\ |varchar(30)|4.0.12 | | ||
| + | |KeyVariable|Ein Schlüssel wie z.B. "sys_BinaryQuotaInKB_1" ("1" steht dann für die Kategorie von "Binaries" mit der ID "1")\\ |varchar(50)|4.0.12 | | ||
| + | |Value|Der Wert zum Schlüssel. Enthält z.B. wieviele Binärobjekte das Mitglied "CommunityMemberID" (in einer Kategorie) ablegen darf und wieviel Speicher die "Binaries" insgesamt belegen dürfen.\\ |varchar(100)|4.0.12 | | ||
| + | ==== 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")) ^ | ||
| + | |-740|Person ist nicht Mitglied in dieser Community|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 ==== | ||
| + | |||
| + | |4.0.12 |2004-04-30|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_GetBinQuotaInformation_Pu|co_GetBinQuotaInformation_Pu im Engine Playground öffnen]] | ||
| + | == cURL == | ||
| + | Unformatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/co_GetBinQuotaInformation_Pu?CommunityID=<value>&CommunityMemberID=<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_GetBinQuotaInformation_Pu?CommunityID=<value>&CommunityMemberID=<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_GetBinQuotaInformation_Pu', | ||
| + | array( | ||
| + | 'CommunityID' => <value>, | ||
| + | 'CommunityMemberID' => <value> | ||
| + | ) | ||
| + | ); | ||
| + | |||
| + | $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_GetBinQuotaInformation_Pu"> | ||
| + | <Parameters> | ||
| + | <Parameter Name="CommunityID"><!-- smallint value --></Parameter> | ||
| + | <Parameter Name="CommunityMemberID"><!-- integer value --></Parameter> | ||
| + | </Parameters> | ||
| + | </Procedure> | ||
| + | </Batch> | ||
| + | </ListOfBatches></code> | ||
engine/procedures/co_getbinquotainformation_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)