Skip to content

PlacesNearbyApi

Method HTTP request
getCoordLonLatPlacesNearby GET coord/{lon};{lat}/places_nearby
getCoordsLonLatPlacesNearby GET coords/{lon};{lat}/places_nearby
getCoverageLonLatPlacesNearby GET coverage/{lon};{lat}/places_nearby
getCoverageLonLatUriPlacesNearby GET coverage/{lon};{lat}/{uri}/places_nearby
getCoverageRegionPlacesNearby GET coverage/{region}/places_nearby
getCoverageRegionUriPlacesNearby GET coverage/{region}/{uri}/places_nearby

getCoordLonLatPlacesNearby

Parameters

Name Type Note
lat Double The latitude of where the coord you want to query
lon Double The longitude of where the coord you want to query
type List Type of the objects to return [optional] [default to [u'stop_area', u'stop_point', u'poi']] [enum: stop_point, poi, administrative_region, stop_area, address]
filter String Filter your objects [optional]
distance Int Distance range of the query in meters [optional] [default to 500]
count Int Elements per page [optional] [default to 10]
depth Int Maximum depth on objects [optional] [default to 1]
startPage Int The page number of the ptref result [optional]
bssStands Boolean DEPRECATED, Use add_poi_infos[]=bss_stands [optional]
addPoiInfos List Show more information about the poi if it's available, for instance, show BSS/car park availability in the pois(BSS/car park) of the response [optional] [default to [u'bss_stands', u'car_park']] [enum: bss_stands, car_park, , none]
disableGeojson Boolean remove geojson from the response [optional]
disableDisruption Boolean remove disruptions from the response [optional]

Return

PlacesNearby

Example

ExpertSdk.getInstance().placesNearbyApi.getCoordLonLatPlacesNearby(
    lat = 0.0,
    lon = 0.0,
    type = listOf(),
    filter = "filter_example",
    distance = 123,
    count = 123,
    depth = 123,
    startPage = 123,
    bssStands = true,
    addPoiInfos = listOf(),
    disableGeojson = true,
    disableDisruption = true
)

if (response.isSuccessful && response.body() != null) {  
    // Success
    val content = response.body()  
} else {  
    // Error
}

getCoordsLonLatPlacesNearby

Parameters

Name Type Note
lat Double The latitude of where the coord you want to query
lon Double The longitude of where the coord you want to query
type List Type of the objects to return [optional] [default to [u'stop_area', u'stop_point', u'poi']] [enum: stop_point, poi, administrative_region, stop_area, address]
filter String Filter your objects [optional]
distance Int Distance range of the query in meters [optional] [default to 500]
count Int Elements per page [optional] [default to 10]
depth Int Maximum depth on objects [optional] [default to 1]
startPage Int The page number of the ptref result [optional]
bssStands Boolean DEPRECATED, Use add_poi_infos[]=bss_stands [optional]
addPoiInfos List Show more information about the poi if it's available, for instance, show BSS/car park availability in the pois(BSS/car park) of the response [optional] [default to [u'bss_stands', u'car_park']] [enum: bss_stands, car_park, , none]
disableGeojson Boolean remove geojson from the response [optional]
disableDisruption Boolean remove disruptions from the response [optional]

Return

PlacesNearby

Example

ExpertSdk.getInstance().placesNearbyApi.getCoordsLonLatPlacesNearby(
    lat = 0.0,
    lon = 0.0,
    type = listOf(),
    filter = "filter_example",
    distance = 123,
    count = 123,
    depth = 123,
    startPage = 123,
    bssStands = true,
    addPoiInfos = listOf(),
    disableGeojson = true,
    disableDisruption = true
)

if (response.isSuccessful && response.body() != null) {  
    // Success
    val content = response.body()  
} else {  
    // Error
}

getCoverageLonLatPlacesNearby

Parameters

Name Type Note
lat Double The latitude of where the coord you want to query
lon Double The longitude of where the coord you want to query
type List Type of the objects to return [optional] [default to [u'stop_area', u'stop_point', u'poi']] [enum: stop_point, poi, administrative_region, stop_area, address]
filter String Filter your objects [optional]
distance Int Distance range of the query in meters [optional] [default to 500]
count Int Elements per page [optional] [default to 10]
depth Int Maximum depth on objects [optional] [default to 1]
startPage Int The page number of the ptref result [optional]
bssStands Boolean DEPRECATED, Use add_poi_infos[]=bss_stands [optional]
addPoiInfos List Show more information about the poi if it's available, for instance, show BSS/car park availability in the pois(BSS/car park) of the response [optional] [default to [u'bss_stands', u'car_park']] [enum: bss_stands, car_park, , none]
disableGeojson Boolean remove geojson from the response [optional]
disableDisruption Boolean remove disruptions from the response [optional]

Return

PlacesNearby

Example

ExpertSdk.getInstance().placesNearbyApi.getCoverageLonLatPlacesNearby(
    lat = 0.0,
    lon = 0.0,
    type = listOf(),
    filter = "filter_example",
    distance = 123,
    count = 123,
    depth = 123,
    startPage = 123,
    bssStands = true,
    addPoiInfos = listOf(),
    disableGeojson = true,
    disableDisruption = true
)

if (response.isSuccessful && response.body() != null) {  
    // Success
    val content = response.body()  
} else {  
    // Error
}

getCoverageLonLatUriPlacesNearby

Parameters

Name Type Note
lat Double The latitude of where the coord you want to query
lon Double The longitude of where the coord you want to query
uri String First part of the uri
type List Type of the objects to return [optional] [default to [u'stop_area', u'stop_point', u'poi']] [enum: stop_point, poi, administrative_region, stop_area, address]
filter String Filter your objects [optional]
distance Int Distance range of the query in meters [optional] [default to 500]
count Int Elements per page [optional] [default to 10]
depth Int Maximum depth on objects [optional] [default to 1]
startPage Int The page number of the ptref result [optional]
bssStands Boolean DEPRECATED, Use add_poi_infos[]=bss_stands [optional]
addPoiInfos List Show more information about the poi if it's available, for instance, show BSS/car park availability in the pois(BSS/car park) of the response [optional] [default to [u'bss_stands', u'car_park']] [enum: bss_stands, car_park, , none]
disableGeojson Boolean remove geojson from the response [optional]
disableDisruption Boolean remove disruptions from the response [optional]

Return

PlacesNearby

Example

ExpertSdk.getInstance().placesNearbyApi.getCoverageLonLatUriPlacesNearby(
    lat = 0.0,
    lon = 0.0,
    uri = "uri_example",
    type = listOf(),
    filter = "filter_example",
    distance = 123,
    count = 123,
    depth = 123,
    startPage = 123,
    bssStands = true,
    addPoiInfos = listOf(),
    disableGeojson = true,
    disableDisruption = true
)

if (response.isSuccessful && response.body() != null) {  
    // Success
    val content = response.body()  
} else {  
    // Error
}

getCoverageRegionPlacesNearby

Parameters

Name Type Note
region String The region you want to query
type List Type of the objects to return [optional] [default to [u'stop_area', u'stop_point', u'poi']] [enum: stop_point, poi, administrative_region, stop_area, address]
filter String Filter your objects [optional]
distance Int Distance range of the query in meters [optional] [default to 500]
count Int Elements per page [optional] [default to 10]
depth Int Maximum depth on objects [optional] [default to 1]
startPage Int The page number of the ptref result [optional]
bssStands Boolean DEPRECATED, Use add_poi_infos[]=bss_stands [optional]
addPoiInfos List Show more information about the poi if it's available, for instance, show BSS/car park availability in the pois(BSS/car park) of the response [optional] [default to [u'bss_stands', u'car_park']] [enum: bss_stands, car_park, , none]
disableGeojson Boolean remove geojson from the response [optional]
disableDisruption Boolean remove disruptions from the response [optional]

Return

PlacesNearby

Example

ExpertSdk.getInstance().placesNearbyApi.getCoverageRegionPlacesNearby(
    region = "region_example",
    type = listOf(),
    filter = "filter_example",
    distance = 123,
    count = 123,
    depth = 123,
    startPage = 123,
    bssStands = true,
    addPoiInfos = listOf(),
    disableGeojson = true,
    disableDisruption = true
)

if (response.isSuccessful && response.body() != null) {  
    // Success
    val content = response.body()  
} else {  
    // Error
}

getCoverageRegionUriPlacesNearby

Parameters

Name Type Note
region String The region you want to query
uri String First part of the uri
type List Type of the objects to return [optional] [default to [u'stop_area', u'stop_point', u'poi']] [enum: stop_point, poi, administrative_region, stop_area, address]
filter String Filter your objects [optional]
distance Int Distance range of the query in meters [optional] [default to 500]
count Int Elements per page [optional] [default to 10]
depth Int Maximum depth on objects [optional] [default to 1]
startPage Int The page number of the ptref result [optional]
bssStands Boolean DEPRECATED, Use add_poi_infos[]=bss_stands [optional]
addPoiInfos List Show more information about the poi if it's available, for instance, show BSS/car park availability in the pois(BSS/car park) of the response [optional] [default to [u'bss_stands', u'car_park']] [enum: bss_stands, car_park, , none]
disableGeojson Boolean remove geojson from the response [optional]
disableDisruption Boolean remove disruptions from the response [optional]

Return

PlacesNearby

Example

ExpertSdk.getInstance().placesNearbyApi.getCoverageRegionUriPlacesNearby(
    region = "region_example",
    uri = "uri_example",
    type = listOf(),
    filter = "filter_example",
    distance = 123,
    count = 123,
    depth = 123,
    startPage = 123,
    bssStands = true,
    addPoiInfos = listOf(),
    disableGeojson = true,
    disableDisruption = true
)

if (response.isSuccessful && response.body() != null) {  
    // Success
    val content = response.body()  
} else {  
    // Error
}