getJAXForms
Die getJAXForms Operation gibt die im System gespeicherten Formulare zurück.
getJAXForms request example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.jaxforms.com/services/soap/">
<soapenv:Header>
<ws:token>30de6360-c1e4-4e72-a3c2-b0b7f0f2b2b1</ws:token>
</soapenv:Header>
<soapenv:Body>
<ws:getJAXForms>
<formId>DEMO-FEEDBACK</formId>
<searchState>2</searchState>
<updateState></updateState>
<startUuid>62</startUuid>
</ws:getJAXForms>
</soapenv:Body>
</soapenv:Envelope>
| Parameter | Beschreibung | |
|---|---|---|
| token | Header | Zugangsschlüssel zur Authentisierung |
| formId | Body | Formular ID |
| searchState | Body | Status, nach dem gesucht werden soll |
| updateState | Body | Status, der nach der Suche auf der Formular-Instanz gesetzt werden soll |
| startUuid | Body | Technische ID nach der aufsteigend inklusiv gesucht werden soll |
getForms
Die getForms Operation gibt die gespeicherten Formulare basierend auf einem XMLDBMapping zurück.
Beispiel PLZ-Register
getForms request example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.jaxforms.com/services/soap/">
<soapenv:Header>
<ws:token>30de6360-c1e4-4e72-a3c2-b0b7f0f2b2b1</ws:token>
</soapenv:Header>
<soapenv:Body>
<ws:getForms>
<formId>ZIP</formId>
<dbmResource></dbmResource>
<mappedSearch>
<searchField>
<fieldId>Name</fieldId>
</searchField>
<searchField>
<fieldId>PLZ</fieldId>
<searchValue>9657</searchValue>
<condition>>=</condition>
<sortOrder>desc</sortOrder>
</searchField>
</mappedSearch>
</ws:getForms>
</soapenv:Body>
</soapenv:Envelope>
| Parameter | Default | Beschreibung | |
|---|---|---|---|
| token | Header | Zugangsschlüssel zur Authentisierung | |
| formId | Body | Formular ID | |
| dbmResource | Body | Absoluter DBM Pfad | |
| pageSize | Body | 30 | Anzahl Zeilen |
| offset | Body | 0 | Anzahl der Zeilen, die übersprungen werden sollen. |
| maxReadRows | Body | -1 (alle) | Anzahl der zu lesenden Zeilen |
| searchField | Body | Beliebige Anzahl Felder gemäss XMLDBMapping nach denen gesucht werden soll. Ergibt implizit die Response Struktur. | |
| fieldId | searchField | field/id gemäss XMLDBMapping | |
| searchValue | searchField | Wert, nachdem in dem Feld gesucht werden soll. Standardmässig werden die Suchabfragen mit AND verknüpft ausser es wird eine orClauseGroup angegeben. | |
| condition | searchField | = | Wie der Wert gesucht werden soll (=, <>, >, <, >=, <=, LIKE, BETWEEN, IN) |
| orClauseGroup | searchField | Identifikation für mind 2 searchFields, welche mit OR selektiert werden sollen. | |
| sortOrder | searchField | asc | Sortierung (asc/desc) |
XMLDBMapping example (PLZ)
<XMLDBMapping openLinkSupported="false" performInitialSearch="false" sortOrder="desc" tableName="PLZ" useColumnChooser="false" uuidFieldName="ONO" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="xmlDBMapping.xsd"> <field> <id>Name</id> <columnName>PLACE_LONG</columnName> <showAsFilter>true</showAsFilter> <showAsColumn>true</showAsColumn> </field> <field> <id>PLZ</id> <columnName>PLZ</columnName> <showAsFilter>false</showAsFilter> <showAsColumn>true</showAsColumn> </field> <field> <id>Canton</id> <columnName>CANTON</columnName> <showAsFilter>true</showAsFilter> <showAsColumn>true</showAsColumn> </field> </XMLDBMapping>
SOAP response example
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:getFormsResponse xmlns:ns2="http://www.jaxforms.com/services/soap/">
<mappedResult>
<resultInfo>
<offset>0</offset>
<pageSize>-1</pageSize>
<readRows>4831</readRows>
<size>2</size>
</resultInfo>
<row>
<field>
<id>Name</id>
<value>Wildhaus</value>
</field>
<field>
<id>PLZ</id>
<value>9658</value>
</field>
</row>
<row>
<field>
<id>Name</id>
<value>Unterwasser</value>
</field>
<field>
<id>PLZ</id>
<value>9657</value>
</field>
</row>
<mappedResult>
</ns2:getFormsResponse>
</S:Body>
</S:Envelope>