Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:co_getmemberbinaries_pu

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:co_getmemberbinaries_pu [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== co_GetMemberBinaries_Pu =====
 +
 +Prozedur, damit ein Community-Mitglied sich alle Binärobjekte einer Kategorie eines anderen Mitglieds (oder natürlich auch seine eigenen "​Binaries"​) holen kann - sofern es über entsprechende Zugriffsrechte innerhalb der angegebenen Kategorie verfügt (siehe auch [[dstoreproc>​co_GetBinaryCategories_Ad]] und [[dstoreproc>​co_GetBinaryCatAccessLevels]]).\\ ​
 +
 +
 +
 +Anmerkung zu den "​OutputCharacteristicID..."​-Parametern :\\ 
 +
 +IDs, die hier übergeben werden und nicht für den Benutzer, der diese Prozedur aufruft, "​sichtbar"​ sind (aufgrund von Zugriffsbeschränkungen,​ s. [[dstoreproc>​pm_GetPChAccRestrForUsers_Ad]]),​ werden grundsätzlich ignoriert ! D.h. es gibt zwar keinen Fehler, aber die entsprechende(n) Eigenschaft(en) werden natürlich nicht zurückgegeben !\\ 
 +|HTTP-Method|GET |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[co Get Member Binaries Pu]}}|
 +|Engine-Kategorie|communities |
 +|Engine-Typ|Daten-Ermittlung |
 +|Letzte Aktualisierung|6.5.4 (2013-04-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 ^
 +|__UniqueID__| |Eindeutige ID eines Besuchers, die dem zu identifizierenden Mitglied aktuell zugeordnet ist. Falls die Identifizierungsdaten zur Person in "​SessionManagement"​ (zu dieser "​UniqueID"​) gespeichert sind, darf "​PersonIdentificationValues"​ auch "​NULL"​ sein.\\ |varchar(50)|3.5.2|
 +|__PersonIdentificationValues__| |Liste von Werten, die das Mitglied identifizieren. Diese Werte müssen Eigenschaften zu den Merkmal-IDs sein, die in "​PersonTypeSettings"​ zur "​PersonTypeID"​ der "​CommunityID"​ zum Schlüssel "​PersonIdentificationIDs"​ hinterlegt sind.\\ |varchar(255)|3.5.2|
 +|__CommunityID__| |ID einer Community\\ |smallint|3.5.2|
 +|__CommunityMemberID__| |ID eines Mitglieds der Community, dessen "​Binaries"​ ermittelt werden sollen. Wird hier "​NULL"​ übergeben, nimmt die Prozedur an, daß die "​Binaries"​ des identifizierte Mitglieds ermittelt werden sollen.\\ |integer|3.5.2|
 +|__CommunityBinaryCategoryID__| |ID einer Kategorie von Binärobjekten in der Community (z.B. für den "​Steckbrief"​ eines Mitglieds). Es  werden alle Binärobjekte des Mitglieds "​CommunityMemberID"​ dieser Kategorie ermittelt (oder nur die "​BinaryID"​ bzw. das "​SortNo"​te Binärobjekt).\\ |smallint|3.5.2|
 +|BinaryID|NULL |(Optional) ID des anzuzeigenden "​Binaries",​ das dem Mitglied "​CommunityMemberID"​ zugeordnet ist. Falls das Binärobjekt nicht zur durch "​CommunityBinaryCategoryID"​ angegebenen Kategorie gehört, ist die Rückgabemenge leer !\\ |integer|3.5.2|
 +|SortNo|NULL |(Optional) Wird nur beachtet, wenn "​BinaryID"​ "​NULL"​ ist ! Falls angegeben, wird nur das "​SortNo"​te Binärobjekt aus der durch "​CommunityBinaryCategoryID"​ angegebenen Kategorie ermittelt.\\ |integer|3.5.2|
 +|OutputCharacteristicID1|NULL |Falls angegeben, enthält die Rückgabemenge in der Spalte "​Value1"​ die Eigenschaft des Mitglieds "​FromCommunityMemberID"​ zu dieser Merkmal-ID. Das Merkmal muß aber in "​CommunitySettings"​ zum Schlüssel "​PublicCharacteristicIDs"​ hinterlegt sein !\\ |smallint|3.5.11|
 +|OutputCharacteristicID2|NULL |Falls angegeben, enthält die Rückgabemenge in der Spalte "​Value2"​ die Eigenschaft des Mitglieds "​FromCommunityMemberID"​ zu dieser Merkmal-ID. Das Merkmal muß aber in "​CommunitySettings"​ zum Schlüssel "​PublicCharacteristicIDs"​ hinterlegt sein !\\ |smallint|3.5.11|
 +|OutputCharacteristicID3|NULL |Falls angegeben, enthält die Rückgabemenge in der Spalte "​Value´3"​ die Eigenschaft des Mitglieds "​FromCommunityMemberID"​ zu dieser Merkmal-ID. Das Merkmal muß aber in "​CommunitySettings"​ zum Schlüssel "​PublicCharacteristicIDs"​ hinterlegt sein !\\ |smallint|3.5.11|
 +|SeparatorInIdentVals|'​¶'​ |Gibt an, durch welche Zeichenkette die Werte in "​PersonIdentificationValues"​ getrennt sind\\ |varchar(4)|5.5.0|
 +==== Rückgabe ====
 +
 +=== (parameterunabhängig) ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|BinaryID|ID eines "​Binaries"​ aus der Kategorie "​CommunityBinaryCategoryID",​ das dem Mitglied "​CommunityMemberID"​ zugeordnet ist\\ |integer|3.5.2 |
 +|BinaryDescription|Beschreibung des Binärobjektes "​BinaryID"​\\ |varchar(255)|3.5.2 |
 +|SortNo|Bestimmt die Reihenfolge des Binärobjektes "​BinaryID"​ innerhalb aller "​Binaries",​ die dem Mitglied "​CommunityMemberID"​ in der Kategorie zugeordnet sind\\ |integer|3.5.2 |
 +|InputDateAndTime|Wann wurd das Binärobjekt "​BinaryID"​ dem Mitglied "​CommunityMemberID"​ zugeordnet\\ |datetime|3.5.2 |
 +|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.2 |
 +|FilesizeInKB|Größe des Binärobjektes "​BinaryID"​ (bzw. der referenzierten Datei, die ja nicht in der Datenbank gespeichert wird !) in KiloBytes\\ |integer|3.5.2 |
 +|FileDateAndTime|Erstellungsdatum der durch "​BinaryID"​ referenzierten Datei\\ |datetime|3.5.2 |
 +|MD5Hash|"​MD5-Hash"​ der durch "​BinaryID"​ referenzierten Datei\\ |varchar(50)|3.5.2 |
 +|FromCommunityMemberID|ID eines Community-Mitglieds,​ von dem die "​BinaryID"​ ursprünglich ist (im Regelfall "​CommunityMemberID"​ selbst)\\ |integer|3.5.11 |
 +|Nickname|Eigenschaft zu dem Merkmal, anhand dessen die Communitymitglieder sich untereinander unterscheiden bzw. erkennen können. (Eintrag in "​CommunitySettings"​ zum Schlüssel "​IdentifyingCharacteristicID"​)\\ |varchar(100)|3.5.11 |
 +|Value1|Eigenschaft des Mitglieds "​FromCommunityMemberID"​ zum Merkmal "​OutputCharacteristicID1"​\\ |varchar(100)|3.5.11 |
 +|Value1RestrictedByPattern|Was enthält "​Value1"​ (womöglich wegen Zugriffsbeschränkungen nur einen Teil) ?\\ - NULL : den vollständigen Wert\\ - "#​left(<​n>​)#"​ : nur die ERSTEN n Zeichen\\ - "#​right(<​n>​)#"​ : nur die LETZTEN n Zeichen\\ Anmerkung : "n = 0" möglich, "​Value1"​ ist dann NULL\\ |varchar(100)|6.5.4 |
 +|Value2|Eigenschaft des Mitglieds "​FromCommunityMemberID"​ zum Merkmal "​OutputCharacteristicID2"​\\ |varchar(100)|3.5.11 |
 +|Value2RestrictedByPattern|Wie "​Value1RestrictedByPattern"​ - nur eben auf "​Value2"​ bezogen\\ |varchar(100)|6.5.4 |
 +|Value3|Eigenschaft des Mitglieds "​FromCommunityMemberID"​ zum Merkmal "​OutputCharacteristicID3"​\\ |varchar(100)|3.5.11 |
 +|Value3RestrictedByPattern|Was enthält "​Value3"​ (womöglich wegen Zugriffsbeschränkungen nur einen Teil) ?\\ - NULL : den vollständigen Wert\\ - "#​left(<​n>​)#"​ : nur die ERSTEN n Zeichen\\ - "#​right(<​n>​)#"​ : nur die LETZTEN n Zeichen\\ Anmerkung : "n = 0" möglich, "​Value3"​ ist dann NULL\\ |varchar(100)|6.5.4 |
 +|InputDateAndTime_char|"​InputDateAndTime"​ als String (Format "​15.04.2001 20:​56:​39"​)\\ |varchar(19)|3.5.11 |
 +|QuotedFileSizeInKB|Wieviel KiloBytes werden "​CommunityMemberID"​ auf seine Quota angerechnet ? Dieser Wert entspricht "​FilesizeInKB",​ wenn "​FromCommunityMemberID = CommunityMemberID"​ ist, ansonsten wird "​0"​ zurückgegeben.\\ |integer|3.5.11 |
 +
 +== Sortierung der Rückgabe ==
 +
 +(parameterunabängige Sortierung)
 +  * 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"​)) ^
 +|-781|Fehlender oder falscher Eintrag in CommunitySettings|nur indirekt|
 +|-780|Fehlender oder falscher Eintrag in CommunityMemberSettings|nur indirekt|
 +|-774|Login vorübergehend gesperrt|nur indirekt|
 +|-773|Login gesperrt|nur indirekt|
 +|-772|User ist nicht angemeldet|nur indirekt|
 +|-771|Der Sweeper ist nicht gestartet|nur indirekt|
 +|-770|Login zur Zeit nicht möglich|nur indirekt|
 +|-750|Fehlende Berechtigung für die Anzeige der Daten|nur direkt|
 +|-733|Keine Berechtigung zum Auslesen von Binärdateien in dieser Kategorie|nur indirekt|
 +|-732|Keine Berechtigung zum Einfügen von Binärdateien in dieser Kategorie|nur indirekt|
 +|-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|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 ====
 +
 +|6.5.4 |2013-04-29|1. Implementierung des neuen Merkmal-Zugriffsbeschränkungen-Features [=> auch Hinweis in der Doku]\\ 2. Länge des Parameter "​SeparatorInIdentVals"​ wurde erweitert [von "​1"​ auf "​4"​]\\ 3. Neue Rückgabespalten "​Value...RestrictedByPattern"​\\ ​ |
 +|5.5.0 |2008-01-07|1. Neuer Parameter "​SeparatorInIdentVals"​\\ 2. Bearbeitung des Quellcodes hinsichtlich neuer Konventionen\\ ​ |
 +|4.0.0 |2003-04-03|"​InputDateAndTime"​ wurde doppelt zurückgegeben !\\  |
 +|3.5.11 |2001-09-06|\\ ​ |
 +|3.5.2 |2001-01-28|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_GetMemberBinaries_Pu|co_GetMemberBinaries_Pu im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​co_GetMemberBinaries_Pu?​UniqueID=<​value>&​PersonIdentificationValues=<​value>&​CommunityID=<​value>&​CommunityMemberID=<​value>&​CommunityBinaryCategoryID=<​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_GetMemberBinaries_Pu?​UniqueID=<​value>&​PersonIdentificationValues=<​value>&​CommunityID=<​value>&​CommunityMemberID=<​value>&​CommunityBinaryCategoryID=<​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_GetMemberBinaries_Pu',​
 + array(
 + '​UniqueID'​ => '<​value>',​
 + '​PersonIdentificationValues'​ => '<​value>',​
 + '​CommunityID'​ => <​value>,​
 + '​CommunityMemberID'​ => <​value>,​
 + '​CommunityBinaryCategoryID'​ => <​value>,​
 + // '​BinaryID'​ => NULL,
 + // '​SortNo'​ => NULL,
 + // '​OutputCharacteristicID1'​ => NULL,
 + // '​OutputCharacteristicID2'​ => NULL,
 + // '​OutputCharacteristicID3'​ => 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="​co_GetMemberBinaries_Pu">​
 + <​Parameters>​
 + <​Parameter Name="​UniqueID"><​!-- varchar value --></​Parameter>​
 + <​Parameter Name="​PersonIdentificationValues"><​!-- varchar value --></​Parameter>​
 + <​Parameter Name="​CommunityID"><​!-- smallint value --></​Parameter>​
 + <​Parameter Name="​CommunityMemberID"><​!-- integer value --></​Parameter>​
 + <​Parameter Name="​CommunityBinaryCategoryID"><​!-- smallint value --></​Parameter>​
 + <!-- <​Parameter Name="​BinaryID">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​SortNo">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​OutputCharacteristicID1">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​OutputCharacteristicID2">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​OutputCharacteristicID3">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​SeparatorInIdentVals">'​¶'</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/co_getmemberbinaries_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)