inventory/get_profiles.php
Zuletzt geändert von YellowFox_RD am 2025/03/12 14:42
Inhaltsverzeichnis
Abruf der Objektprofile samt konfigurierter Detailfelder.
Beschreibung
GET/inventory/get_profiles.php?company=RTI_COMPANYKEY&import=IMPORTKEY
Parameter
| Parameter | Beschreibung | Typ | Hinweis | Pflicht |
|---|---|---|---|---|
| company | RTI Firmenschlüssel | string | ja | |
| import | RTI Importschlüssel | string | ja | |
| offset | int | Pro Abfrage werden bis zu 1000 Einträge zurück geliefert. Um weitere Einträge zu erhalten, können Sie ein Offset angeben. | nein | |
| profiles[] | Profiles UUID | [] string | optionale Einschränkung auf eine Liste an Objektprofilen | nein |
| objects[] | Objects UUID | [] string | optionale Einschränkung auf eine Liste an Objekten | nein |
| groups[] | Gruppenname UUID | [] string | optionale Einschränkung auf eine Liste an Objektgruppen | 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
| Fehler | Beschreibung |
|---|---|
| MISSING_COMPANY | Firmenschlüssel fehlt |
| INVALID_COMPANY | Firma nicht gefunden. Dies kann an einem fehlerhaften Firmen- oder Import-Schlüssel liegen. |
| ERROR_MAINTENANCE | Ihre Firma wird gerade gewartet, währenddessen sind keine RTI Abfragen möglich. |
| MISSING_IMPORT | Import-Schlüssel fehlt. |
| INVENTORY_NOT_ACTIVATED | Objektverwaltung ist für ihre Firma nicht aktiviert. |
| INVALID_FORMAT_OFFSET | Offset ist falsch. |
JSON
Die genaue Spezifikation finden Sie anhand einer JSON Schema Datei hier.
Beispiel Ausgabe
{
"_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": []
}
]
}
]
}
Beispielaufrufe
https://map.yellowfox.de/rti/inventory/get_profiles.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY