pm_GetPersonRelationships_Pu [dstore]

Inhaltsverzeichnis

pm_GetPersonRelationships_Pu

pm_GetPersonRelationships_Pu

Gibt die Personen zurück, die zur identifizierten Person in irgendeiner „Beziehung“ stehen.

Im „dStore“ ist unter einer „Beziehung“ lediglich die Zuordnung einer Person zu einer anderen Person zu verstehen, wobei immer angegeben ist, welcher Art die Beziehung ist, in welchem Zeitraum sie gültig ist und welche Zugriffsrechte die jeweilige Person auf Daten der in Beziehung stehenden Person besitzt.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[pm, Get, Person, Relationships, Pu]
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
PersonIdentificationValues		Liste 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)	5.1.10
PersonTypeID		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	5.1.10
UniqueID		Eindeutige ID eines Besuchers, die der zu identifizierenden Person aktuell zugeordnet ist. Falls die Identifizierungsdaten zur Person in „SessionManagement“ (zu dieser „UniqueID“) gespeichert sind, darf „PersonIdentificationValues“ auch „NULL“ sein.	varchar(50)	5.1.10
RelatedPersonTypeID	NULL	ID eines Personen-Typs. Falls angegeben, werden nur Beziehungen der identifizierten Person zu Personen dieses Typs ermittelt.	tinyint	5.1.10
RelationshipID	NULL	ID einer Art von Beziehungen zwischen Personen. Falls angegeben, werden nur Beziehungen dieser Art berücksichtigt.	tinyint	5.1.10
OutputCharacteristicIDList	NULL	Liste von (durch „¶“ getrennten) Merkmal-IDs, zu denen jeweils Eigenschaften der in Beziehung stehenden Personen ausgegeben werden sollen (s. Rückgabespalten „OutputCharacID…“). Merkmale die für den Aufrufer komplett lesend gesperrt sind, werden ignor.	varchar(255)	5.1.10
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⁴⁾	ab Version
RelatedPersonID	ID einer Person, die zur identifizierten Person in Beziehung steht	integer	5.1.10
RelatedPersonTypeID	ID des Personen-Typs von „RelatedPersonID“	tinyint	5.1.10
RelationshipID	ID der Art in der die identifzierte Person und „RelatedPersonID“ in Beziehung stehen	tinyint	5.1.10
AccessLevel	Summe von Zugriffsrechten, die die identifizierte Person auf Daten von „RelatedPersonID“ hat. Mögliche Einzel-Zugriffsrechte : s. pm_GetRelationAccessLevels.	smallint	5.1.10
OutputCharacID_1	Erste ID aus „OutputCharacteristicIDList“, die dem Personentyp „RelatedPersonTypeID“ zugeordnet ist, und zu der die identifizierte Person auch via pm_GetPersonProperties_Pu Eigenschaften von „RelatedPersonID“ ermitteln dürfte	smallint	5.1.10
OutputCharacID_2	Zweite ID aus „OutputCharacteristicIDList“, die dem Personentyp „RelatedPersonTypeID“ zugeordnet ist, und zu der die identifizierte Person auch via pm_GetPersonProperties_Pu Eigenschaften von „RelatedPersonID“ ermitteln dürfte	smallint	5.1.10
OutputCharacID_3	Dritte ID aus „OutputCharacteristicIDList“, die dem Personentyp „RelatedPersonTypeID“ zugeordnet ist, und zu der die identifizierte Person auch via pm_GetPersonProperties_Pu Eigenschaften von „RelatedPersonID“ ermitteln dürfte	smallint	5.1.10
Value1	Eigenschaft von „RelatedPersonID“ zum Merkmal „OutputCharacID_1“. Kann aufgrund von Zugriffsbeschränkungen „NULL“ oder unvollständig sein, was dann durch „Value1RestrictedByPattern“ gekennzeichnet ist.	varchar(100)	5.1.10
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.2
Value2	Eigenschaft von „RelatedPersonID“ zum Merkmal „OutputCharacID_2“. Kann aufgrund von Zugriffsbeschränkungen „NULL“ oder unvollständig sein, was dann durch „Value2RestrictedByPattern“ gekennzeichnet ist.	varchar(100)	5.1.10
Value2RestrictedByPattern	Wie „Value1RestrictedByPattern“ - nur eben auf „Value2“ bezogen	varchar(100)	6.5.2
Value3	Eigenschaft von „RelatedPersonID“ zum Merkmal „OutputCharacID_3“. Kann aufgrund von Zugriffsbeschränkungen „NULL“ oder unvollständig sein, was dann durch „Value3RestrictedByPattern“ gekennzeichnet ist.	varchar(100)	5.1.10
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.2

Sortierung der Rückgabe

(parameterunabängige Sortierung)

RelatedPersonTypeID (aufsteigend)
RelatedPersonID (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-660	Identifikation fehlgeschlagen	nur indirekt
-624	Fehlender oder falscher Eintrag in RelationshipSettings	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	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	„Start-/Finish-Procedure“-Logik eingebaut, s. Ticket #3670
6.5.2	2013-02-26	1. Beachtung der neuen Zugriffs-Beschränkungen für Merkmale 2. Drei neue „Value…RestrictedByPattern“-Rückgabespalten 3. Datentyp-Erweiterung von „SeparatorInIdentVals“
6.5.0	2012-09-17	Holger Wies : Datentyp des Parameters „PersonTypeID“ von „smallint“ auf „tinyint“ korrigiert
5.5.0	2008-01-07	Neuer Parameter „SeparatorInIdentVals“
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_GetPersonRelationships_Pu im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/pm_GetPersonRelationships_Pu?PersonIdentificationValues=<value>&PersonTypeID=<value>&UniqueID=<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_GetPersonRelationships_Pu',
		array(
			'PersonIdentificationValues' => '<value>',
			'PersonTypeID' => <value>,
			'UniqueID' => '<value>',
			// 'RelatedPersonTypeID' => NULL,
			// 'RelationshipID' => NULL,
			// 'OutputCharacteristicIDList' => NULL,
			// 'SeparatorInIdentVals' => '¶'
		)
);
 
$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_GetPersonRelationships_Pu">
			<Parameters>
				<Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter>
				<Parameter Name="PersonTypeID"><!-- tinyint value --></Parameter>
				<Parameter Name="UniqueID"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="RelatedPersonTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="RelationshipID">NULL</Parameter> -->
				<!-- <Parameter Name="OutputCharacteristicIDList">NULL</Parameter> -->
				<!-- <Parameter Name="SeparatorInIdentVals">'¶'</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