Gibt im „dStore“ definierte Gruppen, in die Personen eingeordnet werden können, zurück.
HTTP-Method | GET |
HTTP-Auth | Optional |
Tags | |
Engine-Kategorie | person management |
Engine-Typ | Daten-Ermittlung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
PersonID | NULL | ID einer Person. Wenn angegeben, werden nur die Gruppen zurückgegeben, denen diese Person angehört. | integer | 3.5.0 |
PersonTypeID | NULL | 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“). | tinyint | 3.5.20 |
IncludeIndependentGroups | 0 | 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 | bit | 3.5.20 |
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 | bit | 3.5.0 |
GroupID | ID einer Personen-Gruppe | smallint | 3.5.0 |
GroupDescription | Bezeichnung der Gruppe „GroupID“ | varchar(100) | 3.5.0 |
SortNo | Bestimmt die Reihenfolge von „GroupID“ innerhalb aller Gruppen (hohe Nummer = hohe Priorität) | smallint | 3.5.0 |
PersonTypeID | ID 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. | tinyint | 3.5.6 |
ConditionID | ID einer (Gruppen-)Bedingung (siehe pm_GetGroupConditions_Ad) | smallint | 3.5.0 |
(parameterunabängige Sortierung)
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 6) |
---|---|---|
-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 |
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
7.0.7 | 2015-01-29 | Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf] |
6.5.0 | 2012-09-17 | Holger Wies : Datentyp des Parameters „PersonTypeID“ von „smallint“ auf „tinyint“ korrigiert |
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 | 1. Ü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-23 | Erstmalig in dieser Version erstellt |
Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
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 -
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();
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>