Schnittstellenleitfaden: Unterschied zwischen den Versionen

Zur Navigation springen Zur Suche springen
← Zum vorherigen VersionsunterschiedZum nächsten Versionsunterschied →
Zeile 1.000: Zeile 1.000:
==Artikel==
==Artikel==


===articleRatings_set===
===article Ratings===


{}
articleRatings_set {}
Feld Typ Beschreibung
<!--//////////    Tabelle ANFANG      //////////-->
id String
:{| class="wikitable" style="text-align:left"
command String
! style="background:#B3B7FF" | Feld
 
!! style="background:#B3B7FF" | Typ  
Erlaubte Werte: articleRatings/set
!! style="background:#B3B7FF" | Beschreibung
params Object
|-
"params":{"data":{}}
|id
Feld Typ Beschreibung
|Alphanumerisch
articleId String
|
 
|-
Betreff
|command
 
|Alphanumerisch
Größenbereich: 24 Zeichen
|Erlaubte Werte: articleRatings/set
userId String
|-
 
|params
Betreff
|Object
 
|
Größenbereich: 24 Zeichen
|}
username String
<!--//////////    Tabelle ENDE      //////////-->
 
Nachricht
 
Größenbereich: 255 Zeichen
rating Integer
 
Erlaubte Werte: 1, 2, 3, 4, 5
comment
String
 
Kommentar
 
Größenbereich: 1000 Zeichen
"result":{"articleRatings": {"data":{} } }
Feld Typ Beschreibung
id String
articleRatings | 2. articleRatings_get
post
 
/
 
{}
Feld Typ Beschreibung
id String
command String
 
Erlaubte Werte: articleRatings/get
params Object
"params":{"filters": [{}, {}]}
Feld Typ Beschreibung
values Array
 
Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich
fields
Array
 
Feld welches gefiltert werden soll
 
Erlaubte Werte: id, articleId, userId, username, rating
useRegex
Enum
 
Führt bei dem Wert 1 eine Suche mit einem regullären Ausdruck durch. Bei 0 muss das Feld exakt übereinstimmen.
 
Standardwert: 0
 
Erlaubte Werte: 1, 0
fieldOperator
Enum
 
Standardwert: or
 
Erlaubte Werte: and, or
or
Object
 
Das Objekt or kann die identischen Werte von filters enthalten. Mit Ausnahme des Parameters or. Einträge werden ausgelesen, wenn der or Filter zutrifft.
"params":{"filterDates": [{}, {}]}
Feld Typ Beschreibung
fields Array
 
Feld welches gefiltert werden soll
 
Erlaubte Werte: lastUpdate, dateCreated
fieldOperator
Enum
 
Standardwert: or
 
Erlaubte Werte: and, or
greaterThan
String
 
Größer als
 
Größenbereich: Date
(Y-m-d H:i:s)
greaterThanEqual
String
 
Größer als oder gleich
 
Größenbereich: Date
(Y-m-d H:i:s)
lessThan
String
 
Kleiner als
 
Größenbereich: Date
(Y-m-d H:i:s)
lessThanEqual
String
 
Kleiner als oder Gleich
 
Größenbereich: Date
(Y-m-d H:i:s)
"params":{"articleRatings": {}}
Feld Typ Beschreibung
start
Number
 
Startwert


Standardwert: 0
"params":{"data":{}}
limit
<!--//////////    Tabelle ANFANG      //////////-->
Number
:{| class="wikitable" style="text-align:left"
! style="background:#B3B7FF" | Feld
!! style="background:#B3B7FF" | Typ
!! style="background:#B3B7FF" | Beschreibung
|-
|articleId
|Alphanumerisch (24)
|
|-
|userId
|Alphanumerisch (24)
|
|-
|username
|Alphanumerisch (24)
|
|-
|Nachricht
|Alphanumerisch (255)
|
|-
|rating
|Integer (1..5)
|
|-
|Kommentar
|Alphanumerisch (1.000)
|
|}
<!--//////////    Tabelle ENDE      //////////-->


Maximale Anzahl an Einträgen
"result":{"articleRatings": {"data":{} } }


Standardwert: 40
<!--//////////    Tabelle ANFANG      //////////-->
sort
:{| class="wikitable" style="text-align:left"
Array
! style="background:#B3B7FF" | Feld
!! style="background:#B3B7FF" | Typ
!! style="background:#B3B7FF" | Beschreibung
|-
|id
|Alphanumerisch (24)
|
|}
<!--//////////    Tabelle ENDE      //////////-->


Siehe "articleRatings": {"sort": [{}, {}]}
articleRatings_get {}
expectedData
<!--//////////    Tabelle ANFANG      //////////-->
Object
:{| class="wikitable" style="text-align:left"
 
! style="background:#B3B7FF" | Feld
Siehe "articleRatings": {"expectedData": {}
!! style="background:#B3B7FF" | Typ
"params":{"articleRatings": {"sort": [{}, {}]} }
!! style="background:#B3B7FF" | Beschreibung
Feld Typ Beschreibung
|-
field String
|id
 
|Alphanumerisch
Feld das sortiert werden soll
|
 
|-
Erlaubte Werte: id, articleId, userId, username, rating, dateCreated, lastUpdate
|command
direction Number
|Alphanumerisch
 
|Erlaubte Werte: articleRatings/get
Richtung der Sortierung
|-
 
|params
Erlaubte Werte: 1, -1
|Object
"params":{"articleRatings": {"expectedData": {}} }
|
Feld Typ Beschreibung
|}
id
<!--//////////    Tabelle ENDE      //////////-->
Number
 
Erlaubte Werte: 1
articleId
Number
 
Erlaubte Werte: 1
userId
Number
 
Erlaubte Werte: 1
username
Number


Erlaubte Werte: 1
"params":{"filters": [{}, {}]}
rating
<!--//////////    Tabelle ANFANG      //////////-->
Number
:{| class="wikitable" style="text-align:left"
! style="background:#B3B7FF" | Feld
!! style="background:#B3B7FF" | Typ
!! style="background:#B3B7FF" | Beschreibung
|-
|values
|Array
|Array aus String die gefiltert werden sollen. Reguläre Ausdrücke möglich
|-
|fields
|Array
|Optional. Feld welches gefiltert werden soll. Erlaubte Werte: id, articleId, userId, username, rating
|-
|useRegex
|Enum (0..1)
|Optional. Default: 0
|-
|fieldOperator
|Enum (and, or)
|Optional. Default: or
|-
|or
|Object
|Optional. kann "or" oder Werte von filters enthalten.
|}
<!--//////////    Tabelle ENDE      //////////-->


Erlaubte Werte: 1
"params":{"filterDates": [{}, {}]}
dateCrated
Number


Erlaubte Werte: 1
<!--//////////    Tabelle ANFANG      //////////-->
lastUpdate
:{| class="wikitable" style="text-align:left"
Number
! style="background:#B3B7FF" | Feld
!! style="background:#B3B7FF" | Typ
!! style="background:#B3B7FF" | Beschreibung
|-
|fields
|Array (lastUpdate, dateCreated)
|Feld welches gefiltert werden soll
|-
|greaterThan
|Alphanumerisch
|Optional. Größenbereich: Date (Y-m-d H:i:s)
|-
|greaterThanEqual
|Alphanumerisch
|Optional. Größenbereich: Date (Y-m-d H:i:s)
|-
|lessThan
|String
|Optional. Größenbereich: Date (Y-m-d H:i:s)
|-
|lessThanEqual
|Alphanumerisch
|Optional. Größenbereich: Date (Y-m-d H:i:s)
|}
<!--//////////    Tabelle ENDE      //////////-->


Erlaubte Werte: 1
"params":{"articleRatings": {}}
"result":{"articleRatings": {}}
<!--//////////    Tabelle ANFANG      //////////-->
Feld Typ Beschreibung
:{| class="wikitable" style="text-align:left"
data
! style="background:#B3B7FF" | Feld
Array
!! style="background:#B3B7FF" | Typ  
!! style="background:#B3B7FF" | Beschreibung
|-
|start
|Number
|Optional. Startwert, Default: 0
|-
|limit
|Number (40)
|Optional. Maximale Anzahl an Einträgen
|-
|sort
|array
|Optional. Siehe "articleRatings": {"sort": [{}, {}]}
|-
|expectedData
|Object
|Optional. Siehe "articleRatings": {"expectedData": {}
|}
<!--//////////    Tabelle ENDE      //////////-->


Ein Array gem. expectedData.
"params":{"articleRatings": {"sort": [{}, {}]} }
count
<!--//////////    Tabelle ANFANG      //////////-->
Object
:{| class="wikitable" style="text-align:left"
! style="background:#B3B7FF" | Feld
!! style="background:#B3B7FF" | Typ
!! style="background:#B3B7FF" | Beschreibung
|-
|field
|Alphanumerisch (id, articleId, userId, username, rating, dateCreated, lastUpdate)
|Feld das sortiert werden soll
|-
|-
|direction
|Number (-1, 1)
|Richtung der Sortierung
|}
<!--//////////    Tabelle ENDE      //////////-->


Siehe "result":{"articleRatings": {"count": {} }}
"params":{"articleRatings": {"expectedData": {}} }
"result":{"articleRatings": {"count": {} }}
<!--//////////    Tabelle ANFANG      //////////-->
Feld Typ Beschreibung
! style="background:#B3B7FF" | Feld
total
!! style="background:#B3B7FF" | Typ
Number
!! style="background:#B3B7FF" | Beschreibung
|-
|id
|Number (1)
|
|-
|articleId
|Number (1)
|
|-
|userId
|Number (1)
|
|-
|username
|Number (1)
|
|-
|rating
|Number (1)
|
|-
|dateCreated
|Number (1)
|
|-
|lastUpdate
|Number (1)
|
|-
|}
<!--//////////    Tabelle ENDE      //////////-->


Alle Einträge in der Datenbank
"result":{"articleRatings": {}}
filtered
<!--//////////    Tabelle ANFANG      //////////-->
Number
! style="background:#B3B7FF" | Feld
!! style="background:#B3B7FF" | Typ
!! style="background:#B3B7FF" | Beschreibung
|-
|data
|Array
|Optional. Siehe "expectedData"
|-
|count
|Object
|Optional. Siehe "result":{"articleRatings": {"count": {} }}
|}
<!--//////////    Tabelle ENDE      //////////-->


Gefundene Einträge mit den übergebenen Parametern
"result":{"articleRatings": {"count": {} }}
"result":{"averageArticleRating": {}
<!--//////////    Tabelle ANFANG      //////////-->
Feld Typ Beschreibung
! style="background:#B3B7FF" | Feld
averageArticleRating
!! style="background:#B3B7FF" | Typ  
Number
!! style="background:#B3B7FF" | Beschreibung
|-
|total
|Number
|Optional. Alle Einträge in der Datenbank
|-
|filtered
|Number
|Optional. Gefundene Einträge mit den übergebenen Parametern
|}
<!--//////////    Tabelle ENDE      //////////-->


Durchschnittliche Bewertung
"result":{"averageArticleRating": {}
articleRatings | 3. articleRatings_delete
<!--//////////    Tabelle ANFANG      //////////-->
post
! style="background:#B3B7FF" | Feld
!! style="background:#B3B7FF" | Typ
!! style="background:#B3B7FF" | Beschreibung
|-
|averageArticleRating
|Number
|Optional. Durchschnittliche Bewertung
|}


/
articleRatings_delete {}
<!--//////////    Tabelle ANFANG      //////////-->
:{| class="wikitable" style="text-align:left"
! style="background:#B3B7FF" | Feld
!! style="background:#B3B7FF" | Typ
!! style="background:#B3B7FF" | Beschreibung
|-
|id
|Alphanumerisch
|
|-
|command
|Alphanumerisch
|Erlaubte Werte: articleRatings/deleted
|-
|params
|Object
|
|}
<!--//////////    Tabelle ENDE      //////////-->


{}
-->
Feld Typ Beschreibung
id String
command String


Erlaubte Werte: articleRatings/delete
params Object
"params":{"data":{}}
"params":{"data":{}}
Feld Typ Beschreibung
Feld Typ Beschreibung
Zeile 12.245: Zeile 12.319:
Feld Typ Beschreibung
Feld Typ Beschreibung
count Number
count Number


= Einzelnachweise =
= Einzelnachweise =


<references />
<references />
Abgerufen von „https://wiki.fakturax.de/index.php?title=Schnittstellenleitfaden“