v1

latestSwagger 2.02026-07-1384122135.6 KB
Place

Gets the places that lie within a geographic region. The geographic region of interest can either be specified by using a lat/lon geo-point and a radius in metres to return places within the locus defined by the lat/lon of its centre or alternatively, by the use of a bounding box defined by the lat/lon of its north-west and south-east corners. Optionally filters on type and can strip properties for a smaller payload.

get/Place

Query parameters

radiusnumber double

The radius of the bounding circle in metres when only lat/lon are specified.

categoriesstring[]

An optional list of comma separated property categories to return in the Place's property bag. If null or empty, all categories of property are returned. Pass the keyword "none" to return no properties (a valid list of categories can be obtained from the /Place/Meta/categories endpoint)

includeChildrenboolean

Defaults to false. If true child places e.g. individual charging stations at a charge point while be included, otherwise just the URLs of any child places will be returned

typestring[]

Place types to filter on, or null to return all types

activeOnlyboolean

An optional parameter to limit the results to active records only (Currently only the 'VariableMessageSign' place type is supported)

numberOfPlacesToReturninteger

If specified, limits the number of returned places equal to the given value

placeGeo.swLatnumber double
placeGeo.swLonnumber double
placeGeo.neLatnumber double
placeGeo.neLonnumber double
placeGeo.latnumber double
placeGeo.lonnumber double

Response

OK

naptanIdstring
platformNamestring
indicatorstring

The indicator of the stop point e.g. "Stop K"

stopLetterstring

The stop letter, if it could be cleansed from the Indicator e.g. "K"

modesstring[]
icsCodestring
smsCodestring
stopTypestring
stationNaptanstring
accessibilitySummarystring
hubNaptanCodestring
fullNamestring
naptanModestring
statusboolean
individualStopIdstring
idstring

A unique identifier.

urlstring

The unique location of this resource.

commonNamestring

A human readable name.

distancenumber double

The distance of the place from its search point, if this is the result of a geographical search, otherwise zero.

placeTypestring

The type of Place. See /Place/Meta/placeTypes for possible values.

childrenUrlsstring[]
latnumber double

WGS84 latitude of the location.

lonnumber double

WGS84 longitude of the location.