Documentation Werk [2] COMET SOAP Interface

  1. Operations
  2. Comet Typen
  3. Error Codes

  1. Operations
    Operation Parameter
    * required (= non-empty)    		 Return Value Comments
    login
    • xsd:string login *
    • xsd:string password *
    • xsd:string client
    • xsd:string language *
    • xsd:int resultCode
    • xsd:string sessionId
    • xsd:string message
    		 Initializes a SOAP session.

    Samples: Request | Response
    • client: symbolic name of a client, which can be linked to a specific namespace, access rights or the like.
    • language: The language as a case insensitive country code (e.g. "en" or "DE"). At minimum, English (en) and German (de) have to be supported.
    • The result is a session ID, which has to be passed with all following SOAP calls.
    • If the login fails, a corresponding error code (resultCode), and the cause of failure as a text (message) have to be returned.
    logout
    • xsd:string sessionId *
    • xsd:int resultCode
    		 Closes a SOAP session.

    Samples: Request | Response
    • sessionId: Session ID from login
    getMessage
    • xsd:string sessionId *
    • xsd:int resultCode *
    • xsd:int resultCode
    • xsd:string message
    		 Returns an error description in the language specified for the session.

    Beispiel: Request | Response
    setLanguage
    • xsd:string sessionId *
    • xsd:string language *
    • xsd:int resultCode
    • xsd:string message
    		 Changes the language for the session.

    Samples: Request | Response
    • language: see login
    • If setLanguage fails, an error code and a description of the error is returned.
      TODO: At this point, there's a possibility no valid language is set for the session. This technically invalidates the session as well. How to handle this?
    getBinaryFile
    • xsd:string sessionId *
    • xsd:string fileId *
    • xsd:int resultCode
    • cometxsd:CometBinary file
    		 Returns a (binary) file referred to by fileId

    Samples: Request | Response
    putBinaryFile
    • xsd:string sessionId *
    • xsd:string fileId *
    • cometxsd:CometBinary file *
    • xsd:int resultCode
    		 Uploads a file. If a file fileId already exists, it is replaced. Otherwise a new file is created.

    Samples: Request | Response
    getProductList
    • xsd:string sessionId *
    • ArrayOfCometCondition conditions
    • ArrayOfCometCondition parentConditions
    • xsd:int resultCode
    • ArrayOfCometProduct productList
    		 Returns a list of products.
    • condition: Collection of (logically AND interconnected) conditions that all returned products have to fulfill.
    • parentCondition: Conditions the respective parent product has to fulfill.
    Samples: Request | Response
    call
    • xsd:string sessionId *
    • xsd:string method *
    • xsd:string arg
    • xsd:int resultCode
    • ArrayOfString result
    		 For application-specific extensoins.

    Samples: Request | Response

  2. Comet Types
    Type Elements
    CometCondition
    • xsd:string expr: Field- / Property Name (e.g. id)
    • xsd:string op: Operator, at minimum, the following (SQL) comparators should be allowed: =, !=, <, >, <=, >=, <>, LIKE, IS, IS NOT
    • xsd:string value: Reference value
    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 The file contents are encoded in Base64 and transmitted as a Mime attachment.
    In the content element, the attachment is referenced by the href attribute.
    Sample: 
    ... 
<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. Error Codes

     Applications can define their own error codes, with the following limitations:
    Code Beschreibung
    0 OK, no error
    1 Generic Error
    2 Session timeout / invalid