inventory/get_latest_history.php

Zuletzt geändert von YellowFox_RD am 2025/03/04 16:34

Table of Contents

Return the current state and position for a single or multiple items.

Description

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

Parameter

ParameterDescriptionsTypeHintMandatory
companyRTI company keystringyes
importRTI import keystringyes
offsetunsigned intPro Abfrage werden bis zu 1000 Einträge zurück geliefert.  Um weitere Einträge zu erhalten, können Sie ein Offset angeben.no
profiles[]profiles UUID[] stringoptional limitation to a list of given profilesno
objects[]objects UUID[] stringoptional limitaiton to a list of given itemsno
groups[]group UUID[] stringoptional limitiation to a list of given object groupsno
with_beaconBeacon position updatesbool
  • false: only return booked item or state changes
  • true: additionally return all beacon position updates
    • Keep in mind: This may result in large response data.
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

FehlerBeschreibung
ERROR_MAINTENANCEYour company is under maintenance, no RTI request are possible at the moment.
INVALID_COMPANYCompany not found. Company key or import key might be faulty.
INVENTORY_NOT_ACTIVATEDInventory management is not activated for your company.
MISSING_COMPANYCompany key is missing.
MISSING_IMPORTImport key is missing.
INVALID_FORMAT_OFFSETOffset value faulty

JSON

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

Output example

{
    "_date": "2025-02-26T10:17:58+01:00",
    "_links": {
        "next": {
            "href": null
        }
    },
    "events": [
        {
            "uuid": "7a2f9959-7ee1-83ec-8599-59901fcbfd93",
            "description": "TestBeacon",
            "gpsdate": "2025-02-26T11:11:06+01",
            "last_status": {
                "value": "aktiv",
                "description": "Status"
            },
            "vehicle_sign": null,
            "driver_key": null,
            "driver_name": null,
            "lat": 51.036697,
            "lon": 13.599357,
            "satellites": 9,
            "text_position": null,
            "customer_text": "Würth",
            "orderdescr": null,
            "data_source": "position",
            "activities": []
        },
        {
            "uuid": "a5ddb6a3-20ad-a418-5236-bc7e6a229b55",
            "description": "046C8",
            "gpsdate": "2025-02-26T11:11:06+01",
            "last_status": {
                "value": "AAAA",
                "description": "dsfdsfsd"
            },
            "vehicle_sign": null,
            "driver_key": null,
            "driver_name": null,
            "lat": 51.036682,
            "lon": 13.5993805,
            "satellites": 9,
            "text_position": null,
            "customer_text": "Würth",
            "orderdescr": null,
            "data_source": "position",
            "activities": []
        }
    ]
}

Example calls

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