Results and Result Types
Except Autosuggest, Places API Entrypoints result items are Place object links, with a type
attribute set to urn:nlp-types:place
. Applications needing to discriminate the different kind of entrypoint results are using either the category.id
or the categories[].id
attribute. On GS7, results have a very similar structure in every endpoint to reduce development and porting costs. For instance customers needing to capture the type of a result item, can use the related resultType
response element and a set of sub-types fields described below.
Note that GS7 currently does not support the intersection result type.
All Entrypoints
For applications not using cs=pds
:
Places API
category.id | GS7
resultType | GS7
administrativeAreaType | GS7
localityType |
administrative-region | administrativeArea | country | |
administrative-region | administrativeArea | state | |
administrative-region | administrativeArea | county | |
city-town-village | locality | | city |
administrative-region | locality | | district |
postal-area | locality | | postalCode |
street-square | street | | |
building | houseNumber | | |
intersection | intersection | | |
anything else | place | |
For applications using cs=pds
:
Places API
categories[].id | Places API
categories[].title | GS7
resultType | GS7
administrativeAreaType | GS7
localityType |
900-9400-0399 | Administrative Region | administrativeArea | country | |
900-9400-0399 | Administrative Region | administrativeArea | state | |
900-9400-0399 | Administrative Region | administrativeArea | county | |
900-9100-0000 | City, Town or Village | locality | | city |
900-9400-0399 | Administrative Region | locality | | district |
900-9400-0400 | Postal Area | locality | | postalCode |
900-9400-0401 | Street or Square | street | | |
900-9300-0000 | Building | houseNumber | | |
900-9400-0402 | Intersection | NA | | |
xxx-xxxx-xxxx | | place | |
Autosuggest
As far as Autosuggest is concerned, both GS7 and Places API result items have a type, useful for customers for post-filtering activities. Note hat GS7 provides more granular types for address results. Check GS7 Result Types chapter for more details.
For applications not using cs=pds
:
Places API
resultType | Places API
category | GS7
resultType | GS7
administrativeAreaType | GS7
localityType |
address | administrative-region | administrativeArea | country | |
| administrative-region | administrativeArea | state | |
| administrative-region | administrativeArea | county | |
| city-town-village | locality | | city |
| administrative-region | locality | | district |
| postal-area | locality | | postalCode |
| street-square | street | | |
| building | houseNumber | | |
place | (anything else) | place | | |
category | (anything else) | categoryQuery | | |
chain | NA | chainQuery | | |
query | NA | NA | NA | NA |
address | intersection | intersection | NA | NA |
For applications using cs=pds
:
Places API
resultType | Places API
category | GS7
resultType | GS7
administrativeAreaType | GS7
localityType |
address | 900-9400-0399 | administrativeArea | country | |
| 900-9400-0399 | administrativeArea | state | |
| 900-9400-0399 | administrativeArea | county | |
| 900-9100-0000 | locality | | city |
| 900-9400-0399 | locality | | district |
| 900-9400-0400 | locality | | postalCode |
| 900-9400-0401 | street | | |
| 900-9300-0000 | houseNumber | | |
place | xxx-xxxx-xxxx | place | | |
category | xxx-xxxx-xxxx | categoryQuery | | |
chain | NA | chainQuery | | |
query | NA | NA | NA | NA |
address | 900-9400-0402 | NA | NA | NA |
query
typed results in Places API Autosuggest entrypoint are to be found in GS7 Autosuggest service results in a separated response element. Check the Query term completion support chapter for more details.