pm_GetRelationships_Ad [dstore]

Inhaltsverzeichnis

pm_GetRelationships_Ad

pm_GetRelationships_Ad

Gibt die im „dStore“ definierten Personen-Beziehungen wieder. 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 und in welchem Zeitraum sie gültig ist.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[pm, Get, Relationships, 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 angeben, wird nur der Datensatz zu dieser Beziehung ausgegeben („IncludeSystemRelationships“ wird dann ignoriert).	integer	3.5.10
IncludeSystemRelationships	2	Schränkt die Ausgabe ein auf bestimmte Beziehungen. „0“ : Alle Beziehnungen, die NICHT vom „dStore“ intern verwaltet werden „1“ : Alle Beziehungen, die NUR vom „dStore“ intern verwaltet werden „2“ : Alle Beziehungen	tinyint	3.5.10

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
RelationshipID	ID einer Art von Beziehung	integer	3.5.10
Relationship	Bezeichnung der Beziehungsart „RelationshipID“	varchar(100)	3.5.10
SystemRelationship	Handelt es sich um eine NUR vom „dStore“ intern verwaltete Beziehung ? („0“ : Nein, „1“ : Ja)	bit	3.5.10

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
-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]
4.0.15	2004-07-30	1. Aufruf der Prozeduren „_mi_StartProcedure“ und „_mi_FinishProcedure“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
3.5.10	2001-07-14	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_GetRelationships_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/pm_GetRelationships_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_GetRelationships_Ad',
		array(
			// 'RelationshipID' => NULL,
			// 'IncludeSystemRelationships' => 2
		)
);
 
$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_GetRelationships_Ad">
			<Parameters>
				<!-- <Parameter Name="RelationshipID">NULL</Parameter> -->
				<!-- <Parameter Name="IncludeSystemRelationships">2</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