Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:om_getbillcontentinforules_ad

om_GetBillContentInfoRules_Ad

Man erhält die konfigurierten Regeln bzgl. der Verwaltung von (zusätzlichen) Informationen zu Rechnungs-Positionen, die auf Auftrags-Positionen basieren.

Diese sind pro Informations-Art konfigurierbar und hängen zum einem vom Benutzer, der die Änderung vornehmen möchte, ab, sowie vom Status, in dem sich die zugehörige Rechnung befindet.

Hinweis zur Reihenfolge der Beachtung der Regeln :

1. Regeln zu einem bestimmten Benutzer („UserID“) werden immer „globalen“ Regeln „(„UserID = -1“) vorgezogen, und zwar unabhängig der „InformationTypeID“ (Informations-Art) und „BillStateID“ (Rechnungs-Status) !

2. Eine Regel zu einer gegebenen „InformationTypeID“ hat eine höhere Priorität als die „allgemeine“ ID mit dem Wert “-32768„, unabhängig der „BillStateID“.

3. Eine Regel zu einer gegebenen „BillStateID“ schließlich hat Vorrang vor dem „allgemeinen“ Status (Wert „255“)

4. Ist für eine „Benutzer-Informationsart-Status-Kombination“ (also zu einer gegebenen „UserID“, „InformationTypeID“ und „BillStateID“) KEINE passende Regel vorhanden, bedeutet dies implizit, daß der Benutzer für diese Informationsart an einer Rechnungsposition GAR KEINE Änderung vornehmen darf, wenn die Rechnung sich in diesem Status befindet !
Anders formuliert : Keine passende Regel ist gleichbedeutend mit einer passenden Regel, bei der „ModificationAllowed = 0“ ist !

Anmerkungen zum Parameter „GetMyRulesForBillContentID“ :

1.) Um einem Benutzer bei einer bestimmten Rechnungsposition anzeigen zu können, welche Informations-Arten noch geändert werden dürfen (und was geändert werden darf), übergibt man im Parameter „GetMyRulesForBillContentID“ die ID der Rechnungs-Position. Die anderen Parameter werden in diesem Fall ignoriert.

Falls also der Parameter mit einer ID belegt wird, gilt :

2.) Alle „ModificationAllowed“-Werte sind natürlich größer als „0“

3.) „UserID“/„UserName“ enthalten immer den gleichen Wert (nämlich die zugehörigen Werte des Benutzers, der dieser Prozedur hier aufruft)

4.) „BillStateID“ enthält die ID des Status der zugehörigen Rechnung

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

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
UserIDNULL ID eines „dStore“-Benutzers, der in „UserInfo“ registriert ist (siehe mi_GetUserInfo_Ad). Falls angegeben, werden nur die Regeln, die für diesen Nutzer definiert sind, zurückgegeben.
smallint5.5.0
BillStateIDNULL Wird nur beachtet, wenn „GetMyRulesForBillContentID = NULL“ ist ! ID eines Rechnungs-Status. Wenn angegeben, werden nur Regeln für diesen Status zurückgegeben.
tinyint5.5.0
InformationTypeIDNULL Wird nur beachtet, wenn „GetMyRulesForBillContentID = NULL“ ist ! ID eines Informations-Typs für Rechnungs-Positionen. Wenn angegeben, werden nur Regeln für diesen Informations-Typ zurückgegeben.
smallint5.5.0
GetMyRulesForBillContentIDNULL ID einer Rechnungs-Position (die auf einer Auftrags-Position basiert), zu der ermittelt werden soll, welche Informations-Arten vom Benutzer (der die Prozedur aufruft) noch geändert werden dürfen (und was geändert werden darf) - s.a. Beschreibung !
tinyint5.5.0

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
InformationTypeIDID eines Typs von Informationen, die zu Rechnungs-Positionen hinterlegt werden können (mögliche Werte : s. om_GetBillContentInfoTypes_Ad). “-32768„ bedeutet, daß die Regel unabhängig der Informations-Art gilt.
smallint5.5.0
InformationTypeBezeichnung der „InformationTypeID“
varchar(100)5.5.0
UserIDID eines „dStore“-Benutzers. Dieser darf die durch „ModificationAllowed“ angegebenen Arten von Änderungen an Informationen des Typs „InformationTypeID“ durchführen, wenn sich die zugehörige Rechnung im Status „BillStateID“ befindet.
smallint5.5.0
UserNameName des Benutzers „UserID“
varchar(50)5.5.0
BillStateIDID eines Rechnungs-Status. Der Benutzer „UserID“ darf die durch „ModificationAllowed“ angegebenen Arten von Änderungen an Informationen des Typs „InformationTypeID“ durchführen, sofern sich die zugehörige Rechnung in diesem Status befindet.
tinyint5.5.0
BillStateBezeichnung des Status „BillStateID“
varchar(50)5.5.0
ModificationAllowed„Summe“ der Arten von Änderungen, die durchgeführt werden dürfen :
- „1“ : NEU hinzufügen
- „2“ : ÄNDERN
- „4“ : LÖSCHEN
⇒ „0“ bedeutet : KEINERLEI Änderungen
tinyint5.5.0
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • InformationType (aufsteigend)
  • UserName (aufsteigend)
  • BillState (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 5)
-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 Parameterdirekt 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-29Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
5.5.0 2008-01-07Erstmalig 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/om_GetBillContentInfoRules_Ad'

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetBillContentInfoRules_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'),
	'om_GetBillContentInfoRules_Ad',
		array(
			// 'UserID' => NULL,
			// 'BillStateID' => NULL,
			// 'InformationTypeID' => NULL,
			// 'GetMyRulesForBillContentID' => NULL
		)
);
 
$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="om_GetBillContentInfoRules_Ad">
			<Parameters>
				<!-- <Parameter Name="UserID">NULL</Parameter> -->
				<!-- <Parameter Name="BillStateID">NULL</Parameter> -->
				<!-- <Parameter Name="InformationTypeID">NULL</Parameter> -->
				<!-- <Parameter Name="GetMyRulesForBillContentID">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
6)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/om_getbillcontentinforules_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)