Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languagede

Gibt eine Liste aller gesuchten Adressen zurück.

Beschreibung

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

Parameter

ParameterBeschreibungTypHinweisPflicht
companyRTI Firmenschlüsselstring
ja
importRTI Importschlüsselstring
ja
formatFormatstring
  • json (Standard)
  • csv
  • xml
nein
searchtypeSoll exakt oder mit einem like gesucht werdenstring
  • exact (Standard)
  • like

nein

searchlogicSollen die Parameter mit "und" oder einem "oder" verknüft werdenstring
  • and (Standard)
  • or


nein 
name1Suchparameter Name 1string
nein
name2Suchparameter Name 2string
nein
streetSuchparameter Straßestring
nein
numberSuchparameter Hausnummerstring
nein
zipcodeSuchparameter Postleitzahlstring
nein
countrySuchparameter Länderkennungstring
nein
commentSuchparameter Kommentarstring
nein
citySuchparameter Stadtstring
nein
phoneSuchparameter Telefonstring
nein
emailSuchparameter E-Mailstring
nein
posdescSuchparameter Positionsbeschreibungstring
nein


Rückgabewerte

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

JSON Format

Spalten

SpalteBeschreibung
name1Name 1
name2Name2
streetStraße
numberHausnummer
zipcodePostleitzahl
cityStadt
countryLänderkennzeichen
mapKartenansicht aktiv0 = nein, 1 = ja
commentKommentar
posdescPositionsbeschreibungstextwird in der Karte, Positionsliste angezeigt
latLatitude
lonLongitude
phoneTelefon
emailE-Mail

Beispiel

Code Block
titleRü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

TrennzeichenSemikolon ( ; )
TextbegrenzerDoppeltes Hochkomma ( " )
Zeilenende0x0D 0x0A (CarriageReturn LineFeed)
HeaderZeile 1
KodierungUTF-8

Spalten

SpalteBeschreibung
NAME1Name 1
NAME2Name2
STREETStraße
NRHausnummer
ZIPPostleitzahl
CITYStadt
COUNTRYLänderkennzeichen
MAPKartenansicht aktiv0 = nein, 1 = ja
COMMENTKommentar
DESCPositionsbeschreibungstextwird in der Karte, Positionsliste angezeigt
LATLatitude
LONLongitude
PHONETelefon
EMAILE-Mail

Beispiel

Code Block
titleRü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

SpalteBeschreibung
name1Name 1
name2Name2
streetStraße
numberHausnummer
zipcodePostleitzahl
cityStadt
countryLänderkennzeichen
mapKartenansicht aktiv0 = nein, 1 = ja
commentKommentar
posdescPositionsbeschreibungstextwird in der Karte, Positionsliste angezeigt
latLatitude
lonLongitude
phoneTelefon
emailE-Mail

Beispiel


Code Block
languagexml
<?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
titleSuche 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



...