inventory/get_inventories.php

Zuletzt geändert von YellowFox_RD am 2025/03/12 14:38

Inhaltsverzeichnis

Beschreibung
Parameter
Rückgabe
- Mögliche Fehlerwerte
- JSON
Beispielaufrufe

Abrufen aller vorhandenen Objekte aus der Objektverwaltung, inklusive ihrer Profil- und Gruppenzuweisungen, sowie UUIDs als Referenzwerte. UUIDs können beispielsweise benutzt werden um Objekte an Touren über den TourWS anzuhängen.

Beschreibung

GET /inventory/get_inventories.php?company=RTI_COMPANYKEY&import=IMPORTKEY

Parameter

Parameter	Beschreibung	Typ	Hinweis	Pflicht
company	RTI Firmenschlüssel	string		ja
import	RTI Importschlüssel	string		ja
offset		int	Diese Funktion gibt maximal 5000 Ergebnisse zurück. Um weitere Einträge zu erhalten, können Sie ein Offset angeben.	nein
profiles[]	Profiles UUID	[] string		nein
objects[]	Objects UUID	[] string		nein
groups[]	Gruppenname UUID	[] string		nein

Rückgabe

Bei Erfolg erhalten Sie die Rückgabe im JSON Format. Bei fehlenden Pflichtparametern oder Fehlern wird ein "ERROR:Beschreibung" zurückgegeben.

Mögliche Fehlerwerte

Fehler	Beschreibung
MISSING_COMPANY	Firmenschlüssel fehlt
INVALID_COMPANY	Firma nicht gefunden. Dies kann an einem fehlerhaften Firmen- oder Import-Schlüssel liegen.
ERROR_MAINTENANCE	Ihre Firma wird gerade gewartet, währenddessen sind keine RTI Abfragen möglich.
MISSING_IMPORT	Import-Schlüssel fehlt.
INVENTORY_NOT_ACTIVATED	Objektverwaltung ist für ihre Firma nicht aktiviert.
INVALID_FORMAT_OFFSET	Offset ist falsch.

JSON

Die genaue Spezifikation finden Sie anhand einer JSON Schema Datei hier.
Beispiel Ausgabe

{
   "_date": "2025-02-26T10:04:30+01:00",
   "_links": {
       "next": {
           "href": null
       }
   },
   "items": [
       {
           "uuid": "a77d258f-362e-0546-2816-501708d9ebb7",
           "description": "AB 1705-05",
           "nfcTag": "04d41a3af94880",
           "beaconMac": null,
           "profiles": [
               {
                   "name": "Abrollcontainer",
                   "uuid": "a4e4f9d6-0144-4c7d-ca86-37f7b94ac673"
               }
           ],
           "groups": [
               {
                   "name": "Container Sachsen",
                   "uuid": "66ff7431-e455-7d1c-7a20-0ec6c464c80a"
               }
           ],
           "canTours": true
       },
       {
           "uuid": "e34135f8-bd5b-93eb-bb97-897806508c33",
           "description": "AB 1705-01",
           "nfcTag": "17071983",
           "beaconMac": "58C356ECE224",
           "profiles": [
               {
                   "name": "Abrollcontainer",
                   "uuid": "a4e4f9d6-0144-4c7d-ca86-37f7b94ac673"
               }
           ],
           "groups": [
               {
                   "name": "Container NRW",
                   "uuid": "c1f91a2d-e867-f18d-f573-9219d66b8330"
               },
               {
                   "name": "Container Sachsen",
                   "uuid": "66ff7431-e455-7d1c-7a20-0ec6c464c80a"
               }
           ],
           "canTours": true
       }
   ]
}

Beispielaufrufe

https://map.yellowfox.de/rti/inventory/get_inventories.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY
https://map.yellowfox.de/rti/inventory/get_inventories.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&profiles[]=PROFILE_UUID