pm_GetPersonBinaries_Pu [dstore]

Inhaltsverzeichnis

pm_GetPersonBinaries_Pu

pm_GetPersonBinaries_Pu

Prozedur, die zu einer Person die hinterlegten Binärdaten ausgibt.

Anmerkung zum Parameter „PersonID“ :
Sollen Binärdaten zu einer anderen Person ausgegebenen werden, kann diese Person über den Parameter „PersonID“ identifiziert
werden. Natürlich klappt dies nur, wenn die beiden Personen auch irgendwie in einer Beziehung zueinander stehen :
1. Zugriff ist erlaubt, wenn die identifizierte Person Auftraggeber eines Auftrags ist, bei dem „PersonID“ die Lieferanschrift („DeliveryPersonID“) ist UND der „PersonTypeSettings“-Eintrag zum Schlüssel „UnlimitedAccessToDeliveryPersonData“ (zur „PersonTypeID = 0“) auf „1“ konfiguriert ist.
2. Andernfalls ist der Zugriff nur erlaubt, wenn aktuell eine Beziehung der identifizierten Person zur „PersonID“ besteht, deren „AccessLevel“ (s. gleichnamige Rückgabespalte von pm_GetPersonRelationships_Pu) dies erlaubt.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[pm, Get, Person, Binaries, Pu]
Engine-Kategorie	person management
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	5.1.10 (2007-03-12)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
PersonIdentificationValues		Liste (durch '¶' getrennt) von Werten, die die Person identifizieren. Diese Werte müssen Eigenschaften zu den Merkmal-IDs sein, die in „PersonTypeSettings“ zur „PersonTypeID“ zum Schlüssel „PersonIdentificationIDs“ hinterlegt sind.	varchar(255)	3.5.6
PersonTypeID	1	ID des Personen-Typs dem die zu identifizierende Person angehört. Dieser muß bei einer Identifizierung immer mit angegeben werden, da die Merkmale zur Identifizierung pro Personentyp variieren können.	tinyint	3.5.6
CaseSensitive	1	„0“ : Der Vergleich der Identifizierungsdaten erfolgt unabhängig von der Groß- und Kleinschreibung „1“ : Die Identifizierungsdaten werden EXAKT verglichen	bit	3.5.6
PersonID	NULL	ID der Person, zu der die Binärdaten ausgegeben werden sollen. Angeben, falls NICHT die „Binaries“ der identifizierten Person ermittelt werden sollen.	integer	3.5.6
IncludeBinaryCode	0	Gibt an, ob man… „0“ : Nur die „BinaryCodeID“ „1“ : „BinaryCodeID“ und „BinaryCode“ „2“ : „BinaryCodeID“, „BinaryCode“ und „ThumbnailCode“ „3“ : „BinaryCodeID“ und „ThumbnailCode“ … zurück haben möchte (entspr. Rückgabespalten sind dann „NULL“)	tinyint	3.5.6
BinaryCharacteristicID	NULL	ID eines Merkmals von Binärdaten. Zusammen mit „Value“ dient dieser Parameter (optional) dazu, nur die „Binaries“ ausgeben zu lassen, die eine bestimmte Eigenschaft haben.	tinyint	3.5.6
Value	NULL	Wenn angegeben, werden nur die „Binaries“ ausgegeben, die zum Merkmal „BinaryCharacteristicID“ diese Eigenschaft besitzen	varchar(250)	3.5.6

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
PersonID	ID der identifizierten Person, falls „PersonID“ nicht angegeben wurde, sonst „PersonID“	integer	3.5.6
BinaryCodeID	ID eines „Binaries“, das der Person „PersonID“ zugeordnet ist	integer	3.5.6
BinaryCode	Der zur „BinaryCodeID“ zugehörige Code, also quasi das Binärobjekt selbst. Kann je nach „IncludeBinaryCode“ „NULL“ sein.	longvarbinary	3.5.6
ThumbnailCode	Der zur „BinaryCodeID“ zugehörige Code des „Thumbnails“ (ein kleines Bild, das das eigentliche Binärobjekt symbolisieren soll). Kann je nach „IncludeBinaryCode“ „NULL“ sein.	longvarbinary	3.5.6
BinaryDescription	Bezeichnung/Beschreibung der „BinaryCodeID“	varchar(100)	5.1.0

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-670	Daten anderer Personen können nicht geändert/eingesehen werden, wenn keine entspr. Beziehung besteht	nur direkt
-660	Identifikation fehlgeschlagen	nur indirekt
-624	Fehlender oder falscher Eintrag in RelationshipSettings	nur indirekt
-621	Fehlender oder falscher Eintrag in PersonTypeSettings	nur indirekt
-599	Lizenz ist ungültig oder abgelaufen	nur indirekt
-500	Falsche Parameter	direkt und indirekt

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

5.1.10	2007-03-12	1. Berücksichtigung des neuen „AccessLevel“-features in „PersonRelationships“ 2. Ausgabe an die Standard-Ausgabe [via „print“] im Fehler-Fall „-500“, die nähere Informationen über die Ursache enthält.
5.1.7	2006-10-31	Fehlende Index-Angabe beim Zugriff aus „Orders“
5.1.0	2006-02-08	Neue Rückgabespalte „BinaryDescription“
3.5.6	2001-04-17	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:

pm_GetPersonBinaries_Pu im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/pm_GetPersonBinaries_Pu?PersonIdentificationValues=<value>'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/pm_GetPersonBinaries_Pu?PersonIdentificationValues=<value>' | xmllint --format -

dStore_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'),
	'pm_GetPersonBinaries_Pu',
		array(
			'PersonIdentificationValues' => '<value>',
			// 'PersonTypeID' => 1,
			// 'CaseSensitive' => 1,
			// 'PersonID' => NULL,
			// 'IncludeBinaryCode' => 0,
			// 'BinaryCharacteristicID' => NULL,
			// 'Value' => NULL
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();

engine/execute

XML zur Ausführung mit der Methode engine/execute, z.B. per

curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>'

<?xml version="1.0" encoding="UTF-8"?>
<ListOfBatches>
	<Batch No="0">
		<Procedure Name="pm_GetPersonBinaries_Pu">
			<Parameters>
				<Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="PersonTypeID">1</Parameter> -->
				<!-- <Parameter Name="CaseSensitive">1</Parameter> -->
				<!-- <Parameter Name="PersonID">NULL</Parameter> -->
				<!-- <Parameter Name="IncludeBinaryCode">0</Parameter> -->
				<!-- <Parameter Name="BinaryCharacteristicID">NULL</Parameter> -->
				<!-- <Parameter Name="Value">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“

⁶⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Inhaltsverzeichnis