Platform Data Extension API Developer's Guide

Index

Return the list of tiles that contain information on the given attribute, e.g. a list of link IDs, in JSON (/index.json) or text (/index.txt) format. Applications should look up the maximum supported number of attribute values per request through the resource serviceconfiguration.json / serviceconfiguration.txt.

Resource URI

/index

Resource Parameters

Parameter Type Description
app_id String

Typically, but not guaranteed to be, 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. See Acquiring Credentials.

app_code String

Typically, but not guaranteed to be, 20 bytes Base64 URL-safe encoded string used for the authentication of the client application. See Acquiring Credentials.

region String Optional (default=whole world). Map coverage region, e.g. APAC, AUS, WEU, IND, MEA, NA, SAM, TWN. The region may also contain hints to distinguish specific content. E.g. there can be an WEU and PCBEU, where the 2nd map contains only Postal Code Boundary layers. This parameter is optional. If not specified, Platform Data Extension API will find the region(s) automatically, that cover the tile. The parameter can also contain a comma separated list of regions. If it contains more than one region, Platform Data Extension API will use these regions out of the list that cover the tile. Specifying a region is strongly discouraged, because regions might change and hence applications that specify a region might stop working when the region gets discontinued, renamed, splitted or changed otherwise.
release String Map release quarter, e.g. 2015Q4, 161J0, 16153 or LATEST (= default) for the latest available map release quarter. Specifying a map release is strongly discouraged, because there is no guarantee how long old map releases are available, hence applications that specify a release might stop working when the release gets retired. To choose a (nearest to) specific snapshot of the live traffic speed record layer, a UNIX timestamp (number of seconds since 1970) or a date in 2017-12-01T17:30:00+01:00 format can be passed.
layer String Thematic Layer
attributes String Specifies the attributes that are searched, as a comma separated list. E.g. LINK_ID.
values String Specifies the attribute values that are searched, as a comma separated list. E.g. 123,456,789. If attributes is a list with several values, then values contains a value for each attribute. E.g. attributes=LEFT_POSTAL_AREA_ID,TUNNEL with values 222,Y,333,Y,444,N.