pm_GetRelationshipSettings_Ad [dstore]

Inhaltsverzeichnis

pm_GetRelationshipSettings_Ad

pm_GetRelationshipSettings_Ad

Liefert alle oder nur bestimmte Einträge aus „RelationshipSettings“ zurück. Diese Tabelle enthält Einstellungen zu einer bestimmten Beziehungs-Art, die jeweils für eine Beziehung einer Person eines bestimmten Typs zu einer anderen Person eines bestimmten des Typs gelten.

Anmerkungen zu den Parametern „FromPersonTypeID“ und „ToPersonTypeID“ :

Es gibt Einträge, die „Personen-Typ-unabhängig“ sind (intern : „PersonTypeID = 0“), d.h. „FromPersonTypeID“ und/oder „ToPersonTypeID“ in „RelationshipSettings“ kann „0“ sein (s. a. pm_GetRelationshipSettingEntry). Es erfolgt hier jedoch immer eine Filterung der Datensätze nach GENAU der angegebenen ID (in „FromPersonTypeID“ bzw. „ToPersonTypeID“).

Hinweis zur Gültigkeit von „RelationshipSettings“-Einträgen :

Es gibt Einträge, die „Personen-Typ-unabhängig“ sind (intern : „PersonTypeID = 0“), d.h. „FromPersonTypeID“ und/oder „ToPersonTypeID“ in der Rückgabemenge 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, Settings, 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
RelationshipID	NULL	ID einer Art von Beziehung. Falls angegeben, werden nur Einstellungen, die für diese Art von Beziehungen gelten, ermittelt.	tinyint	5.1.10
FromPersonTypeID	NULL	ID eines Personen-Typs. Falls angegeben, werden nur Datensätze ermittelt, für die „FromPersonTypeID“ den hier angegebenen Wert besitzt.	tinyint	5.1.10
ToPersonTypeID	NULL	ID eines Personen-Typs. Falls angegeben, werden nur Datensätze ermittelt, für die „ToPersonTypeID“ den hier angegebenen Wert besitzt.	tinyint	5.1.10
KeyVariable	NULL	Ein Schlüssel (mögliche Werte : siehe Rückgabemenge von „ do_GetSettingsDescriptions_Ad 'RelationshipSettings' “), nach dem gefiltert werden soll	varchar(50)	5.1.10

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
RelationshipID	ID einer Beziehungs-Art	tinyint	5.1.10
Relationship	Bezeichnung der Beziehungsart „RelationshipID“	varchar(100)	5.1.10
FromPersonTypeID	ID eines Personen-Typs. Der zum Schlüssel „KeyVariable“ konfigurierte Wert „Value“ gilt für Beziehungen der Art „RelationshipID“ von Personen dieses Typs zu Personen des Typs „ToPersonTypeID“ (Sonderfall „0“ beachten, s. Beschreibung).	tinyint	5.1.10
FromPersonTypeDescription	Bezeichnung des Personen-Typs „FromPersonTypeID“	varchar(100)	5.1.10
ToPersonTypeID	ID eines Personen-Typs. Der zum Schlüssel „KeyVariable“ konfigurierte Wert „Value“ gilt für Beziehungen der Art „RelationshipID“ von Personen des Typs „FromPersonTypeID“ zu Personen dieses Typs (Sonderfall „0“ beachten, s. Beschreibung).	tinyint	5.1.10
ToPersonTypeDescription	Bezeichnung des Personen-Typs „ToPersonTypeID“	varchar(100)	5.1.10
KeyVariable	Ein Schlüssel, zu dem der Wert „Value“ konfiguriert ist. Mögliche Werte : siehe Rückgabemenge von „ do_GetSettingsDescriptions_Ad 'RelationshipSettings' “.	varchar(100)	5.1.10
Value	Der zum Schlüssel „KeyVariable“ konfigurierte Wert	varchar(250)	5.1.10

Sortierung der Rückgabe

(parameterunabängige Sortierung)

Relationship (aufsteigend)
KeyVariable (aufsteigend)
FromPersonTypeID (aufsteigend)

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	nur 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.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_GetRelationshipSettings_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/pm_GetRelationshipSettings_Ad'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/pm_GetRelationshipSettings_Ad' | 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_GetRelationshipSettings_Ad',
		array(
			// 'RelationshipID' => NULL,
			// 'FromPersonTypeID' => NULL,
			// 'ToPersonTypeID' => NULL,
			// 'KeyVariable' => 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_GetRelationshipSettings_Ad">
			<Parameters>
				<!-- <Parameter Name="RelationshipID">NULL</Parameter> -->
				<!-- <Parameter Name="FromPersonTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="ToPersonTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="KeyVariable">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