Die Filterparameter werden als GET-Anfrageparameter übergeben.
Filter werden verwendet, um nicht alle Objekte auszuwählen, sondern nur bestimmte, z.B. eine Liste nur aktiver DJ. Für Objekte stehen die folgenden Filter zur Verfügung:
- Server - gibt es keine Filter
- Channel - [server <id des Servers>]
- History - [server <id des Servers>]
- DJ - [server <id des Servers> | active <0|1> | connected <0|1> | on_air <0|1>], wobei:
- active - ist DJ eingeschaltet (kann er sich mit dem Stream verbinden)
- connected - ist DJ im Moment verbunden
- on_air - wenn 1, bedeutet dies, dass der DJ verbunden, aktiv und gerade auf Sendung ist.
Beispiele für Filterungen:
/api/djs/?limit=1?server=1&on_air=1 - Daten über einen DJ auf Sendung auf Server 1 erhalten
/api/channels/?server=1 - Liste der Kanäle des Servers 1 erhalten
/api/history/?server=1&limit=1 - aktueller Titel auf Server 1
