Die getForms Operation gibt die gespeicherten Formulare zurück.
Request Struktur
<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 | |
dbmResource | Absoluter DBM Pfad | |
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 as xmlField zurückgegeben werden soll. |
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) |
Response Struktur
<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 |
id | Field-id gemäss XMLDBMapping |
Beispiele anhand des PLZ Registers
XMLDBMapping PLZ Register
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>
Seitenweise suchen
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.eforms.jaxfront.com/"> <soapenv:Header> <ws:token>b86d157d-491f-4af0-b0ad-0141c8fe480c</ws:token> </soapenv:Header> <soapenv:Body> <ws:getForms> <formId>ZIP</formId> <countTotal>true</countTotal> <pageSize>10</pageSize> <offset>5329</offset> </ws:getForms> </soapenv:Body> </soapenv:Envelope>
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>5329</offset> <pageSize>10</pageSize> <size>2</size> <totalSize>5331</totalSize> </info> <row> <field id="Name">Lausanne 1 Dépôt</field> <field id="PLZ">1000</field> <field id="Canton">VD</field> </row> <row> <field id="Name">Lausanne</field> <field id="PLZ">1000</field> <field id="Canton">VD</field> </row> </result> </ns2:getFormsResponse> </S:Body> </S:Envelope>