addresses_get.php [Original Seitentitel]
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
Parameter | Description | Typ | Note | Mandatory |
---|---|---|---|---|
company | RTI company key | string | yes | |
import | RTI Importschlüssel | string | yes | |
format | format | string |
| no |
searchtype | should be searched with "exact" or "like" | string |
| no |
searchlogic | if the parameters are to be linked with "and" or an "or" | string |
| 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 | |
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 | |
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
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 | |
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
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 | |
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