engine:procedures:co_getbinariesofonemember_ad
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
|
engine:procedures:co_getbinariesofonemember_ad [11.01.2016 ] |
engine:procedures:co_getbinariesofonemember_ad [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== co_GetBinariesOfOneMember_Ad ===== | ||
| + | |||
| + | Liefert alle "Binaries" eines Community-Mitglieds, bzw. nur die Informationen dazu - weil der Binärcode selbst ja nicht in der Datenbank gespeichert ist !\\ | ||
| + | |HTTP-Method|GET | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Tags|{{tag>[co Get Binaries Of One Member Ad]}}| | ||
| + | |Engine-Kategorie|communities | | ||
| + | |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 ^ | ||
| + | |__CommunityMemberID__| |ID eines Mitglieds der Community "CommunityID"\\ |integer|3.5.8| | ||
| + | |__CommunityID__| |ID einer Community\\ |smallint|3.5.8| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | === (parameterunabhängig) === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |CommunityBinaryCategoryID|ID einer Kategorie von Binärdateien (z.B. für den "Steckbrief" eines Mitglieds)\\ |smallint|3.5.8 | | ||
| + | |CommunityBinaryCategory|Bezeichnung der Kategorie "CommunityBinaryCategoryID"\\ |varchar(100)|3.5.8 | | ||
| + | |BinaryID|ID eines "Binaries", das zum Mitglied "CommunityMemberID" in der Kategorie "CommunityBinaryCategoryID" hinterlegt ist\\ |integer|3.5.8 | | ||
| + | |SortNo|Bestimmt die Reihenfolge der "BinaryID" innerhalb aller "Binaries" der Kategorie "CommunityBinaryCategoryID"\\ |integer|3.5.8 | | ||
| + | |BinaryDescription|Beschreibung des Binärobjektes "BinaryID"\\ |varchar(255)|3.5.8 | | ||
| + | |InputDateAndTime|Wann wurd das Binärobjekt "BinaryID" dem Mitglied "CommunityMemberID" zugeordnet\\ |datetime|3.5.8 | | ||
| + | |InputDateAndTime_char|"InputDateAndTime" als "String" - in der Form "15.01.2001 22:16:55"\\ |varchar(19)|3.5.8 | | ||
| + | |QuotedFileSizeInKB|Angabe in KiloBytes, die dem Mitglied auf sein Quota angerechnet wird (Immer gleich "FileSizeInKB" oder "0", wenn quasi nur eine Referenz gespeichert wird auf eine Datei, die ein anderes Mitglied hochgeladen hat)\\ |integer|3.5.8 | | ||
| + | |FilesizeInKB|Größe des Binärobjektes "BinaryID" (bzw. der referenzierten Datei, die ja nicht in der Datenbank gespeichert wird !) in KiloBytes\\ |integer|3.5.8 | | ||
| + | |FileDateAndTime|Erstellungsdatum der durch "BinaryID" referenzierten Datei\\ |datetime|3.5.8 | | ||
| + | |FileDateAndTime_char|"FileDateAndTime" als "String" - in der Form "15.01.2001 22:16:55"\\ |varchar(19)|3.5.8 | | ||
| + | |MD5Hash|"MD5-Hash" der durch "BinaryID" referenzierten Datei\\ |varchar(50)|3.5.8 | | ||
| + | |ContentType|Um was für einen Dateityp handelt es sich bei dem durch "BinaryID" referenzierten Binärobjekt (z.B. "gif" oder "jpg" etc)\\ |varchar(100)|3.5.8 | | ||
| + | |||
| + | == Sortierung der Rückgabe == | ||
| + | |||
| + | (parameterunabängige Sortierung) | ||
| + | * CommunityBinaryCategory (aufsteigend) | ||
| + | * SortNo (aufsteigend) | ||
| + | |||
| + | ==== 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.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=co_GetBinariesOfOneMember_Ad|co_GetBinariesOfOneMember_Ad im Engine Playground öffnen]] | ||
| + | == cURL == | ||
| + | Unformatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/co_GetBinariesOfOneMember_Ad?CommunityMemberID=<value>&CommunityID=<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_GetBinariesOfOneMember_Ad?CommunityMemberID=<value>&CommunityID=<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_GetBinariesOfOneMember_Ad', | ||
| + | array( | ||
| + | 'CommunityMemberID' => <value>, | ||
| + | 'CommunityID' => <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_GetBinariesOfOneMember_Ad"> | ||
| + | <Parameters> | ||
| + | <Parameter Name="CommunityMemberID"><!-- integer value --></Parameter> | ||
| + | <Parameter Name="CommunityID"><!-- smallint value --></Parameter> | ||
| + | </Parameters> | ||
| + | </Procedure> | ||
| + | </Batch> | ||
| + | </ListOfBatches></code> | ||
engine/procedures/co_getbinariesofonemember_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)