Sv translation

language	de

Gibt eine Liste aller gesuchten Adressen zurück.

Beschreibung

Status

colour	Green
title	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

Code Block

title	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

Code Block

title	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

Code Block

language	xml

<?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

Code Block

title	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

Sv translation

language	en

addresses_get.php [Original Seitentitel]

Returns a list of all addresses searched for.

Description

Status

colour	Green
title	GET

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

Parameter

Parameter	Description	Typ	Note	Mandatory
company	RTI company key	string		yes
import	RTI Importschlüssel	string		yes
format	format	string	json (standard) csv xml	no
searchtype	should be searched with "exact" or "like"	string	exact (standard) like	no
searchlogic	if the parameters are to be linked with "and" or an "or"	string	and (standard) or	no
name1	search parameter name 1	string		no
name2	search parameter name 2	string		no
street	search parameter street	string		no
number	search parameter streetnumber	string		no
zipcode	search parameter zipcode	string		no
country	search parameter country-code	string		no
comment	search parameter comment	string		no
city	search parameter city	string		no
phone	search parameter phone	string		no
email	search parameter e-mail	string		no
posdesc	search parameter position description	string		no

Retrurn

A string gets returned. In case of error, "ERROR:Beschreibung" zurückgegeben

JSON format

Column

column	description
name1	name 1
name2	name 2
street	streetname
number	streetnumber
zipcode	zipcode
city	cityname
country	country-code
map	map active?	0 = no, 1 = yes
comment	comment
posdesc	position description text	will be displayed on map, position list
lat	latitude
lon	longitude
phone	phone
email	e-mail

Example

Code Block

title	return in 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

Separator	Semikolon ( ; )
Textlimit	Doppeltes Hochkomma ( " )
End of line	0x0D 0x0A (CarriageReturn LineFeed)
Header	Zeile 1
Encoding	UTF-8

Column

Column	Description
name1	name 1
name2	name 2
street	streetname
number	streetnumber
zipcode	zipcode
city	cityname
country	country-code
map	map active?	0 = no, 1 = yes
comment	comment
posdesc	position description text	will be displayed on map, position list
lat	latitude
lon	longitude
phone	phone
email	e-mail

Example

Code Block

title	return in 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

Column

Column	Description
name1	name 1
name2	name 2
street	streetname
number	streetnumber
zipcode	zipcode
city	cityname
country	country-code
map	map active?	0 = no, 1 = yes
comment	comment
posdesc	position description text	will be displayed on map, position list
lat	latitude
lon	longitude
phone	phone
email	e-mail

Example

Code Block

language	xml

<?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>

Example call

Code Block

title	search with 2 different search criteria

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

Page tree

Versions Compared

Old Version 5

New Version Current

Key

Beschreibung

Parameter

Rückgabewerte

JSON Format

Spalten

Beispiel

CSV Format

Metainformationen

Spalten

Beispiel

XML Format

Spalten

Beispiel

Beispiele

addresses_get.php [Original Seitentitel]

Description

Parameter

Retrurn

JSON format

Column

Example

CSV Format

Metainformationen

Column

Example

XML format

Column

Example

Example call

Page tree

Page History

Versions Compared

Old Version 5

New Version Current

Key

Beschreibung

Parameter

Rückgabewerte

JSON Format

Spalten

Beispiel

CSV Format

Metainformationen

Spalten

Beispiel

XML Format

Spalten

Beispiel

Beispiele

addresses_get.php [Original Seitentitel]

Description

Parameter

Retrurn

JSON format

Column

Example

CSV Format

Metainformationen

Column

Example

XML format

Column

Example

Example call