pm_GetPeriodsForPredefVals_Ad [dstore]

Inhaltsverzeichnis

pm_GetPeriodsForPredefVals_Ad

pm_GetPeriodsForPredefVals_Ad

Gibt die hinterlegten Gültigkeits-Zeiträume für vordefinierte Eigenschaften (die Personen haben können) aus.

HTTP-Method	GET
HTTP-Auth	Optional
Alias	pm_GetPeriodsForPredefinedValues_Ad
Tags	[pm, Get, Periods, For, Predefined, Values, 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
PersonCharacteristicID	NULL	ID eines Merkmals. Falls angegeben, werden nur Eigenschaften zu diesem Merkmal berücksichtigt.	smallint	4.0.0
ValueID	NULL	ID einer Eigenschaft. Falls angegeben, ermittelt die Prozedur nur hinterlegte Gültigkeitszeiträume für diese Eigenschaft.	integer	4.0.0

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
SortNo⁵⁾	Wird nicht ausgegeben, sondern nur zur Sortierung der Rückgabemenge verwendet. Bestimmt die Reihenfolge von „Value“ innerhalb aller Eigenschaften zum Merkmal „PersonCharacteristicID“.	integer	4.0.1
ValueID	ID der Eigenschaft „Value“	integer	4.0.0
PersonCharacteristicID	ID des Personen-Merkmals, zu dem die Eigenschaft „Value“ gehört. Besteht für ein Merkmal eine komplett lesende Zugriffsbeschränkung (s. pm_GetPChAccRestrForUsers_Ad) für den Aufrufer, FEHLT der entsprechende Datensatz im Ergebnis !	smallint	4.0.1
Value	Eine Eigenschaft, die nur im Zeitraum „ValidFrom“ bis „ValidTo“ verwendet werden kann. Kann aufgrund von Zugriffsbeschränkungen „NULL“ oder unvollständig sein, was dann durch „ValueRestrictedByPattern“ gekennzeichnet ist.	varchar(100)	4.0.0
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
ValidFrom	Beginn des Gültigkeits-Zeitraums der Eigenschaft „Value“	datetime	4.0.0
ValidTo	Ende des Gültigkeits-Zeitraums der Eigenschaft „Value“. „NULL“ bedeutet, daß die Eigenschaft aktuell (und bis auf weiteres auch in Zukunft) verwendet werden kann.	datetime	4.0.0
ValidFrom_char	„ValidFrom“ als „String“ im Format „01.04.2001 15:20:55:115“	varchar(23)	4.0.13
ValidTo_char	„ValidTo“ als „String“ im Format „01.04.2001 15:20:55:115“	varchar(23)	4.0.13

Sortierung der Rückgabe

(parameterunabängige Sortierung)

PersonCharacteristicID (aufsteigend)
SortNo (absteigend)
ValidFrom (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	direkt und 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. Neues feature „Zugriffsbeschränkungen für Merkmale“ implementiert ⇒ Evtl. werden für den Benutzer, der diese Prozedur aufruft, Merkmale herausgefiltert 2. Neue Rückgabespalte „ValueRestrictedByPattern“
4.0.13	2004-05-18	1. Neue Rückgabespalten „ValidFrom_char“ und „ValidTo_char“ 2. Aufruf der Prozeduren „_mi_StartProcedure“ und „_mi_FinishProcedure“ 3. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
4.0.1	2003-05-16	1. Fehlende Doku der Rückgabemenge 2. Neue Rückgabespalte „PersonCharacteristicID“ 3. „set forceplan“ eingefügt, fehlende Index-Angaben an einigen Stellen 4. Ab jetzt wird das Ergebnis auch sortiert
4.0.0	2003-04-03	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_GetPeriodsForPredefVals_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁷⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/pm_GetPeriodsForPredefVals_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_GetPeriodsForPredefVals_Ad',
		array(
			// 'PersonCharacteristicID' => NULL,
			// 'ValueID' => 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_GetPeriodsForPredefVals_Ad">
			<Parameters>
				<!-- <Parameter Name="PersonCharacteristicID">NULL</Parameter> -->
				<!-- <Parameter Name="ValueID">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.

⁶⁾

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