Last modified by YellowFox_RD on 2025/03/12 14:43
From version 3.1
edited by YellowFox_RD
on 2025/03/12 14:43
Change comment: There is no comment for this version
To version 1.1
edited by Dominic Lippmann
on 2025/03/04 16:39
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.YellowFox_RD
1 +XWiki.yf-dominic
Content
... ... @@ -1,32 +1,31 @@
1 1  (% class="box" %)
2 -(((
3 -Table of Contents
4 -)))
5 -
2 +(((Table of Contents)))
6 6  {{toc/}}
7 7  
8 8  Return the item profiles including assigned detail values.
9 -
10 10  = Description =
11 -
12 12  (% class="green mark" %)**GET**(%%)//**/inventory/get_profiles.php?company**=RTI_COMPANYKEY**&import**=IMPORTKEY//
13 13  
14 14  = Parameter =
15 -
16 16  |=Parameter|=Descriptions|=Type|=Hint|=Mandatory
17 -|company|RTI company key|string| |yes
18 -|import|RTI import key|string| |yes
19 -|offset| |unsigned int|Pro Abfrage werden bis zu 1000 Einträge zurück geliefert. Um weitere Einträge zu erhalten, können Sie ein Offset angeben.|no
11 +|company|RTI company key|string||yes
12 +|import|RTI import key|string||yes
13 +|offset||unsigned int|Pro Abfrage werden bis zu 1000 Einträge zurück geliefert.  Um weitere Einträge zu erhalten, können Sie ein Offset angeben.|no
20 20  |profiles[]|profiles UUID|[] string|optional limitation to a list of given profiles|no
21 21  |objects[]|objects UUID|[] string|optional limitaiton to a list of given items|no
22 22  |groups[]|group UUID|[] string|optional limitiation to a list of given object groups|no
17 +|with_beacon|Beacon position updates|bool| (((
18 +* false: only return booked item or state changes
19 +* true: additionally return all beacon position updates(((
20 +* Keep in mind: This may result in large response data.
21 +)))
22 +)))|no
23 23  
24 += =
24 24  = Return value =
25 -
26 26  On success you will receive the result as json. On missing parameters or errors you will receive "(% class="error" %)**ERROR:description**(%%)".
27 27  
28 28  == Possible error values ==
29 -
30 30  |=Fehler|=Beschreibung
31 31  |ERROR_MAINTENANCE|Your company is under maintenance, no RTI request are possible at the moment.
32 32  |INVALID_COMPANY|Company not found. Company key or import key might be faulty.
... ... @@ -36,13 +36,11 @@
36 36  |INVALID_FORMAT_OFFSET|Offset value faulty
37 37  
38 38  = JSON =
39 -
40 40  You can access the specification as a JSON Schema file [[here>>https://map.yellowfox.de/rti/schema/get_profiles_schema.json]].
41 41  
42 42  **Output example**
43 43  
44 -{{code language="js"}}
45 -{
42 +{{code language="js"}}{
46 46      "_date": "2025-02-26T10:26:09+01:00",
47 47      "_links": {
48 48          "next": {
... ... @@ -124,11 +124,8 @@
124 124              ]
125 125          }
126 126      ]
127 -}
128 -{{/code}}
124 +}{{/code}}
129 129  
130 130  = Example calls =
127 +{{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 131  
132 -{{code language="java"}}
133 -https://map.yellowfox.de/rti/inventory/get_profiles.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY
134 -{{/code}}