Versions Compared

Old Version 10

changes.mady.by.user YellowFox R&D

Saved on

compared with

New Version Current

changes.mady.by.user YellowFox R&D

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Sv translation
languageen

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

ParameterDescriptionTypeHintMandatory
companyRTI company keystring
yes
importRTI import keystring
yes
offset
intThis function returns 5000 results at max. To get further entries, you can add an offset.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_COMPANYCompany key is missing.
INVALID_COMPANYCompany not found. Company key or import key might be faulty.
ERROR_MAINTENANCEYour company is under maintenance, no RTI request are possible at the moment.
MISSING_IMPORTImport key is missing.
INVENTORY_NOT_ACTIVATEDInventory management is not activated for your company.


JSON

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

Example 

Code Block
[
    {
	"_date": "2024-12-04T09:07:00+01:00",
    "_links": {
        "next": {
            "href": null
        }
    },
    "items": [     
		{
        	"uuid": "d0482b24095511ec9a030242ac130003",
        	"description": "Object1",
        	"nfcTag": "Tag1234",
        	"profiles": [
            	"Messger\u00e4te"
        	],
        	"groups": [],
        	"attachablecanTours": false
    	},
    	{
        	"uuid": "d70c4da0095511ec9a030242ac130003",
        	"description": "Tag5678",
        	"nfcTag": "0441C0B2915B80",
        	"profiles": [
            	"Abrollcontainer"
        	],
        	"groups": [
            	"Container Sachsen"
        	],
        	"attachablecanTours": true
    	},
    	[...]
	]
}

Example calls

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