mi_ModifyUserGroups_Ad [dstore]

Inhaltsverzeichnis

mi_ModifyUserGroups_Ad

mi_ModifyUserGroups_Ad

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

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).

Hinweis :
Gruppen mit IDs unter „101“ sind für interne Zwecke reserviert, d.h. sie können weder geändert noch gelöscht werden, und neue (durch diese Prozedur angelegte) Gruppen haben eine ID, die höher als „100“ ist.

HTTP-Method	POST
HTTP-Auth	Optional
Tags	[mi, Modify, User, Groups, Ad]
Engine-Kategorie	configurations
Engine-Typ	Daten-Änderung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
UserGroupID	NULL	ID einer Benutzer-Gruppe. Bei Angabe von „NULL“ wird eine neue Gruppe angelegt, ansonsten wird die vorhandene Gruppe geändert bzw. gelöscht (je nach „DeleteGroup“).	smallint	5.0.0
GroupName		Beschreibung, 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
GroupDescription		Ausführlichere Beschreibung der Gruppe	varchar(255)	5.0.0
DeleteGroup	0	Wird nur beachtet, wenn „UserGroupID“ angegeben ist. „0“ : Die bestehende Gruppe soll geändert werden „1“ : Die bestehende Gruppe soll gelöscht werden	bit	5.0.0

Rückgabe

Die Prozedur hat keine Rückgaben.

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
-512	Die Benutzer-Gruppe darf nicht geändert/gelöscht werden	nur direkt
-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
-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]
6.5.3	2013-03-18	Interne Anpassungen wg. UTF8-Unterstützung
6.0.3	2011-09-07	Ab jetzt gibt's „-500“ wenn „GroupName“ bei Neu-Anlage oder Änderung mit „NULL“ übergeben wird
5.1.10	2007-03-12	Ab jetzt sind „UserGroupID“s unter „101“ für interne Zwecke reserviert
5.0.0	2004-12-21	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:

mi_ModifyUserGroups_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/mi_ModifyUserGroups_Ad?GroupName=<value>&GroupDescription=<value>'

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X POST  'http://<partner>-<project>.dstore.de/default/engine/mi_ModifyUserGroups_Ad?GroupName=<value>&GroupDescription=<value>' | 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_ModifyUserGroups_Ad',
		array(
			'GroupName' => '<value>',
			'GroupDescription' => '<value>',
			// 'UserGroupID' => NULL,
			// 'DeleteGroup' => 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_ModifyUserGroups_Ad">
			<Parameters>
				<Parameter Name="GroupName"><!-- varchar value --></Parameter>
				<Parameter Name="GroupDescription"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="UserGroupID">NULL</Parameter> -->
				<!-- <Parameter Name="DeleteGroup">0</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