om_GetBillContentInfo_Ad [dstore]

Inhaltsverzeichnis

om_GetBillContentInfo_Ad

om_GetBillContentInfo_Ad

Gibt zusätzliche Informationen zu einer oder mehreren angegebenen Rechnungs-Positionen aus, die auf Auftrags-Positionen basieren.

HTTP-Method	GET
HTTP-Auth	Optional
Alias	om_GetBillContentInformation_Ad
Tags	[om, Get, Bill, Content, Information, Ad]
Engine-Kategorie	order management
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
BillContentID	NULL	ID einer Rechnungs-Position (die auf einer Auftrags-Position basiert), zu der hinterlegte zusätzliche Informationen ermittelt werden sollen. Bei Angabe von „NULL“ werden „BillContentID“s in „tempdb.dbo.OneID“ erwartet.	integer	5.5.0
InformationTypeIDList	NULL	Möchte man nur die Daten zu bestimmten Informations-Typen haben, kann man die entsprechenden IDs (durch „¶“ getrennt) hier übergeben. Achtung : Aus technischen Gründen dürfen maximal 253 Zeichen übergeben werden !	varchar(255)	5.5.0

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
BillContentID	ID einer Rechnungs-Position (die auf einer Auftrags-Position basiert)	integer	5.5.0
InformationTypeID	ID eines Informationstyps, also um was es sich bei der Zusatz-Information „Information“ handelt	smallint	5.5.0
InformationType	Bezeichnung der „InformationTypeID“	varchar(100)	5.5.0
Information	Die zur Rechnungs-Position „BillContentID“ hinterlegt Information des Typs „InformationTypeID“	varchar(250)	5.5.0
CreatedAtDateAndTime	Wann wurde die Information „Information“ zur „BillContentID“ hinterlegt ?	datetime	5.5.0
CreatedByUserID	ID des „dStore“-Benutzers (der in „UserInfo“ registriert ist) der die Information hinterlegt hat	smallint	5.5.0

Sortierung der Rückgabe

(parameterunabängige Sortierung)

BillContentID (aufsteigend)
InformationTypeID (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-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	direkt und indirekt
-502	Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)	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]
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

Code-Snippets

Engine Playground

Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:

om_GetBillContentInfo_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetBillContentInfo_Ad'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetBillContentInfo_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_GetBillContentInfo_Ad',
		array(
			// 'BillContentID' => NULL,
			// 'InformationTypeIDList' => 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_GetBillContentInfo_Ad">
			<Parameters>
				<!-- <Parameter Name="BillContentID">NULL</Parameter> -->
				<!-- <Parameter Name="InformationTypeIDList">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“

⁶⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Inhaltsverzeichnis