====== XML-RPC: Konten ======

  * Name des Service: **hibiscus.xmlrpc.konto**

===== Schlüssel-Namen =====

^ Bezeichnung     ^ Beschreibung                     ^
| kontonummer     | Kontonummer                      |
| unterkonto      | Unterkontonummer (i.d.R. leer)   |
| blz             | Bankleitzahl                     |
| name            | Name des Kontoinhabers           |
| bezeichnung     | Bezeichnung des Kontos           |
| kundennummer    | Kundennummer                     |
| kommentar       | Kommentar (Freitext)             |
| bic             | BIC-Nummer (EU-BLZ)              |
| iban            | IBAN-Nummer (EU-Kontonummer)     |
| waehrung        | Währungsbezeichnung (EUR)        |
| saldo           | aktueller Saldo des Kontos im Locale-spezifischen Format des Systems |
| saldo_available | verfügbarer Saldo (incl. Dispo) im Locale-spezifischen Format des Systems oder "", falls die Bank das nicht unterstützt |
| saldo_datum     | Datum des Saldos im Format dd.mm.yyyy |



===== Verfügbare Funktionen =====



==== Liste der Konten ermitteln ====

<code java>
public List<Map<String,String>> find() throws RemoteException;
</code>

  * Name der Funktion: **find**
  * Liste der Parameter <keine>
  * Rückgabe-Wert: **array<struct>** (Liste mit "struct"-Elementen)\\ Liste der Konten. Jedes Element der Liste enthält ein Konto in Form eines Struct mit den o.g. Schlüsseln

=== Code-Beispiele ===

== Java ==

<code java>
import java.util.Map;

Object[] list = (Object[]) client.execute("hibiscus.xmlrpc.konto.find",(Object[]) null);
for (Object o:list)
{
  Map konto = (Map) o;
  System.out.println("ID  : " + konto.get("id"));
  System.out.println("Name: " + konto.get("name"));
  System.out.println("Nr. : " + konto.get("kontonummer"));
  System.out.println("BLZ : " + konto.get("blz"));
}
</code>


== PHP ==

<code php>
$msg = new xmlrpcmsg("hibiscus.xmlrpc.konto.find");
$response = $client->send($msg);
$value = $response->value();

for ($i=0;$i<$value->arraySize();$i++)
{
  $konto = $value->arrayMem($i);
  print("ID  : ".$konto->structMem("id")->scalarVal()."\n");
  print("Name: ".$konto->structMem("name")->scalarVal()."\n");
  print("Nr. : ".$konto->structMem("kontonummer")->scalarVal()."\n");
  print("BLZ : ".$konto->structMem("blz")->scalarVal()."\n");
}
</code>


==== Liste der Konten ermitteln (veraltet) ====

| **deprecated** Diese Funktion existiert aus Gründen der Abwärtskompatibilität weiterhin. \\ Verwende künftig jedoch bitte die Funktion **[[develop:xmlrpc:konto#liste_der_konten_ermitteln|find]]** - die neue Funktion liefert zudem detailliertere Rückgabe-Werte. |


<code java>
public String[] list() throws RemoteException; //deprecated
</code>

  * Name der Funktion: **list**
  * Liste der Parameter <keine>
  * Rückgabe-Werte: **array<string>** (Liste mit "String"-Elementen) \\ Liste der Konten. Die Werte in jeder Zeile sind durch Doppelpunkte getrennt.\\ \\ Aufbau der Zeilen <code><ID>:<kontonummer>:<blz>:<bezeichnung>:<kundennummer>:<name>:<saldo>:<saldo_datum></code>


=== Code-Beispiele ===

== Java ==

<code java>
Object[] list = (Object[]) client.execute("hibiscus.xmlrpc.konto.list",(Object[]) null);
for (Object o:list)
{
  System.out.println(o);
}
</code>


== PHP ==

<code php>
$msg = new xmlrpcmsg("hibiscus.xmlrpc.konto.list");
$response = $client->send($msg);
$value = $response->value();

for ($i=0;$i<$value->arraySize();$i++)
{
  print($value->arrayMem($i)->scalarVal()."\n");
}
</code>

==== Bankverbindung prüfen ====

<code java>
public boolean checkAccountCRC(String blz, String kontonummer) throws RemoteException;
</code>

  * Name der Funktion: **checkAccountCRC**
  * Beschreibung: Prüfung einer Kontonummer-/BLZ-Kombination auf Plausibilität; Prüfsummen-Check der Kontonummer
  * Liste der Parameter
    - **String** Bankleitzahl
    - **String** Kontonummer
  * Rückgabe-Wert: **boolean** //TRUE//, wenn die Konto-/BLZ-Kombination korrekt ist, sonst //FALSE//


=== Code-Beispiele ===

== Java ==

<code java>
Object result = client.execute("hibiscus.xmlrpc.konto.checkAccountCRC",new String[]{"12345678","1234567890"});
System.out.println(result);
</code>


== PHP ==

<code php>
$msg = new xmlrpcmsg("hibiscus.xmlrpc.konto.checkAccountCRC",array(new xmlrpcval("12345678","string"),new xmlrpcval("1234567890","string")));
$response = $client->send($msg);
$value = $response->value();
print($value->scalarVal()."\n");
</code>


==== Name des Kreditinstitutes zur BLZ ermitteln ====

<code java>
  public String getBankname(String blz) throws RemoteException;
</code>

  * Name der Funktion: **getBankname**
  * Verwendung: Ermitteln des Namens des Kreditinstituts zu einer BLZ
  * Liste der Parameter
    - **String** BLZ
  * Rückgabe-Wert: **String** Name des Kreditinstituts oder ein Leer-String, wenn zu dieser BLZ kein Kreditinstitut gefunden wurde



=== Code-Beispiele ===

== Java ==

<code java>
Object result = client.execute("hibiscus.xmlrpc.konto.getBankname",new String[]{"10000000"});
System.out.println(result);
</code>


== PHP ==

<code php>
$msg = new xmlrpcmsg("hibiscus.xmlrpc.konto.getBankname",array(new xmlrpcval("10000000","string")));
$response = $client->send($msg);
$value = $response->value();
print($value->scalarVal()."\n");
</code>