Benutzer-Werkzeuge

Webseiten-Werkzeuge

Action disabled: source

engine:procedures:pm_getgroups_ad

pm_GetGroups_Ad

Gibt im „dStore“ definierte Gruppen, in die Personen eingeordnet werden können, zurück.

HTTP-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategorieperson management
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
PersonIDNULL ID einer Person. Wenn angegeben, werden nur die Gruppen zurückgegeben, denen diese Person angehört.
integer3.5.0
PersonTypeIDNULL ID eines Personen-Typs. Wird nur beachtet, wenn „PersonID“ „NULL“ ist ! Falls angegeben, gibt die Prozedur nur die Gruppen zurück, die für diesen Personentyp existieren (→ Rückgabespalte „PersonTypeID“).
tinyint3.5.20
IncludeIndependentGroups0 Wird eine „PersonTypeID“ als Filter angegeben, gibt die Prozedur Gruppen für den speziellen Personentyp mit der ID „0“ („Personentyp unabhängig“) nur zurück, falls hier „1“ angegeben wird
bit3.5.20

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
CheckCondition5)Wird nicht mehr zurückgegeben, da das Konzept der Gruppen-Bedingungen sich in Version 3.5.15 geändert hat
bit3.5.0
GroupIDID einer Personen-Gruppe
smallint3.5.0
GroupDescriptionBezeichnung der Gruppe „GroupID“
varchar(100)3.5.0
SortNoBestimmt die Reihenfolge von „GroupID“ innerhalb aller Gruppen (hohe Nummer = hohe Priorität)
smallint3.5.0
PersonTypeIDID eines Personen-Typs. Es können nur Personen diesen Typs in der Gruppe „GroupID“ sein. Ausnahme : Der spezielle Personentyp mit der ID „0“ („Personentyp unabhängig“) - in diesem Fall ist die Gruppe nicht nur einem einzigen Personentyp vorbehalten.
tinyint3.5.6
ConditionIDID einer (Gruppen-)Bedingung (siehe pm_GetGroupConditions_Ad)
smallint3.5.0
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • SortNo (absteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 6)
-569Der Benutzer hat kein Ausführungsrecht für die Prozedurnur indirekt
-567Die Prozedur darf z. Zt. nicht ausgeführt werdennur indirekt
-566Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werdennur indirekt
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochennur indirekt
-500Falsche Parameternur 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-29Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
6.5.0 2012-09-17Holger Wies : Datentyp des Parameters „PersonTypeID“ von „smallint“ auf „tinyint“ korrigiert
4.0.15 2004-07-301. 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-031. Überarbeitung der Doku
2. Fehlende Sortierung der Rückgabemenge in einem Fall
3.5.20 2002-07-22
3.5.6 2001-04-17
3.5.0 2000-11-23Erstmalig 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:

cURL

Unformatierte Ausgabe:

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

Mit xmllint 7) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/pm_GetGroups_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_GetGroups_Ad',
		array(
			// 'PersonID' => NULL,
			// 'PersonTypeID' => NULL,
			// 'IncludeIndependentGroups' => 0
		)
);
 
$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_GetGroups_Ad">
			<Parameters>
				<!-- <Parameter Name="PersonID">NULL</Parameter> -->
				<!-- <Parameter Name="PersonTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="IncludeIndependentGroups">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.
6)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
7)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/pm_getgroups_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)