Zuletzt geändert von YellowFox_RD am 2025/03/12 14:38
Zeige letzte Bearbeiter
1 (% class="box" %)
2 (((
3 Inhaltsverzeichnis
4 )))
5
6 {{toc/}}
7
8 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
10 = Beschreibung =
11
12 (% class="green mark" %)**GET**(%%)//**  /inventory/get_inventories.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|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
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_inventories_schema.json]].
41 **Beispiel Ausgabe**
42
43 {{code language="java"}}
44 {
45 "_date": "2025-02-26T10:04:30+01:00",
46 "_links": {
47 "next": {
48 "href": null
49 }
50 },
51 "items": [
52 {
53 "uuid": "a77d258f-362e-0546-2816-501708d9ebb7",
54 "description": "AB 1705-05",
55 "nfcTag": "04d41a3af94880",
56 "beaconMac": null,
57 "profiles": [
58 {
59 "name": "Abrollcontainer",
60 "uuid": "a4e4f9d6-0144-4c7d-ca86-37f7b94ac673"
61 }
62 ],
63 "groups": [
64 {
65 "name": "Container Sachsen",
66 "uuid": "66ff7431-e455-7d1c-7a20-0ec6c464c80a"
67 }
68 ],
69 "canTours": true
70 },
71 {
72 "uuid": "e34135f8-bd5b-93eb-bb97-897806508c33",
73 "description": "AB 1705-01",
74 "nfcTag": "17071983",
75 "beaconMac": "58C356ECE224",
76 "profiles": [
77 {
78 "name": "Abrollcontainer",
79 "uuid": "a4e4f9d6-0144-4c7d-ca86-37f7b94ac673"
80 }
81 ],
82 "groups": [
83 {
84 "name": "Container NRW",
85 "uuid": "c1f91a2d-e867-f18d-f573-9219d66b8330"
86 },
87 {
88 "name": "Container Sachsen",
89 "uuid": "66ff7431-e455-7d1c-7a20-0ec6c464c80a"
90 }
91 ],
92 "canTours": true
93 }
94 ]
95 }
96 {{/code}}
97
98 = Beispielaufrufe =
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}}