Änderungen von Dokument inventory/get_groups.php

Zusammenfassung

• Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Inhalt

...	...	@@ -1,36 +1,27 @@
1	1	(% class="box" %)
2		-(((
3		-Inhaltsverzeichnis
4		-)))
5		-
	2	+(((Inhaltsverzeichnis)))
6	6	{{toc/}}
7	7
8	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	10	= Beschreibung =
11		-
12		-//(% class="green mark" %)**GET**(%%)**/inventory/get_groups.php?company**=RTI_COMPANYKEY**&import**=IMPORTKEY//
13		-
	7	+//**GET **////**/inventory/get_groups.php?company**=RTI_COMPANYKEY**&import**=IMPORTKEY//
14	14	= Parameter =
15		-
16	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
	10	+|company|RTI Firmenschlüssel|string||ja
	11	+|import|RTI Importschlüssel|string||ja
	12	+|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	20	|profiles[]|Profiles UUID|[] string|optionale Einschränkung auf eine Liste an Objektprofilen|nein
21	21	|objects[]|Objects UUID|[] string|optionale Einschränkung auf eine Liste an Objekten|nein
22	22	|groups[]|Gruppenname UUID|[] string|optionale Einschränkung auf eine Liste an Objektgruppen|nein
23		-|with_beacon|Beacon Positionsmeldungen|bool|(((
	16	+|with_beacon|Beacon Positionsmeldungen|bool| (((
24	24	* false: der letzte Status wird nur anhand der gebuchten Aktivitäten zurückgegeben
25	25	* true: Als Zeitpunkt des letzten Status werden auch Beacon-Positionsmeldungen beachtet.
26	26	)))|nein
27	27
28	28	= Rückgabe =
29		-
30	30	Bei Erfolg erhalten Sie die Rückgabe im JSON Format. Bei fehlenden Pflichtparametern oder Fehlern wird ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben.
31	31
32	32	== Mögliche Fehlerwerte ==
33		-
34	34	|=Fehler|=Beschreibung
35	35	|MISSING_COMPANY|Firmenschlüssel fehlt
36	36	|INVALID_COMPANY|Firma nicht gefunden. Dies kann an einem fehlerhaften Firmen- oder Import-Schlüssel liegen.
...	...	@@ -40,13 +40,11 @@
40	40	|INVALID_FORMAT_OFFSET|Offset ist falsch.
41	41
42	42	== JSON ==
43		-
44	44	Die genaue Spezifikation finden Sie anhand einer JSON Schema Datei [[hier>>https://map.yellowfox.de/rti/schema/get_groups_schema.json]].
45	45
46	46	**Beispiel Ausgabe**
47	47
48		-{{code language="js"}}
49		-{
	38	+{{code language="js"}}{
50	50	"_date": "2025-02-26T10:22:37+01:00",
51	51	"_links": {
52	52	"next": {
...	...	@@ -67,11 +67,7 @@
67	67	"name": "Container Bayern"
68	68	}
69	69	]
70		-}
71		-{{/code}}
	59	+}{{/code}}
72	72
73	73	= Beispielaufrufe =
74		-
75		-{{code language="java"}}
76		-https://map.yellowfox.de/rti/inventory/get_groups.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY
77		-{{/code}}
	62	+{{code language="java"}}https://map.yellowfox.de/rti/inventory/get_groups.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY{{/code}}