Wiki source code of inventory/get_groups.php
Last modified by YellowFox_RD on 2025/03/04 16:26
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
1.1 | 1 | (% class="box" %) |
| |
2.1 | 2 | ((( |
| |
4.1 | 3 | Table of Contents |
| |
2.1 | 4 | ))) |
| 5 | |||
| |
1.1 | 6 | {{toc/}} |
| 7 | |||
| |
4.1 | 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. |
| |
2.1 | 9 | |
| |
4.1 | 10 | = Description = |
| |
2.1 | 11 | |
| |
3.1 | 12 | (% class="green mark" %)**GET**(%%)//**/inventory/get_groups.php?company**=RTI_COMPANYKEY**&import**=IMPORTKEY// |
| |
2.1 | 13 | |
| |
1.1 | 14 | = Parameter = |
| |
2.1 | 15 | |
| |
4.1 | 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 | ||
| 20 | |profiles[]|Profiles UUID|[] string|optional limitation to items, having one of the given profiles|no | ||
| 21 | |objects[]|Objects UUID|[] string|optional limitation to a list of items|no | ||
| 22 | |groups[]|proup UUID|[] string|optional limitiation to items, having one of the given object groups|no | ||
| |
1.1 | 23 | |
| 24 | = Rückgabe = | ||
| |
2.1 | 25 | |
| |
4.1 | 26 | On success you will receive the result as json. On missing parameters or errors you will receive "(% class="error" %)**ERROR:description**(%%)". |
| |
1.1 | 27 | |
| |
4.1 | 28 | == Possible error values == |
| |
2.1 | 29 | |
| |
4.1 | 30 | |=Error|=Description |
| 31 | |MISSING_COMPANY|Company key is missing. | ||
| 32 | |INVALID_COMPANY|Company not found. Company key or import key might be faulty. | ||
| 33 | |ERROR_MAINTENANCE|Your company is under maintenance, no RTI request are possible at the moment. | ||
| 34 | |MISSING_IMPORT|Import key is missing. | ||
| 35 | |INVENTORY_NOT_ACTIVATED|Inventory management is not activated for your company. | ||
| 36 | |INVALID_FORMAT_OFFSET|Faults offset value. | ||
| |
1.1 | 37 | |
| |
4.1 | 38 | You can access the specification as a JSON Schema file [[here>>https://map.yellowfox.de/rti/schema/get_groups_schema.json]]. |
| |
2.1 | 39 | |
| |
4.1 | 40 | **Output example** |
| |
1.1 | 41 | |
| |
2.1 | 42 | {{code language="js"}} |
| 43 | { | ||
| |
1.1 | 44 | "_date": "2025-02-26T10:22:37+01:00", |
| 45 | "_links": { | ||
| 46 | "next": { | ||
| 47 | "href": null | ||
| 48 | } | ||
| 49 | }, | ||
| 50 | "groups": [ | ||
| 51 | { | ||
| 52 | "uuid": "66ff7431-e455-7d1c-7a20-0ec6c464c80a", | ||
| 53 | "name": "Container Sachsen" | ||
| 54 | }, | ||
| 55 | { | ||
| 56 | "uuid": "c1f91a2d-e867-f18d-f573-9219d66b8330", | ||
| 57 | "name": "Container NRW" | ||
| 58 | }, | ||
| 59 | { | ||
| 60 | "uuid": "7d69b118-2174-df57-9ab2-574c251f5c8d", | ||
| 61 | "name": "Container Bayern" | ||
| 62 | } | ||
| 63 | ] | ||
| |
2.1 | 64 | } |
| 65 | {{/code}} | ||
| |
1.1 | 66 | |
| |
4.1 | 67 | = Example calls = |
| |
2.1 | 68 | |
| 69 | {{code language="java"}} | ||
| 70 | https://map.yellowfox.de/rti/inventory/get_groups.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY | ||
| 71 | {{/code}} |