Changes for page inventory/get_groups.php

Last modified by YellowFox_RD on 2025/03/04 16:26
From version 1.1
edited by Dominic Lippmann
on 2025/03/04 16:18
Change comment: There is no comment for this version
To version 2.1
edited by YellowFox_RD
on 2025/03/04 16:26
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.yf-dominic
1 +XWiki.YellowFox_RD
Content
... ... @@ -1,23 +1,32 @@
1 1  (% class="box" %)
2 -(((Table of Contents)))
2 +(((
3 +Table of Contents
4 +)))
5 +
3 3  {{toc/}}
4 4  
5 5  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 +
6 6  = Description =
7 -//**GET **////**/inventory/get_groups.php?company**=RTI_COMPANYKEY**&import**=IMPORTKEY//
11 +
12 +(% class="green mark" %)**GET**(%%)//**/inventory/get_groups.php?company**=RTI_COMPANYKEY**&import**=IMPORTKEY//
13 +
8 8  = Parameter =
15 +
9 9  |=Parameter|=Description|=Type|=Hint|=Mandatory
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
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
13 13  |profiles[]|Profiles UUID|[] string|optional limitation to items, having one of the given profiles|no
14 14  |objects[]|Objects UUID|[] string|optional limitation to a list of items|no
15 15  |groups[]|proup UUID|[] string|optional limitiation to items, having one of the given object groups|no
16 16  
17 17  = Rückgabe =
25 +
18 18  On success you will receive the result as json. On missing parameters or errors you will receive "(% class="error" %)**ERROR:description**(%%)".
19 19  
20 20  == Possible error values ==
29 +
21 21  |=Error|=Description
22 22  |MISSING_COMPANY|Company key is missing.
23 23  |INVALID_COMPANY|Company not found. Company key or import key might be faulty.
... ... @@ -30,7 +30,8 @@
30 30  
31 31  **Output example**
32 32  
33 -{{code language="js"}}{
42 +{{code language="js"}}
43 +{
34 34      "_date": "2025-02-26T10:22:37+01:00",
35 35      "_links": {
36 36          "next": {
... ... @@ -51,7 +51,11 @@
51 51              "name": "Container Bayern"
52 52          }
53 53      ]
54 -}{{/code}}
64 +}
65 +{{/code}}
55 55  
56 56  = Example calls =
57 -{{code language="java"}}https://map.yellowfox.de/rti/inventory/get_groups.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY{{/code}}
68 +
69 +{{code language="java"}}
70 +https://map.yellowfox.de/rti/inventory/get_groups.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY
71 +{{/code}}