addresses_get.php

Last modified by YellowFox_RD on 2025/01/23 09:12

Table of Contents

addresses_get.php

Returns a list of all addresses searched for.

Description

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

Parameter

ParameterDescriptionTypNoteMandatory
companyRTI company keystring yes
importRTI Importschlüsselstring yes
formatformatstring
  • json (standard)
  • csv
  • xml
no
searchtypeshould be searched with "exact" or "like"string
  • exact (standard)
  • like
no
searchlogicif the parameters are to be linked with "and" or an "or"string
  • and (standard)
  • or
no
name1search parameter name 1string no
name2search parameter name 2string no
streetsearch parameter streetstring no
numbersearch parameter streetnumberstring no
zipcodesearch parameter zipcodestring no
countrysearch parameter country-codestring no
commentsearch parameter commentstring no
citysearch parameter citystring no
phonesearch parameter phonestring no
emailsearch parameter e-mailstring no
posdescsearch parameter position descriptionstring no

Retrurn

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

JSON format

Column

columndescription 
name1name 1 
name2name 2 
streetstreetname 
numberstreetnumber 
zipcodezipcode 
citycityname 
countrycountry-code 
mapmap active?0 = no, 1 = yes
commentcomment 
posdescposition description textwill be displayed on map, position list
latlatitude 
lonlongitude 
phonephone 
emaile-mail 

Example

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

SeparatorSemikolon ( ; )
TextlimitDoppeltes Hochkomma ( " )
End of line0x0D 0x0A (CarriageReturn LineFeed)
HeaderZeile 1
EncodingUTF-8

Column

ColumnDescription 
name1name 1 
name2name 2 
streetstreetname 
numberstreetnumber 
zipcodezipcode 
citycityname 
countrycountry-code 
mapmap active?0 = no, 1 = yes
commentcomment 
posdescposition description textwill be displayed on map, position list
latlatitude 
lonlongitude 
phonephone 
emaile-mail 

Example

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

ColumnDescription 
name1name 1 
name2name 2 
streetstreetname 
numberstreetnumber 
zipcodezipcode 
citycityname 
countrycountry-code 
mapmap active?0 = no, 1 = yes
commentcomment 
posdescposition description textwill be displayed on map, position list
latlatitude 
lonlongitude 
phonephone 
emaile-mail 

Example

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

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