Versions Compared

Old Version 5

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
languagede

Abrufen aller vorhandenen Objekte aus der Objektverwaltung, inklusive ihrer Profil- und Gruppenzuweisungen, sowie UUIDs als Referenzwerte. UUIDs können beispielsweise benutzt werden um Objekte an Touren über den TourWS anzuhängen.

Beschreibung

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

Parameter

ParameterBeschreibungTypHinweisPflicht
companyRTI Firmenschlüsselstring
ja
importRTI Importschlüsselstring
ja
offset
intDiese Funktion gibt maximal 5000 Ergebnisse zurück. Um weitere Einträge zu erhalten, können Sie ein Offset angeben.nein

Rückgabe

Bei Erfolg erhalten Sie die Rückgabe im JSON Format. Bei fehlenden Pflichtparametern oder Fehlern wird ein "ERROR:Beschreibung" zurückgegeben.


Mögliche Fehlerwerte

FehlerBeschreibung
MISSING_COMPANYFirmenschlüssel fehlt
INVALID_COMPANYFirma nicht gefunden. Dies kann an einem fehlerhaften Firmen- oder Import-Schlüssel liegen. 
ERROR_MAINTENANCEIhre Firma wird gerade gewartet, währenddessen sind keine RTI Abfragen möglich.
MISSING_IMPORTImport-Schlüssel fehlt.
INVENTORY_NOT_ACTIVATEDObjektverwaltung ist für ihre Firma nicht aktiviert.


JSON

Die genaue Spezifikation finden Sie anhand einer JSON Schema Datei hier.

Beispiel Ausgabe

Code Block
{
	"_date": "2024-12-04T09:07:00+01:00",
    "_links": {
        "next": {
            "href": null
        }
    },
    "items": [    
Wiki Markup
[
    {
        	"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
    	},
    	[...]
	]
}

Beispielaufrufe

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


Sv translation
languageen

Get all existing inventory objects items including their profile and group assignments, as well as their uuids for reference. For example uuids might be used to assign inventory objects to 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 "OK"the result as json. On missing parameters or errors you will receive "ERROR:description".


Possible error values

Error

Description

MISSING_COMPANYcompany Company 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 Import 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": [],
        	"canTours": false
    	},
    	{
        	"uuid": "d70c4da0095511ec9a030242ac130003",
        	"description": "Tag5678",
        	"nfcTag": "0441C0B2915B80",
        	"profiles": [
            	"Abrollcontainer"
        	],
        	"groups": [
            	"Container Sachsen"
        	],
        	"canTours": true
    	},
    	[...]
	]
}

Example calls

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