Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:om_getpredefinedbillcontent_ad

om_GetPredefinedBillContent_Ad

Gibt vordefinierte „Elemente“ aus, die als „andere“ Positionen auf einer Rechnung (nicht auf einer Auftrags-Position basierend) auftauchen können - wie z.B. „Versandkosten“ oder „Mindermengenzuschlag“ etc.

Anmerkungen zu den Parametern „TableID“ und „TableKeyID“ :

1.) Wenn „PredefinedBillContentID = NULL“ ist, kann man auch mit „TableID“ und „TableKeyID“ nach bestimmten vordefinierten „Elementen“ (die als „andere“ Rechnungs-Position verwendet werden können) filtern.
Hintergrund : Jede vordefinierte Rechnungsposition KANN (muß aber nicht) eindeutig auf einen Datensatz einer anderen Tabelle referenzieren, wie z.B. einer Versandart (also einer „PaymentTypeID“ aus der Tabelle „PaymentTypes“).

2.) Es findet zwar keine Überprüfung bzgl. dieser Parameter statt, aber sinnvolle Werte erhält man durch mi_GetTabsRefInOtherTabs_Ad. Genauer :

  • TableID : Siehe Aufruf „exec mi_GetTabsRefInOtherTabs_Ad UsedInPredefinedBillContent = 1“
  • TableKeyID : Wert der durch „PrimaryKeyColumnName“ (s. Rückgabemenge von „exec mi_GetTabsRefInOtherTabs_Ad TableID“) angegebenen Spalte der durch „TableID“ angegebenen Tabelle

3.) Mann kann „TableID“ angeben und „TableKeyID“ mit „NULL“ belegen, um alle vordefinierten Positionen zu erhalten, die auf Datensätze einer bestimmten Tabelle referenzieren.

4.) „TableKeyID“ wird ignoriert, wenn „TableID“ mit „NULL“ übergeben wird

HTTP-MethodGET
HTTP-AuthOptional
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
PredefinedBillContentIDNULL ID eines vordefinierten „Elementes“, das als „andere“ (nicht auf einer Auftrags-Position basierenden) Rechnungs-Position verwendet werden kann. Falls angegeben, wird nur der entsprechende Datensatz ermittelt.
smallint5.5.0
TableIDNULL Wird nur beachtet, falls „PredefinedBillContentID“ „NULL“ ist ! ID einer Tabelle, in der ein Element (→ „TableKeyID“) definiert ist, auf das sich ein vordefiniertes Element bezieht - und dieses soll ausgegeben werden. (s. Beschreibung)
tinyint5.5.0
TableKeyIDNULL Wird nur beachtet, falls „PredefinedBillContentID“ „NULL“ ist ! ID eines Objektes der durch „TableID“ angegebenen Tabelle, auf das sich ein vordefiniertes Element bezieht - und dieses soll ausgegeben werden. (s. Beschreibung)
integer5.5.0
ActiveNULL Filterung nach der „Active“-Spalte der Rückgabemenge :
„NULL“ : KEINE Einschränkung
„1“ : Nur Datensätze mit „Active = 1“
„0“ : Nur Datensätze mit „Active = 0“
tinyint5.5.0

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
PredefinedBillContentIDID eines vordefinierten „Elementes“, das als „andere“ (nicht auf einer Auftrags-Position basierenden) Rechnungs-Position verwendet werden kann
smallint5.5.0
ContentDescriptionBezeichnung der „PredefinedBillContentID“
varchar(100)5.5.0
TableIDID einer Tabelle, in der ein Element (→ „TableKeyID“) definiert ist, auf das sich der Wert „PredefinedBillContentID“ bezieht. Mögliche Werte : siehe Ergebnis des Aufrufs „exec mi_GetTabsRefInOtherTabs_Ad UsedInPredefinedBillContent = 1“.
tinyint5.5.0
TableKeyIDID eines Objektes der durch „TableID“ angegebenen Tabelle, auf das sich der Wert „PredefinedBillContentID“ bezieht. Mögliche Werte : Werte für die „PrimaryKeyColumnName“-Spalte der Tabelle (siehe „exec mi_GetTabsRefInOtherTabs_Ad TableID = <TableID>“).
integer5.5.0
CreatedAtDateAndTimeWann wurde das vordefinierte Element „PredefinedBillContentID“ erstellt ?
datetime5.5.0
Active„0“ : Das vordefinierte Element kann NICHT mehr als „andere“ Rechnungs-Position verwendet werden
„1“ : Das vordefinierte Element kann aktuell als „andere“ Rechnungs-Position verwendet werden
bit5.5.0
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • TableID (aufsteigend)
  • ContentDescription (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_GetPredefinedBillContent_Ad'

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetPredefinedBillContent_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_GetPredefinedBillContent_Ad',
		array(
			// 'PredefinedBillContentID' => NULL,
			// 'TableID' => NULL,
			// 'TableKeyID' => NULL,
			// 'Active' => 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_GetPredefinedBillContent_Ad">
			<Parameters>
				<!-- <Parameter Name="PredefinedBillContentID">NULL</Parameter> -->
				<!-- <Parameter Name="TableID">NULL</Parameter> -->
				<!-- <Parameter Name="TableKeyID">NULL</Parameter> -->
				<!-- <Parameter Name="Active">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_getpredefinedbillcontent_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)