Benutzer-Werkzeuge

Webseiten-Werkzeuge


develop:xmlrpc:einzelauftrag

Dies ist eine alte Version des Dokuments!


XML-RPC: Einzel-Aufträge

  • Namen der Services
    • hibiscus.xmlrpc.ueberweisung Für den Zugriff auf Einzel-Überweisungen
    • hibiscus.xmlrpc.lastschrift Für den Zugriff auf Einzel-Lastschriften

Die Funktionen für Überweisungen und Lastschriften sind identisch, lediglich die Service-Namen unterscheiden sich.

Schüssel-Namen

Bezeichnung Beschreibung
konto ID des Kontos
termin Ausführungstermin im Format dd.mm.yyyy
blz Bankleitzahl des Gegenkontos
kontonummer Kontonummer des Gegenkontos
name Inhaber-Name des Gegenkontos
betrag Betrag des Auftrages im Format „0,00“
verwendungszweck Verwendungszweck (Array)
textschluessel Text-Schlüssel (Auftragsart)
ausgefuehrt Auftragsstatus (true/false)

Verfügbare Funktionen

Liste der Aufträge ermitteln

public List<Map> find(String text, String von, String bis) throws RemoteException;
  • Name der Funktion: find
  • Liste der Parameter
    1. String Suchbegriff (darf leer sein)
    2. String Start-Datum des Termins im Format „dd.mm.yyyy“ oder „yyyy-mm-dd“ (darf leer sein)
    3. String End-Datum des Termins im Format „dd.mm.yyyy“ oder „yyyy-mm-dd“ (darf leer sein)
  • Rückgabe-Werte: array<struct> (Liste mit „struct“-Elementen)
    Liste der gefundenen Aufträge. Jedes Element der Liste enthält einen Auftrag in Form eines Struct mit den o.g. Schlüsseln

Code-Beispiele

Java
String[] params = new String[]{"test",
                               "01.01.2009",
                               "31.12.2011"
                              };
Object[] l = (Object[]) client.execute("hibiscus.xmlrpc.ueberweisung.find",params);
// Object[] l = (Object[]) client.execute("hibiscus.xmlrpc.lastschrift.find",params);
 
for (Object o:l)
{
  System.out.println(o);
}
PHP
$params = array(new xmlrpcval("test","string"),
                new xmlrpcval("01.01.2009","string"),
                new xmlrpcval("31.12.2011","string"));
 
$msg = new xmlrpcmsg("hibiscus.xmlrpc.ueberweisung.find",$params);
// $msg = new xmlrpcmsg("hibiscus.xmlrpc.lastschrift.find",$params);
 
$response = $client->send($msg);
 
$value = $response->value();
 
for ($i=0;$i<$value->arraySize();$i++)
{
  $job = $value->arrayMem($i);
  print("ID        : ".$job->structMem("id")->scalarVal()."\n");
  print("Termin    : ".$job->structMem("termin")->scalarVal()."\n");
  print("Ausgeführt: ".$job->structMem("ausgefuehrt")->scalarVal()."\n");
  print("Name      : ".$job->structMem("name")->scalarVal()."\n");
  print("Konto     : ".$job->structMem("konto")->scalarVal()."\n");
  print("BLZ       : ".$job->structMem("blz")->scalarVal()."\n");
  print("Betrag    : ".$job->structMem("betrag")->scalarVal()."\n");
 
  $zweck = $job->structMem("verwendungszweck");
  for ($k=0;$k<$zweck->arraySize();$k++)
  {
    $line = $zweck->arrayMem($k);
    print("  ".$line->scalarVal()."\n");
  }
  print("\n");
}

Liste der Aufträge ermitteln (veraltet)

deprecated Diese Funktion existiert aus Gründen der Abwärtskompatibilität weiterhin.
Verwende künftig jedoch bitte die Funktion find mit dem „struct“-Parameter - die neue Funktion liefert zudem detailliertere Rückgabe-Werte.
public String[] list() throws RemoteException;
  • Name der Funktion: list
  • Verwendung: Liefert eine Liste aller Aufträge
  • Liste der Parameter: <keine>
  • Rückgabe-Werte: array<string> (Liste mit „String“-Elementen)
    Liste der gefundenen Aufträge. Die Werte in jeder Zeile sind durch Doppelpunkte getrennt.

    Aufbau der Zeilen
    <konto_id>:<kontonummer>:<blz>:<name>:<zweck (nur Zeile 1)>:<zweck (nur Zeile 2)>:<betrag>

Code-Beispiele

Java
Object[] list = (Object[]) client.execute("hibiscus.xmlrpc.ueberweisung.list",(Object[])null);
// Object[] list = (Object[]) client.execute("hibiscus.xmlrpc.lastschrift.list",(Object[])null);
for (Object o:list)
{
  System.out.println(o);
}
PHP
$msg = new xmlrpcmsg("hibiscus.xmlrpc.ueberweisung.list");
// $msg = new xmlrpcmsg("hibiscus.xmlrpc.lastschrift.list");
$response = $client->send($msg);
$value = $response->value();
 
for ($i=0;$i<$value->arraySize();$i++)
{
  print($value->arrayMem($i)->scalarVal()."\n");
}

Auftrag anlegen

public String create(Map auftrag) throws RemoteException;
  • Name der Funktion: create
  • Liste der Parameter
    1. struct Struct mit den Eigenschaften des Auftrages. Als Schlüssel sind die o.g. Schlüssel-Namen zu verwenden.
  • Rückgabe-Wert

Code-Beispiele

Java
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.util.HashMap;
 
Map params = new HashMap();
params.put("betrag","1,50");
params.put("termin","15.01.2011");
params.put("konto","1");
params.put("name","Max Mustermann");
params.put("blz","12345678");
params.put("kontonummer","1234567890");
 
params.put("verwendungszweck","Test");
// alternativ
// List lines = new ArrayList();
// lines.add("Zweck 1");
// lines.add("Zweck 2");
// lines.add(...);
// params.put("verwendungszweck",lines);
 
Object result = client.execute("hibiscus.xmlrpc.ueberweisung.create",new Object[]{params});
// Object result = client.execute("hibiscus.xmlrpc.lastschrift.create",new Object[]{params});
System.out.println(result);
PHP
$params = new xmlrpcval(
  array(
    "betrag"           => new xmlrpcval("1,50","string"),
    "termin"           => new xmlrpcval("15.01.2011","string"),
    "konto"            => new xmlrpcval("1","string"),
    "name"             => new xmlrpcval("Max Mustermann","string"),
    "blz"              => new xmlrpcval("12345678","string"),
    "kontonummer"      => new xmlrpcval("1234567890","string"),
    "verwendungszweck" => new xmlrpcval("Test","string"),
    // alternativ
    // "verwendungszweck" => new xmlrpcval(array(new xmlrpcval("Zweck 1","string"),new xmlrpcval("Zweck 2","string")))
  ),"struct");
 
$msg = new xmlrpcmsg("hibiscus.xmlrpc.ueberweisung.create",array($params));
// $msg = new xmlrpcmsg("hibiscus.xmlrpc.lastschrift.create",array($params));
$response = $client->send($msg);
print($response->value()->scalarval());


Impressum | Datenschutz
develop/xmlrpc/einzelauftrag.1297348004.txt.gz · Zuletzt geändert: d.m.Y H:i (Externe Bearbeitung)