Änderungen von Dokument inventory/get_inventories.php

Zuletzt geändert von YellowFox_RD am 2025/03/12 14:38
Von Version 1.1
bearbeitet von Dominic Lippmann
am 2025/03/04 16:28
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 2.1
bearbeitet von YellowFox_RD
am 2025/03/12 14:38
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.yf-dominic
1 +XWiki.YellowFox_RD
Inhalt
... ... @@ -1,23 +1,32 @@
1 1  (% class="box" %)
2 -(((Inhaltsverzeichnis)))
2 +(((
3 +Inhaltsverzeichnis
4 +)))
5 +
3 3  {{toc/}}
4 4  
5 5  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.
9 +
6 6  = Beschreibung =
7 -**(% class="green mark" %)GET(%%)**//**  /inventory/get_inventories.php?company**=RTI_COMPANYKEY**&import**=IMPORTKEY//
11 +
12 +(% class="green mark" %)**GET**(%%)//**  /inventory/get_inventories.php?company**=RTI_COMPANYKEY**&import**=IMPORTKEY//
13 +
8 8  = Parameter =
15 +
9 9  |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
10 -|company|RTI Firmenschlüssel|string||ja
11 -|import|RTI Importschlüssel|string||ja
12 -|offset||int|Diese Funktion gibt maximal 5000 Ergebnisse zurück. Um weitere Einträge zu erhalten, können Sie ein Offset angeben.|nein
13 -|profiles[]|Profiles UUID|[] string||nein
14 -|objects[]|Objects UUID|[] string||nein
15 -|groups[]|Gruppenname UUID|[] string||nein
17 +|company|RTI Firmenschlüssel|string| |ja
18 +|import|RTI Importschlüssel|string| |ja
19 +|offset| |int|Diese Funktion gibt maximal 5000 Ergebnisse zurück. Um weitere Einträge zu erhalten, können Sie ein Offset angeben.|nein
20 +|profiles[]|Profiles UUID|[] string| |nein
21 +|objects[]|Objects UUID|[] string| |nein
22 +|groups[]|Gruppenname UUID|[] string| |nein
16 16  
17 17  = Rückgabe =
25 +
18 18  Bei Erfolg erhalten Sie die Rückgabe im JSON Format. Bei fehlenden Pflichtparametern oder Fehlern wird ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben.
19 19  
20 20  == Mögliche Fehlerwerte ==
29 +
21 21  |=Fehler|=Beschreibung
22 22  |MISSING_COMPANY|Firmenschlüssel fehlt
23 23  |INVALID_COMPANY|Firma nicht gefunden. Dies kann an einem fehlerhaften Firmen- oder Import-Schlüssel liegen.
... ... @@ -27,10 +27,12 @@
27 27  |INVALID_FORMAT_OFFSET|Offset ist falsch.
28 28  
29 29  == JSON ==
39 +
30 30  Die genaue Spezifikation finden Sie anhand einer JSON Schema Datei [[hier>>https://map.yellowfox.de/rti/schema/get_inventories_schema.json]].
31 31  **Beispiel Ausgabe**
32 32  
33 -{{code language="java"}}{
43 +{{code language="java"}}
44 +{
34 34   "_date": "2025-02-26T10:04:30+01:00",
35 35   "_links": {
36 36   "next": {
... ... @@ -81,8 +81,12 @@
81 81   "canTours": true
82 82   }
83 83   ]
84 -}{{/code}}
95 +}
96 +{{/code}}
85 85  
86 86  = Beispielaufrufe =
87 -{{code language="java"}}https://map.yellowfox.de/rti/inventory/get_inventories.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY
88 -https://map.yellowfox.de/rti/inventory/get_inventories.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&profiles[]=PROFILE_ID{{/code}}
99 +
100 +{{code language="java"}}
101 +https://map.yellowfox.de/rti/inventory/get_inventories.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY
102 +https://map.yellowfox.de/rti/inventory/get_inventories.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&profiles[]=PROFILE_UUID
103 +{{/code}}