Dient der Verwaltung von vordefinierten „Elementen“, die als „andere“ Positionen auf einer Rechnung auftauchen können - wie z.B. „Versandkosten“ oder „Mindermengenzuschlag“ etc.
Anmerkungen zu den Parametern „TableID“ und „TableKeyID“ :
1.) Optional kann über „TableID“ und „TableKeyID“ eine Referenz auf einen Datensatz einer anderen Tabelle erzeugt werden (z.B. auf eine Versandart, also eine „ShippingTypeID“ der Tabelle „ShippingTypes“.
2.) Mögliche Werte für „TableID“ : siehe Rückgabespalte „TableID“ der Ergebnismenge des Aufrufs
„exec mi_GetTabsRefInOtherTabs_Ad UsedInPredefinedBillContent = 1“
3.) „TableKeyID“ muß dann ein Wert aus der entsprechenden (durch „TableID“ angegebenen) Tabelle sein, der in der durch „PrimaryKeyColumnName“ angegebenen Spalte dieser Tabelle vorkommt.
HTTP-Method | POST |
HTTP-Auth | Optional |
Alias | om_ModifyPredefinedBillContent_Ad |
Tags | |
Engine-Kategorie | order management |
Engine-Typ | Daten-Änderung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
PredefinedBillContentID | ID eines vordefinierten „Elementes“, das als „andere“ (nicht auf einer Auftrags-Position basierenden) Rechnungs-Position verwendet werden kann. Bei „NULL“ wird ein neues Element angelegt, sonst das vorhandene (je nach „Delete“) gelöscht oder geändert. | smallint | 5.5.0 | |
ContentDescription | Bezeichnung des vordefinierten Elementes (z.B. „Versandkosten“) | varchar(100) | 5.5.0 | |
TableID | NULL | ID einer Tabelle, in der ein Element (→ „TableKeyID“) definiert ist, auf das sich das vordefiniertes Element („PredefinedBillContentID“ bzw. das neue Element) bezieht. Mögliche Werte : siehe Beschreibung. | tinyint | 5.5.0 |
TableKeyID | NULL | ID eines Objektes der durch „TableID“ angegebenen Tabelle, auf das sich das vordefiniertes Element („PredefinedBillContentID“ bzw. das neue Element) bezieht. Mögliche Werte : siehe Beschreibung. | integer | 5.5.0 |
Active | 1 | Die Einstellung „Active“, steuerbar über diesen Parameter, dient als Filter-Option für om_GetPredefinedBillContent_Ad, um alte, nicht mehr zu verwendende, Elemente (die aber nicht gelöscht werden können) „auszublenden“ | bit | 5.5.0 |
Delete | 0 | Wird nur beachtet, falls „PredefinedBillContentID“ nicht „NULL“ ist ! „0“ : Das Element soll (gemäß den Werten der anderen Parameter) geändert werden „1“ : Das Element soll gelöscht werden | bit | 5.5.0 |
Die Prozedur hat keine Rückgaben.
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 4) |
---|---|---|
-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 |
-502 | Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen) | nur indirekt |
-500 | Falsche Parameter | nur 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] |
6.5.4 | 2013-04-29 | Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung |
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 POST 'http://<partner>-<project>.dstore.de/default/engine/om_ModifyPredefBillContent_Ad?PredefinedBillContentID=<value>&ContentDescription=<value>'
Mit xmllint 5) formatierte Ausgabe:
curl -X POST 'http://<partner>-<project>.dstore.de/default/engine/om_ModifyPredefBillContent_Ad?PredefinedBillContentID=<value>&ContentDescription=<value>' | 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_ModifyPredefBillContent_Ad', array( 'PredefinedBillContentID' => <value>, 'ContentDescription' => '<value>', // 'TableID' => NULL, // 'TableKeyID' => NULL, // 'Active' => 1, // 'Delete' => 0 ) ); $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_ModifyPredefBillContent_Ad"> <Parameters> <Parameter Name="PredefinedBillContentID"><!-- smallint value --></Parameter> <Parameter Name="ContentDescription"><!-- varchar value --></Parameter> <!-- <Parameter Name="TableID">NULL</Parameter> --> <!-- <Parameter Name="TableKeyID">NULL</Parameter> --> <!-- <Parameter Name="Active">1</Parameter> --> <!-- <Parameter Name="Delete">0</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>