Inhaltsverzeichnis
om_GetBillInformationRules_Ad
Man erhält die konfigurierten Regeln bzgl. der Verwaltung von (zusätzlichen) Informationen zu Rechnungen.
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 Rechnung befindet.
Hinweis zur Reihenfolge der Beachtung der Regeln :
1. Regeln zu einer gegebenen „UserID“ werden immer „globalen“ Regeln („UserID = -1“) vorgezogen, und zwar unabhängig von der „InformationTypeID“ und „BillStateID“ !
2. Eine Regel zu einer gegebenen „InformationTypeID“ hat eine höhere Priorität als die „allgemeine“ ID mit dem Wert „-32768“ - unabhängig von „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 Rechnung 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 !
| HTTP-Method | GET |
| HTTP-Auth | Optional |
| Tags | |
| Engine-Kategorie | order management |
| Engine-Typ | Daten-Ermittlung |
| Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Parameter
| Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
|---|---|---|---|---|
| UserID | NULL | 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. | smallint | 5.5.0 |
| InformationTypeID | NULL | ID eines Informations-Typs für Rechnungen. Wenn angegeben, werden nur Regeln für diesen Informations-Typ zurückgegeben. | smallint | 5.5.0 |
| BillStateID | NULL | ID eines Rechnungs-Status. Wenn angegeben, werden nur Regeln für diesen Status zurückgegeben. | tinyint | 5.5.0 |
Rückgabe
(parameterunabhängig)
| Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
|---|---|---|---|
| InformationTypeID | ID eines Typs von Informationen, die zu Rechnungen hinterlegt werden können (mögliche Werte : s. om_GetBillInformationTypes_Ad). „-32768“ bedeutet, daß die Regel unabhängig der Informations-Art gilt. | smallint | 5.5.0 |
| InformationType | Bezeichnung der „InformationTypeID“ | varchar(100) | 5.5.0 |
| UserID | ID eines „dStore“-Benutzers. Dieser darf die durch „ModificationAllowed“ angegebenen Arten von Änderungen an Informationen des Typs „InformationTypeID“ durchführen, wenn sich die Rechnung im Status „BillStateID“ befindet. | smallint | 5.5.0 |
| UserName | Name des Benutzers „UserID“ | varchar(50) | 5.5.0 |
| BillStateID | ID eines Rechnungs-Status. Der Benutzer „UserID“ darf die durch „ModificationAllowed“ angegebenen Arten von Änderungen an Informationen des Typs „InformationTypeID“ durchführen, sofern sich die Rechnung in diesem Status befindet. | tinyint | 5.5.0 |
| BillState | Bezeichnung 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 | tinyint | 5.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) |
|---|---|---|
| -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 |
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] |
| 5.5.0 | 2008-01-07 | 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:
cURL
Unformatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetBillInformationRules_Ad'
Mit xmllint 6) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetBillInformationRules_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_GetBillInformationRules_Ad', array( // 'UserID' => NULL, // 'InformationTypeID' => NULL, // 'BillStateID' => 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_GetBillInformationRules_Ad"> <Parameters> <!-- <Parameter Name="UserID">NULL</Parameter> --> <!-- <Parameter Name="InformationTypeID">NULL</Parameter> --> <!-- <Parameter Name="BillStateID">NULL</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>