addresses_get.php

Zuletzt geändert von YellowFox_RD am 2025/01/20 15:36

Inhaltsverzeichnis

Beschreibung
Parameter
Rückgabewerte
Beispiele

Gibt eine Liste aller gesuchten Adressen zurück.

Beschreibung

GET addresses_get.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&name1=Test&city=Dresden&searchtype=like&searchlogic=or&format=json

Parameter

Parameter	Beschreibung	Typ	Hinweis	Pflicht
company	RTI Firmenschlüssel	string		ja
import	RTI Importschlüssel	string		ja
format	Format	string	json (Standard) csv xml	nein
searchtype	Soll exakt oder mit einem like gesucht werden	string	exact (Standard) like	nein
searchlogic	Sollen die Parameter mit "und" oder einem "oder" verknüft werden	string	and (Standard) or	nein
name1	Suchparameter Name 1	string		nein
name2	Suchparameter Name 2	string		nein
street	Suchparameter Straße	string		nein
number	Suchparameter Hausnummer	string		nein
zipcode	Suchparameter Postleitzahl	string		nein
country	Suchparameter Länderkennung	string		nein
comment	Suchparameter Kommentar	string		nein
city	Suchparameter Stadt	string		nein
phone	Suchparameter Telefon	string		nein
email	Suchparameter E-Mail	string		nein
posdesc	Suchparameter Positionsbeschreibung	string		nein

Rückgabewerte

Es wird ein string zurückgegeben. Im Fehlerfall wird "ERROR:Beschreibung" zurückgegeben

JSON Format

Spalten

Spalte	Beschreibung
name1	Name 1
name2	Name2
street	Straße
number	Hausnummer
zipcode	Postleitzahl
city	Stadt
country	Länderkennzeichen
map	Kartenansicht aktiv	0 = nein, 1 = ja
comment	Kommentar
posdesc	Positionsbeschreibungstext	wird in der Karte, Positionsliste angezeigt
lat	Latitude
lon	Longitude
phone	Telefon
email	E-Mail

Beispiel

Rückgabe JSON
[{"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":""}]

CSV Format

Metainformationen

Trennzeichen	Semikolon ( ; )
Textbegrenzer	Doppeltes Hochkomma ( " )
Zeilenende	0x0D 0x0A (CarriageReturn LineFeed)
Header	Zeile 1
Kodierung	UTF-8

Spalten

Spalte	Beschreibung
NAME1	Name 1
NAME2	Name2
STREET	Straße
NR	Hausnummer
ZIP	Postleitzahl
CITY	Stadt
COUNTRY	Länderkennzeichen
MAP	Kartenansicht aktiv	0 = nein, 1 = ja
COMMENT	Kommentar
DESC	Positionsbeschreibungstext	wird in der Karte, Positionsliste angezeigt
LAT	Latitude
LON	Longitude
PHONE	Telefon
EMAIL	E-Mail

Beispiel

Rückgabe CSV
"NAME1";"NAME2";"STREET";"NR";"ZIP";"CITY";"COUNTRY";"MAP";"COMMENT";"DESC";"LAT";"LON";"PHONE";"EMAIL"
"ASDF Test-2";"";"Hariboweg";"7";"";"Gummibärenstadt";"D";"0";"";"";"";"";"";""
"IrlandTest";"";"Main Street";"1";"";"Dublin";"IRL";"1";"";"IrlandTest";"53.3884";"-6.2983";"";""

XML Format

Spalten

Spalte	Beschreibung
name1	Name 1
name2	Name2
street	Straße
number	Hausnummer
zipcode	Postleitzahl
city	Stadt
country	Länderkennzeichen
map	Kartenansicht aktiv	0 = nein, 1 = ja
comment	Kommentar
posdesc	Positionsbeschreibungstext	wird in der Karte, Positionsliste angezeigt
lat	Latitude
lon	Longitude
phone	Telefon
email	E-Mail

Beispiel

<?xml version="1.0" encoding="UTF-8"?>
<addresses>
  <address>
     <name1>ASDF Test-2</name1>
     <name2 />
     <street>Hariboweg</street>
     <number>7</number>
     <zipcode />
     <city>Gummibärenstadt</city>
     <country>D</country>
     <map>0</map>
     <comment />
     <posdesc />
     <lat />
     <lon />
     <phone />
     <email />
  </address>
  <address>
     <name1>IrlandTest</name1>
     <name2 />
     <street>Main Street</street>
     <number>1</number>
     <zipcode />
     <city>Dublin</city>
     <country>IRL</country>
     <map>1</map>
     <comment />
     <posdesc>IrlandTest</posdesc>
     <lat>53.3884</lat>
     <lon>-6.2983</lon>
     <phone />
     <email />
  </address>
</addresses>

Beispiele

Suche mit 2 verschiedenen Suchkriterien
https://map.yellowfox.de/rti/addresses_get.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&city=Dresden&name1=Test&searchtype=like&searchlogic=or&format=csv