...
| Element | Default | Beschreibung |
|---|---|---|
| token | Zugangsschlüssel zur Authentisierung | |
| formId | ID des Formulars | |
| dbmResource | Absoluter Pfad zu einem DBM. Beispiel: resources/MANDANT/FormularXY/special_search.dbm | |
| pageSize | 100 | Anzahl Zeilen |
| offset | 0 | Anzahl der Zeilen, die übersprungen werden sollen. |
| countTotal | false | Liest alle Zeilen und gibt die Anzahl in der Response zurück. |
| includeXML | false | Definiert, ob das xmlField zurückgegeben werden soll. |
| checkPDF | false | Definiert, das überprüft werden soll, ob für ein Formular ein PDF existiert. Die einzelnen PDF müssen dann über einen Rest-Aufruf konsumiert werden. |
| checkAttachment | false | Definiert, das überprüft werden soll, ob für das Formular Beilagen existieren. Die einzelnen Attachments müssen dann über einen Rest-Aufruf konsumiert werden. |
| resultFields | * (alle) | Im XMLDBMapping definierte Felder, welche zurückgegeben werden sollten. |
| id | Field-ID gemäss XMLDBMapping | |
| value | Wert, nachdem in dem Feld gesucht werden soll. Standardmässig werden die Suchabfragen mit AND verknüpft ausser es wird eine orClauseGroup angegeben. | |
| condition | = | Wie der Wert gesucht werden soll (=, <>, >, <, >=, <=, LIKE, IN), mehr unter "Mögliche Operatoren für Condition" |
| orClauseGroup | Identifikation für mindestens 2 searchFields, welche mit OR selektiert werden sollen. Siehe "Eingeschränkte Abfrage mit Verwendung der orClauseGroup". | |
| sortOrder | asc | Sortierung aufsteigend/absteigend (asc/desc) |
...
| Operator | Beschreibung |
|---|---|
| = | Gleich |
| <> | Nicht gleich |
| > | Grösser als |
| < | Kleiner als |
| >= | Grösser gleich |
| <= | Kleiner gleich |
| LIKE | Ähnlich wie. Suchbegriff muss mit % umgeben sein, z.B: %formular% |
| IN | TRUE wenn der Operand gleich ist wie einer aus einer Liste von Werten, z.B: 'Begriff1','Test','weitererBegriff' WICHTIG: Kein Whitespace zwischen den Werten und Single-Quotes verwenden |
| NOT [Operator] | Kann als Prefix zur Verneinung eines Operators verwendet werden, z.B.: NOT LIKE |
<orClauseGroup>?</orClauseGroup>
Response Struktur
| Codeblock | ||
|---|---|---|
| ||
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getFormsResponse xmlns:ns2="http://ws.eforms.jaxfront.com/">
<result>
<info>
<hasNext>?</hasNext>
<offset>?</offset>
<pageSize>?</pageSize>
<size>?</size>
<totalSize>?</totalSize>
</info>
<row>
<field id="?">?</field>
</row>
</result>
</ns2:getFormsResponse>
</S:Body>
</S:Envelope> |
...
| Codeblock | ||||
|---|---|---|---|---|
| ||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.eforms.jaxfront.com/">
<soapenv:Header>
<ws:token>b86d157d-491f-4af0-b0ad-0141c8fe480c</ws:token>
</soapenv:Header>
<soapenv:Body>
<ws:getForms>
<formId>ZIP</formId>
<countTotal>true</countTotal>
<search>
<field id ="PLZ">
<value>6085</value>
<condition>></condition>
<orClauseGroup>OR1</orClauseGroup>
</field>
<field id ="Name">
<value>Schangnau</value>
<condition>=</condition>
<orClauseGroup>OR1</orClauseGroup>
</field>
<field id ="Canton">
<value>BE</value>
<condition>=</condition>
</field>
</search>
</ws:getForms>
</soapenv:Body>
</soapenv:Envelope> |
...