inventory/get_inventories.php

Last modified by YellowFox_RD on 2025/03/12 14:37

Table of Contents

Description
Parameter
Return value
- Possible error values
- JSON

Get all existing inventory items including their profile and group assignments, as well as their uuids for reference. For example uuids might be used to assign inventory itemsto tours created via TourWS.

Description

GET /inventory/get_inventories.php?company=RTI_COMPANYKEY&import=IMPORTKEY

Parameter

Parameter	Description	Type	Hint	Mandatory
company	RTI company key	string		yes
import	RTI import key	string		yes
offset		int	This function returns 5000 results at max. To get further entries, you can add an offset.	no
profiles[]	profiles UUID	[] string		no
objects	objects UUID	[] string		no
groups	groups UUID	[] string		no

Return value

On success you will receive the result as json. On missing parameters or errors you will receive "ERROR:description".

Possible error values

Error	Description
MISSING_COMPANY	Company key is missing.
INVALID_COMPANY	Company not found. Company key or import key might be faulty.
ERROR_MAINTENANCE	Your company is under maintenance, no RTI request are possible at the moment.
MISSING_IMPORT	Import key is missing.
INVENTORY_NOT_ACTIVATED	Inventory management is not activated for your company.
INVALID_FORMAT_OFFSET	Offset value faulty.

JSON

You can access the specification as a JSON Schema file here.
Example

{
   "_date": "2025-02-26T10:04:30+01:00",
   "_links": {
       "next": {
           "href": null
       }
   },
   "items": [
       {
           "uuid": "a77d258f-362e-0546-2816-501708d9ebb7",
           "description": "AB 1705-05",
           "nfcTag": "04d41a3af94880",
           "beaconMac": null,
           "profiles": [
               {
                   "name": "Abrollcontainer",
                   "uuid": "a4e4f9d6-0144-4c7d-ca86-37f7b94ac673"
               }
           ],
           "groups": [
               {
                   "name": "Container Sachsen",
                   "uuid": "66ff7431-e455-7d1c-7a20-0ec6c464c80a"
               }
           ],
           "canTours": true
       },
       {
           "uuid": "e34135f8-bd5b-93eb-bb97-897806508c33",
           "description": "AB 1705-01",
           "nfcTag": "17071983",
           "beaconMac": "58C356ECE224",
           "profiles": [
               {
                   "name": "Abrollcontainer",
                   "uuid": "a4e4f9d6-0144-4c7d-ca86-37f7b94ac673"
               }
           ],
           "groups": [
               {
                   "name": "Container NRW",
                   "uuid": "c1f91a2d-e867-f18d-f573-9219d66b8330"
               },
               {
                   "name": "Container Sachsen",
                   "uuid": "66ff7431-e455-7d1c-7a20-0ec6c464c80a"
               }
           ],
           "canTours": true
       }
   ]
}

https://map.yellowfox.de/rti/inventory/get_inventories.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY
https://map.yellowfox.de/rti/inventory/get_inventories.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&profiles[]=PROFILE_UUID