pm_GetPersonCharacsInCats_Ad [dstore]

Inhaltsverzeichnis

pm_GetPersonCharacsInCats_Ad

pm_GetPersonCharacsInCats_Ad

Gibt die Merkmale zurück, die einer (bestimmten) Kategorie zugeordnet sind.

HTTP-Method	GET
HTTP-Auth	Optional
Alias	pm_GetPersonCharacteristicsInCategories_Ad
Tags	[pm, Get, Person, Characteristics, In, 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, werden nur die Merkmale, die dieser Kategorie zugordnet sind, zurückgegeben.	tinyint	3.5.0
Country	'german'	Gibt an, in welchem Format Werte der Rückgabespalte „DefaultValue“ ausgegeben werden soll, wenn eine Datums-Angabe vorliegt (Groß-/Kleinschreibung wird nicht beachtet) : 'german', 'germany' : Tag-Monat-Jahr 'english', 'england' : Monat-Tag-Jahr	varchar(10)	6.0.0

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
SortNo⁵⁾	Wird nicht ausgegeben, sondern nur zur Sortierung verwendet. Bestimmt die Reihenfolge von „PersonCharacteristicID“ innerhalb aller Merkmale.	smallint	3.5.0
PersonCharacCategoryID	ID einer Kategorie von Personen-Merkmalen	tinyint	3.5.0
CategoryDescription	Bezeichnung der Kategorie „PersonCharacCategoryID“	varchar(100)	3.5.0
PersonCharacteristicID	ID eines der Kategorie „PersonCharacCategoryID“ zugeordneten Merkmals. 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	3.5.0
CharacteristicDescription	Bezeichnung des Personen-Merkmals	varchar(100)	3.5.0
DescriptionForAdmin	Bezeichnung der „PersonCharacteristicID“ für den Administrator. Hintergrund : Merkmale, die von der Bezeichnung her identisch sind, und für einen Administrator bei Konfigurierungen nicht auseinander zu halten wären.	varchar(100)	3.5.22
Required	Falls „1“, so MUSS eine Person, die eine Angabe zu wenigstens einem Merkmal der Kategorie „PersonCharacCategoryID“ macht, auf JEDEN FALL auch eine Angabe zum Merkmal „PersonCharacteristicID“ machen	bit	3.5.0
KeepPropertiesHistoryInDays	Wieviele Tage sollen Änderungen von Eigenschaften (zum Merkmal „PersonCharacteristicID“) von Personen des Typs, dem die Kategorie „PersonCharacCategoryID“ zugewiesen ist, gehalten werden ? „NULL“ bedeutet, daß keine Historie gepflegt wird.	smallint	4.0.0
DefaultValue	Standard-Wert, der autom. zu einer Person als Eigenschaft zum Merkmal „PersonCharteristicID“ gespeichert wird, wenn Daten der Kategorie „PersonCharacCategoryID“ bearbeitet werden, die Person aber KEINE Eigenschaften zu Merkmalen dieser Kategorie besitzt	varchar(100)	6.0.0
DefValRestrictedByPattern	Was enthält „DefaultValue“ (womöglich wg. Zugriffsbeschränk. nur einen Teil) ? - NULL : den vollst. Wert - „#left(<n>)#“ : nur die ERSTEN n Zeichen - „#right(<n>)#“ : nur die LETZTEN n Zeichen Anmerkung : „n = 0“ möglich, „DefaultValue“ ist dann NULL	varchar(100)	6.5.2

Sortierung der Rückgabe

(parameterunabängige Sortierung)

PersonCharacCategoryID (aufsteigend)
SortNo (absteigend)

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
-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	Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
7.0.4	2014-03-19	„set forceplan off“-Anweisung fehlte an einer Stelle
6.5.2	2013-02-26	1. Neues feature „Zugriffsbeschränkungen für Merkmale“ implementiert 2. Neue Rückgabespalte „DefValRestrictedByPattern“ 3. Interne Änderungen
6.0.0	2010-03-26	1. Neue Rückgabespalte „DefaultValue“ 2. Neuer Parameter „Country“
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
4.0.0	2003-04-03	Neue Rückgabespalte „KeepPropertiesHistoryInDays“
3.5.22	2002-08-30
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_GetPersonCharacsInCats_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁷⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/pm_GetPersonCharacsInCats_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_GetPersonCharacsInCats_Ad',
		array(
			// 'PersonCharacCategoryID' => NULL,
			// 'Country' => 'german'
		)
);
 
$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_GetPersonCharacsInCats_Ad">
			<Parameters>
				<!-- <Parameter Name="PersonCharacCategoryID">NULL</Parameter> -->
				<!-- <Parameter Name="Country">'german'</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