pm_GetPersonPropertiesHist_Ad [dstore]

Inhaltsverzeichnis

pm_GetPersonPropertiesHist_Ad

pm_GetPersonPropertiesHist_Ad

Gibt die Historie der Eigenschaften zu einem bestimmten Merkmal einer Person zurück.

HTTP-Method	GET
HTTP-Auth	Optional
Alias	pm_GetPersonPropertiesHistory_Ad
Tags	[pm, Get, Person, Properties, History, 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, für die die Eigenschaften-Historie (zum Merkmal „PersonCharacteristicID“) ermittelt werden soll	integer	5.0.3
PersonCharacteristicID		ID des Merkmals zu dem die Eigenschaften-Historie (der Person „PersonID“) ermittelt werden soll. Ist jedoch für den Aufrufer der lesende Zugriff auf das Merkmal komplett gesperrt (s. pm_GetPChAccRestrForUsers_Ad), gibt es einen Fehler !	smallint	5.0.3
FromDate	NULL	Optionale Einschränkung der Ausgabe der Eigenschaften-Historie. Falls angegeben, werden nur Eigenschaften von „PersonID“ zum Merkmal „PersonCharacteristicID“ ausgegeben, die AB diesem Zeitpunkt gültig waren.	datetime	5.0.3
ToDate	NULL	Optionale Einschränkung der Ausgabe der Eigenschaften-Historie. Falls angegeben, werden nur Eigenschaften von „PersonID“ zum Merkmal „PersonCharacteristicID“ ausgegeben, die BIS zu diesem Zeitpunkt gültig waren.	datetime	5.0.3

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
ValidFrom	Beginn des Gültigkeits-Zeitraums der Eigenschaft „Value“ (für „PersonID“)	datetime	5.0.3
ValidFrom_char	„ValidFrom“ als „String“ im Format „01.04.2001 15:20:55:115“	varchar(23)	5.0.3
ValidTo	Ende des Gültigkeits-Zeitraums der Eigenschaft „Value“ (für „PersonID“). „NULL“ bedeutet, daß die Eigenschaft aktuell und bis auf weiteres auch in Zukunft („für immer“) „PersonID“ zugewiesen ist.	datetime	5.0.3
ValidTo_char	„ValidTo“ als „String“ im Format „01.04.2001 15:20:55:115“	varchar(23)	5.0.3
Value	Eine Eigenschaft zu „PersonCharacteristicID“, die „PersonID“ von „ValidFrom“ bis „ValidTo“ zugewiesen ist/war. Kann aufgrund von Zugriffsbeschränkungen „NULL“ oder unvollständig sein, was dann durch „ValueRestrictedByPattern“ gekennzeichnet ist.	varchar(100)	5.0.3
ValueRestrictedByPattern	Was enthält „Value“ (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, „Value“ ist dann „NULL“	varchar(100)	6.5.2
ValueID	ID der Eigenschaft „Value“. Anmerkung: Kann „NULL“ sein, da „Values“ aus der Historie genau dann nicht mehr in „PersonCharacteristicValues“ vorkommen, wenn der Wert AKTUELL keiner Person zugewiesen ist !	integer	5.0.3

Sortierung der Rückgabe

(parameterunabängige Sortierung)

ValidFrom (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-697	Aktion kann nicht durchgeführt werden, da für ein Merkmal eine Zugriffsbeschränkung besteht	nur direkt
-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	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.2	2013-02-26	1. Beachtung der neuen Zugriffs-Beschränkungen für Merkmale [⇒ Doku-Anpassung] 2. Neue Rückgabespalte „ValueRestrictedByPattern“ [wg. des neuen features „Zugriffsbeschränkung“] 3. Anpassungen an den aktuellen Quellcode-Standard
5.1.5	2006-08-29	Fehler : Falls „FromDate“ angegeben war, wurden nur aktuelle Eigenschaften berücksichtigt, die vor diesem Zeitpunkt geändert wurden
5.0.3	2005-06-07	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_GetPersonPropertiesHist_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/pm_GetPersonPropertiesHist_Ad?PersonID=<value>&PersonCharacteristicID=<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_GetPersonPropertiesHist_Ad',
		array(
			'PersonID' => <value>,
			'PersonCharacteristicID' => <value>,
			// 'FromDate' => NULL,
			// 'ToDate' => 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_GetPersonPropertiesHist_Ad">
			<Parameters>
				<Parameter Name="PersonID"><!-- integer value --></Parameter>
				<Parameter Name="PersonCharacteristicID"><!-- smallint value --></Parameter>
				<!-- <Parameter Name="FromDate">NULL</Parameter> -->
				<!-- <Parameter Name="ToDate">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