Die getForms Operation gibt die gespeicherten Formulare Formulareingänge zurück.
Request Struktur
| 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>
<update>
<state>?</state>
</update>
</ws:getForms>
</soapenv:Body>
</soapenv:Envelope> |
| Element | Default | Beschreibung |
|---|
| token |
|
| Zugangsschlüssel zur Authentisierung |
| formId |
| Formular
| ID des Formulars |
| dbmResource |
DBM Pfad| 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, BETWEEN, IN)| orClauseGroup | | Identifikation für mind 2 searchFields, welche mit OR selektiert werden sollen. |
| sortOrder | asc | Sortierung (asc/desc) |
| , LIKE, IN), mehr unter "Mögliche Operatoren für Condition" |
| orClauseGroup |
| Identifikation für mindestens 2 searchFields, welche mit OR selektiert werden sollen. |
| sortOrder | asc | Sortierung aufsteigend/absteigend (asc/desc) |
Mögliche Operatoren für Condition
| 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 |
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> |
| Element | Beschreibung |
|---|
| hasNext | toalSize - offset > pageSize |
| offset | Definiertes offset |
| pageSize | Definierte pageSize |
| size | Effektiv zurükgebene Anzahl Zeilen |
| totalSize | Total gelesene Zeilen |
| field | Wert des Feldes |
| id | Field-id gemäss XMLDBMapping |
Beispiele anhand des PLZ Registers
...
| Codeblock |
|---|
| language | html/xml |
|---|
| title | Response |
|---|
|
<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> |
...
<getForms xmlns="http://ws.eforms.jaxfront.com/"> <formId xmlns="">[string?]</formId> <dbmResource xmlns="">[string?]</dbmResource> <pageSize xmlns="">[int?]</pageSize> <offset xmlns="">[int?]</offset> <countTotal xmlns="">[boolean?]</countTotal> <includeXML xmlns="">[boolean?]</includeXML> <resultFields xmlns="">[string?]</resultFields> <!-- Optional --> <search xmlns=""> <!-- Optional --> <field> <condition>[string?]</condition> <orClauseGroup>[string?]</orClauseGroup> <sortOrder>[string?]</sortOrder> <value>[string?]</value> </field> </search> <!-- Optional --> <update xmlns=""> <state>[string?]</state> </update> </getForms>