inventory/get_profiles.php
Last modified by Dominic Lippmann on 2025/03/04 16:39
Table of Contents
Return the item profiles including assigned detail values.
Description
GET/inventory/get_profiles.php?company=RTI_COMPANYKEY&import=IMPORTKEY
Parameter
| Parameter | Descriptions | Type | Hint | Mandatory |
|---|---|---|---|---|
| company | RTI company key | string | yes | |
| import | RTI import key | string | yes | |
| offset | unsigned int | Pro 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 | [] string | optional limitation to a list of given profiles | no |
| objects[] | objects UUID | [] string | optional limitaiton to a list of given items | no |
| groups[] | group UUID | [] string | optional limitiation to a list of given object groups | no |
| with_beacon | Beacon position updates | bool |
| 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
| Fehler | Beschreibung |
|---|---|
| ERROR_MAINTENANCE | Your company is under maintenance, no RTI request are possible at the moment. |
| INVALID_COMPANY | Company not found. Company key or import key might be faulty. |
| INVENTORY_NOT_ACTIVATED | Inventory management is not activated for your company. |
| MISSING_COMPANY | Company key is missing. |
| MISSING_IMPORT | Import key is missing. |
| INVALID_FORMAT_OFFSET | Offset value faulty |
JSON
You can access the specification as a JSON Schema file here.
Output example
{
"_date": "2025-02-26T10:26:09+01:00",
"_links": {
"next": {
"href": null
}
},
"profiles": [
{
"uuid": "37550737-e840-e655-a229-0fbdfa84cfb2",
"name": "Standardprofil",
"profileGroup": "",
"details": [
{
"title": "Status",
"dataType": "enum",
"mandantory": false,
"availableAtDisplay": true,
"valueUnit": "default",
"values": [
"Abgesetzt",
"Aufgenommen"
]
}
]
},
{
"uuid": "1190caa5-33f5-5019-260f-0cae3d4f5277",
"name": "Leasing",
"profileGroup": "Finanzen",
"details": [
{
"title": "Anzahlung",
"dataType": "float",
"mandantory": true,
"availableAtDisplay": false,
"valueUnit": "EUR",
"values": []
},
{
"title": "Rate",
"dataType": "float",
"mandantory": true,
"availableAtDisplay": false,
"valueUnit": "EUR",
"values": []
},
{
"title": "Abschlußrate",
"dataType": "float",
"mandantory": true,
"availableAtDisplay": false,
"valueUnit": "EUR",
"values": []
},
{
"title": "Vertragsbeginn",
"dataType": "date",
"mandantory": false,
"availableAtDisplay": false,
"valueUnit": null,
"values": []
},
{
"title": "Vertragsende",
"dataType": "date",
"mandantory": false,
"availableAtDisplay": false,
"valueUnit": null,
"values": []
},
{
"title": "Leasinggeber",
"dataType": "text",
"mandantory": false,
"availableAtDisplay": false,
"valueUnit": null,
"values": []
}
]
}
]
}
"_date": "2025-02-26T10:26:09+01:00",
"_links": {
"next": {
"href": null
}
},
"profiles": [
{
"uuid": "37550737-e840-e655-a229-0fbdfa84cfb2",
"name": "Standardprofil",
"profileGroup": "",
"details": [
{
"title": "Status",
"dataType": "enum",
"mandantory": false,
"availableAtDisplay": true,
"valueUnit": "default",
"values": [
"Abgesetzt",
"Aufgenommen"
]
}
]
},
{
"uuid": "1190caa5-33f5-5019-260f-0cae3d4f5277",
"name": "Leasing",
"profileGroup": "Finanzen",
"details": [
{
"title": "Anzahlung",
"dataType": "float",
"mandantory": true,
"availableAtDisplay": false,
"valueUnit": "EUR",
"values": []
},
{
"title": "Rate",
"dataType": "float",
"mandantory": true,
"availableAtDisplay": false,
"valueUnit": "EUR",
"values": []
},
{
"title": "Abschlußrate",
"dataType": "float",
"mandantory": true,
"availableAtDisplay": false,
"valueUnit": "EUR",
"values": []
},
{
"title": "Vertragsbeginn",
"dataType": "date",
"mandantory": false,
"availableAtDisplay": false,
"valueUnit": null,
"values": []
},
{
"title": "Vertragsende",
"dataType": "date",
"mandantory": false,
"availableAtDisplay": false,
"valueUnit": null,
"values": []
},
{
"title": "Leasinggeber",
"dataType": "text",
"mandantory": false,
"availableAtDisplay": false,
"valueUnit": null,
"values": []
}
]
}
]
}
Example calls
https://[[map.yellowfox.de/rti/inventory/get_profiles.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY>>http://map.yellowfox.de/rti/inventory/get_inventories.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY]]