TheegartenInterface SOAP WebService interface description

Endpoint URI: https://www.api.tp-be.rsm-live.de/soap.php

WSDL URI: https://www.api.tp-be.rsm-live.de/soap.php?WSDL

PHP SOAP client download URI: https://www.api.tp-be.rsm-live.de/soap.php?PHPSOAPCLIENT

Index

Public methods:

Public methods

checkSerialNumber

array checkSerialNumber ( string serial_number )

Prueft eine uebergebene Seriennummer.
.
(ready)
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status integer Status-Code des Vorgangs.
- interface_version string Versionsnummer der Schnittstelle.
- serial_number_data array Das Ergebnis der Seriennummern-Pruefung.
- error_message [status gt. 100] string Verstaendliche Fehlermeldung.
- error_debug [status gt. 100] string Technische Fehlermeldung.

Return value array: Rueckgabe-Array. Siehe Beschreibung.

checkStatus

array checkStatus (
    string customer_id,
    string access_code,
    string usage_time
)

Prueft den Status und Authentifizierung. Sendet ggf. Anwendungs-Kommandos
(Anwendung loeschen, etc.):
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status (integer): Status-Code des Vorgangs.
- interface_version (string): Versionsnummer der Schnittstelle.
- rpc (object): Remote Procedure Call (z.B. Anwendung loeschen)
- error_message [status ge. 100] (string): Verstaendliche Fehlermeldung.
- error_debug [status ge. 100] (string): Technische Fehlermeldung.
- save_video_allowed (boolean): Download von Filmen moeglich (1 = ja, 0 = nein)
- gdpr_confirmed (boolean): DSGVO bestaetigt (1 = ja, 0 = nein)
- gdpr_confirmed_date (integer): Enthaelt den Timestamp der Bestaetigung (wenn gdpr_confirmed == 1)

Return value array: Rueckgabe-Array. Siehe Beschreibung.

closeUpdateProcess

array closeUpdateProcess (
    string customer_id,
    string access_code,
    string update_code
)

Schliesst einen Update-Vorgang und loescht temporaere Dateien. Dateien und
Aenderungen stehen dann nicht mehr zur Verfuegung und muessen mit
retrieveChanges erneut angefordert werden. Entsprechende Zeitstempel
werden im Kunden-Konto entsprechend gesetzt (last_update).
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status integer Status-Code des Vorgangs.
- interface_version string Versionsnummer der Schnittstelle.
- error_message [status gt. 100] string Verstaendliche Fehlermeldung.
- error_debug [status gt. 100] string Technische Fehlermeldung.

Return value array: Rueckgabe-Array. Siehe Beschreibung.

confirmGdpr

array confirmGdpr (
    string customer_id,
    string access_code,
    string usage_time
)

Speichert den DSGVO Status.
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status (integer): Status-Code des Vorgangs.
- interface_version (string): Versionsnummer der Schnittstelle.
- rpc (object): Remote Procedure Call (z.B. Anwendung loeschen)
- error_message [status ge. 100] (string): Verstaendliche Fehlermeldung.
- error_debug [status ge. 100] (string): Technische Fehlermeldung.
- save_video_allowed (boolean): Download von Filmen moeglich (1 = ja, 0 = nein)
- gdpr_confirmed (boolean): DSGVO bestaetigt (1 = ja, 0 = nein)
- gdpr_confirmed_date (integer): Enthaelt den Timestamp der Bestaetigung (wenn gdpr_confirmed == 1)

Return value array: Rueckgabe-Array. Siehe Beschreibung.

createSerialNumber

array createSerialNumber (
    string type,
    integer day,
    integer month,
    integer year,
    integer duration
)

Generiert eine neue Seriennummer.
.
(ready)
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status integer Status-Code des Vorgangs.
- interface_version string Versionsnummer der Schnittstelle.
- serial_number string Die generierte Seriennummer
- error_message [status gt. 100] string Verstaendliche Fehlermeldung.
- error_debug [status gt. 100] string Technische Fehlermeldung.

Return value array: Rueckgabe-Array. Siehe Beschreibung.

getOfflinePackage

array getOfflinePackage ( string key )

Fordert den Download-Link für das Offline Packet n. Gibt ggf. Status zurueck, dass Dateien noch
bearbeitet werden. Generierte Dateien koennen bis zu 24 h nach Erstellung
heruntergeladen werden. Benötigt einen General-Schlüssel (key).
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status (integer): Status-Code des Vorgangs.
- interface_version (string): Versionsnummer der Schnittstelle.
- download_link [status gt. 100] (object): Link zum Download der gesamten Updatedateien
- error_message [status lt. 100] (string): Verstaendliche Fehlermeldung.
- error_debug [status lt. 100] (string): Technische Fehlermeldung.

Return value array: Rueckgabe-Array. Siehe Beschreibung.

getOfflinePackageState

array getOfflinePackageState (
    string key,
    string update_code
)

Fordert den Download-Link für das Offline Packet n. Gibt ggf. Status zurueck, dass Dateien noch
bearbeitet werden. Generierte Dateien koennen bis zu 24 h nach Erstellung
heruntergeladen werden. Benötigt einen General-Schlüssel (key).
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status (integer): Status-Code des Vorgangs.
- interface_version (string): Versionsnummer der Schnittstelle.
- download_link [status gt. 100] (object): Link zum Download der gesamten Updatedateien
- error_message [status lt. 100] (string): Verstaendliche Fehlermeldung.
- error_debug [status lt. 100] (string): Technische Fehlermeldung.

Return value array: Rueckgabe-Array. Siehe Beschreibung.

getUpdate

array getUpdate (
    string customer_id,
    string access_code,
    integer last_timestamp,
    string current_file_structure,
    string app_version,
    boolean json_encode
)

Gibt das komplette Update zurück.
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status (integer): Status-Code des Vorgangs.
- interface_version (string): Versionsnummer der Schnittstelle.
- update_list [status lt. 100] (object): Liste mit den Aenderungen.
- update_size [status lt. 100] (integer): Ungefaehre Groeße des Updates.
- error_message [status ge. 100] (string): Verstaendliche Fehlermeldung.
- error_debug [status ge. 100] (string): Technische Fehlermeldung.

Return value array: Rueckgabe-Array. Siehe Beschreibung.

getUpdateProcessState

array getUpdateProcessState (
    string customer_id,
    string access_code,
    string update_code
)

Fordert den Download-Link an. Gibt ggf. Status zurueck, dass Dateien noch
bearbeitet werden. Generierte Dateien koennen bis zu 24 h nach Erstellung
heruntergeladen werden.
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status (integer): Status-Code des Vorgangs.
- interface_version (string): Versionsnummer der Schnittstelle.
- download_link [status gt. 100] (object): Link zum Download der gesamten Updatedateien
- error_message [status lt. 100] (string): Verstaendliche Fehlermeldung.
- error_debug [status lt. 100] (string): Technische Fehlermeldung.

Return value array: Rueckgabe-Array. Siehe Beschreibung.

isUpdateAvailable

array isUpdateAvailable (
    string customer_id,
    string access_code,
    integer last_timestamp,
    string current_file_structure,
    string app_version
)

Fragt an, ob ein Update fuer das aktuelle Geraet zur Verfuegung steht.
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status (integer): Status-Code des Vorgangs.
- interface_version (string): Versionsnummer der Schnittstelle.
- update_available [status lt. 100] (boolean): true - Es gibt ein Update. / false - Es gibt kein Update.
- error_message [status ge. 100] (string): Verstaendliche Fehlermeldung.
- error_debug [status ge. 100] (string): Technische Fehlermeldung.

Return value array: Rueckgabe-Array. Siehe Beschreibung.

registerSerial

array registerSerial (
    string customer_id,
    string serial_number,
    string device_id,
    string operating_system
)

Prueft die uebergebene Seriennummer und fordert einen Access-Key an.
Bei Falscheingabe des ProduktKeys wird ein Counter des entsprechenden
Kunden-Accounts hochgezaehlt.
.
Moeglicher allgemeiner Rueckgabestatus:
- OK
- Falscher Key
- neue UID
- API gesperrt
.
(ready)
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status (integer): Status-Code des Vorgangs.
- interface_version (string): Versionsnummer der Schnittstelle.
- access_code [status lt. 100] (string): MD5 Hash 128 bit
- counter [status lt. 100] (integer): Initalwert Anzahl der Katalogbenutzung -> Erstbentzung: 0
- usage_time [status lt. 100] (integer): Nutzungszeit -> Erstbentzung: 0
- error_message [status ge. 100] (string): Verstaendliche Fehlermeldung.
- error_debug [status ge. 100] (string): Technische Fehlermeldung.
- save_video_allowed (boolean): Download von Filmen moeglich (1 = ja, 0 = nein)

Return value array: Rueckgabe-Array. Siehe Beschreibung.

registerSerialDemo

array registerSerialDemo (
    string serial_number,
    string device_id
)

(wird derzeit nicht benoetigt)
.
Prueft den zeitlich begrenzten Key und traegt ihn zusammen mit der UID in die Datenbank.
Moeglichkeiten der Sperrung:
.
- Key schon vorhanden unter anderer UID
- Key gesperrt
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status (integer): Status-Code des Vorgangs.
- interface_version (string): Versionsnummer der Schnittstelle.
- access_code [status lt. 100] (string): MD5 Hash 128 bit
- counter [status lt. 100] (integer): Initalwert Anzahl der Katalogbenutzung -> Erstbentzung: 0
- usage_time [status lt. 100] (integer): Nutzungszeit -> Erstbentzung: 0
- error_message [status ge. 100] (string): Verstaendliche Fehlermeldung.
- error_debug [status ge. 100] (string): Technische Fehlermeldung.

Return value array: Rueckgabe-Array. Siehe Beschreibung.

requestOfflinePackage

array requestOfflinePackage (
    string key,
    boolean json_encode
)

Startet die Offline-Packet-Generierung auf dem Server. Gibt die komplette Liste
an Aenderungen zurueck und stoesst den Dateizusammenstell-Prozess auf dem
Server an. Benötigt einen General-Schlüssel (key).
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status (integer): Status-Code des Vorgangs.
- interface_version (string): Versionsnummer der Schnittstelle.
- update_list [status lt. 100] (xml-string): Liste mit den Aenderungen. (1*)
- update_code [status lt. 100] (string): MD5 Hash des aktuellen Updatevorgangs.
- error_message [status ge. 100] (string): Verstaendliche Fehlermeldung.
- error_debug [status ge. 100] (string): Technische Fehlermeldung.

Return value array: Rueckgabe-Array. Siehe Beschreibung.

requestUpdateProcess

array requestUpdateProcess (
    string customer_id,
    string access_code,
    integer last_timestamp,
    string current_file_structure,
    string app_version,
    boolean json_encode
)

Startet den Updateprozess auf dem Server. Gibt die komplette Liste
an Aenderungen zurueck und stoesst den Dateizusammenstell-Prozess auf dem
Server an.
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status (integer): Status-Code des Vorgangs.
- interface_version (string): Versionsnummer der Schnittstelle.
- update_list [status lt. 100] (xml-string): Liste mit den Aenderungen. (1*)
- update_code [status lt. 100] (string): MD5 Hash des aktuellen Updatevorgangs.
- error_message [status ge. 100] (string): Verstaendliche Fehlermeldung.
- error_debug [status ge. 100] (string): Technische Fehlermeldung.

Return value array: Rueckgabe-Array. Siehe Beschreibung.

resetAccount

array resetAccount (
    string customer_id,
    string access_code
)

Setzt einen Account eines Members zurueck, sodass dieser sich neu anmelden
muss. Eine alte bestehende Geräteverbindung ist dann nicht mehr gültig.
.
(ready)
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status (integer): Status-Code des Vorgangs.
- interface_version (string): Versionsnummer der Schnittstelle.
- error_message [status ge. 100] (string): Verstaendliche Fehlermeldung.
- error_debug [status ge. 100] (string): Technische Fehlermeldung.

Return value array: Rueckgabe-Array. Siehe Beschreibung.

retrieveChangeInformations

array retrieveChangeInformations (
    string customer_id,
    string access_code,
    integer last_timestamp,
    string current_file_structure,
    string app_version,
    boolean json_encode
)

Gibt allgemeine Informationen zu den Aenderungen zurueck. Wird benoetigt um
den User Aenderungsinformationen zu uebermitteln, ohne den eigentlichen
Updatevorgang zu starten.
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status (integer): Status-Code des Vorgangs.
- interface_version (string): Versionsnummer der Schnittstelle.
- update_list [status lt. 100] (object): Liste mit den Aenderungen.
- update_size [status lt. 100] (integer): Ungefaehre Groeße des Updates.
- error_message [status ge. 100] (string): Verstaendliche Fehlermeldung.
- error_debug [status ge. 100] (string): Technische Fehlermeldung.

Return value array: Rueckgabe-Array. Siehe Beschreibung.

sayHello

array sayHello ( string name )

Say hello demo.
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status (integer): Status-Code des Vorgangs.
- interface_version (string): Versionsnummer der Schnittstelle.
- greeting (string): Begruessung mit dem uebergebenem Namen.
.
(ready)

Return value array: Rueckgabe-Array.

sendErrorreport

array sendErrorreport (
    string error_code,
    string error_message,
    string subject
)

Sendet eine Errorreport Mail direkt vom Server an eine fest hinterlegte
Adresse.
.
(ready)
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status integer Status-Code des Vorgangs.
- interface_version string Versionsnummer der Schnittstelle.
- error_message [status gt. 100] string Verstaendliche Fehlermeldung.
- error_debug [status gt. 100] string Technische Fehlermeldung.

Return value array: Rueckgabe-Array. Siehe Beschreibung.

sendFeedback

array sendFeedback (
    string customer_id,
    string access_code,
    string subject,
    string body,
    string company,
    string name,
    string email,
    string telephone
)

Sendet eine Feedback-Mail direkt vom Server an eine fest hinterlegte
Adresse.
.
(ready)
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status integer Status-Code des Vorgangs.
- interface_version string Versionsnummer der Schnittstelle.
- error_message [status gt. 100] string Verstaendliche Fehlermeldung.
- error_debug [status gt. 100] string Technische Fehlermeldung.

Return value array: Rueckgabe-Array. Siehe Beschreibung.

sendMailPlain

array sendMailPlain (
    string customer_id,
    string access_code,
    string subject,
    string body,
    string recipient
)

(wird derzeit nicht benoetigt)
.
Sendet eine Mail direkt vom Server. Entspricht technisch gesehen der
sendFeedback - Funktion, jedoch enthaelt diese Funktion einen Empfaenger.
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status integer Status-Code des Vorgangs.
- interface_version string Versionsnummer der Schnittstelle.
- error_message [status gt. 100] string Verstaendliche Fehlermeldung.
- error_debug [status gt. 100] string Technische Fehlermeldung.

Return value array: Rueckgabe-Array. Siehe Beschreibung.

sendProductMail

array sendProductMail (
    string customer_id,
    string access_code,
    string subject,
    string body,
    array machine_ids,
    string recipient
)

Sendet eine Mail direkt vom Server. Inkl. Maschinen, Zubehoer +
Allgemeine IDs
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status integer Status-Code des Vorgangs.
- interface_version string Versionsnummer der Schnittstelle.
- error_message [status gt. 100] string Verstaendliche Fehlermeldung.
- error_debug [status gt. 100] string Technische Fehlermeldung.

Return value array: Rueckgabe-Array. Siehe Beschreibung.

sendTrackingStatistic

array sendTrackingStatistic (
    string customer_id,
    string access_code,
    integer counter,
    integer usage_time
)

Sendet userspezifische statistische Daten an den Server.
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status (integer): Status-Code des Vorgangs.
- interface_version (string): Versionsnummer der Schnittstelle.
- error_message [status ge. 100] (string): Verstaendliche Fehlermeldung.
- error_debug [status ge. 100] (string): Technische Fehlermeldung.

Return value array: Rueckgabe-Array. Siehe Beschreibung.

setLastUpdate

array setLastUpdate (
    string customer_id,
    string access_code,
    string version,
    string plattform
)

Prueft den Status und Authentifizierung. Sendet ggf. Anwendungs-Kommandos
(Anwendung loeschen, etc.):
.
Das Rueckgabe-Array enthaelt folgende Elemente:
- status (integer): Status-Code des Vorgangs.
- interface_version (string): Versionsnummer der Schnittstelle.
- rpc (object): Remote Procedure Call (z.B. Anwendung loeschen)
- error_message [status ge. 100] (string): Verstaendliche Fehlermeldung.
- error_debug [status ge. 100] (string): Technische Fehlermeldung.
- save_video_allowed (boolean): Download von Filmen moeglich (1 = ja, 0 = nein)
- gdpr_confirmed (boolean): DSGVO bestaetigt (1 = ja, 0 = nein)
- gdpr_confirmed_date (integer): Enthaelt den Timestamp der Bestaetigung (wenn gdpr_confirmed == 1)

Return value array: Rueckgabe-Array. Siehe Beschreibung.

Powered by PhpWsdl - PDF download: Download this page as PDF