Wiki-Quellcode von inventory/get_profiles.php

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