Logo.CortexAG

Anmelden +

Methoden und Parameter

Der nachfolgende Abschnitt beschreibt die verschiedenen Methoden in Kurzform für eine generelle Nutzung über beliebige Programmiersprachen. Detaillierte Beispiele für unterschiedliche Sprachen finden Sie in den gesonderen Abschnitten.

Grundsätzlicher Aufruf

Der DataService ist bei einer lokalen Standard-Installation (HTTP-Port ist 80) mit folgendem Aufruf erreichbar:

http://localhost/i/UniPlexDataservice/updjsr.php

Bei einer korrekten Verbindung ohne vorherigen Login wird ein leeres Objekt zurückgeliefert:

{"requesterror":-1,"requestid":null,"requestmethod":null,"result":""}

Grundaufbau des Anfrage- und Antwort-Objektes:

Grundsätzlich gliedert sich eine Anfrage an den DataService in drei Parameter:

{
  'method'    : string MethodName,
  'requestid' : int RequestId,
  'param'     : {object Parameter}
}

Bei dem Methoden-Namen handelt es sich um eine der zur Verfügung stehenden Methoden, die in nachfolgender Auflistung erläutert werden; die RequestID kann frei vergeben werden, um bei asynchronen Anfragen die Antworten den Anfragen zuordnen zu können. Die Parameter zu der Methode werden als Objekt angegeben (siehe bei der jeweiligen Methode).

Das Ergebnis der Anfrage wird als sog. "Antwort-Objekt" zurückgeliefert:

{
  'requesterror': int RequestStatus,
  'requestmethod': string MethodName,
  'requestid': int RequestId,
  'requestduration': float Duration,
  'result': {object ResultObject}
}

Rückgabewerte

  • RequestStatus: 0=ok; -1=Fehler; Status über die Verarbeitung der Anfrage. Weitere Fehlercodes werden im "ResultObject" zurückgeliefert und sind in der Tabelle der Fehlercodes ersichtlich.
  • MethodName: Name der angefragten Methode
  • RequestId: angefragte RequestId
  • Duration: Anfragedauer in Sekunden
  • ResultObject: Ergebnisobjekt der aufgerufenen Methode

 Hinweise zur Online-Hilfe
 

© 2017 Cortex AG
(letzte Aktualisierung: 12.04.2017)

 Haftungsausschluss 

Impressum    AGB