pm_GetPersonBinaries_Ad [dstore]

Inhaltsverzeichnis

pm_GetPersonBinaries_Ad

pm_GetPersonBinaries_Ad

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

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[pm, Get, Person, Binaries, Ad]
Engine-Kategorie	person management
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
PersonID		ID der Person, zu der man die hinterlegten „Binaries“ ausgegeben haben möchte	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	Enthält zur Zeit immer die „PersonID“ - da es aber in einer zukünftigen Version möglich sein soll, mehrer „PersonID“s via „tempdb.dbo.OneID“ zu übergeben, macht diese Rückgabespalte Sinn	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 ⁵⁾
-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 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
5.1.0	2006-02-08	Neue Rückgabespalte „BinaryDescription“
4.0.15	2004-07-30	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.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_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/pm_GetPersonBinaries_Ad?PersonID=<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_Ad',
		array(
			'PersonID' => <value>,
			// '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_Ad">
			<Parameters>
				<Parameter Name="PersonID"><!-- integer value --></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