zevvy API Referenz

Endpunkt Beschreibungen

Alle Endpunkte können auf folgender Seite angesehen und getestet werden:
https://api.zevvy.ch/docs/ui

Building Unit

Unter "Building Unit" wird eine einzige Nutzeinheit gemeint. Eine Nutzeinheit kann z.B. eine Garage, Wohnung, Bastelraum etc. sein.

Endpunkt: Nutzeinheiten (/building-unit)

Measurments

"Measurements" sind die Messdaten welche z.B. durch die Nutzeinheit, PV-Anlage oder Elektrotankstelle generiert werden.

Endpunkt: Messdaten (/measurement)

Tariff

Unter "Tariff" sind die Tarife gemeint. Es kann z.B. Hoch oder Niedertarif eingestellt werden.

Endpunkt: Tarife (/tariff)

System

Damit abgerechnet werden kann, müssen verschiedene Kosten eingetragen werden. Die Kosten können in verschiedene Systeme (z.B. Wasser, Warmwasser, Strom, Heizung etc.) eingetragen werden.

Endpunkt: Kosten (/system)

Complex

Ein "Complex" ist eine Liegenschaft. In einer Liegenschaft werden Nutzeineheiten, Systeme (Kosten), Kontakte sowie Messdaten verwaltet.

Endpunkt: Liegenschaft (/complex)

Beispiele

Nutzeinheiten und Systeme einer Liegenschaft mit Referenz abfragen

Mit den Parametern können Anfragen auch gefiltert werden. Folgendes Beispiel zeigt wie man alle Nutzeinheiten einer Liegenschaft mit einer spezifischen Referenz abfragen kann. Damit die Abfragen funktionieren muss <meineReferenz123> und <BASE64 USERNAME:PASSWORD> durch Ihre Werte ersetzt werden.

Liegenschaft ID abfragen mit der Referenz Filter

Parameter für die Abfrage:

/complex?page=0&size=20&reference=meineReferenz123

Abfrage:

curl -X 'GET' \
 'http://api.zevvy.ch/complex?page=0&size=20&reference=<meineReferenz123>' \
 -H 'accept: application/json' \
 -H 'Authorization: Basic <BASE64 USERNAME:PASSWORD>'

Alle Systeme mit der Liegenschaft ID von oben abfragen

Parameter für die Abfrage:

/system?page=0&size=20&complex=<complexID>

Abfrage:

curl -X 'GET' \
 'http://api.zevvy.ch/system?page=0&size=20&complex=<complexID>' \
 -H 'accept: application/json' \
 -H 'Authorization: Basic <BASE64 USERNAME:PASSWORD>'

Alle Nutzeinheiten mit der Liegenschaft ID von oben abfragen

Parameter für die Abfrage:

/building-unit?page=0&size=20&complex=<complexID>

Abfrage:

curl -X 'GET' \
 'http://api.zevvy.ch/building-unit?page=0&size=20&complex=<complexID>' \
 -H 'accept: application/json' \
 -H 'Authorization: Basic <BASE64 USERNAME:PASSWORD>'