Wiki-Quellcode von inventory/get_groups.php
Zuletzt geändert von YellowFox_RD am 2025/03/12 14:35
Zeige letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
| 1 | (% class="box" %) | ||
| 2 | ((( | ||
| 3 | Inhaltsverzeichnis | ||
| 4 | ))) | ||
| 5 | |||
| 6 | {{toc/}} | ||
| 7 | |||
| 8 | Diese Funktion liefert die Liste an Objektgruppen zurück. Jede Gruppe besteht aus einem Namen und einer UUID. Die Objektgruppen können vor allem in Verbindung mit den anderen objektspezifischen Funktionen verwendet werden, um die Ergebnismenge einzugrenzen. | ||
| 9 | |||
| 10 | = Beschreibung = | ||
| 11 | |||
| 12 | (% class="green mark" %)**GET**(%%)//**/inventory/get_groups.php?company**=RTI_COMPANYKEY**&import**=IMPORTKEY// | ||
| 13 | |||
| 14 | = Parameter = | ||
| 15 | |||
| 16 | |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht | ||
| 17 | |company|RTI Firmenschlüssel|string| |ja | ||
| 18 | |import|RTI Importschlüssel|string| |ja | ||
| 19 | |offset| |int|Pro Abfrage werden bis zu 1000 Einträge zurück geliefert. Um weitere Einträge zu erhalten, können Sie ein Offset angeben.|nein | ||
| 20 | |profiles[]|Profiles UUID|[] string|optionale Einschränkung auf eine Liste an Objektprofilen|nein | ||
| 21 | |objects[]|Objects UUID|[] string|optionale Einschränkung auf eine Liste an Objekten|nein | ||
| 22 | |groups[]|Gruppenname UUID|[] string|optionale Einschränkung auf eine Liste an Objektgruppen|nein | ||
| 23 | |||
| 24 | = Rückgabe = | ||
| 25 | |||
| 26 | Bei Erfolg erhalten Sie die Rückgabe im JSON Format. Bei fehlenden Pflichtparametern oder Fehlern wird ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben. | ||
| 27 | |||
| 28 | == Mögliche Fehlerwerte == | ||
| 29 | |||
| 30 | |=Fehler|=Beschreibung | ||
| 31 | |MISSING_COMPANY|Firmenschlüssel fehlt | ||
| 32 | |INVALID_COMPANY|Firma nicht gefunden. Dies kann an einem fehlerhaften Firmen- oder Import-Schlüssel liegen. | ||
| 33 | |ERROR_MAINTENANCE|Ihre Firma wird gerade gewartet, währenddessen sind keine RTI Abfragen möglich. | ||
| 34 | |MISSING_IMPORT|Import-Schlüssel fehlt. | ||
| 35 | |INVENTORY_NOT_ACTIVATED|Objektverwaltung ist für ihre Firma nicht aktiviert. | ||
| 36 | |INVALID_FORMAT_OFFSET|Offset ist falsch. | ||
| 37 | |||
| 38 | == JSON == | ||
| 39 | |||
| 40 | Die genaue Spezifikation finden Sie anhand einer JSON Schema Datei [[hier>>https://map.yellowfox.de/rti/schema/get_groups_schema.json]]. | ||
| 41 | |||
| 42 | **Beispiel Ausgabe** | ||
| 43 | |||
| 44 | {{code language="js"}} | ||
| 45 | { | ||
| 46 | "_date": "2025-02-26T10:22:37+01:00", | ||
| 47 | "_links": { | ||
| 48 | "next": { | ||
| 49 | "href": null | ||
| 50 | } | ||
| 51 | }, | ||
| 52 | "groups": [ | ||
| 53 | { | ||
| 54 | "uuid": "66ff7431-e455-7d1c-7a20-0ec6c464c80a", | ||
| 55 | "name": "Container Sachsen" | ||
| 56 | }, | ||
| 57 | { | ||
| 58 | "uuid": "c1f91a2d-e867-f18d-f573-9219d66b8330", | ||
| 59 | "name": "Container NRW" | ||
| 60 | }, | ||
| 61 | { | ||
| 62 | "uuid": "7d69b118-2174-df57-9ab2-574c251f5c8d", | ||
| 63 | "name": "Container Bayern" | ||
| 64 | } | ||
| 65 | ] | ||
| 66 | } | ||
| 67 | {{/code}} | ||
| 68 | |||
| 69 | = Beispielaufrufe = | ||
| 70 | |||
| 71 | {{code language="java"}} | ||
| 72 | https://map.yellowfox.de/rti/inventory/get_groups.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY | ||
| 73 | {{/code}} |