...
getForms
Die getJAXForms getForms Operation gibt die im System gespeicherten Formulare zurück.
Beispiel PLZ-Register
| Codeblock |
|---|
| language | html/xml |
|---|
| title | getJAXForms getForms request example |
|---|
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://wwwws.eforms.jaxformsjaxfront.com/services/soap/">
<soapenv:Header>
<ws:token>30de6360-c1e4-4e72-a3c2-b0b7f0f2b2b1<token>?</ws:token>
</soapenv:Header>
<soapenv:Body>
<ws:getJAXForms>getForms>
<formId>DEMO-FEEDBACK<<formId>?</formId>
<searchState>2<<dbmResource>?</searchState>dbmResource>
<updateState><<pageSize>?</updateState>pageSize>
<startUuid>62<<offset>?</startUuid>offset>
<countTotal>?</ws:getJAXForms>countTotal>
</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
| Codeblock |
|---|
| language | html/xml |
|---|
| title | getForms request example |
|---|
|
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://www.jaxforms.com/services/soap/">
<soapenv:Header><includeXML>?</includeXML>
<ws:token>30de6360-c1e4-4e72-a3c2-b0b7f0f2b2b1</ws:token>
<resultFields>?</soapenv:Header>resultFields>
<soapenv:Body>
<ws:getForms>
<search>
<formId>ZIP</formId><field id="?">
<dbmResource></dbmResource>
<condition>?</condition>
<mappedSearch>
<searchField><orClauseGroup>?</orClauseGroup>
<fieldId>Name<<sortOrder>?</fieldId>sortOrder>
<value>?</searchField>value>
<searchField>
<fieldId>PLZ</fieldId>
</field>
<searchValue>9657</searchValue>
</search>
<condition>>=</condition><update>
<sortOrder>desc</sortOrder>
<state>?</state>
</searchField>
</mappedSearch>update>
</ws:getForms>
</soapenv:Body>
</soapenv:Envelope> |
| Parameter | Default | Beschreibung |
|---|
| tokenHeader | | Zugangsschlüssel zur Authentisierung |
| formId | Body | | Formular ID |
| dbmResource | Body | | Absoluter DBM Pfad |
| pageSizeBody | 30 | Anzahl Zeilen |
| offset | Body | 0 | Anzahl der Zeilen, die übersprungen werden sollen. |
| maxReadRowscountTotal | Body | -1 (alle) | Anzahl der zu lesenden Zeilen |
| includeXML | false | Definiert, ob as xmlField zurückgegeben werden soll. |
| resultFields | searchField | Body | | Beliebige Anzahl Felder gemäss XMLDBMapping nach denen gesucht werden soll. Ergibt implizit die Response Struktur. | Im XMLDBMapping definierte Felder, welche zurückgegeben werden sollten. * = alle |
| id | | Field- | fieldId | searchField | | field/id gemäss XMLDBMapping |
| searchValuevalue | 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) |
| orClauseGroupsearchField | | Identifikation für mind 2 searchFields, welche mit OR selektiert werden sollen. |
| sortOrdersearchField | asc | Sortierung (asc/desc) |
| Codeblock |
|---|
| language | html/xml |
|---|
| title | 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> |
...