pm_GetRelationshipSettingEntry [dstore]

Inhaltsverzeichnis

pm_GetRelationshipSettingEntry

pm_GetRelationshipSettingEntry

Liefert den konfigurierten Wert aus „RelationshipSettings“ zu einer bestimmten Beziehungs-Art zurück, der für eine Beziehung einer Person eines bestimmten Typs zu einer anderen Person eines bestimmten des Typs gilt.

Hinweis zur Ermittlung :

Es gibt Einträge, die „Personen-Typ-unabhängig“ sind (intern : „PersonTypeID = 0“), d.h. „FromPersonTypeID“ und/oder „ToPersonTypeID“ in „RelationshipSettings“ kann „0“ sein. Daher muß eine „Priorisierung“ vorgenommen werden, die so aussieht :
1.) Ein Eintrag zu „konkreter“ (also ungleich „0“) „FromPersonTypeID“ und „ToPersonTypeID“ hat Vorrang
2.) An zweiter Stelle kommt ein Eintrag zu konreter (also ungleich „0“) „FromPersonTypeID“, aber mit unabhängiger „ToPersonTypeID“ (die also „0“ ist)
3.) Danach wird ein Eintrag zu konkreter (also ungleich „0“) „ToPersonTypeID“ und unabhängiger (also gleich „0“) „FromPersonTypeID“ beachtet
4.) An letzer Stelle wird der gänzlich Personen-Typ unabhängige Eintrag („FromPersonTypeID“ und „ToPersonTypeID“ sind „0“) berücksichtigt

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[pm, Get, Relationship, Setting, Entry]
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
RelationshipID		ID einer Beziehungs-Art, zu dem der konfigurierte Wert zum Schlüssel „KeyVariable“ ermittelt werden soll, der für eine Beziehung einer Person des Typs „FromPersonTypeID“ zu einer anderen Person des Typs „ToPersonTypeID“ gilt.	tinyint	5.1.10
FromPersonTypeID		ID eines Personen-Typs („0“ ist nicht erlaubt !). Es wird der konfigurierte Wert zum Schlüssel „KeyVariable“ ermittelt, der für eine Beziehung (der Art „RelationshipID“) einer Person dieses Typs zu einer anderen Person des Typs „ToPersonTypeID“ gilt.	tinyint	5.1.10
ToPersonTypeID		ID eines Personen-Typs („0“ ist nicht erlaubt !). Es wird der konfigurierte Wert zum Schlüssel „KeyVariable“ ermittelt, der für eine Beziehung (der Art „RelationshipID“) einer Person des Typs „FromPersonTypeID zu einer anderen Person dieses Typs gilt.	tinyint	5.1.10
KeyVariable		Es wird der konfigurierte Wert zu dem hierdurch angegebenen Schlüssel ermittelt, der für eine Beziehung (der Art „RelationshipID“) einer Person des Typs „FromPersonTypeID zu einer anderen Person des Typs „ToPersonTypeID“ gilt.	varchar(100)	5.1.10
SelectResult	0	„0“ : Der hinterlegte Wert wird NUR über den Ausgabeparameter „Value“ zurückgegeben „1“ : Es wird ZUSÄTZLICH eine Rückgabemenge bereitgestellt	bit	5.1.10

Rückgabe

wenn SelectResult = 1

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
Value		varchar(250)	5.1.10

Output-Parameter

Value

Ausgabeparameter für den zum Schlüssel „KeyVariable“ hinterlegten Wert, der für eine Beziehung (der Art „RelationshipID“) einer Person des Typs „FromPersonTypeID zu einer anderen Person des Typs „ToPersonTypeID“ gilt.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-624	Fehlender oder falscher Eintrag in RelationshipSettings	nur direkt
-500	Falsche Parameter	nur direkt

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

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_GetRelationshipSettingEntry im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/pm_GetRelationshipSettingEntry?RelationshipID=<value>&FromPersonTypeID=<value>&ToPersonTypeID=<value>&KeyVariable=<value>'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/pm_GetRelationshipSettingEntry?RelationshipID=<value>&FromPersonTypeID=<value>&ToPersonTypeID=<value>&KeyVariable=<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_GetRelationshipSettingEntry',
		array(
			'RelationshipID' => <value>,
			'FromPersonTypeID' => <value>,
			'ToPersonTypeID' => <value>,
			'KeyVariable' => '<value>',
			// 'SelectResult' => 0
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();
 
$OutputParams = $xml_result->getOutputParametersAsArray();

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_GetRelationshipSettingEntry">
			<Parameters>
				<Parameter Name="RelationshipID"><!-- tinyint value --></Parameter>
				<Parameter Name="FromPersonTypeID"><!-- tinyint value --></Parameter>
				<Parameter Name="ToPersonTypeID"><!-- tinyint value --></Parameter>
				<Parameter Name="KeyVariable"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="SelectResult">0</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