...
Die getForms Operation gibt die gespeicherten Formulare 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> |
ParameterElement | Default | Beschreibung | |
---|---|---|---|
token | Zugangsschlüssel zur Authentisierung | ||
formId | Formular ID | ||
dbmResource | Absoluter DBM Pfad | ||
pageSize | 30100 | Anzahl Zeilen | |
offset | 0 | Anzahl der Zeilen, die übersprungen werden sollen. | |
countTotal | -1 (alle) | false | Liest alle Zeilen und gibt die Anzahl in der Response zurück.Anzahl der zu lesenden Zeilen |
includeXML | false | Definiert, ob as xmlField zurückgegeben werden soll. | |
resultFields | * (alle) | Im XMLDBMapping definierte Felder, welche zurückgegeben werden sollten. * = alle | |
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) |
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 | |
offset | Definiertes offset |
pageSize | Definierte pageSize |
size | Effektiv zurükgebene Anzahl Zeilen |
totalSize | Total gelesene Zeilen |
field | Wert |
id | Field-id gemäss XMLDBMapping |
Codeblock | ||||
---|---|---|---|---|
| ||||
<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> |
...