pm_GetPersonCharacCats_Ad [dstore]

Inhaltsverzeichnis

pm_GetPersonCharacCats_Ad

pm_GetPersonCharacCats_Ad

Gibt Kategorien von Personen-Merkmalen zurück.

HTTP-Method	GET
HTTP-Auth	Optional
Alias	pm_GetPersonCharacteristicCategories_Ad
Tags	[pm, Get, Person, Characteristic, Categories, 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
PersonCharacCategoryID	NULL	ID einer Kategorie von Personen-Merkmalen. Falls angegeben, wird nur der Datensatz zu dieser Kategorie zurückgegeben.	tinyint	3.5.0
PersonTypeID	NULL	ID eines Personen-Typs. Falls angegeben, werden nur die Kategorien für diesen Personentyp berücksichtigt.	tinyint	3.5.0
PersonCharacteristicID	NULL	ID eines Merkmals. Falls angegeben, werden nur Kategorien ermittelt, denen diese Merkmal zugeordnet ist. Ist jedoch für den Aufrufer der lesende Zugriff auf das Merkmal komplett gesperrt (s. pm_GetPChAccRestrForUsers_Ad), gibt es einen Fehler !	smallint	5.1.0

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
PersonCharacCategoryID	ID einer Kategorie von Personen-Merkmalen	tinyint	3.5.0
CategoryDescription	Bezeichnung der Kategorie „PersonCharacCategoryID“	varchar(100)	3.5.0
ContainsRequiredCharacs	„1“, falls die Kategorie „PersonCharacCategoryID“ Pflicht-Merkmale enthält - das sind Merkmale, zu denen eine Person Eigenschaften besitzen MUSS, damit sie überhaupt ANGELEGT werden kann. Andernfalls „0“.	bit	5.1.10
PersonTypeID	ID des Peronen-Typs, für den die Kategorie „PersonCharacCategoryID“ gilt. Einer Kategorie von Personen-Merkmalen ist immer GENAU EIN Personen-Typ zugeordnet.	tinyint	3.5.0
PersonTypeDescription	Bezeichnung des Personen-Typs „PersonTypeID“	varchar(100)	3.5.0

Sortierung der Rückgabe

(parameterunabängige Sortierung)

PersonTypeID (aufsteigend)
PersonCharacCategoryID (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. Anpassung des Quellcodes an den aktuellen Standard
5.1.10	2007-03-12	Neue Rückgabespalte „ContainsRequiredCharacs“
5.1.0	2006-02-08	Neuer Parameter „PersonCharacteristicID“
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.0	2000-11-23	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_GetPersonCharacCats_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/pm_GetPersonCharacCats_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_GetPersonCharacCats_Ad',
		array(
			// 'PersonCharacCategoryID' => NULL,
			// 'PersonTypeID' => NULL,
			// 'PersonCharacteristicID' => 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_GetPersonCharacCats_Ad">
			<Parameters>
				<!-- <Parameter Name="PersonCharacCategoryID">NULL</Parameter> -->
				<!-- <Parameter Name="PersonTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="PersonCharacteristicID">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