Wiki-Quellcode von inventory/get_profiles.php

Version 1.1 von Dominic Lippmann am 2025/03/04 16:38
Zeige letzte Bearbeiter
1 (% class="box" %)
2 (((Inhaltsverzeichnis)))
3 {{toc/}}
4
5 Abruf der Objektprofile samt konfigurierter Detailfelder.
6 = Beschreibung =
7 (% class="green mark" %)**GET**(%%)//**/inventory/get_profiles.php?company**=RTI_COMPANYKEY**&import**=IMPORTKEY//
8 = Parameter =
9 |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
10 |company|RTI Firmenschlüssel|string||ja
11 |import|RTI Importschlüssel|string||ja
12 |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
13 |profiles[]|Profiles UUID|[] string|optionale Einschränkung auf eine Liste an Objektprofilen|nein
14 |objects[]|Objects UUID|[] string|optionale Einschränkung auf eine Liste an Objekten|nein
15 |groups[]|Gruppenname UUID|[] string|optionale Einschränkung auf eine Liste an Objektgruppen|nein
16 |with_beacon|Beacon Positionsmeldungen|bool| (((
17 * false: der letzte Status wird nur anhand der gebuchten Aktivitäten zurückgegeben
18 * true: Als Zeitpunkt des letzten Status werden auch Beacon-Positionsmeldungen beachtet.
19 )))|nein
20
21 = Rückgabe =
22 Bei Erfolg erhalten Sie die Rückgabe im JSON Format. Bei fehlenden Pflichtparametern oder Fehlern wird ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben.
23
24 == Mögliche Fehlerwerte ==
25 |=Fehler|=Beschreibung
26 |MISSING_COMPANY|Firmenschlüssel fehlt
27 |INVALID_COMPANY|Firma nicht gefunden. Dies kann an einem fehlerhaften Firmen- oder Import-Schlüssel liegen.
28 |ERROR_MAINTENANCE|Ihre Firma wird gerade gewartet, währenddessen sind keine RTI Abfragen möglich.
29 |MISSING_IMPORT|Import-Schlüssel fehlt.
30 |INVENTORY_NOT_ACTIVATED|Objektverwaltung ist für ihre Firma nicht aktiviert.
31 |INVALID_FORMAT_OFFSET|Offset ist falsch.
32
33 == JSON ==
34 Die genaue Spezifikation finden Sie anhand einer JSON Schema Datei [[hier>>https://map.yellowfox.de/rti/schema/get_profiles_schema.json]].
35
36 **Beispiel Ausgabe**
37
38 {{code language="js"}}{
39     "_date": "2025-02-26T10:26:09+01:00",
40     "_links": {
41         "next": {
42             "href": null
43         }
44     },
45     "profiles": [
46         {
47             "uuid": "37550737-e840-e655-a229-0fbdfa84cfb2",
48             "name": "Standardprofil",
49             "profileGroup": "",
50             "details": [
51                 {
52                     "title": "Status",
53                     "dataType": "enum",
54                     "mandantory": false,
55                     "availableAtDisplay": true,
56                     "valueUnit": "default",
57                     "values": [
58                         "Abgesetzt",
59                         "Aufgenommen"
60                     ]
61                 }
62             ]
63         },
64         {
65             "uuid": "1190caa5-33f5-5019-260f-0cae3d4f5277",
66             "name": "Leasing",
67             "profileGroup": "Finanzen",
68             "details": [
69                 {
70                     "title": "Anzahlung",
71                     "dataType": "float",
72                     "mandantory": true,
73                     "availableAtDisplay": false,
74                     "valueUnit": "EUR",
75                     "values": []
76                 },
77                 {
78                     "title": "Rate",
79                     "dataType": "float",
80                     "mandantory": true,
81                     "availableAtDisplay": false,
82                     "valueUnit": "EUR",
83                     "values": []
84                 },
85                 {
86                     "title": "Abschlußrate",
87                     "dataType": "float",
88                     "mandantory": true,
89                     "availableAtDisplay": false,
90                     "valueUnit": "EUR",
91                     "values": []
92                 },
93                 {
94                     "title": "Vertragsbeginn",
95                     "dataType": "date",
96                     "mandantory": false,
97                     "availableAtDisplay": false,
98                     "valueUnit": null,
99                     "values": []
100                 },
101                 {
102                     "title": "Vertragsende",
103                     "dataType": "date",
104                     "mandantory": false,
105                     "availableAtDisplay": false,
106                     "valueUnit": null,
107                     "values": []
108                 },
109                 {
110                     "title": "Leasinggeber",
111                     "dataType": "text",
112                     "mandantory": false,
113                     "availableAtDisplay": false,
114                     "valueUnit": null,
115                     "values": []
116                 }
117             ]
118         }
119     ]
120 }{{/code}}
121
122 = Beispielaufrufe =
123 {{code language="java"}}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]]{{/code}}
124