Änderungen von Dokument inventory/get_profiles.php

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

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.YellowFox_RD
1 +XWiki.yf-dominic
Inhalt
... ... @@ -1,32 +1,27 @@
1 1  (% class="box" %)
2 -(((
3 -Inhaltsverzeichnis
4 -)))
5 -
2 +(((Inhaltsverzeichnis)))
6 6  {{toc/}}
7 7  
8 8  Abruf der Objektprofile samt konfigurierter Detailfelder.
9 -
10 10  = Beschreibung =
11 -
12 12  (% class="green mark" %)**GET**(%%)//**/inventory/get_profiles.php?company**=RTI_COMPANYKEY**&import**=IMPORTKEY//
13 -
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
16 +|with_beacon|Beacon Positionsmeldungen|bool| (((
17 +* false: der letzte Status wird nur anhand der gebuchten Aktivitäten zurückgegeben
18 +* true: Als Zeitpunkt des letzten Status werden auch Beacon-Positionsmeldungen beachtet.
19 +)))|nein
23 23  
24 24  = Rückgabe =
25 -
26 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 27  
28 28  == Mögliche Fehlerwerte ==
29 -
30 30  |=Fehler|=Beschreibung
31 31  |MISSING_COMPANY|Firmenschlüssel fehlt
32 32  |INVALID_COMPANY|Firma nicht gefunden. Dies kann an einem fehlerhaften Firmen- oder Import-Schlüssel liegen.
... ... @@ -36,13 +36,11 @@
36 36  |INVALID_FORMAT_OFFSET|Offset ist falsch.
37 37  
38 38  == JSON ==
39 -
40 40  Die genaue Spezifikation finden Sie anhand einer JSON Schema Datei [[hier>>https://map.yellowfox.de/rti/schema/get_profiles_schema.json]].
41 41  
42 42  **Beispiel Ausgabe**
43 43  
44 -{{code language="js"}}
45 -{
38 +{{code language="js"}}{
46 46      "_date": "2025-02-26T10:26:09+01:00",
47 47      "_links": {
48 48          "next": {
... ... @@ -124,10 +124,8 @@
124 124              ]
125 125          }
126 126      ]
127 -}
128 -{{/code}}
120 +}{{/code}}
129 129  
130 130  = Beispielaufrufe =
131 -
132 -{{code language="java"}}https://map.yellowfox.de/rti/inventory/get_profiles.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY{{/code}}
123 +{{code language="java"}}https://[[map.yellowfox.de/rti/inventory/get_profiles.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY>>http://map.yellowfox.de/rti/inventory/get_inventories.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY]]{{/code}}
133 133