FoxInsights (Vorschau)
Bringen Sie FoxInsights Tankdaten in Ihre Flüsse und Geschäfts-Apps. Rufen Sie Geräte, Füllstufen und die neuesten Messwerte ab, lösen Sie Bestellungen oder Warnungen aus, wenn ein Tank niedrig ist, und halten Sie Partner, Kunden, Produkte und Tankeinstellungen mit Ihrem ERP oder CRM synchron.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: - Azure Government Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | FoxInsights-Partnersupport |
| URL | https://www.foxinsights.ai/en/contact |
| E‑Mail | partner-support@foxinsights.ai |
| Connectormetadaten | |
|---|---|
| Herausgeber | FoxInsights |
| Website | https://www.foxinsights.ai |
| Datenschutzrichtlinie | https://www.foxinsights.ai/en/privacy |
| Categories | Internet der Dinge; Daten |
FoxInsights
Bringen Sie FoxInsights Tankdaten in Power Automate, Power Apps und Copilot Studio und durch sie in Dynamics 365. Rufen Sie Geräte, Füllstufen und die neuesten Messwerte ab, lösen Sie Bestellungen oder Warnungen aus, wenn ein Tank niedrig ist, und halten Sie Partner, Kunden, Produkte und Tankeinstellungen mit Ihrem ERP oder CRM synchron.
Publisher: FoxInsights
Prerequisites
- Ein FoxInsights-Partnerkonto mit aktivierter Partner-API. Kontakt partner-support@foxinsights.ai , um ihn zu aktivieren.
- Partner-API-Anmeldeinformationen (Client-ID und geheimer Clientschlüssel), erstellt im FoxInsights-Portal unter "Einstellungen > Partner-API".
Unterstützte Vorgänge
Partners
- Partner auflisten: der Partner, der die Anmeldeinformationen und alle Unterpartner als flache Liste besitzt.
- Partnerstruktur abrufen: die gleichen Partner wie eine geschachtelte Struktur.
- Partner / abrufenSuchpartner nach interner ID.
- Partner erstellen, Partner umbenennen, interne ID des Partners aktualisieren, E-Mails für Partnerbenachrichtigungen festlegen, Partnerprodukte festlegen.
Devices
- Erhalten Sie Partnergeräte: Geräte eines Partners mit dem aktuellen Füllstand und der neuesten Messung. Geräte von Unterpartnern sind nicht enthalten.
- Geräte abrufen, Benutzergeräte abrufen, Geräte nach interner ID durchsuchen, Geräte nach Unternehmen durchsuchen, Zustand des Geräteabbruchs abrufen.
- Gerätename und Notizen aktualisieren, Geräteadresse aktualisieren, Gerätebezeichnungen festlegen, Gerätebenachrichtigungen aktualisieren, Gerät sperren oder entsperren, Gerät auf Partner verschieben, Geräteprodukt ändern, Gerätevertrag abbrechen.
- Set custom tank, Set catalog tank, Set silo, Delete tank configuration.
Endkunden
- Benutzer abrufen, Benutzer per E-Mail abrufen, Benutzer nach interner ID durchsuchen, Benutzer nach benutzerdefiniertem Feld durchsuchen.
- Benutzer erstellen, Benutzer aktualisieren, Gerät dem Benutzer zuweisen, Gerät vom Benutzer aufheben.
Products
- Suchen Sie Produkte nach Code, Abrufen von Produkttypen, Abrufen vordefinierter Tanktypen.
- Produkt erstellen, Produkt aktualisieren.
Abrufen von Anmeldeinformationen
- Melden Sie sich beim FoxInsights-Portal als Partneradministrator an.
- Öffnen Sie die Partner-API für Einstellungen>, und wählen Sie "Neue Anmeldeinformationen" aus.
- Kopieren Sie die Client-ID und den geheimen Clientschlüssel. Das Geheimnis wird nur einmal angezeigt.
Die Anmeldeinformationen gewähren Zugriff auf den Partner, der sie erstellt hat, und alle seine Unterpartner. Erstellen Sie separate Anmeldeinformationen für jede Integration, damit sie unabhängig voneinander widerrufen werden können.
Getting Started
- Erstellen Sie eine Verbindung mit der Client-ID und dem geheimen Clientschlüssel. Der Connector fordert Zugriffstoken automatisch an; kein Token muss eingegeben oder erneuert werden.
- Fügen Sie listenpartner zu einem Fluss hinzu, und durchlaufen Sie das Ergebnis mit "Apply to each".
- Fügen Sie in der Schleife " Partnergeräte abrufen " mit der Partner-ID aus der Schleife hinzu.
- Ordnen Sie die Gerätefelder dem Zielsystem zu, z. B. einer Dataverse-Tabelle oder einem Business Central Datensatz, der von der Hardware-ID schlüsselt.
Bekannte Probleme und Einschränkungen
- Gerätelisten werden pro Partner ohne Paging zurückgegeben. Um eine Partnerstruktur abzudecken, rufen Sie Partnergeräte für jeden Partner von Listenpartnern ab.
- Nur die neueste Messung ist verfügbar; es gibt keine Messhistorie.
- Gemessen am Zeitpunkt der neuesten zuverlässigen Messung, nicht zum Zeitpunkt der letzten Synchronisierung. Ein Gerät ohne Maß hat keine Gemessen an; Die Füllebene kann als 0 angegeben werden. Überprüfen Sie daher vor der Verwendung der Füllebene gemessen.
- Füllebenen können 100 Prozent überschreiten.
- Festlegen von Gerätebezeichnungen, Festlegen von Partnerbenachrichtigungs-E-Mails und Festlegen von Partnerprodukten ersetzen die gesamte Liste.
- Heben Sie die Zuweisung des Geräts vom Benutzer auf, löscht die Geräteadresse und die Tankeinstellungen, es sei denn , die Geräteeinstellungen bleiben festgelegt.
- Partner erstellen, Benutzer erstellen und Produkt erstellen, sind nicht sicher zu wiederholen: Ein wiederholter Aufruf erstellt ein Duplikat oder schlägt fehl.
- Der Vertrag für das Gerät kann nicht über den Verbinder rückgängig gemacht werden.
- Ratenbeschränkungen der Partner-API gelten pro Anmeldeinformationen; eine Antwort von 429 bedeutet, dass der Grenzwert erreicht wurde.
Häufig gestellte Fragen
Speichert der Connector FoxInsights-Daten?
No. Jede Aktion liest oder schreibt FoxInsights-Daten zum Zeitpunkt der Ausführung.
Kann eine Verbindung mehrere Partner sehen?
Ja. Eine Verbindung sieht den Partner, der die Anmeldeinformationen und alle seine Unterpartner erstellt hat.
Wo erhalte ich Hilfe?
Kontaktieren Sie partner-support@foxinsights.ai.
Bereitstellungsanweisungen
Stellen Sie den Connector als benutzerdefinierten Connector mit der Power Platform CLI bereit:
pac connector create --api-definition-file apiDefinition.swagger.json --api-properties-file apiProperties.json --script-file script.csx
Eine Verbindung wird erstellt
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Standard | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Standard
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Required |
|---|---|---|---|
| Client-ID | securestring | Client-ID der Partner-API-Anmeldeinformationen, die in FoxInsights unter "Partner-API für Einstellungen" > erstellt wurden | True |
| Geheimer Clientschlüssel | securestring | Geheimer Clientschlüssel der Partner-API-Anmeldeinformationen | True |
Aktionen
| Abrufen des Zustands des Abbruchs des Geräts |
Gibt zurück, ob der Gerätevertrag für die Kündigung storniert oder markiert wird und wann er storniert werden kann. |
| Abrufen von Benutzergeräten |
Gibt die Geräte zurück, die einem Endkunden zugewiesen sind, mit dem aktuellen Füllstand und der neuesten Messung. |
| Abrufen vordefinierter Tanktypen |
Gibt die Katalogtanktypen zurück, die für ein Produkt verfügbar sind. |
| Aktualisieren des Gerätenamens und der Notizen |
Ersetzt den Gerätenamen, die interne ID und die Partnernotizen. |
| Aktualisieren von Gerätebenachrichtigungen |
Legt die Füllebenen fest, auf denen die Informationen und Benachrichtigungen gesendet werden. |
| Aufheben der Zuweisung des Geräts vom Benutzer |
Entfernt ein Gerät von einem Endkunden. Ohne "Geräteeinstellungen beibehalten" werden die Geräteadresse und die Tankeinstellungen gelöscht. |
| Benutzer abrufen |
Gibt einen Endkunden zurück. |
| Benutzer aktualisieren |
Ersetzt alle Felder eines Endkunden; Felder, die leer sind, werden gelöscht. |
| Benutzer erstellen |
Erstellt einen Endkunden. Es ist nicht sicher, einen Wiederholungsversuche auszuführen: Ein wiederholter Anruf schlägt fehl oder erstellt ein Duplikat. |
| Benutzer nach benutzerdefiniertem Feld durchsuchen |
Gibt die Endbenutzer zurück, deren benutzerdefiniertes Feld den angegebenen Wert aufweist. |
| Benutzer nach interner ID durchsuchen |
Gibt die Endbenutzer mit der angegebenen internen ID zurück. |
| Benutzer per E-Mail abrufen |
Gibt den Endkunden mit der angegebenen E-Mail-Adresse zurück. |
| Benutzerdefinierter Tank festlegen |
Konfiguriert das Gerät für einen tank, der durch seine Abmessungen beschrieben wird; ersetzt jede vorherige Tank- oder Silokonfiguration. |
| Durchsuchen von Geräten nach interner ID |
Gibt die Geräte mit der angegebenen partnerspezifischen internen ID zurück. |
| Festlegen von Gerätebeschriftungen |
Ersetzt alle Bezeichnungen des Geräts durch die angegebene Liste; Bezeichnungen, die nicht in der Liste enthalten sind, werden entfernt. |
| Festlegen von Partnerbenachrichtigungs-E-Mails |
Ersetzt die Liste der E-Mail-Adressen, die Partnerbenachrichtigungen erhalten. |
| Festlegen von Partnerprodukten |
Ersetzt die Liste der Produkte, die dem Partner zugewiesen sind. |
| Gerät abrufen |
Gibt ein Gerät anhand seiner Hardware-ID zurück, wobei der aktuelle Füllstand und die neueste Messung vorhanden sind. |
| Gerät an Partner verschieben |
Verschiebt das Gerät innerhalb der barrierefreien Partnerstruktur zu einem anderen Partner. |
| Gerät sperren oder entsperren |
Sperrt oder entsperrt die Gerätekonfiguration für Endbenutzer. |
| Geräte nach Unternehmen durchsuchen |
Gibt die Geräte zurück, deren Adressunternehmen dem angegebenen Namen entspricht. |
| Geräteadresse aktualisieren |
Ersetzt die Geräteadresse. |
| Interne PARTNER-ID aktualisieren |
Ändert die interne ID des Partners. |
| Katalogtank festlegen |
Konfiguriert das Gerät für einen Katalogtanktyp (siehe "Abrufen vordefinierter Tanktypen"); ersetzt jede vorherige Tank- oder Silokonfiguration. |
| Partner abrufen |
Gibt einen Partner mit seinen internen ID-, Produkt- und Benachrichtigungs-E-Mail-Adressen zurück. |
| Partner auflisten |
Gibt den Partner zurück, der die Verbindungsanmeldeinformationen und alle zugehörigen Unterpartner als flache Liste besitzt, die für "Für jede anwendung" bereit ist. |
| Partner erstellen |
Erstellt einen Unterpartner. Nicht sicher zu wiederholen: Ein wiederholter Anruf erstellt einen zweiten Partner. |
| Partner umbenennen |
Ändert den Partnernamen. |
| Partnergeräte abrufen |
Gibt die Geräte zurück, die direkt zu einem Partner gehören, mit dem aktuellen Füllstand und der neuesten Messung. Geräte von Unterpartnern sind nicht enthalten. |
| Partnerstruktur abrufen |
Gibt den Partner zurück, der die Verbindungsanmeldeinformationen zusammen mit allen Unterpartnern als geschachtelte Struktur besitzt. Verwenden Sie "Partner auflisten", um Partner in einem Fluss zu durchlaufen. |
| Produkt aktualisieren |
Ersetzt alle Felder eines Produkts. |
| Produkt erstellen |
Erstellt ein Produkt. Nicht sicher zu versuchen: Ein wiederholter Aufruf erstellt ein zweites Produkt. |
| Produkttypen abrufen |
Gibt alle Produkttypen mit ihren Standardeinstellungen zurück. |
| Silo festlegen |
Konfiguriert das Gerät für ein Silo; ersetzt jede vorherige Tank- oder Silokonfiguration. |
| Suchen von Produkten nach Code |
Gibt die Produkte mit dem angegebenen Produktcode zurück. |
| Suchpartner nach interner ID |
Gibt die Partner mit der angegebenen internen ID zurück. |
| Tankkonfiguration löschen |
Entfernt den Tank oder die Silokonfiguration des Geräts; Füllebenen werden erst berechnet, wenn eine neue Konfiguration festgelegt ist. |
| Vertrag für Das Gerät kündigen |
Kennzeichnet den Gerätevertrag für die Kündigung am angegebenen Datum. |
| Zuweisen eines Geräts zum Benutzer |
Weist einem Endkunden ein Gerät zu. |
| Ändern des Geräteprodukts |
Ändert das im Tank oder Silo des Geräts gespeicherte Produkt. |
Abrufen des Zustands des Abbruchs des Geräts
Gibt zurück, ob der Gerätevertrag für die Kündigung storniert oder markiert wird und wann er storniert werden kann.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Hardware-ID
|
hwid | True | string |
Hardware-ID des Geräts. |
Gibt zurück
- Body
- CancellationState
Abrufen von Benutzergeräten
Gibt die Geräte zurück, die einem Endkunden zugewiesen sind, mit dem aktuellen Füllstand und der neuesten Messung.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
userId | True | string |
ID des Endkunden. |
Gibt zurück
- response
- array of Device
Abrufen vordefinierter Tanktypen
Gibt die Katalogtanktypen zurück, die für ein Produkt verfügbar sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Produkt-ID
|
productId | True | string |
ID des Produkts. |
Gibt zurück
- Body
- PredefinedTankTypes
Aktualisieren des Gerätenamens und der Notizen
Ersetzt den Gerätenamen, die interne ID und die Partnernotizen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Hardware-ID
|
hwid | True | string |
Hardware-ID des Geräts, gedruckt auf dem Sensor. |
|
Gerätename
|
name | string |
Gerätename; Leer lassen, um zu löschen. |
|
|
Interne ID
|
internalId | True | string |
Eigene ID des Partners für das Gerät; Leere Zeichenfolge löscht sie. |
|
Partnernotizen
|
partnerNotes | True | string |
Partnernotizen; Leere Zeichenfolge löscht sie. |
Gibt zurück
- Body
- Device
Aktualisieren von Gerätebenachrichtigungen
Legt die Füllebenen fest, auf denen die Informationen und Benachrichtigungen gesendet werden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Hardware-ID
|
hwid | True | string |
Hardware-ID des Geräts, gedruckt auf dem Sensor. |
|
Infobenachrichtigung aktiviert
|
notificationInfoEnabled | True | boolean | |
|
Infobenachrichtigungsebene (Prozent)
|
notificationInfoPercentage | True | integer |
Füllgrad in Prozent (0-100), der die Infobenachrichtigung auslöst. |
|
Benachrichtigung aktiviert
|
notificationAlertEnabled | True | boolean | |
|
Warnungsbenachrichtigungsebene (Prozent)
|
notificationAlertPercentage | True | integer |
Füllgrad in Prozent (0-100), der die Warnungsbenachrichtigung auslöst. |
Gibt zurück
- Body
- Device
Aufheben der Zuweisung des Geräts vom Benutzer
Entfernt ein Gerät von einem Endkunden. Ohne "Geräteeinstellungen beibehalten" werden die Geräteadresse und die Tankeinstellungen gelöscht.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
userId | True | string |
ID des Endkunden. |
|
Hardware-ID
|
hwid | True | string | |
|
Geräteeinstellungen beibehalten
|
keepData | boolean |
Ja, um die Adresse und die Tankeinstellungen des Geräts beizubehalten; standardmäßig werden sie nicht gelöscht. |
Gibt zurück
- Body
- Device
Benutzer abrufen
Gibt einen Endkunden zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
userId | True | string |
ID des Endkunden. |
Gibt zurück
- Body
- User
Benutzer aktualisieren
Ersetzt alle Felder eines Endkunden; Felder, die leer sind, werden gelöscht.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
userId | True | string |
ID des Endkunden. |
|
E‑Mail
|
True | string | ||
|
Vorname
|
firstName | True | string | |
|
Nachname
|
lastName | True | string | |
|
Titel
|
title | string | ||
|
Phone
|
phone | string | ||
|
Unternehmensname
|
companyName | True | string |
Firmenname; kann leer sein. |
|
Position des Unternehmens
|
companyPosition | string | ||
|
Straße
|
street | string | ||
|
Postleitzahl
|
zipCode | string | ||
|
City
|
city | string | ||
|
Land
|
country | True | string |
Land als ISO 3166-1 Alpha-2-Code. |
|
Locale
|
locale | True | string |
Sprache und Region, z. B. de-DE. |
|
Role
|
role | True | string |
USER für Privatkunden, B2B_CUSTOMER / B2B_ADMIN für Geschäftskunden. |
|
Interne Benutzer-ID
|
internalId | string | ||
|
Benutzerpartner
|
partnerId | string |
Partner, zu dem der Benutzer gehört. |
|
|
Benutzerdefinierte Felder
|
customFields | True | object |
Benutzerdefinierte Felder als JSON-Objekt von Name/Wert-Paaren; wird für keine verwendet {} . |
Gibt zurück
- Body
- User
Benutzer erstellen
Erstellt einen Endkunden. Es ist nicht sicher, einen Wiederholungsversuche auszuführen: Ein wiederholter Anruf schlägt fehl oder erstellt ein Duplikat.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
E‑Mail
|
True | string | ||
|
Vorname
|
firstName | True | string | |
|
Nachname
|
lastName | True | string | |
|
Titel
|
title | string | ||
|
Phone
|
phone | string | ||
|
Unternehmensname
|
companyName | True | string |
Firmenname; kann leer sein. |
|
Position des Unternehmens
|
companyPosition | string | ||
|
Straße
|
street | string | ||
|
Postleitzahl
|
zipCode | string | ||
|
City
|
city | string | ||
|
Land
|
country | True | string |
Land als ISO 3166-1 Alpha-2-Code. |
|
Locale
|
locale | True | string |
Sprache und Region, z. B. de-DE. |
|
Role
|
role | True | string |
USER für Privatkunden, B2B_CUSTOMER / B2B_ADMIN für Geschäftskunden. |
|
Interne Benutzer-ID
|
internalId | string | ||
|
Benutzerpartner
|
partnerId | string |
Partner, zu dem der Benutzer gehört. |
|
|
Benutzerdefinierte Felder
|
customFields | True | object |
Benutzerdefinierte Felder als JSON-Objekt von Name/Wert-Paaren; wird für keine verwendet {} . |
Gibt zurück
- Body
- User
Benutzer nach benutzerdefiniertem Feld durchsuchen
Gibt die Endbenutzer zurück, deren benutzerdefiniertes Feld den angegebenen Wert aufweist.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name des benutzerdefinierten Felds
|
fieldName | True | string |
Name des benutzerdefinierten Felds. |
|
Wert des benutzerdefinierten Felds
|
fieldValue | True | string |
Wert, nach dem gesucht werden soll. |
Gibt zurück
- response
- array of User
Benutzer nach interner ID durchsuchen
Gibt die Endbenutzer mit der angegebenen internen ID zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Interne ID
|
internalId | True | string |
Interne ID des Endkunden. |
Gibt zurück
- response
- array of User
Benutzer per E-Mail abrufen
Gibt den Endkunden mit der angegebenen E-Mail-Adresse zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
E‑Mail
|
True | string |
E-Mail-Adresse des Endkunden. |
Gibt zurück
- Body
- User
Benutzerdefinierter Tank festlegen
Konfiguriert das Gerät für einen tank, der durch seine Abmessungen beschrieben wird; ersetzt jede vorherige Tank- oder Silokonfiguration.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Hardware-ID
|
hwid | True | string |
Hardware-ID des Geräts, gedruckt auf dem Sensor. |
|
Tankhöhe (cm)
|
heightCm | True | double | |
|
Sensoroffset (cm)
|
offsetCm | True | double |
Abstand zwischen Sensor und Tankoberseite. |
|
Tankvolumen (L)
|
volumeL | True | integer | |
|
Volume ist verwendbares Volume
|
isUsableVolume | True | boolean |
Ja, wenn das Volume das verwendbare Volume ist, nein, wenn es sich um das Gesamtvolume handelt. |
|
Tank-Shape
|
shape | True | string |
VERTICAL_CYLINDER wird als gesendet, aber als SQUARED gemeldet. |
|
Montagetyp
|
mountingType | True | string |
Wie der Sensor montiert wird. |
|
Produkt-ID
|
productId | True | string |
ID des gespeicherten Produkts. |
Gibt zurück
- Body
- Device
Durchsuchen von Geräten nach interner ID
Gibt die Geräte mit der angegebenen partnerspezifischen internen ID zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Interne ID
|
internalId | True | string |
Die eigene ID des Partners für das Gerät. |
Gibt zurück
- response
- array of Device
Festlegen von Gerätebeschriftungen
Ersetzt alle Bezeichnungen des Geräts durch die angegebene Liste; Bezeichnungen, die nicht in der Liste enthalten sind, werden entfernt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Hardware-ID
|
hwid | True | string |
Hardware-ID des Geräts, gedruckt auf dem Sensor. |
|
Labels
|
labels | True | array of string |
Vollständige Liste der Etiketten; ersetzt die aktuellen Bezeichnungen. |
Gibt zurück
- Body
- Device
Festlegen von Partnerbenachrichtigungs-E-Mails
Ersetzt die Liste der E-Mail-Adressen, die Partnerbenachrichtigungen erhalten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Partnerunternehmen
|
partnerId | True | string |
Partner, der geändert werden soll. |
|
E-Mail-Benachrichtigungen
|
notificationEmails | True | array of string |
Vollständige Liste; ersetzt die aktuellen Adressen. |
Gibt zurück
- Body
- Partner
Festlegen von Partnerprodukten
Ersetzt die Liste der Produkte, die dem Partner zugewiesen sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Partnerunternehmen
|
partnerId | True | string |
Partner, der geändert werden soll. |
|
Produkt-IDs
|
productIds | True | array of string |
Vollständige Liste; ersetzt die aktuellen Produkte. |
Gibt zurück
- Body
- Partner
Gerät abrufen
Gibt ein Gerät anhand seiner Hardware-ID zurück, wobei der aktuelle Füllstand und die neueste Messung vorhanden sind.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Hardware-ID
|
hwid | True | string |
Hardware-ID des Geräts, gedruckt auf dem Sensor. |
Gibt zurück
- Body
- Device
Gerät an Partner verschieben
Verschiebt das Gerät innerhalb der barrierefreien Partnerstruktur zu einem anderen Partner.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Hardware-ID
|
hwid | True | string |
Hardware-ID des Geräts, gedruckt auf dem Sensor. |
|
Zielpartner
|
partnerId | True | string |
Partner, um das Gerät zu verschieben. |
Gibt zurück
- Body
- Device
Gerät sperren oder entsperren
Sperrt oder entsperrt die Gerätekonfiguration für Endbenutzer.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Hardware-ID
|
hwid | True | string |
Hardware-ID des Geräts, gedruckt auf dem Sensor. |
|
Gesperrt
|
isLocked | True | boolean |
Ja, um die Konfiguration für Endbenutzer zu sperren. |
Gibt zurück
- Body
- Device
Geräte nach Unternehmen durchsuchen
Gibt die Geräte zurück, deren Adressunternehmen dem angegebenen Namen entspricht.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Firma
|
company | True | string |
Firmenname in der Geräteadresse. |
Gibt zurück
- response
- array of Device
Geräteadresse aktualisieren
Ersetzt die Geräteadresse.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Hardware-ID
|
hwid | True | string |
Hardware-ID des Geräts, gedruckt auf dem Sensor. |
|
Firma
|
company | True | string |
Firma; kann leer sein. |
|
Straße
|
streetLines | True | string |
Straße und Hausnummer. |
|
Postleitzahl
|
zipCode | True | string |
Postleitzahl. |
|
City
|
city | True | string |
Stadt. |
|
Land
|
country | True | string |
Land als ISO 3166-1 Alpha-2-Code. |
Gibt zurück
- Body
- Device
Interne PARTNER-ID aktualisieren
Ändert die interne ID des Partners.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Partnerunternehmen
|
partnerId | True | string |
Partner, der geändert werden soll. |
|
Neue interne Partner-ID
|
internalId | True | string |
Gibt zurück
- Body
- Partner
Katalogtank festlegen
Konfiguriert das Gerät für einen Katalogtanktyp (siehe "Abrufen vordefinierter Tanktypen"); ersetzt jede vorherige Tank- oder Silokonfiguration.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Hardware-ID
|
hwid | True | string |
Hardware-ID des Geräts, gedruckt auf dem Sensor. |
|
Tanktyp-ID
|
storageTypeId | True | string |
Katalogtanktyp-ID aus "Vordefinierte Tanktypen abrufen". |
|
Anzahl der Tanks
|
storageCount | True | integer |
Anzahl der angeschlossenen Tanks dieses Typs. |
|
Sensoroffset (cm)
|
offsetTopCm | True | double | |
|
Montagetyp
|
mountingType | True | string |
Wie der Sensor montiert wird. |
|
Produkt-ID
|
productId | True | string |
ID des gespeicherten Produkts. |
Gibt zurück
- Body
- Device
Partner abrufen
Gibt einen Partner mit seinen internen ID-, Produkt- und Benachrichtigungs-E-Mail-Adressen zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Partnerunternehmen
|
partnerId | True | string |
Partner, der zurückgegeben werden soll. |
Gibt zurück
- Body
- Partner
Partner auflisten
Gibt den Partner zurück, der die Verbindungsanmeldeinformationen und alle zugehörigen Unterpartner als flache Liste besitzt, die für "Für jede anwendung" bereit ist.
Gibt zurück
- response
- array of PartnerListItem
Partner erstellen
Erstellt einen Unterpartner. Nicht sicher zu wiederholen: Ein wiederholter Anruf erstellt einen zweiten Partner.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Name des Partners
|
name | True | string | |
|
Interne Partner-ID
|
internalId | string | ||
|
Übergeordneter Partner
|
parentId | True | string |
Partner, unter dem der neue Partner erstellt wird. |
|
Produkt-IDs
|
productIds | True | array of string |
Dem neuen Partner zugewiesene Produkte. |
Gibt zurück
- Body
- Partner
Partner umbenennen
Ändert den Partnernamen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Partnerunternehmen
|
partnerId | True | string |
Partner, der geändert werden soll. |
|
Neuer Partnername
|
name | True | string |
Gibt zurück
- Body
- Partner
Partnergeräte abrufen
Gibt die Geräte zurück, die direkt zu einem Partner gehören, mit dem aktuellen Füllstand und der neuesten Messung. Geräte von Unterpartnern sind nicht enthalten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Partnerunternehmen
|
partnerId | True | string |
Partner, deren eigene Geräte zurückgegeben werden. |
Gibt zurück
- response
- array of Device
Partnerstruktur abrufen
Gibt den Partner zurück, der die Verbindungsanmeldeinformationen zusammen mit allen Unterpartnern als geschachtelte Struktur besitzt. Verwenden Sie "Partner auflisten", um Partner in einem Fluss zu durchlaufen.
Gibt zurück
- Body
- PartnerTree
Produkt aktualisieren
Ersetzt alle Felder eines Produkts.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Produkt-ID
|
productId | True | string |
ID des Produkts. |
|
Produktname
|
name | True | string | |
|
Produktcode
|
code | True | string | |
|
Produkttyp
|
type | True | string | |
|
Dichte (kg pro L)
|
densityKgpl | double | ||
|
Bild-URL
|
imageUrl | True | string |
Bild-URL; take it from 'Get product types'. |
|
Messintervall
|
measurementInterval | True | integer |
Verwenden Sie die Standardeinstellung von "Produkttypen abrufen". |
|
Sicherheitsrand
|
safetyMargin | True | double |
Verwenden Sie die Standardeinstellung von "Produkttypen abrufen". |
|
100 Prozent Basis
|
displayAs100Percent | True | string | |
|
Partner-IDs
|
partnerIds | True | array of string |
Partner, denen das Produkt zugewiesen ist. |
|
Offlinebenachrichtigung aktiviert
|
enabled | boolean | ||
|
Erste Anzahl der Offlinebenachrichtigungen
|
countFirst | integer | ||
|
Anzahl der zweiten Offlinebenachrichtigungen
|
countSecond | integer | ||
|
Anzahl der Offlinebenachrichtigungsserien
|
countRecurring | integer | ||
|
Metering Hour
|
hour | integer | ||
|
Metering Minute
|
minute | integer |
Gibt zurück
- Body
- Product
Produkt erstellen
Erstellt ein Produkt. Nicht sicher zu versuchen: Ein wiederholter Aufruf erstellt ein zweites Produkt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Produktname
|
name | True | string | |
|
Produktcode
|
code | True | string | |
|
Produkttyp
|
type | True | string | |
|
Dichte (kg pro L)
|
densityKgpl | double | ||
|
Bild-URL
|
imageUrl | True | string |
Bild-URL; take it from 'Get product types'. |
|
Messintervall
|
measurementInterval | True | integer |
Verwenden Sie die Standardeinstellung von "Produkttypen abrufen". |
|
Sicherheitsrand
|
safetyMargin | True | double |
Verwenden Sie die Standardeinstellung von "Produkttypen abrufen". |
|
100 Prozent Basis
|
displayAs100Percent | True | string | |
|
Partner-IDs
|
partnerIds | True | array of string |
Partner, denen das Produkt zugewiesen ist. |
|
Offlinebenachrichtigung aktiviert
|
enabled | boolean | ||
|
Erste Anzahl der Offlinebenachrichtigungen
|
countFirst | integer | ||
|
Anzahl der zweiten Offlinebenachrichtigungen
|
countSecond | integer | ||
|
Anzahl der Offlinebenachrichtigungsserien
|
countRecurring | integer | ||
|
Metering Hour
|
hour | integer | ||
|
Metering Minute
|
minute | integer |
Gibt zurück
- Body
- Product
Produkttypen abrufen
Gibt alle Produkttypen mit ihren Standardeinstellungen zurück.
Gibt zurück
- response
- array of ProductType
Silo festlegen
Konfiguriert das Gerät für ein Silo; ersetzt jede vorherige Tank- oder Silokonfiguration.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Hardware-ID
|
hwid | True | string |
Hardware-ID des Geräts, gedruckt auf dem Sensor. |
|
Silohöhe (cm)
|
heightCm | True | double | |
|
Silobreite (cm)
|
widthCm | True | double | |
|
Silolänge (cm)
|
lengthCm | True | double | |
|
Silo oben versetzt (cm)
|
offsetTopCm | True | double | |
|
Siloseitiger Offset (cm)
|
offsetSideCm | True | double | |
|
Silospeichertyp
|
storeType | True | string | |
|
Silo-Montage
|
mounting | True | string | |
|
Silokapazität (kg)
|
massKg | True | integer | |
|
Produkt-ID
|
productId | True | string |
ID des gespeicherten Produkts. |
Gibt zurück
- Body
- Device
Suchen von Produkten nach Code
Gibt die Produkte mit dem angegebenen Produktcode zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Produktcode
|
productCode | True | string |
Produktcode. |
Gibt zurück
- response
- array of Product
Suchpartner nach interner ID
Gibt die Partner mit der angegebenen internen ID zurück.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Interne ID
|
internalId | True | string |
Interne ID des Partners. |
Gibt zurück
- response
- array of Partner
Tankkonfiguration löschen
Entfernt den Tank oder die Silokonfiguration des Geräts; Füllebenen werden erst berechnet, wenn eine neue Konfiguration festgelegt ist.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Hardware-ID
|
hwid | True | string |
Hardware-ID des Geräts, gedruckt auf dem Sensor. |
Gibt zurück
- Body
- Device
Vertrag für Das Gerät kündigen
Kennzeichnet den Gerätevertrag für die Kündigung am angegebenen Datum.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Hardware-ID
|
hwid | True | string |
Hardware-ID des Geräts, gedruckt auf dem Sensor. |
|
Absagen im Jahr
|
year | True | integer | |
|
Kündigen am Monat
|
month | True | integer | |
|
Absagen am Tag
|
day | True | integer |
Gibt zurück
- Body
- CancelDeviceRequest
Zuweisen eines Geräts zum Benutzer
Weist einem Endkunden ein Gerät zu.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Benutzer-ID
|
userId | True | string |
ID des Endkunden. |
|
Hardware-ID
|
hwid | True | string | |
|
Geräteeinstellungen beibehalten
|
keepData | True | boolean |
Ja, um die Adresse und die Tankeinstellungen des Geräts beizubehalten. |
Gibt zurück
- Body
- Device
Ändern des Geräteprodukts
Ändert das im Tank oder Silo des Geräts gespeicherte Produkt.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Hardware-ID
|
hwid | True | string |
Hardware-ID des Geräts, gedruckt auf dem Sensor. |
|
Produkt-ID
|
productId | True | string |
ID des neuen Produkts. |
Gibt zurück
- Body
- Device
Definitionen
Partnerunternehmen
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Partner-ID
|
id | uuid |
Partner-ID. |
|
Interne Partner-ID
|
internalId | string |
Interne ID des Partners. |
|
Name des Partners
|
name | string |
Name des Partners |
|
Products
|
products | array of PartnerProduct |
Dem Partner zugewiesene Produkte. |
|
E-Mail-Benachrichtigungen
|
notificationEmails | array of string |
E-Mail-Adressen, die Partnerbenachrichtigungen empfangen. |
User
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Benutzer-ID
|
id | uuid |
Benutzer-ID. |
|
Interne Benutzer-ID
|
internalId | string |
Die eigene ID des Partners für den Endkunden. |
|
Benutzerpartner-ID
|
partnerId | uuid |
DIE ID des Partners, zu dem der Benutzer gehört. |
|
E‑Mail
|
string |
E-Mail-Adresse. |
|
|
Phone
|
phone | string |
Telefonnummer. |
|
Titel
|
title | string |
Titel. |
|
Vorname
|
firstName | string |
Vorname. |
|
Nachname
|
lastName | string |
Nachname. |
|
Unternehmensname
|
companyName | string |
Firmenname. |
|
Position des Unternehmens
|
companyPosition | string |
Position im Unternehmen, z.B. MANAGEMENT, VERTRIEB, DISPATCHING. |
|
Straße
|
street | string |
Straße und Hausnummer. |
|
Postleitzahl
|
zipCode | string |
Postleitzahl. |
|
City
|
city | string |
Stadt. |
|
Land
|
country | string |
Land als ISO 3166-1 Alpha-2-Code. |
|
Locale
|
locale | string |
Sprache und Region, z. B. de-DE. |
|
Role
|
role | string |
Rolle, z. B. USER, B2B_CUSTOMER, B2B_ADMIN. |
|
Benutzerdefinierte Felder
|
customFields | object |
Partnerdefinierte benutzerdefinierte Felder als Name/Wert-Paare. |
Produkt
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Produkt-ID
|
id | uuid |
Produkt-ID. |
|
Produktname
|
name | string |
Produktname |
|
Produktcode
|
code | string |
Produktcode. |
|
Produkttyp
|
type | string |
Produkttyp, z. B. HEATING_OIL, DIESEL, LPG, PELLETS. |
|
Sammelt
|
isCollecting | boolean |
Gibt an, ob das Produkt (z. B. Altöl) statt verbraucht wird. |
|
Dichte (kg pro L)
|
densityKgpl | double |
Dichte in kg pro Liter. |
|
Messintervall
|
measurementInterval | integer |
Maßintervall. |
|
100 Prozent Basis
|
displayAs100Percent | string |
Welche Kapazität 100 Prozent beträgt: USABLE_VOLUME oder TOTAL_VOLUME. |
|
Sicherheitsrand
|
safetyMargin | double |
Sicherheitsrand. |
|
Bild-URL
|
imageUrl | string |
Produktbild-URL. |
|
Partner-IDs
|
partnerIds | array of uuid |
Partner, denen das Produkt zugewiesen ist. |
|
Offlinebenachrichtigung aktiviert
|
offlineNotification.enabled | boolean | |
|
Erste Anzahl der Offlinebenachrichtigungen
|
offlineNotification.countFirst | integer | |
|
Anzahl der zweiten Offlinebenachrichtigungen
|
offlineNotification.countSecond | integer | |
|
Anzahl der Offlinebenachrichtigungsserien
|
offlineNotification.countRecurring | integer | |
|
Standardqualitätsindex
|
qualityList.defaultIndex | integer | |
|
Standard
|
qualityList.default | ProductQuality | |
|
Qualitäten
|
qualityList.items | array of ProductQuality | |
|
Metering Hour
|
meteringTime.hour | integer | |
|
Metering Minute
|
meteringTime.minute | integer | |
|
Metering Second
|
meteringTime.second | integer | |
|
Meterieren von Nanosekunden
|
meteringTime.nano | integer |
ProductQuality
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Qualitäts-ID
|
id | uuid | |
|
Qualitätsname
|
name | string | |
|
Qualitätscode
|
code | string |
Produkttyp
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Produkttyp
|
type | string |
Produkttyp, z. B. HEATING_OIL, DIESEL, LPG, PELLETS. |
|
Standarddichte (kg pro L)
|
defaultDensityKgpl | double |
Standarddichte in kg pro Liter. |
|
Standardmaßintervall
|
measurementInterval | integer | |
|
Standardsicherheitsrand
|
safetyMargin | double | |
|
Standardbasis von 100 Prozent
|
displayAs100Percent | string |
USABLE_VOLUME oder TOTAL_VOLUME. |
|
Bild-URL
|
imageUrl | string |
PredefinedTankTypes
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Tanktypen
|
types | array of TankPredefinedType |
Katalogtanktypen. |
CancellationState
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Hardware-ID
|
hwid | string |
Hardware-ID des Geräts. |
|
Wird abgebrochen
|
isCancelled | boolean |
Gibt an, ob der Gerätevertrag abgebrochen wird. |
|
Nach Jahr gekündigt
|
cancellableAfter.year | integer | |
|
Nach Monat gekündigt
|
cancellableAfter.month | integer | |
|
Gekündigt nach Tag
|
cancellableAfter.day | integer | |
|
Stornierungsjahr
|
markedForCancellationOn.year | integer | |
|
Kündigungsmonat
|
markedForCancellationOn.month | integer | |
|
Stornierungstag
|
markedForCancellationOn.day | integer |
CancelDeviceRequest
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Absagen im Jahr
|
cancelAt.year | integer | |
|
Kündigen am Monat
|
cancelAt.month | integer | |
|
Absagen am Tag
|
cancelAt.day | integer |
PartnerTree
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Partner-ID
|
id | uuid |
Partner-ID. |
|
Name des Partners
|
name | string |
Name des Partners |
|
Products
|
products | array of PartnerProduct |
Dem Partner zugewiesene Produkte. |
|
Unterpartner
|
children | array of object |
Unterpartner mit der gleichen Struktur wie der Partner. |
|
Elemente
|
children | object |
PartnerListItem
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Partner-ID
|
id | uuid |
Partner-ID. |
|
Name des Partners
|
name | string |
Name des Partners |
|
Übergeordnete Partner-ID
|
parentId | uuid |
ID des übergeordneten Partners; leer für den Partner, der die Anmeldeinformationen besitzt. |
|
Tiefe
|
depth | integer |
Ebene in der Partnerstruktur; 0 für den Partner, der die Anmeldeinformationen besitzt. |
|
Products
|
products | array of PartnerProduct |
Dem Partner zugewiesene Produkte. |
PartnerProduct
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Produkt-ID
|
id | uuid |
Produkt-ID. |
|
Produktname
|
name | string |
Produktname |
|
Produktcode
|
code | string |
Produktcode. |
|
Produkttyp
|
type | string |
Produkttyp, z. B. HEATING_OIL. |
Gerät
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Hardware-ID
|
hwid | string |
Hardware-ID des Geräts; stabiler Schlüssel für das Gerät. |
|
Gerätename
|
name | string |
Name des Geräts. |
|
Partner-ID
|
partnerId | uuid |
DIE ID des Partners, zu dem das Gerät gehört. |
|
Interne ID
|
internalId | string |
Eigene ID des Partners für das Gerät; kann leer sein und ist nicht garantiert einzigartig. |
|
Partnernotizen
|
partnerNotes | string |
Partnernotizen. |
|
Produkt-ID
|
productId | uuid |
ID des gespeicherten Produkts. |
|
Produktcode
|
productCode | string |
Code des gespeicherten Produkts. |
|
Benutzer-ID
|
userId | uuid |
Die ID des Endbenutzers, dem das Gerät zugewiesen ist. |
|
Hat Servicevertrag
|
hasServiceAgreement | boolean |
Gibt an, ob der Endbenutzer über einen Servicevertrag verfügt. |
|
Wartungszustand
|
maintenanceState | string |
Wartungszustand: UNBEKANNT, OK, BESCHWERT, SENT_BACK, EMPFANGEN, ÜBERPRÜFT oder DEFEKT. |
|
address
|
address | Address | |
|
Max. Volume (Legacy)
|
maxVolume | integer |
Altes Höchstvolumen in Litern; verwenden Sie stattdessen verwendbare Menge /Gesamtmenge. |
|
lastMetering
|
lastMetering | Metering |
Neueste zuverlässige Messung; leer, wenn das Gerät noch nicht gemessen wurde. |
|
Infobenachrichtigung aktiviert
|
notificationInfoEnabled | boolean |
Gibt an, ob die Infobenachrichtigung aktiviert ist. |
|
Infobenachrichtigungsebene (Prozent)
|
notificationInfoPercentage | integer |
Füllgrad in Prozent, der die Infobenachrichtigung auslöst. |
|
Benachrichtigung aktiviert
|
notificationAlertEnabled | boolean |
Gibt an, ob die Benachrichtigung aktiviert ist. |
|
Warnungsbenachrichtigungsebene (Prozent)
|
notificationAlertPercentage | integer |
Füllgrad in Prozent, der die Warnungsbenachrichtigung auslöst. |
|
Ist gesperrt
|
isLocked | boolean |
Gibt an, ob die Gerätekonfiguration gesperrt ist. |
|
berechnet
|
computed | ComputedStorage |
Aus der Speicherkonfiguration berechnete Füllebene; leer, wenn das Gerät keinen Speicher konfiguriert hat. |
|
tankCustom
|
tankCustom | TankCustom |
Benutzerdefinierte Tankkonfiguration. |
|
Silo
|
silo | Silo |
Silokonfiguration. |
|
tankPredefined
|
tankPredefined | TankPredefined |
Vordefinierte (Katalog)-Tankkonfiguration. |
|
salesAssistantPrediction
|
salesAssistantPrediction | SalesPrediction |
Auftragsvorhersage des Vertriebsassistenten. |
|
Labels
|
labels | array of string |
Dem Gerät zugewiesene Bezeichnungen. |
Adresse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Adressunternehmen
|
company | string |
Unternehmen. |
|
Adresse Straße
|
streetLines | string |
Straße und Hausnummer. |
|
Adressort
|
city | string |
Stadt. |
|
Adresse Postleitzahl
|
zipCode | string |
Postleitzahl. |
|
Adressland
|
country | string |
Land als ISO 3166-1 Alpha-2-Code. |
Messung
Neueste zuverlässige Messung; leer, wenn das Gerät noch nicht gemessen wurde.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Gemessene Menge (L)
|
quantity | integer |
Gemessene Menge in Litern. |
|
Gemessene Mengeneinheit
|
quantityUnit | string |
Einheit der gemessenen Menge. |
|
Gemessen bei (Unix-Sekunden)
|
timestamp | integer |
Messzeit als Unix-Sekunden. |
|
Gemessen bei
|
measuredAt | date-time |
Messzeit in UTC, abgeleitet vom Unix-Zeitstempel der neuesten Messung. |
|
estimatedForecastDate
|
estimatedForecastDate | LocalDate |
Geschätztes Datum, an dem der Speicher ein Erneutes Ausfüllen benötigt. |
|
Akkustand
|
batteryLevel | string |
Akkustand: VOLL, GUT, MITTEL, WARNUNG oder KRITISCH. |
|
Signalstärke
|
signalStrength | string |
Signalstärke: VERY_WEAK, SCHWACH, GUT oder HERVORRAGEND. |
|
Unformatierter Abstand (cm)
|
distanceCm | double |
Unformatierter gemessener Abstand in cm. |
|
Rohdruck (Pa)
|
pressurePa | double |
Roher gemessener Druck in Pa. |
|
Unformatierter Winkel (Deg)
|
angleDeg | double |
Roher gemessener Winkel in Grad. |
ComputedStorage
Aus der Speicherkonfiguration berechnete Füllebene; leer, wenn das Gerät keinen Speicher konfiguriert hat.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
currentQuantity
|
currentQuantity | Quantity | |
|
Füllgrad (Prozent)
|
percentage | integer |
Füllstand in Prozent; überprüfung bei, ein Gerät ohne Maß kann "0" melden. |
|
verwendbare Menge
|
usableQuantity | Quantity | |
|
Gesamtmenge
|
totalQuantity | Quantity | |
|
Produktsicherheitsspanne
|
productSafetyMargin | double |
Produktsicherheitsspanne. |
|
100 Prozent Basis
|
displayAs100Percent | string |
Welche Kapazität 100 Prozent beträgt: USABLE_VOLUME oder TOTAL_VOLUME. |
|
Produktname
|
productName | string |
Gespeichertes Produkt. |
|
Das Produkt wird gesammelt
|
isCollectingProduct | boolean |
Gibt an, ob die Lagerung Produkte (z. B. Altöl) sammelt, anstatt es zu verbrauchen. |
Menge
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Wert
|
value | integer |
Menge. |
|
Einheit
|
unit | string |
Einheit: L oder kg. |
LocalDate
Geschätztes Datum, an dem der Speicher ein Erneutes Ausfüllen benötigt.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Prognosejahr
|
year | integer | |
|
Prognosemonat
|
month | integer | |
|
Prognosetag
|
day | integer |
SalesPrediction
Auftragsvorhersage des Vertriebsassistenten.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Order-Wahrscheinlichkeit (roh)
|
indexRaw | double |
Index der Unformatierungsreihenfolge. |
|
Order-Wahrscheinlichkeit
|
index | string |
Bestellwahrscheinlichkeit: VERY_HIGH, HOCH, MITTEL oder NIEDRIG. |
|
Menge
|
quantity | Quantity |
TankCustom
Benutzerdefinierte Tankkonfiguration.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Tankhöhe (cm)
|
heightCm | double | |
|
Sensoroffset (cm)
|
offsetCm | double | |
|
Tankvolumen (L)
|
volumeL | integer | |
|
Verwendbares Volume (L)
|
usableVolumeL | integer | |
|
Volume ist verwendbares Volume
|
isUsableVolume | boolean | |
|
Tank-Shape
|
shape | string |
QUADRATISCH, ABGERUNDET ODER ZYLINDER. |
|
Montagetyp
|
mountingType | string |
KLEBSTOFF oder SCHRAUBEN. |
|
Tankprodukt-ID
|
productId | uuid |
TankPredefined
Vordefinierte (Katalog)-Tankkonfiguration.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Sensoroffset (cm)
|
offsetTopCm | double | |
|
Anzahl der Tanks
|
storageCount | integer | |
|
Montagetyp
|
mountingType | string |
KLEBSTOFF oder SCHRAUBEN. |
|
Tankprodukt-ID
|
productId | uuid | |
|
type
|
type | TankPredefinedType |
TankPredefinedType
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Tanktyp-ID
|
id | uuid | |
|
Tankhersteller
|
manufacturerName | string | |
|
Tanktyp
|
typeName | string | |
|
Höhe des Tanktyps (cm)
|
totalHeightCm | double | |
|
Tanktyp oben versetzt (cm)
|
offsetTopInternalCm | double | |
|
Tanktyp bodenversatz (cm)
|
offsetBottomCm | double | |
|
Gesamtmenge
|
totalQuantity | Quantity |
Silo
Silokonfiguration.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Silohöhe (cm)
|
heightCm | double | |
|
Silobreite (cm)
|
widthCm | double | |
|
Silolänge (cm)
|
lengthCm | double | |
|
Silo oben versetzt (cm)
|
offsetTopCm | double | |
|
Siloseitiger Offset (cm)
|
offsetSideCm | double | |
|
Silospeichertyp
|
storeType | string |
SACK_SILO, BUNKER_CONVEYOR oder BUNKER_PROBE. |
|
Silo-Montage
|
mounting | string |
CEILING_VERTICAL, CEILING_DIAGONAL, PIPE_DIAGONAL oder PIPE_VERTICAL. |
|
Silokapazität (kg)
|
massKg | integer | |
|
Silo-Produkt-ID
|
productId | uuid |