Änderungen von Dokument inventory/get_profiles.php

Zuletzt geändert von YellowFox_RD am 2025/03/13 09:20
Von Version 1.1
bearbeitet von Dominic Lippmann
am 2025/03/04 16:38
Änderungskommentar: Es gibt keinen Kommentar für diese Version
Auf Version 2.1
bearbeitet von YellowFox_RD
am 2025/03/12 14:42
Ä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,27 +1,32 @@
1 1  (% class="box" %)
2 -(((Inhaltsverzeichnis)))
2 +(((
3 +Inhaltsverzeichnis
4 +)))
5 +
3 3  {{toc/}}
4 4  
5 5  Abruf der Objektprofile samt konfigurierter Detailfelder.
9 +
6 6  = Beschreibung =
11 +
7 7  (% class="green mark" %)**GET**(%%)//**/inventory/get_profiles.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|Pro Abfrage werden bis zu 1000 Einträge zurück geliefert.  Um weitere Einträge zu erhalten, können Sie ein Offset angeben.|nein
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
13 13  |profiles[]|Profiles UUID|[] string|optionale Einschränkung auf eine Liste an Objektprofilen|nein
14 14  |objects[]|Objects UUID|[] string|optionale Einschränkung auf eine Liste an Objekten|nein
15 15  |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
20 20  
21 21  = Rückgabe =
25 +
22 22  Bei Erfolg erhalten Sie die Rückgabe im JSON Format. Bei fehlenden Pflichtparametern oder Fehlern wird ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben.
23 23  
24 24  == Mögliche Fehlerwerte ==
29 +
25 25  |=Fehler|=Beschreibung
26 26  |MISSING_COMPANY|Firmenschlüssel fehlt
27 27  |INVALID_COMPANY|Firma nicht gefunden. Dies kann an einem fehlerhaften Firmen- oder Import-Schlüssel liegen.
... ... @@ -31,11 +31,13 @@
31 31  |INVALID_FORMAT_OFFSET|Offset ist falsch.
32 32  
33 33  == JSON ==
39 +
34 34  Die genaue Spezifikation finden Sie anhand einer JSON Schema Datei [[hier>>https://map.yellowfox.de/rti/schema/get_profiles_schema.json]].
35 35  
36 36  **Beispiel Ausgabe**
37 37  
38 -{{code language="js"}}{
44 +{{code language="js"}}
45 +{
39 39      "_date": "2025-02-26T10:26:09+01:00",
40 40      "_links": {
41 41          "next": {
... ... @@ -117,8 +117,10 @@
117 117              ]
118 118          }
119 119      ]
120 -}{{/code}}
127 +}
128 +{{/code}}
121 121  
122 122  = Beispielaufrufe =
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}}
131 +
132 +{{code language="java"}}https://map.yellowfox.de/rti/inventory/get_profiles.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY{{/code}}
124 124