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 :
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-Method | GET |
HTTP-Auth | Optional |
Tags | |
Engine-Kategorie | order management |
Engine-Typ | Daten-Ermittlung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
PredefinedBillContentID | NULL | 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. | smallint | 5.5.0 |
TableID | NULL | 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) | tinyint | 5.5.0 |
TableKeyID | NULL | 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) | integer | 5.5.0 |
Active | NULL | 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“ | tinyint | 5.5.0 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
PredefinedBillContentID | ID eines vordefinierten „Elementes“, das als „andere“ (nicht auf einer Auftrags-Position basierenden) Rechnungs-Position verwendet werden kann | smallint | 5.5.0 |
ContentDescription | Bezeichnung der „PredefinedBillContentID“ | varchar(100) | 5.5.0 |
TableID | ID 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“. | tinyint | 5.5.0 |
TableKeyID | ID 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>“). | integer | 5.5.0 |
CreatedAtDateAndTime | Wann wurde das vordefinierte Element „PredefinedBillContentID“ erstellt ? | datetime | 5.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 | bit | 5.5.0 |
(parameterunabängige Sortierung)
Die Prozedur hat keine Output-Parameter.
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 | direkt und indirekt |
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
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 |
Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
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 -
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();
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>