Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:mi_getusergroups_ad

mi_GetUserGroups_Ad

Gibt Gruppen, in die registrierte „dStore“-Benutzer (s. mi_GetUserInfo_Ad) eingeordnet werden können, aus.

Hintergrund : Mit Hilfe von solchen Benutzer-Gruppen läßt sich die Administration der Rechtevergabe für Prozeduren und die Einschränkung von Prozedur-Aufrufen vereinfachen (s. z.B. mi_ModifyProcExRestForGroup_Ad).

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

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
UserGroupIDNULL ID einer Benutzer-Gruppe. Falls angegeben, werden nur die Daten zu dieser Gruppe ausgegeben.
smallint5.0.0
GetAssignedUsers0 „1“ angeben, um zu jeder Gruppe in der Ergebnismenge noch die Benutzer zu erhalten, die der jeweiligen Gruppe zugeordnet sind.
bit5.0.0

Rückgabe

wenn GetAssignedUsers = 0

Spaltenname Beschreibung SQL-Datentyp4) ab Version
UserGroupIDID einer User-Gruppe
smallint5.0.0
GroupNameBeschreibung, wofür die Gruppe da ist, bzw. eine Art Charakterisierung aller Benutzer in dieser Gruppe, z.B. „Produkt-Management“ oder „Auftrags-Clearing“ etc.
varchar(100)5.0.0
GroupDescriptionAusführlichere Beschreibung der Gruppe
varchar(255)5.0.0
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • GroupName (aufsteigend)

wenn GetAssignedUsers = 1

Spaltenname Beschreibung SQL-Datentyp5) ab Version
UserGroupIDID einer User-Gruppe
smallint5.0.0
GroupNameBeschreibung, wofür die Gruppe da ist, bzw. eine Art Charakterisierung aller Benutzer in dieser Gruppe, z.B. „Produkt-Management“ oder „Auftrags-Clearing“ etc.
varchar(100)5.0.0
GroupDescriptionAusführlichere Beschreibung der Gruppe
varchar(255)5.0.0
UserIDID eines „dStore“-Benutzers, der in „UserInfo“ registriert ist, und der der Gruppe „UserGroupID“ zugeordnet ist
smallint5.0.0
UserNameName des Benutzers „UserID“
varchar(50)5.0.0
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • GroupName (aufsteigend)
  • UserName (aufsteigend)

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.3 2013-03-18Anpassungen an den aktuellen Quellcode-Standard
5.0.0 2004-12-21Erstmalig 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/mi_GetUserGroups_Ad'

Mit xmllint 7) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetUserGroups_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'),
	'mi_GetUserGroups_Ad',
		array(
			// 'UserGroupID' => NULL,
			// 'GetAssignedUsers' => 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="mi_GetUserGroups_Ad">
			<Parameters>
				<!-- <Parameter Name="UserGroupID">NULL</Parameter> -->
				<!-- <Parameter Name="GetAssignedUsers">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
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/mi_getusergroups_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)