Changes for page inventory/get_groups.php

Last modified by YellowFox_RD on 2025/03/04 16:26
From version 2.1
edited by YellowFox_RD
on 2025/03/04 16:26
Change comment: There is no comment for this version
To version 1.1
edited by Dominic Lippmann
on 2025/03/04 16:18
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,23 @@
1 1  (% class="box" %)
2 -(((
3 -Table of Contents
4 -)))
5 -
2 +(((Table of Contents)))
6 6  {{toc/}}
7 7  
8 8  This function return a list of item groups, consisting of group name and uuid. Item groups are used in this context especially to limit the resultset of items.
9 -
10 10  = Description =
11 -
12 -(% class="green mark" %)**GET**(%%)//**/inventory/get_groups.php?company**=RTI_COMPANYKEY**&import**=IMPORTKEY//
13 -
7 +//**GET **////**/inventory/get_groups.php?company**=RTI_COMPANYKEY**&import**=IMPORTKEY//
14 14  = Parameter =
15 -
16 16  |=Parameter|=Description|=Type|=Hint|=Mandatory
17 -|company|RTI company key|string| |yes
18 -|import|RTI import key|string| |yes
19 -|offset| |int|The resultset contains up to 1000 entries per request. If more than 1000 results available, use the offset parameter to get additional results.|no
10 +|company|RTI company key|string||yes
11 +|import|RTI import key|string||yes
12 +|offset||int|The resultset contains up to 1000 entries per request. If more than 1000 results available, use the offset parameter to get additional results.|no
20 20  |profiles[]|Profiles UUID|[] string|optional limitation to items, having one of the given profiles|no
21 21  |objects[]|Objects UUID|[] string|optional limitation to a list of items|no
22 22  |groups[]|proup UUID|[] string|optional limitiation to items, having one of the given object groups|no
23 23  
24 24  = Rückgabe =
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  |=Error|=Description
31 31  |MISSING_COMPANY|Company key is missing.
32 32  |INVALID_COMPANY|Company not found. Company key or import key might be faulty.
... ... @@ -39,8 +39,7 @@
39 39  
40 40  **Output example**
41 41  
42 -{{code language="js"}}
43 -{
33 +{{code language="js"}}{
44 44      "_date": "2025-02-26T10:22:37+01:00",
45 45      "_links": {
46 46          "next": {
... ... @@ -61,11 +61,7 @@
61 61              "name": "Container Bayern"
62 62          }
63 63      ]
64 -}
65 -{{/code}}
54 +}{{/code}}
66 66  
67 67  = Example calls =
68 -
69 -{{code language="java"}}
70 -https://map.yellowfox.de/rti/inventory/get_groups.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY
71 -{{/code}}
57 +{{code language="java"}}https://map.yellowfox.de/rti/inventory/get_groups.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY{{/code}}