Wiki-Quellcode von addresses_get.php

Zuletzt geändert von YellowFox_RD am 2025/01/20 15:36
Zeige letzte Bearbeiter
1 (% class="box" %)
2 (((Inhaltsverzeichnis)))
3 {{toc/}}
4
5 Gibt eine Liste aller gesuchten Adressen zurück.
6 = Beschreibung =
7 **(% class="green mark" %)GET(%%) addresses_get.php**?**company**=COMPANY_RTIKEY&**import**=IMPORT_RTIKEY&**name1**=Test&**city**=Dresden&**searchtype**=like&**searchlogic**=or&**format**=json
8 = Parameter =
9 |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
10 |company|RTI Firmenschlüssel|string||ja
11 |import|RTI Importschlüssel|string||ja
12 |format|Format|string|(((
13 * json (Standard)
14 * csv
15 * xml
16 )))|nein
17 |searchtype|Soll exakt oder mit einem like gesucht werden|string|(((
18 * exact (Standard)
19 * like
20 )))|nein
21 |searchlogic|Sollen die Parameter mit "und" oder einem "oder" verknüft werden|string|(((
22 * and (Standard)
23 * or
24 )))|nein
25 |name1|Suchparameter Name 1|string||nein
26 |name2|Suchparameter Name 2|string||nein
27 |street|Suchparameter Straße|string||nein
28 |number|Suchparameter Hausnummer|string||nein
29 |zipcode|Suchparameter Postleitzahl|string||nein
30 |country|Suchparameter Länderkennung|string||nein
31 |comment|Suchparameter Kommentar|string||nein
32 |city|Suchparameter Stadt|string||nein
33 |phone|Suchparameter Telefon|string||nein
34 |email|Suchparameter E-Mail|string||nein
35 |posdesc|Suchparameter Positionsbeschreibung|string||nein
36
37 = Rückgabewerte =
38 Es wird ein **string** zurückgegeben. Im Fehlerfall wird "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben
39 == JSON Format ==
40 === Spalten ===
41 |=Spalte|=Beschreibung|=
42 |name1|Name 1|
43 |name2|Name2|
44 |street|Straße|
45 |number|Hausnummer|
46 |zipcode|Postleitzahl|
47 |city|Stadt|
48 |country|Länderkennzeichen|
49 |map|Kartenansicht aktiv|0 = nein, 1 = ja
50 |comment|Kommentar|
51 |posdesc|Positionsbeschreibungstext|wird in der Karte, Positionsliste angezeigt
52 |lat|Latitude|
53 |lon|Longitude|
54 |phone|Telefon|
55 |email|E-Mail|
56
57 === Beispiel ===
58 **Rückgabe JSON**
59 {{code language="java"}}[{"name1":"ASDF Test-2","name2":"","street":"Hariboweg","number":"7","zipcode":"","city":"Gummib\u00e4renstadt","country":"D","map":"0","comment":"","posdesc":"","lat":null,"lon":null,"phone":"","email":""},{"name1":"IrlandTest","name2":"","street":"Main Street","number":"1","zipcode":"","city":"Dublin","country":"IRL","map":"1","comment":"","posdesc":"IrlandTest","lat":"53.3884","lon":"-6.2983","phone":"","email":""}]{{/code}}
60
61 == CSV Format ==
62 === Metainformationen ===
63 |=Trennzeichen|Semikolon ( ; )
64 |=Textbegrenzer|Doppeltes Hochkomma ( " )
65 |=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed)
66 |=Header|Zeile 1
67 |=Kodierung|UTF-8
68
69 === Spalten ===
70 |=Spalte|=Beschreibung|=
71 |NAME1|Name 1|
72 |NAME2|Name2|
73 |STREET|Straße|
74 |NR|Hausnummer|
75 |ZIP|Postleitzahl|
76 |CITY|Stadt|
77 |COUNTRY|Länderkennzeichen|
78 |MAP|Kartenansicht aktiv|0 = nein, 1 = ja
79 |COMMENT|Kommentar|
80 |DESC|Positionsbeschreibungstext|wird in der Karte, Positionsliste angezeigt
81 |LAT|Latitude|
82 |LON|Longitude|
83 |PHONE|Telefon|
84 |EMAIL|E-Mail|
85
86 === Beispiel ===
87 **Rückgabe CSV**
88 {{code language="java"}}"NAME1";"NAME2";"STREET";"NR";"ZIP";"CITY";"COUNTRY";"MAP";"COMMENT";"DESC";"LAT";"LON";"PHONE";"EMAIL"
89 "ASDF Test-2";"";"Hariboweg";"7";"";"Gummibärenstadt";"D";"0";"";"";"";"";"";""
90 "IrlandTest";"";"Main Street";"1";"";"Dublin";"IRL";"1";"";"IrlandTest";"53.3884";"-6.2983";"";""{{/code}}
91
92 == XML Format ==
93 === Spalten ===
94 |=Spalte|=Beschreibung|=
95 |name1|Name 1|
96 |name2|Name2|
97 |street|Straße|
98 |number|Hausnummer|
99 |zipcode|Postleitzahl|
100 |city|Stadt|
101 |country|Länderkennzeichen|
102 |map|Kartenansicht aktiv|0 = nein, 1 = ja
103 |comment|Kommentar|
104 |posdesc|Positionsbeschreibungstext|wird in der Karte, Positionsliste angezeigt
105 |lat|Latitude|
106 |lon|Longitude|
107 |phone|Telefon|
108 |email|E-Mail|
109
110 === Beispiel ===
111
112 {{code language="xml"}}<?xml version="1.0" encoding="UTF-8"?>
113 <addresses>
114 <address>
115 <name1>ASDF Test-2</name1>
116 <name2 />
117 <street>Hariboweg</street>
118 <number>7</number>
119 <zipcode />
120 <city>Gummibärenstadt</city>
121 <country>D</country>
122 <map>0</map>
123 <comment />
124 <posdesc />
125 <lat />
126 <lon />
127 <phone />
128 <email />
129 </address>
130 <address>
131 <name1>IrlandTest</name1>
132 <name2 />
133 <street>Main Street</street>
134 <number>1</number>
135 <zipcode />
136 <city>Dublin</city>
137 <country>IRL</country>
138 <map>1</map>
139 <comment />
140 <posdesc>IrlandTest</posdesc>
141 <lat>53.3884</lat>
142 <lon>-6.2983</lon>
143 <phone />
144 <email />
145 </address>
146 </addresses>{{/code}}
147
148 = Beispiele =
149 **Suche mit 2 verschiedenen Suchkriterien**
150 {{code language="java"}} https://map.yellowfox.de/rti/addresses_get.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&city=Dresden&name1=Test&searchtype=like&searchlogic=or&format=csv{{/code}}
151