...
Wichtig: Ein Field bzw. dessen ID kann nur einmal in einer orClauseGroup verwendet werden. Es darf also nicht zweimal "PLZ" im selben Request gebraucht werden.
...
| Codeblock | ||
|---|---|---|
| ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.eforms.jaxfront.com/"> <soapenv:Header> <ws:token>?</ws:token> </soapenv:Header> <soapenv:Body> <ws:getForms> <formId>?</formId> <dbmResource>?</dbmResource> <pageSize>?</pageSize> <offset>?</offset> <countTotal>?</countTotal> <includeXML>?</includeXML> <resultFields>?</resultFields> <search> <field id="?"> <condition>?</condition> <orClauseGroup>?</orClauseGroup> <sortOrder>?</sortOrder> <value>?</value> </field> </search> </ws:getForms> </soapenv:Body> </soapenv:Envelope> |
...
| 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 erläutert 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) |
Mögliche Operatoren für Condition
| Operator | Beschreibung | Beispiel |
|---|---|---|
| = | Gleich | |
| <> | Nicht gleich | |
| > | Grösser als | |
| < | Kleiner als | |
| >= | Grösser gleich | |
| <= | Kleiner gleich | |
| LIKE | Ähnlich wie. Suchbegriff muss mit den Wildcards % oder * umgeben sein |
| . | <value>*formular*</value> | |
MULTI_LIKE | Wenn der Operand entweder ähnlich wie einer angegebenen Werten ist. Die Zahlenwerte müssen per "_;_" getrennt werden. | <value>BL_;_XX_;_GL</value> wenn LIKE %BL%, %XX% und %GL% gesucht werden soll. |
| IN | Wenn der Operand gleich ist wie einer aus einer Liste von Werten. |
WICHTIG: Kein Whitespace zwischen den Werten und Single-Quotes verwenden |
<orClauseGroup>?</orClauseGroup>
Response Struktur
| <value>'BegriffEins','Test','weitererBegriff'</value> | ||
| BETWEEN | Wenn der Operand zwischen den beiden Zahlenwerten ist. Die Zahlenwerte müssen per Komma oder "_;_" getrennt werden. | <value>5000,6000</value> wenn 5221 gesucht wird. |
| CUSTOM | Eigene Where-Bedingung, erlaubt komplexe Abfragen mit Verschachtelungen. | <value>PLZ > 3000 AND PLZ < 3100 AND PLZ not like '%50%'</value> |
| NOT [Operator] | Kann als Prefix zur Verneinung eines Operators verwendet werden, z.B.: NOT LIKE |
Response Struktur
| Codeblock | ||
|---|---|---|
| ||
<S: | ||
| 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 | ||||
|---|---|---|---|---|
| ||||
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getFormsResponse xmlns:ns2="http://ws.eforms.jaxfront.com/">
<result>
<info>
<hasNext>false</hasNext>
<offset>0</offset>
<pageSize>100</pageSize>
<size>1</size>
<totalSize>1</totalSize>
</info>
<row>
<field id="Type">DEMO-FEEDBACK</field>
<field id="Sender">rwu@jaxfront.com</field>
</row>
</result>
</ns2:getFormsResponse>
</S:Body>
</S:Envelope> |
...