develop:xmlrpc:einzelauftrag
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Nächste Überarbeitung | Vorhergehende ÜberarbeitungNächste ÜberarbeitungBeide Seiten der Revision | ||
develop:xmlrpc:einzelauftrag [d.m.Y H:i] – angelegt willuhn | develop:xmlrpc:einzelauftrag [d.m.Y H:i] – [Schlüssel-Namen] willuhn | ||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
- | ==== hibiscus.xmlrpc.ueberweisung | + | ====== XML-RPC: Einzel-Aufträge ====== |
- | | Name der Funktion | //list// | | + | * Namen der Services |
- | | Verwendung | + | * **hibiscus.xmlrpc.ueberweisung** Für den Zugriff auf Einzel-Überweisungen |
- | | Aufruf-Parameter | + | * **hibiscus.xmlrpc.lastschrift** Für den Zugriff auf Einzel-Lastschriften |
- | | Rückgabe-Wert | + | * **hibiscus.xmlrpc.sepaueberweisung** Für den Zugriff auf SEPA-Überweisungen |
- | < | + | * **hibiscus.xmlrpc.sepalastschrift** Für den Zugriff auf SEPA-Lastschriften |
- | | Name der Funktion | //create// | | + | Die Funktionen für Überweisungen |
- | | Verwendung | + | |
- | | Aufruf-Parameter | + | |
- | | Rückgabe-Wert | // | + | |
+ | ===== Schlüssel-Namen ===== | ||
+ | ^ Bezeichnung | ||
+ | | konto | ID des Kontos | ||
+ | | termin | ||
+ | | blz | Bankleitzahl oder BIC des Gegenkontos | ||
+ | | kontonummer | ||
+ | | name | Inhaber-Name des Gegenkontos | ||
+ | | betrag | ||
+ | | verwendungszweck | Verwendungszweck (Array) | ||
+ | | textschluessel | ||
+ | | ausgefuehrt | ||
- | ==== hibiscus.xmlrpc.lastschrift ==== | ||
- | | Name der Funktion | + | Für SEPA-Überweisungen existieren zusätzlich noch die folgenden Schlüssel-Namen: |
- | | Verwendung | + | |
- | | Aufruf-Parameter | + | ^ Bezeichnung |
- | | Rückgabe-Wert | + | | endtoendid |
- | <Verwendungszweck | + | | pmtinfid |
+ | |||
+ | Für SEPA-Lastschriften | ||
+ | |||
+ | ^ Bezeichnung | ||
+ | | endtoendid | ||
+ | | mandateid | ||
+ | | creditorid | ||
+ | | sigdate | ||
+ | | sequencetype | ||
+ | | sepatype | ||
+ | | targetdate | ||
+ | |||
+ | Generell gilt bei SEPA-Aufträgen: | ||
+ | |||
+ | ===== Zeichensatz ===== | ||
+ | |||
+ | Es ist zu beachten, dass die Zeichenketten insbesondere Namen und Verwendungszwecke im ISO-8859-1 Zeichensatz übermittelt werden. UTF-8 Umlaute werden z.B. abgelehnt. | ||
+ | In PHP kann UTF-8 mittels utf8_decode umgewandelt werden. | ||
+ | |||
+ | ===== Verfügbare Funktionen ===== | ||
+ | |||
+ | |||
+ | ==== Liste der Schlüsselnamen ermitteln ==== | ||
+ | |||
+ | <code java> | ||
+ | public Map< | ||
+ | </ | ||
+ | |||
+ | * Name der Funktion: **createParams** | ||
+ | * Liste der Parameter | ||
+ | | ||
+ | |||
+ | |||
+ | ==== Liste der Aufträge ermitteln ==== | ||
+ | |||
+ | <code java> | ||
+ | public List< | ||
+ | </code> | ||
+ | |||
+ | * Name der Funktion: **find** | ||
+ | * Liste der Parameter | ||
+ | - **String** Suchbegriff (darf leer sein) | ||
+ | - **String** Start-Datum des Termins im Format " | ||
+ | - **String** End-Datum des Termins im Format " | ||
+ | * Rückgabe-Werte: | ||
+ | |||
+ | |||
+ | === Code-Beispiele === | ||
+ | |||
+ | == Java == | ||
+ | |||
+ | <code java> | ||
+ | String[] | ||
+ | " | ||
+ | " | ||
+ | }; | ||
+ | Object[] l = (Object[]) client.execute(" | ||
+ | // Object[] l = (Object[]) client.execute(" | ||
+ | |||
+ | for (Object o:l) | ||
+ | { | ||
+ | System.out.println(o); | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | |||
+ | == PHP == | ||
+ | |||
+ | <code php> | ||
+ | |||
+ | $params = array(new xmlrpcval(" | ||
+ | new xmlrpcval(" | ||
+ | new xmlrpcval(" | ||
+ | |||
+ | $msg = new xmlrpcmsg(" | ||
+ | // $msg = new xmlrpcmsg(" | ||
+ | |||
+ | $response = $client-> | ||
+ | |||
+ | $value = $response-> | ||
+ | |||
+ | for ($i=0; | ||
+ | { | ||
+ | $job = $value-> | ||
+ | print(" | ||
+ | print(" | ||
+ | print(" | ||
+ | print(" | ||
+ | print(" | ||
+ | print(" | ||
+ | print(" | ||
+ | print(" | ||
+ | |||
+ | $zweck = $job-> | ||
+ | for ($k=0; | ||
+ | { | ||
+ | $line = $zweck-> | ||
+ | print(" | ||
+ | } | ||
+ | print(" | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | |||
+ | |||
+ | ==== 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 **[[develop: | ||
+ | |||
+ | <code java> | ||
+ | public String[] list() throws RemoteException; | ||
+ | </ | ||
+ | |||
+ | * Name der Funktion: **list** | ||
+ | * Verwendung: Liefert eine Liste aller Aufträge | ||
+ | * Liste der Parameter: < | ||
+ | * Rückgabe-Werte: | ||
+ | |||
+ | |||
+ | === Code-Beispiele === | ||
+ | |||
+ | == Java == | ||
+ | |||
+ | <code java> | ||
+ | Object[] list = (Object[]) client.execute(" | ||
+ | // Object[] list = (Object[]) client.execute(" | ||
+ | for (Object o:list) | ||
+ | { | ||
+ | System.out.println(o); | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | |||
+ | == PHP == | ||
+ | |||
+ | <code php> | ||
+ | $msg = new xmlrpcmsg(" | ||
+ | // $msg = new xmlrpcmsg(" | ||
+ | $response = $client-> | ||
+ | $value = $response-> | ||
+ | |||
+ | for ($i=0; | ||
+ | { | ||
+ | print($value-> | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | |||
+ | ==== Auftrag anlegen ==== | ||
+ | |||
+ | <code java> | ||
+ | public String create(Map auftrag) throws RemoteException; | ||
+ | </ | ||
+ | |||
+ | * Name der Funktion: **create** | ||
+ | * Liste der Parameter | ||
+ | - **struct** Struct mit den Eigenschaften des Auftrages. Als Schlüssel sind die o.g. Schlüssel-Namen zu verwenden. | ||
+ | * Rückgabe-Wert | ||
+ | * bei [[develop: | ||
+ | * bei [[develop: | ||
+ | |||
+ | Beim Anlegen einer SEPA-Überweisung wird die IBAN mit dem Schlüssel " | ||
+ | |||
+ | === Code-Beispiele === | ||
+ | |||
+ | == Java == | ||
+ | |||
+ | <code java> | ||
+ | import java.util.List; | ||
+ | import java.util.ArrayList; | ||
+ | import java.util.Map; | ||
+ | import java.util.HashMap; | ||
+ | |||
+ | Map params = new HashMap(); | ||
+ | params.put(" | ||
+ | params.put(" | ||
+ | params.put(" | ||
+ | params.put(" | ||
+ | params.put(" | ||
+ | params.put(" | ||
+ | |||
+ | params.put(" | ||
+ | // alternativ | ||
+ | // List lines = new ArrayList(); | ||
+ | // lines.add(" | ||
+ | // lines.add(" | ||
+ | // lines.add(...); | ||
+ | // params.put(" | ||
+ | |||
+ | Object result = client.execute(" | ||
+ | // Object result = client.execute(" | ||
+ | System.out.println(result); | ||
+ | </ | ||
+ | |||
+ | |||
+ | == PHP == | ||
+ | |||
+ | <code php> | ||
+ | $params = new xmlrpcval( | ||
+ | array( | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | // alternativ | ||
+ | // " | ||
+ | )," | ||
+ | |||
+ | $msg = new xmlrpcmsg(" | ||
+ | // $msg = new xmlrpcmsg(" | ||
+ | $response = $client-> | ||
+ | print($response-> | ||
+ | </ | ||
+ | |||
+ | |||
+ | ==== Auftrag anlegen (veraltet) ==== | ||
+ | |||
+ | | **deprecated** Diese Funktion existiert aus Gründen der Abwärtskompatibilität weiterhin. \\ Verwende künftig jedoch bitte die Funktion **[[develop: | ||
+ | |||
+ | <code java> | ||
+ | public String create(String kontoID, String kto, String blz, String name, String zweck, String zweck2, double betrag, String termin, String type) throws RemoteException; | ||
+ | </ | ||
+ | |||
+ | * Name der Funktion: **create** | ||
+ | * Liste der Parameter | ||
+ | - **String** ID des Kontos | ||
+ | - **String** Kontonummer des Gegenkontos | ||
+ | - **String** Bankleitzahl des Gegenkontos | ||
+ | - **String** Inhaber-Name des Gegenkontos | ||
+ | - **String** Verwendungszweck (Zeile 1, max. 27 Zeichen) | ||
+ | - **String** Verwendungszweck (Zeile 2, max. 27 Zeichen) | ||
+ | - **double** | ||
+ | - **String** Ausführungstermin | ||
+ | - **String** Textschlüssel (Auftragsart) | ||
+ | * Rückgabe-Wert | ||
+ | * bei [[develop: | ||
+ | * bei [[develop: | ||
+ | |||
+ | |||
+ | |||
+ | === Code-Beispiele === | ||
+ | |||
+ | == Java == | ||
+ | |||
+ | <code java> | ||
+ | Object[] params = { | ||
+ | | ||
+ | " | ||
+ | " | ||
+ | "Max Mustermann", | ||
+ | "Zweck 1", | ||
+ | "Zweck 2", | ||
+ | 1.5d, // Betrag | ||
+ | " | ||
+ | "", | ||
+ | }; | ||
+ | |||
+ | Object result = client.execute(" | ||
+ | // Object result = client.execute(" | ||
+ | System.out.println(result); | ||
+ | </code> | ||
+ | |||
+ | |||
+ | == PHP == | ||
+ | |||
+ | <code php> | ||
+ | $params = array( | ||
+ | new xmlrpcval(" | ||
+ | new xmlrpcval(" | ||
+ | new xmlrpcval(" | ||
+ | new xmlrpcval(" | ||
+ | new xmlrpcval(" | ||
+ | new xmlrpcval(" | ||
+ | new xmlrpcval(1.5," | ||
+ | new xmlrpcval(" | ||
+ | new xmlrpcval(""," | ||
+ | ); | ||
+ | |||
+ | $msg = new xmlrpcmsg(" | ||
+ | // $msg = new xmlrpcmsg(" | ||
+ | $response = $client-> | ||
+ | print($response-> | ||
+ | print($response-> | ||
+ | </ | ||
+ | |||
+ | |||
+ | ==== Auftrag löschen ==== | ||
+ | |||
+ | <code java> | ||
+ | public String delete(String id) throws RemoteException; | ||
+ | </ | ||
+ | |||
+ | * Name der Funktion: **delete** | ||
+ | * Liste der Parameter | ||
+ | - **String** ID des zu löschenden Auftrages | ||
+ | * Rückgabe-Wert | ||
+ | * bei [[develop: | ||
+ | * bei [[develop: | ||
+ | |||
+ | === Code-Beispiele === | ||
+ | |||
+ | == Java == | ||
+ | |||
+ | <code java> | ||
+ | Object result = client.execute(" | ||
+ | // Object result = client.execute(" | ||
+ | System.out.println(result); | ||
+ | </ | ||
+ | |||
+ | |||
+ | == PHP == | ||
+ | |||
+ | <code php> | ||
+ | $msg = new xmlrpcmsg(" | ||
+ | // $msg = new xmlrpcmsg(" | ||
+ | $response = $client-> | ||
+ | print($response-> | ||
+ | </ | ||
- | | Name der Funktion | //create// | | ||
- | | Verwendung | ||
- | | Aufruf-Parameter | ||
- | | Rückgabe-Wert | ||
Impressum | Datenschutz
develop/xmlrpc/einzelauftrag.txt · Zuletzt geändert: d.m.Y H:i von willuhn