User Tools

Site Tools


design2budget:webservice:operation:list

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

design2budget:webservice:operation:list [2015/04/04 20:52]
10.1.1.56 created
design2budget:webservice:operation:list [2015/11/27 14:09]
Line 1: Line 1:
-====== design2budget Entwickler Webservice Dokumentation ====== 
- 
-Zurück zur [[design2budget:​webservice|Webservice Dokumentation Startseite]] 
- 
-====== Basisoperation <​module>/​list ====== 
- 
-Diese Action wird von jedem Modul angeboten und liefert eine Liste mit Einträgen für das jeweilige Modul. 
- 
-Die Anzahl an zurückgegebenen Records wird über den Parameter perpage angegeben. 
- 
-Die zurückgegebene Liste kann durch Angabe von Filterkriterien eingeschränkt werden. Die Filterkriterien werden im POST Request übergeben. 
- 
-Die Filterkriterien müssen nur beim 1. Aufruf von list übergeben werden. Beim Holen der Seite 2 (z.B. Paramter p=1) verwendet das System automatisch die zuvor gesetzten Filterkriterien. 
- 
-==== GET ==== 
- 
-https://​server/​tenant/​s/​module/​list/?​sid=sessionID[&​output=outputMode][&​perpage=(1-500)][&​p=page][&​o=sortField][&​d=sortDirection] 
- 
-^  parameter ​   ^ Optional: Standard ^ Beschreibung ​    ^ 
-| output ​       | JA: json           | JSON REST API (json) oder XML REST API (xml) | 
-| perpage ​      | JA: 12             | anzahl an Elemente pro Seite (1-500) ​        | 
-| p             | JA: 0              | aktuelle Seite (0=erste Seite) ​              | 
-| o             | JA: unterschiedlich je modul | Feld für Sortierung ​               | 
-| d             | JA: 0              | aufsteigend (0) oder absteigend (1)          | 
- 
-Beispiel: 
- 
-https://​server/​tenant/​s/​offer/​list/?​sid=9bd3b5f93692e4659632c8585eb35447&​perpage=100&​p=2&​o=startdate&​d=0 
- 
-Holt 100 Angebote (perpage=100) beginnend auf Seite 3 (page=2) sortiert nach Startdatum (o=startdate) in aufsteigender Reihenfolge (d=0) 
- 
-==== POST ==== 
- 
-Per POST Parameter werden die Filterkriterien übergeben. 
- 
-Der Parametername entspricht hierbei einfach dem Feldnamen (siehe Aktion schema) und der Parameterwert entspricht dem jeweiligen Inhalt, den das Feld haben muss. 
- 
-Die einzelnen Kriterien werden UND verknüpft (d.h. alle Kriterien müssen zutreffen). 
- 
-^ Parameter ​   ^ Beschreibung ​   ^ 
-| <​field>​=<​value> ​ | Das angegebene Feld muss dem Wert value entsprechen | 
-| <​field2>​=<​value2> ​ | Das angegebene Feld muss dem Wert value entsprechen | 
-| <​field...>​=<​value...> ​ | Das angegebene Feld muss dem Wert value entsprechen | 
- 
-=== Filter Syntax === 
- 
-^ Syntaxelement ^ Beschreibung ​       ^ 
-| keines ​       | Der angegebene Inhalt muss exakt entsprechen | 
-| %             | Es kann ein beliebiger Inhalt vorkommen ​     | 
-| >             | Nur gültig bei Zahlen: Zahl muss größer sein | 
-| >=            | Nur gültig bei Zahlen: Zahl muss größer gleich sein | 
-| <             | Nur gültig bei Zahlen: Zahl muss kleiner sein | 
-| <=            | Nur gültig bei Zahlen: Zahl muss kleiner gleich sein | 
-| !             | Nur gültig bei Zahlen: Zahl muss ungleich sein | 
-| &             | Nur gültig bei Zahlen: UND Verknüpfung 2er Bedingungen | 
-| %%|%%         | Nur gültig bei Zahlen: ODER Verknüpfung 2er Bedingungen | 
- 
-Bei Datumsfelder kann direkt das Datum im deutschsprachigen Format DD.MM.YYYY angegeben werden. Das System kann hier auch mit Vergleichen (Größer, Kleiner) umgehen. \\ 
-Alternativ ist auch die Angabe von Unixtimestamps möglich. \\ 
-Das System erkennt das Datums/​Zeitformat automatisch. 
- 
- 
-**ACHTUNG:​** Groß- und Kleinschreibung wird bei Filterwerten NICHT unterschieden (bei Feldnamen jedoch schon). 
- 
-Beispiele: 
- 
-^ Beispiel ​              ^ Erklärung ​     ^ 
-| lastname="​Mustermann" ​ | Nachname muss exakt "​Mustermann"​ sein | 
-| lastname="​Muster%" ​    | Nachname muss mit "​Muster"​ beginnen | 
-| id=">​5" ​               | Die ID muss größer 5 sein | 
-| id=">​5&<​9" ​            | Die ID muss größer 5 und kleiner 9 sein | 
-| id="​!100" ​             | Die ID muss ungleich 100 sein | 
-| startdate=">​=1.10.2014&<​=31.12.2014"​ | Das Startdatum muss zwischen 1.10.2014 und 31.12.2014 liegen | 
- 
- 
- 
- 
  
design2budget/webservice/operation/list.txt · Last modified: 2015/11/27 14:09 (external edit)