Dokumentation Werk [2] COMET Soap-Schnittstelle

  1. Operationen
  2. Comet Typen
  3. Fehlercodes

  1. Operationen
    Operation Parameter
    * erforderlich (= nicht leer)    		 Rückgabe Bemerkungen
    login
    • xsd:string login *
    • xsd:string password *
    • xsd:string client
    • xsd:string language *
    • xsd:int resultCode
    • xsd:string sessionId
    • xsd:string message
    		 Initialisiert eine SOAP Session.

    Beispiel: Request | Response
    • client: symbolische Bezeichnung eines Klienten / Mandanten, der in der Anwendung mit einem bestimmten Namensraum, Zugriffsrechten o.ä. verknüpft sein kann.
    • language: Übergabe der Sprache als Ländercode (z.B. "de" oder "DE"). Groß- / Kleinschreibung nicht signifikant. Es müssen wenigstens Englisch (en) und Deutsch (de) unterstützt werden.
    • Rückgabe ist eine Session Id, die in allen folgenden SOAP Aufrufe mit übergeben werden muss
    • schlägt der Login fehl, muß ein entsprechender Fehlercode (resultCode) und die Fehlerursache als Text (message) zurückgegeben werden.
    logout
    • xsd:string sessionId *
    • xsd:int resultCode
    		 Beendet eine SOAP Session.

    Beispiel: Request | Response
    • sessionId: Session Id aus login
    getMessage
    • xsd:string sessionId *
    • xsd:int resultCode *
    • xsd:int resultCode
    • xsd:string message
    		 Liefert eine Fehlerbeschreibung in der für die Session festgelegten Sprache.

    Beispiel: Request | Response
    setLanguage
    • xsd:string sessionId *
    • xsd:string language *
    • xsd:int resultCode
    • xsd:string message
    		 Ändert die Sprache der Session.

    Beispiel: Request | Response
    • language: siehe login
    • schlägt setLanguage fehl, wird neben einem entsprechenden Fehler-Code eine Beschreibung zurückgegeben.
      TODO: Für die Session ist eventuell keine gültige Sprache mehr festgelegt: eigentlich wird die Session damit ebenfalls ungültig. Wie handhaben?
    getBinaryFile
    • xsd:string sessionId *
    • xsd:string fileId *
    • xsd:int resultCode
    • cometxsd:CometBinary file
    		 Liefert eine durch fileId bezeichnete (binäre) Datei

    Beispiel: Request | Response
    putBinaryFile
    • xsd:string sessionId *
    • xsd:string fileId *
    • cometxsd:CometBinary file *
    • xsd:int resultCode
    		 Lädt eine Datei hoch. Existiert eine Datei fileId bereits, wird diese aktualisiert, andernfalls neu angelegt.

    Beispiel: Request | Response
    getProductList
    • xsd:string sessionId *
    • ArrayOfCometCondition conditions
    • ArrayOfCometCondition parentConditions
    • xsd:int resultCode
    • ArrayOfCometProduct productList
    		 Liefert eine Liste von Produkten.
    • condition: Feld von (logisch AND verknüpften) Bedingungen, die die zurückgegebenen Produkte erfüllen müssen.
    • parentCondition: Bedingungen, die das jeweils übergeordnete Produkt erfüllen muss.
    Beispiel: Request | Response
    call
    • xsd:string sessionId *
    • xsd:string method *
    • xsd:string arg
    • xsd:int resultCode
    • ArrayOfString result
    		 Für anwendungsspezifische Erweiterungen.

    Beispiel: Request | Response

  2. Comet Typen
    Typ Elemente
    CometCondition
    • xsd:string expr: Feld- / Eigenschaftsname (z.B. id)
    • xsd:string op: Operator, erlaubt sein sollen mindestens folgende (SQL) Vergleichsoperatoren: =, !=, <, >, <=, >=, <>, LIKE, IS, IS NOT
    • xsd:string value: Vergleichswert
    CometProduct
    • xsd:int id
    • xsd:int id2
    • xsd:int id3
    • xsd:int imageId
    • xsd:int classId
    • xsd:string num
    • xsd:string name
    • xsd:boolean forceDelete
    • xsd:int panelStatementId
    CometBinary Der Dateiinhalt wird Base-64 kodiert als Mime-Attachment übertragen.
    Im content Element wird das Attachment über das Attribut href referenziert.
    Beispiel: 
    ... 
<content href="cid:2b03c65156c223991aae16fc1dd7b1a9"/>
...
--=_177a27d17b079b0ac5e3aba1b5bad7f6
Content-Type: text/plain
Content-Transfer-Encoding: base64
Content-ID: <2b03c65156c223991aae16fc1dd7b1a9>
...
    • xsd:string filename
    • xsd:string mimetype
    • xsd:int size
    • xsd:binary content

  3. Fehlercodes

     Anwendungen können eigene Fehlercodes festlegen, unter den folgenden Einschränkungen:
    Code Beschreibung
    0 OK, kein Fehler
    1 Allgemeiner Fehler
    2 Session timeout / invalid