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

Summary

Details

Page properties
Content
... ... @@ -1,20 +1,26 @@
1 1  (% class="box" %)
2 -(((Table of Contents)))
2 +(((
3 +Table of Contents
4 +)))
5 +
3 3  {{toc/}}
4 4  
5 5  Return the item profiles including assigned detail values.
9 +
6 6  = Description =
11 +
7 7  (% class="green mark" %)**GET**(%%)//**/inventory/get_profiles.php?company**=RTI_COMPANYKEY**&import**=IMPORTKEY//
8 8  
9 9  = Parameter =
15 +
10 10  |=Parameter|=Descriptions|=Type|=Hint|=Mandatory
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
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
14 14  |profiles[]|profiles UUID|[] string|optional limitation to a list of given profiles|no
15 15  |objects[]|objects UUID|[] string|optional limitaiton to a list of given items|no
16 16  |groups[]|group UUID|[] string|optional limitiation to a list of given object groups|no
17 -|with_beacon|Beacon position updates|bool| (((
23 +|with_beacon|Beacon position updates|bool|(((
18 18  * false: only return booked item or state changes
19 19  * true: additionally return all beacon position updates(((
20 20  * Keep in mind: This may result in large response data.
... ... @@ -21,11 +21,12 @@
21 21  )))
22 22  )))|no
23 23  
24 -= =
25 25  = Return value =
31 +
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 ==
35 +
29 29  |=Fehler|=Beschreibung
30 30  |ERROR_MAINTENANCE|Your company is under maintenance, no RTI request are possible at the moment.
31 31  |INVALID_COMPANY|Company not found. Company key or import key might be faulty.
... ... @@ -35,11 +35,13 @@
35 35  |INVALID_FORMAT_OFFSET|Offset value faulty
36 36  
37 37  = JSON =
45 +
38 38  You can access the specification as a JSON Schema file [[here>>https://map.yellowfox.de/rti/schema/get_profiles_schema.json]].
39 39  
40 40  **Output example**
41 41  
42 -{{code language="js"}}{
50 +{{code language="js"}}
51 +{
43 43      "_date": "2025-02-26T10:26:09+01:00",
44 44      "_links": {
45 45          "next": {
... ... @@ -121,8 +121,11 @@
121 121              ]
122 122          }
123 123      ]
124 -}{{/code}}
133 +}
134 +{{/code}}
125 125  
126 126  = 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}}
128 128  
138 +{{code language="java"}}
139 +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]]
140 +{{/code}}