diff --git a/BUILD.bazel b/BUILD.bazel
index 58d738cb..893cd809 100644
--- a/BUILD.bazel
+++ b/BUILD.bazel
@@ -186,6 +186,7 @@ bundle_external_specs(
"transit",
"datasets",
"distance",
+ "localities",
],
)
diff --git a/WORKSPACE b/WORKSPACE
index 0dfcb08e..a922ae64 100644
--- a/WORKSPACE
+++ b/WORKSPACE
@@ -87,4 +87,5 @@ rules_pkg_dependencies()
"transit",
"datasets",
"distance",
+ "localities",
]]
diff --git a/dist/documentation/parameters/woosmap_http_parameters_localitiesautocomplete.html b/dist/documentation/parameters/woosmap_http_parameters_localitiesautocomplete.html
deleted file mode 100644
index 43901ab6..00000000
--- a/dist/documentation/parameters/woosmap_http_parameters_localitiesautocomplete.html
+++ /dev/null
@@ -1,169 +0,0 @@
-
-
-
Required parameters
-
-
-
-
- The text string on which to search, for example: "london" or "123 Cross
- Road". The Woosmap Localities API will return predictions matches based on
- this string and order the results based on their perceived relevance. To
- protect against illegitimate requests, only the 20 first tokens found in
- the first 150 characters will be used.
-
-
-
-Optional parameters
-
-
- components
-
- A grouping of places to which you would like to restrict your results.
- Components can and should be used when applicable to filter over countries
- and retrieve more accurate results. Countries must be passed as an ISO
- 3166-1 Alpha-2 or Alpha-3 compatible country code. For example:
- components=country:fr or
- components=country:fra would restrict your results to places
- within France and components=country:fr-fr returns locations
- only in Metropolitan France. Multiple countries must be passed as multiple
- country:XX filters, with the pipe character (|)
- as a separator. For example:
- components=country:gb|country:fr|country:be|country:sp|country:it
- would restrict your results to city names or postal codes within the
- United Kingdom, France, Belgium, Spain and Italy.
-
-
-
- custom_description
-
- This parameter allows to choose the description format for all or some of
- the suggestion types selected. The custom formats are described as follows
- (available fields depend on the returned type):
- custom_description=type_A:"{field_1}, {field_2},
- [...]"|type_B:"{field_1}, {field_2}, [...]"
-
-
-
- data
-
- Two values for this parameter: standard or
- advanced. By default, if the parameter is not defined, value
- is set as standard. The advanced value opens
- suggestions to worldwide postal codes in addition to postal codes for
- Western Europe.
- A dedicated option subject to specific billing on your license is
- needed to use this parameter. Please contact us if you are interested
- in using this parameter and you do not have subscribed the proper
- option yet.
-
-
-
- excluded_types
-
- The types of suggestion to exclude. Multiple types can be passed using the
- pipe character (|) as a separator.
-
-
-
- extended
-
- If set, this parameter allows a refined search over locality names that
- bears the same postal code. By triggering this parameter, integrators will
- benefit from a search spectrum on the locality type that
- includes postal codes . To avoid confusion, it is recommended not to activate this parameter
- along with the postal_code type which could lead to duplicate
- locations. Also, the default description returned by the API changes to
- name (postal code), admin_1, admin_0. It is only available
- for France, Monaco, Italy, Spain, Belgium, Switzerland and Luxembourg.
-
-
-
- language
-
- The language code, using ISO 639-2 Alpha-2 country codes, indicating in
- which language the results should be returned, if possible. If language is
- not supplied, first Accept-Language of the browser will be
- used. If neither the provided language or the
- Accept-Language are known, the Localities service uses the
- international default language (English). No language is
- necessary for a postal_code request. According to requested language, only
- parts of the address components might be translated.
-
-
-
- location
-
- This parameter is used to add a geographical bias to the query. The
- location defines the point around which to retrieve results in priority.
- It must be specified in the latitude,longitude string format.
-
-
-
- radius
-
- This parameter may be used in addition to the
- location parameter to define the distance in meters within
- which the API will return results in priority. Results outside of the
- defined area may still be displayed. Default radius if this parameter is
- not set is 100000.
-
-
-
- types
-
- Specifies the types of suggestions to return in the query. Multiple types
- can be combined using the pipe character (|) as a separator.
- This parameter supports a wide range of locality classifications,
- including:
-
-
-
- Standard locality types (e.g., cities, administrative areas, postal
- codes)
-
- Points of Interest (POI) categories
- POI aliases
-
-
- These classifications enable flexible geographic data representation and
- querying.
-
-
-
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/parameters/woosmap_http_parameters_localitiesautocomplete.md b/dist/documentation/parameters/woosmap_http_parameters_localitiesautocomplete.md
deleted file mode 100644
index 4357792f..00000000
--- a/dist/documentation/parameters/woosmap_http_parameters_localitiesautocomplete.md
+++ /dev/null
@@ -1,61 +0,0 @@
-
-
-Required parameters
-
--
-
- The text string on which to search, for example: "london" or "123 Cross Road".
- The Woosmap Localities API will return predictions matches based on this string and order the results based on their perceived relevance.
- To protect against illegitimate requests, only the 20 first tokens found in the first 150 characters will be used.
-
-Optional parameters
-
-- components
-
- A grouping of places to which you would like to restrict your results. Components can and should be used when applicable to filter over countries and retrieve more accurate results. Countries must be passed as an ISO 3166-1 Alpha-2 or Alpha-3 compatible country code. For example: `components=country:fr` or `components=country:fra` would restrict your results to places within France and `components=country:fr-fr` returns locations only in Metropolitan France. Multiple countries must be passed as multiple `country:XX` filters, with the pipe character (`|`) as a separator. For example: `components=country:gb|country:fr|country:be|country:sp|country:it` would restrict your results to city names or postal codes within the United Kingdom, France, Belgium, Spain and Italy.
-
-- custom_description
-
- This parameter allows to choose the description format for all or some of the suggestion types selected. The custom formats are described as follows (available fields depend on the returned type): `custom_description=type_A:"{field_1}, {field_2}, [...]"|type_B:"{field_1}, {field_2}, [...]"`
-
-- data
-
- Two values for this parameter: `standard` or `advanced`. By default, if the parameter is not defined, value is set as `standard`. The `advanced` value opens suggestions to worldwide postal codes in addition to postal codes for Western Europe. ***A dedicated option subject to specific billing on your license is needed to use this parameter. Please contact us if you are interested in using this parameter and you do not have subscribed the proper option yet.***
-
-- excluded_types
-
- The types of suggestion to exclude. Multiple types can be passed using the pipe character (`|`) as a separator.
-
-- extended
-
- If set, this parameter allows a refined search over locality names that bears the same postal code. By triggering this parameter, integrators will benefit from a search spectrum on the `locality` type that ***includes postal codes***. To avoid confusion, it is recommended not to activate this parameter along with the `postal_code` type which could lead to duplicate locations. Also, the default description returned by the API changes to `name (postal code), admin_1, admin_0`. It is only available for France, Monaco, Italy, Spain, Belgium, Switzerland and Luxembourg.
-
-- language
-
- The language code, using ISO 639-2 Alpha-2 country codes, indicating in which language the results should be returned, if possible. If language is not supplied, first `Accept-Language` of the browser will be used. If neither the provided `language` or the `Accept-Language` are known, the Localities service uses the international default language (English). No `language` is necessary for a postal\_code request. According to requested language, only parts of the address components might be translated.
-
-- location
-
- This parameter is used to add a geographical bias to the query. The location defines the point around which to retrieve results in priority. It must be specified in the `latitude,longitude` string format.
-
-- radius
-
- This parameter may be used in addition to the `location` parameter to define the distance in meters within which the API will return results in priority. Results outside of the defined area may still be displayed. Default radius if this parameter is not set is 100000.
-
-- types
-
- Specifies the types of suggestions to return in the query. Multiple types can be combined using the pipe character (`|`) as a separator. This parameter supports a wide range of locality classifications, including:
-
- - Standard locality types (e.g., cities, administrative areas, postal codes)
- - Points of Interest (POI) categories
- - POI aliases
-
- These classifications enable flexible geographic data representation and querying.
-
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
\ No newline at end of file
diff --git a/dist/documentation/parameters/woosmap_http_parameters_localitiesdetails.html b/dist/documentation/parameters/woosmap_http_parameters_localitiesdetails.html
deleted file mode 100644
index 49ea7cd3..00000000
--- a/dist/documentation/parameters/woosmap_http_parameters_localitiesdetails.html
+++ /dev/null
@@ -1,109 +0,0 @@
-
-
-Required parameters
-
-Optional parameters
-
-
-
- addresses_per_page
-
-
- addresses_per_page is deprecated.
-
-
- In a few cases, a postal code details may contain addresses (UK postal
- codes). The address list is paginated. In that case, you can navigate in
- the address list thanks to the addresses_per_page and
- page parameters. Notice: as all the addresses are now
- automatically returned in the response, the
- addresses_per_page parameter is deprecated and has been
- turned off on December 31, 2021.
-
-
-
-
-
- To specify the format for the short
- country code
- expected to be returned in the address_components field. Default is the
- format used to specify components or alpha2 if
- no components are specified.
-
-
-
- fields
-
- If set, it will limit the content of responses to the specified fields.
- This parameter can be any combination of geometry,
- address_components or shape (defaults to
- geometry|address_components).
-
-
-
- language
-
- The language code, using ISO 639-2 Alpha-2 country codes, indicating in
- which language the results should be returned, if possible. If language is
- not supplied, first Accept-Language of the browser will be
- used. If neither the provided language or the
- Accept-Language are known, the Localities service uses the
- international default language (English). No language is
- necessary for a postal_code request. According to requested language, only
- parts of the address components might be translated.
-
-
-
- page
-
-
- In a few cases, a postal code details may contain addresses (UK postal
- codes). The address list is paginated. In that case, you can navigate in
- the address list thanks to the addresses_per_page and
- page parameters. Notice: as all the addresses are now
- automatically returned in the response, the page parameter is
- deprecated and has been turned off on December 31, 2021.
-
-
-
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/parameters/woosmap_http_parameters_localitiesdetails.md b/dist/documentation/parameters/woosmap_http_parameters_localitiesdetails.md
deleted file mode 100644
index 906d576b..00000000
--- a/dist/documentation/parameters/woosmap_http_parameters_localitiesdetails.md
+++ /dev/null
@@ -1,41 +0,0 @@
-
-
-Required parameters
-
-- public_id
-
- A textual identifier that uniquely identifies a locality, returned from a [Localities Autocomplete](https://developers.woosmap.com/products/localities/autocomplete/).
-
-Optional parameters
-
-- addresses_per_page
-
- addresses_per_page is deprecated.
-
- In a few cases, a postal code details may contain addresses (UK postal codes). The address list is paginated. In that case, you can navigate in the address list thanks to the `addresses_per_page` and `page` parameters. Notice: as all the addresses are now automatically returned in the response, the `addresses_per_page` parameter is deprecated and has been turned off on December 31, 2021.
-
--
-
- To specify the format for the short [country code](https://en.wikipedia.org/wiki/ISO_3166-1) expected to be returned in the address\_components field. Default is the format used to specify `components` or `alpha2` if no components are specified.
-
-- fields
-
- If set, it will limit the content of responses to the specified fields. This parameter can be any combination of `geometry`, `address_components` or `shape` (defaults to `geometry|address_components`).
-
-- language
-
- The language code, using ISO 639-2 Alpha-2 country codes, indicating in which language the results should be returned, if possible. If language is not supplied, first `Accept-Language` of the browser will be used. If neither the provided `language` or the `Accept-Language` are known, the Localities service uses the international default language (English). No `language` is necessary for a postal\_code request. According to requested language, only parts of the address components might be translated.
-
-- page
-
-
-
- In a few cases, a postal code details may contain addresses (UK postal codes). The address list is paginated. In that case, you can navigate in the address list thanks to the `addresses_per_page` and `page` parameters. Notice: as all the addresses are now automatically returned in the response, the `page` parameter is deprecated and has been turned off on December 31, 2021.
-
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
\ No newline at end of file
diff --git a/dist/documentation/parameters/woosmap_http_parameters_localitiesgeocode.html b/dist/documentation/parameters/woosmap_http_parameters_localitiesgeocode.html
deleted file mode 100644
index 09de20fd..00000000
--- a/dist/documentation/parameters/woosmap_http_parameters_localitiesgeocode.html
+++ /dev/null
@@ -1,160 +0,0 @@
-
-
-Optional parameters
-
-
- address
-
- The input string to geocode. Can represent an address, a street, a
- locality or a postal code. The address parameter must be URL
- encoded. To protect against illegitimate requests, only the 20 first
- tokens found in the first 150 characters will be used.
-
-
-
-
-
- To specify the format for the short
- country code
- expected to be returned in the address_components field. Default is the
- format used to specify components or alpha2 if
- no components are specified.
-
-
-
- components
-
- A grouping of places to which you would like to restrict your results.
- Components can and should be used when applicable to filter over countries
- and retrieve more accurate results. Countries must be passed as an ISO
- 3166-1 Alpha-2 or Alpha-3 compatible country code. For example:
- components=country:fr or
- components=country:fra would restrict your results to places
- within France and components=country:fr-fr returns locations
- only in Metropolitan France. Multiple countries must be passed as multiple
- country:XX filters, with the pipe character (|)
- as a separator. For example:
- components=country:gb|country:fr|country:be|country:sp|country:it
- would restrict your results to city names or postal codes within the
- United Kingdom, France, Belgium, Spain and Italy.
-
-
-
- data
-
- Two values for this parameter: standard or
- advanced. By default, if the parameter is not defined, value
- is set as standard. The advanced value opens
- suggestions to worldwide postal codes in addition to postal codes for
- Western Europe.
- A dedicated option subject to specific billing on your license is
- needed to use this parameter. Please contact us if you are interested
- in using this parameter and you do not have subscribed the proper
- option yet.
-
-
-
- excluded_types
-
- The types of suggestion to exclude. Multiple types can be passed using the
- pipe character (|) as a separator.
-
-
-
- fields
-
- If set, it will limit the content of responses to the specified fields.
- This parameter can be any combination of geometry,
- address_components or shape (defaults to
- geometry|address_components).
-
-
-
- language
-
- The language code, using ISO 639-2 Alpha-2 country codes, indicating in
- which language the results should be returned, if possible. If language is
- not supplied, first Accept-Language of the browser will be
- used. If neither the provided language or the
- Accept-Language are known, the Localities service uses the
- international default language (English). No language is
- necessary for a postal_code request. According to requested language, only
- parts of the address components might be translated.
-
-
-
- latlng
-
- The latlng parameter is used for reverse geocoding, it's required if the
- address parameter is missing.
-
-
-
- list_sub_buildings
-
- When latlng parameter is used for reverse geocoding, setting
- list_sub_building=true allows to retrieve all addresses at
- the same location for a common street number or building. Results may
- contain an additional key "sub_buildings" with "public_id" and
- "description" values for every addresses at the same location sharing the
- same address components.
-
-
-
- types
-
- When executing a geocode request with the address parameter,
- it specifies the types of suggestions to return in the query. Multiple
- types can be combined using the pipe character (|) as a
- separator. This parameter supports a wide range of locality
- classifications, including:
-
-
-
- Standard locality types (e.g., cities, administrative areas, postal
- codes)
-
- Points of Interest (POI) categories
- POI aliases
-
-
- These classifications enable flexible geographic data representation and
- querying. This parameter is ignored when used with the
- latlng parameter.
-
-
-
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/parameters/woosmap_http_parameters_localitiesgeocode.md b/dist/documentation/parameters/woosmap_http_parameters_localitiesgeocode.md
deleted file mode 100644
index 6487f1ee..00000000
--- a/dist/documentation/parameters/woosmap_http_parameters_localitiesgeocode.md
+++ /dev/null
@@ -1,61 +0,0 @@
-
-
-
-
-Optional parameters
-
-- address
-
- The input string to geocode. Can represent an address, a street, a locality or a postal code. The `address` parameter must be URL encoded.
- To protect against illegitimate requests, only the 20 first tokens found in the first 150 characters will be used.
-
--
-
- To specify the format for the short [country code](https://en.wikipedia.org/wiki/ISO_3166-1) expected to be returned in the address\_components field. Default is the format used to specify `components` or `alpha2` if no components are specified.
-
-- components
-
- A grouping of places to which you would like to restrict your results. Components can and should be used when applicable to filter over countries and retrieve more accurate results. Countries must be passed as an ISO 3166-1 Alpha-2 or Alpha-3 compatible country code. For example: `components=country:fr` or `components=country:fra` would restrict your results to places within France and `components=country:fr-fr` returns locations only in Metropolitan France. Multiple countries must be passed as multiple `country:XX` filters, with the pipe character (`|`) as a separator. For example: `components=country:gb|country:fr|country:be|country:sp|country:it` would restrict your results to city names or postal codes within the United Kingdom, France, Belgium, Spain and Italy.
-
-- data
-
- Two values for this parameter: `standard` or `advanced`. By default, if the parameter is not defined, value is set as `standard`. The `advanced` value opens suggestions to worldwide postal codes in addition to postal codes for Western Europe. ***A dedicated option subject to specific billing on your license is needed to use this parameter. Please contact us if you are interested in using this parameter and you do not have subscribed the proper option yet.***
-
-- excluded_types
-
- The types of suggestion to exclude. Multiple types can be passed using the pipe character (`|`) as a separator.
-
-- fields
-
- If set, it will limit the content of responses to the specified fields. This parameter can be any combination of `geometry`, `address_components` or `shape` (defaults to `geometry|address_components`).
-
-- language
-
- The language code, using ISO 639-2 Alpha-2 country codes, indicating in which language the results should be returned, if possible. If language is not supplied, first `Accept-Language` of the browser will be used. If neither the provided `language` or the `Accept-Language` are known, the Localities service uses the international default language (English). No `language` is necessary for a postal\_code request. According to requested language, only parts of the address components might be translated.
-
-- latlng
-
- The latlng parameter is used for reverse geocoding, it's required if the `address` parameter is missing.
-
-- list_sub_buildings
-
- When latlng parameter is used for reverse geocoding, setting `list_sub_building=true` allows to retrieve all addresses at the same location for a common street number or building. Results may contain an additional key "sub\_buildings" with "public\_id" and "description" values for every addresses at the same location sharing the same address components.
-
-- types
-
- When executing a geocode request with the `address` parameter, it specifies the types of suggestions to return in the query. Multiple types can be combined using the pipe character (`|`) as a separator. This parameter supports a wide range of locality classifications, including:
-
- - Standard locality types (e.g., cities, administrative areas, postal codes)
- - Points of Interest (POI) categories
- - POI aliases
-
- These classifications enable flexible geographic data representation and querying.
- This parameter is ignored when used with the `latlng` parameter.
-
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
\ No newline at end of file
diff --git a/dist/documentation/parameters/woosmap_http_parameters_localitiesnearby.html b/dist/documentation/parameters/woosmap_http_parameters_localitiesnearby.html
deleted file mode 100644
index 248b181d..00000000
--- a/dist/documentation/parameters/woosmap_http_parameters_localitiesnearby.html
+++ /dev/null
@@ -1,72 +0,0 @@
-
-
-Required parameters
-
-
- location
- Center of the search circle.
-
-
- types
-
- The types of points of interest to return. Multiple types can be passed
- using the pipe character (|) as a separator. For example:
- types=business.shop|medical.pharmacy|business.finance.bank.
-
-
-
-Optional parameters
-
-
- excluded_types
-
- The types of points of interest to exclude from results. Results will
- match the specified types, if any, but will not match the
- specified excluded_types. Multiple types can be passed using
- the pipe character (|) as a separator. For example:
- excluded_types=business.food_and_drinks.fast_food|business.food_and_drinks.pub.
-
-
-
- limit
- Defines how many results should be included in a page.
-
-
- page
- Use page to navigate through paginated results.
-
-
- radius
- Radius of the search circle, in meters.
-
-
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/parameters/woosmap_http_parameters_localitiesnearby.md b/dist/documentation/parameters/woosmap_http_parameters_localitiesnearby.md
deleted file mode 100644
index ce65395a..00000000
--- a/dist/documentation/parameters/woosmap_http_parameters_localitiesnearby.md
+++ /dev/null
@@ -1,37 +0,0 @@
-
-
-Required parameters
-
-- location
-
- Center of the search circle.
-
-- types
-
- The types of points of interest to return. Multiple types can be passed using the pipe character (`|`) as a separator. For example: `types=business.shop|medical.pharmacy|business.finance.bank`.
-
-Optional parameters
-
-- excluded_types
-
- The types of points of interest to exclude from results. Results will match the specified `types`, if any, but will not match the specified `excluded_types`. Multiple types can be passed using the pipe character (`|`) as a separator. For example: `excluded_types=business.food_and_drinks.fast_food|business.food_and_drinks.pub`.
-
-- limit
-
- Defines how many results should be included in a page.
-
-- page
-
- Use `page` to navigate through paginated results.
-
-- radius
-
- Radius of the search circle, in meters.
-
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
\ No newline at end of file
diff --git a/dist/documentation/schemas/woosmap_http_schema_addresscomponents.html b/dist/documentation/schemas/woosmap_http_schema_addresscomponents.html
deleted file mode 100644
index efd1df87..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_addresscomponents.html
+++ /dev/null
@@ -1,32 +0,0 @@
-
-
-AddressComponents
-An array containing Address Components with additional information
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_addresscomponents.md b/dist/documentation/schemas/woosmap_http_schema_addresscomponents.md
deleted file mode 100644
index 486a19d8..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_addresscomponents.md
+++ /dev/null
@@ -1,12 +0,0 @@
-
-
-AddressComponents
-
-An array containing Address Components with additional information
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_administrativearealabel.html b/dist/documentation/schemas/woosmap_http_schema_administrativearealabel.html
deleted file mode 100644
index 976ebe20..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_administrativearealabel.html
+++ /dev/null
@@ -1,38 +0,0 @@
-
-
-
- AdministrativeAreaLabel
-
-
- Only available for admin_level suggestions, this contains the
- local english name of the administration level ("department" for France or
- "federal_state" for Germany).
-
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_administrativearealabel.md b/dist/documentation/schemas/woosmap_http_schema_administrativearealabel.md
deleted file mode 100644
index 4849ba57..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_administrativearealabel.md
+++ /dev/null
@@ -1,12 +0,0 @@
-
-
-AdministrativeAreaLabel
-
-Only available for `admin_level` suggestions, this contains the local english name of the administration level ("department" for France or "federal_state" for Germany).
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_formattedaddress.html b/dist/documentation/schemas/woosmap_http_schema_formattedaddress.html
deleted file mode 100644
index 0f61c579..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_formattedaddress.html
+++ /dev/null
@@ -1,32 +0,0 @@
-
-
-
-Contains the readable text description of the result.
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_formattedaddress.md b/dist/documentation/schemas/woosmap_http_schema_formattedaddress.md
deleted file mode 100644
index 6807857a..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_formattedaddress.md
+++ /dev/null
@@ -1,12 +0,0 @@
-
-
-
-
-Contains the readable text description of the result.
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_geojsoncoords.html b/dist/documentation/schemas/woosmap_http_schema_geojsoncoords.html
deleted file mode 100644
index 3c4bc797..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_geojsoncoords.html
+++ /dev/null
@@ -1,32 +0,0 @@
-
-
-GeoJsonCoords
-an array containing Positions.
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_geojsoncoords.md b/dist/documentation/schemas/woosmap_http_schema_geojsoncoords.md
deleted file mode 100644
index c377a775..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_geojsoncoords.md
+++ /dev/null
@@ -1,12 +0,0 @@
-
-
-GeoJsonCoords
-
-an array containing Positions.
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_geojsongeometry.html b/dist/documentation/schemas/woosmap_http_schema_geojsongeometry.html
deleted file mode 100644
index 8a522ec8..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_geojsongeometry.html
+++ /dev/null
@@ -1,124 +0,0 @@
-
-
-GeoJsonGeometry
-
- A GeoJSon Geometry representing the shape of the area, as specified in
- RFC7946 . To
- display on the map, simply wrap this object in a feature:
-
-{
- "type": "Feature",
- "geometry": this_geojson_geometry
-}
-
-
-
-
- Field
- Required
- Type
- Description
-
-
-
-
-
-
- coordinates
-
-
- optional
-
- Array<GeoJsonCoords >
-
-
- See GeoJsonCoords for
- more information.
-
-
-
-
-
- type
-
-
- optional
- string
-
-
-
the geometry type
-
- The allowed values include: Polygon, and
- MultiPoligon
-
-
-
-
-
-
-Example
-
-{
- "type": "Polygon",
- "coordinates": [
- [
- [
- 2.06984,
- 48.77919
- ],
- [
- 2.07984,
- 48.77919
- ],
- [
- 2.07984,
- 48.78919
- ],
- [
- 2.06984,
- 48.78919
- ],
- [
- 2.06984,
- 48.77919
- ]
- ]
- ]
-}
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_geojsongeometry.md b/dist/documentation/schemas/woosmap_http_schema_geojsongeometry.md
deleted file mode 100644
index 2837f1a0..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_geojsongeometry.md
+++ /dev/null
@@ -1,55 +0,0 @@
-
-
-GeoJsonGeometry
-
-A GeoJSon Geometry representing the shape of the area, as specified in [RFC7946](https://datatracker.ietf.org/doc/html/rfc7946).
-To display on the map, simply wrap this object in a feature:
-
-```json
-{
- "type": "Feature",
- "geometry": this_geojson_geometry
-}
-```
-
-| Field | Required | Type | Description |
-| :------------------------------------------------------------------------------------------------------------- | -------- | -------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| coordinates | optional | Array\<[GeoJsonCoords](#GeoJsonCoords "GeoJsonCoords")\> | See [GeoJsonCoords](#GeoJsonCoords "GeoJsonCoords") for more information. |
-| type | optional | string | the geometry type
The allowed values include: `Polygon`, and `MultiPoligon`
|
-
-Example
-
-{
- "type": "Polygon",
- "coordinates": [
- [
- [
- 2.06984,
- 48.77919
- ],
- [
- 2.07984,
- 48.77919
- ],
- [
- 2.07984,
- 48.78919
- ],
- [
- 2.06984,
- 48.78919
- ],
- [
- 2.06984,
- 48.77919
- ]
- ]
- ]
-}
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesaddressgeometry.html b/dist/documentation/schemas/woosmap_http_schema_localitiesaddressgeometry.html
deleted file mode 100644
index a7f9b961..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesaddressgeometry.html
+++ /dev/null
@@ -1,166 +0,0 @@
-
-
-
- LocalitiesAddressGeometry
-
-
- The location of the result, in latitude and longitude. Accuracy is also
- provided.
-
-
-
-
- Field
- Required
- Type
- Description
-
-
-
-
-
-
- location
-
-
- optional
- LatLngLiteral
-
- See LatLngLiteral for
- more information.
-
-
-
-
-
- location_type
-
-
- optional
- string
-
-
-
- Specifies additional data about the geocoded location. The following
- values are currently supported:
-
-
-
- ROOFTOP result is a precise geocode for which we have
- location information accurate down to street address precision.
-
-
- RANGE_INTERPOLATED result reflects an approximation
- (usually on a road) interpolated between two precise points (such
- as intersections). Interpolated results are generally returned
- when rooftop geocodes are unavailable for a street address.
-
-
- GEOMETRIC_CENTER result is the geometric center of a
- result such as a polyline (for example, a street) or polygon
- (city, region, …).
-
-
- APPROXIMATE result is approximate (usually when no
- other above value applies)
-
-
- POSTAL_CODE Address has inherited from the location
- of the postal code it is part of (for NYB addresses)
-
-
- DISTRICT Address has inherited from the location of
- the district it is part of (for NYB addresses)
-
-
-
- The allowed values include: ROOFTOP,
- RANGE_INTERPOLATED, GEOMETRIC_CENTER,
- APPROXIMATE, POSTAL_CODE, and
- DISTRICT
-
-
-
-
-
-
-
- shape
-
-
- optional
-
- GeoJsonGeometry
-
-
- See
- GeoJsonGeometry
- for more information.
-
-
-
-
-
- viewport
-
-
- optional
- Bounds
-
- See Bounds for more information.
-
-
-
-
-
- Example
-
-
-{
- "location": {
- "lat": 48.829405,
- "lng": 2.367944
- },
- "location_type": "GEOMETRIC_CENTER"
-}
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesaddressgeometry.md b/dist/documentation/schemas/woosmap_http_schema_localitiesaddressgeometry.md
deleted file mode 100644
index 25d64986..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesaddressgeometry.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-
-LocalitiesAddressGeometry
-
-The location of the result, in latitude and longitude. Accuracy is also provided.
-
-| Field | Required | Type | Description |
-| :--------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| location | optional | [LatLngLiteral](#LatLngLiteral "LatLngLiteral") | See [LatLngLiteral](#LatLngLiteral "LatLngLiteral") for more information. |
-| location_type | optional | string | Specifies additional data about the geocoded location. The following values are currently supported:
ROOFTOP result is a precise geocode for which we have location information accurate down to street address precision.RANGE_INTERPOLATED result reflects an approximation (usually on a road) interpolated between two precise points (such as intersections). Interpolated results are generally returned when rooftop geocodes are unavailable for a street address.GEOMETRIC_CENTER result is the geometric center of a result such as a polyline (for example, a street) or polygon (city, region, …).APPROXIMATE result is approximate (usually when no other above value applies)POSTAL_CODE Address has inherited from the location of the postal code it is part of (for NYB addresses)DISTRICT Address has inherited from the location of the district it is part of (for NYB addresses)The allowed values include: `ROOFTOP`, `RANGE_INTERPOLATED`, `GEOMETRIC_CENTER`, `APPROXIMATE`, `POSTAL_CODE`, and `DISTRICT`
|
-| shape | optional | [GeoJsonGeometry](#GeoJsonGeometry "GeoJsonGeometry") | See [GeoJsonGeometry](#GeoJsonGeometry "GeoJsonGeometry") for more information. |
-| viewport | optional | [Bounds](#Bounds "Bounds") | See [Bounds](#Bounds "Bounds") for more information. |
-
-Example
-
-{
- "location": {
- "lat": 48.829405,
- "lng": 2.367944
- },
- "location_type": "GEOMETRIC_CENTER"
-}
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesaddresssummary.html b/dist/documentation/schemas/woosmap_http_schema_localitiesaddresssummary.html
deleted file mode 100644
index f3adf350..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesaddresssummary.html
+++ /dev/null
@@ -1,92 +0,0 @@
-
-
-
- LocalitiesAddressSummary
-
-A short description of an address
-
-
-
- Field
- Required
- Type
- Description
-
-
-
-
-
-
- description
-
-
- required
- string
-
-
-
A human readable description of the address
-
-
-
-
-
-
- public_id
-
-
- required
- string
-
-
-
- The public_id of the address can be used to gather details on that
- specific address
-
-
-
-
-
-
-
- Example
-
-
-{
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9faitia1pNNURnOWYvQmRjMUdweXl5SjdLZUZnPQ==",
- "description": "Flat 1, Radway House, Alfred Road, London, W2 5ER"
-}
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesaddresssummary.md b/dist/documentation/schemas/woosmap_http_schema_localitiesaddresssummary.md
deleted file mode 100644
index e92834b8..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesaddresssummary.md
+++ /dev/null
@@ -1,24 +0,0 @@
-
-
-LocalitiesAddressSummary
-
-A short description of an address
-
-| Field | Required | Type | Description |
-| :---------------------------------------------------------------------------------------------------------------------- | ------------ | ------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
-| description | **required** | string | A human readable description of the address
|
-| public_id | **required** | string | The public_id of the address can be used to gather details on that specific address
|
-
-Example
-
-{
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9faitia1pNNURnOWYvQmRjMUdweXl5SjdLZUZnPQ==",
- "description": "Flat 1, Radway House, Alfred Road, London, W2 5ER"
-}
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesautocompletecollectionresponse.html b/dist/documentation/schemas/woosmap_http_schema_localitiesautocompletecollectionresponse.html
deleted file mode 100644
index 425e97e2..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesautocompletecollectionresponse.html
+++ /dev/null
@@ -1,170 +0,0 @@
-
-
-
- LocalitiesAutocompleteCollectionResponse
-
-Localities Collection Response containing Localities
-
-
- Example
-
-
-{
- "localities": [
- {
- "public_id": "Ch6qA8cLmvyvEEoFy6nYeFcEdNU=",
- "type": "locality",
- "types": [
- "locality",
- "city"
- ],
- "description": "London, City of London, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 0,
- "length": 4
- }
- ]
- }
- },
- {
- "public_id": "m/T2C4YI2LgszkKXrELBC+9dfC8=",
- "type": "locality",
- "types": [
- "locality",
- "city"
- ],
- "description": "Derry/Londonderry, Derry City and Strabane, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 6,
- "length": 4
- }
- ]
- }
- },
- {
- "public_id": "J6eISGMjjvQwPkao8rsByB3aVwM=",
- "type": "locality",
- "types": [
- "locality",
- "village"
- ],
- "description": "London Colney, Hertfordshire, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 0,
- "length": 4
- }
- ]
- }
- },
- {
- "public_id": "52MnrbHVWH21CLWH8VY/YWKhqeM=",
- "type": "locality",
- "types": [
- "locality",
- "village"
- ],
- "description": "London Apprentice, Cornwall, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 0,
- "length": 4
- }
- ]
- }
- },
- {
- "public_id": "S/5AkUmMBhX35qVI2jR38+dALwk=",
- "type": "locality",
- "types": [
- "locality",
- "city"
- ],
- "description": "City of London, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 8,
- "length": 4
- }
- ]
- }
- }
- ]
-}
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesautocompletecollectionresponse.md b/dist/documentation/schemas/woosmap_http_schema_localitiesautocompletecollectionresponse.md
deleted file mode 100644
index 6bc77bf1..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesautocompletecollectionresponse.md
+++ /dev/null
@@ -1,108 +0,0 @@
-
-
-LocalitiesAutocompleteCollectionResponse
-
-Localities Collection Response containing Localities
-
-| Field | Required | Type | Description |
-| :------------------------------------------------------------------------------------------------------------------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
-| localities | optional | Array\<[LocalitiesAutocompleteResponse](#LocalitiesAutocompleteResponse "LocalitiesAutocompleteResponse")\> | See [LocalitiesAutocompleteResponse](#LocalitiesAutocompleteResponse "LocalitiesAutocompleteResponse") for more information. |
-
-Example
-
-{
- "localities": [
- {
- "public_id": "Ch6qA8cLmvyvEEoFy6nYeFcEdNU=",
- "type": "locality",
- "types": [
- "locality",
- "city"
- ],
- "description": "London, City of London, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 0,
- "length": 4
- }
- ]
- }
- },
- {
- "public_id": "m/T2C4YI2LgszkKXrELBC+9dfC8=",
- "type": "locality",
- "types": [
- "locality",
- "city"
- ],
- "description": "Derry/Londonderry, Derry City and Strabane, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 6,
- "length": 4
- }
- ]
- }
- },
- {
- "public_id": "J6eISGMjjvQwPkao8rsByB3aVwM=",
- "type": "locality",
- "types": [
- "locality",
- "village"
- ],
- "description": "London Colney, Hertfordshire, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 0,
- "length": 4
- }
- ]
- }
- },
- {
- "public_id": "52MnrbHVWH21CLWH8VY/YWKhqeM=",
- "type": "locality",
- "types": [
- "locality",
- "village"
- ],
- "description": "London Apprentice, Cornwall, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 0,
- "length": 4
- }
- ]
- }
- },
- {
- "public_id": "S/5AkUmMBhX35qVI2jR38+dALwk=",
- "type": "locality",
- "types": [
- "locality",
- "city"
- ],
- "description": "City of London, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 8,
- "length": 4
- }
- ]
- }
- }
- ]
-}
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesautocompletematchedfields.html b/dist/documentation/schemas/woosmap_http_schema_localitiesautocompletematchedfields.html
deleted file mode 100644
index a926efb1..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesautocompletematchedfields.html
+++ /dev/null
@@ -1,76 +0,0 @@
-
-
-
- LocalitiesAutocompleteMatchedFields
-
-
- Contains a set of substrings in the description field that match
- elements in the input. It can be used to highlight those
- substrings. Each substring is identified by an offset and a
- length.
-
-
-
-
- Field
- Required
- Type
- Description
-
-
-
-
-
-
- description
-
-
- optional
-
- Array<MatchedSubstring >
-
-
-
-
match substrings for localities description
-
- See MatchedSubstring for more
- information.
-
-
-
-
-
-
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesautocompletematchedfields.md b/dist/documentation/schemas/woosmap_http_schema_localitiesautocompletematchedfields.md
deleted file mode 100644
index 58fc561e..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesautocompletematchedfields.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-
-LocalitiesAutocompleteMatchedFields
-
-Contains a set of substrings in the `description` field that match elements in the `input`. It can be used to highlight those substrings. Each substring is identified by an `offset` and a `length`.
-
-| Field | Required | Type | Description |
-| :--------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| description | optional | Array\<[MatchedSubstring](#MatchedSubstring "MatchedSubstring")\> | match substrings for localities description
See MatchedSubstring for more information.
|
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesautocompleterelated.html b/dist/documentation/schemas/woosmap_http_schema_localitiesautocompleterelated.html
deleted file mode 100644
index 7eb29e3c..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesautocompleterelated.html
+++ /dev/null
@@ -1,76 +0,0 @@
-
-
-
-Contains a set of related elements to the locality suggestion.
-
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesautocompleterelated.md b/dist/documentation/schemas/woosmap_http_schema_localitiesautocompleterelated.md
deleted file mode 100644
index a272c16d..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesautocompleterelated.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-
-
-
-Contains a set of related elements to the locality suggestion.
-
-| Field | Required | Type | Description |
-| :----------------------------------------------------------------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| postal_codes | optional | Array\<[LocalitiesAutocompleteRelatedItem](#LocalitiesAutocompleteRelatedItem "LocalitiesAutocompleteRelatedItem")\> | |
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesautocompleterelateditem.html b/dist/documentation/schemas/woosmap_http_schema_localitiesautocompleterelateditem.html
deleted file mode 100644
index 3b0dd30b..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesautocompleterelateditem.html
+++ /dev/null
@@ -1,80 +0,0 @@
-
-
-
-Contains a set of related elements to the locality suggestion.
-
-
-
- Field
- Required
- Type
- Description
-
-
-
-
-
-
-
- optional
- string
-
-
-
Formatted description for the related Postal Code.
-
-
-
-
-
-
-
- optional
- string
-
-
-
Public ID of a related Postal Code.
-
-
-
-
-
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesautocompleterelateditem.md b/dist/documentation/schemas/woosmap_http_schema_localitiesautocompleterelateditem.md
deleted file mode 100644
index 6371a887..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesautocompleterelateditem.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-
-
-
-Contains a set of related elements to the locality suggestion.
-
-| Field | Required | Type | Description |
-| :------------------------------------------------------------------------------------------------------------------------------- | -------- | ------ | -------------------------------------------------------------------------------------------------------- |
-| | optional | string | Formatted description for the related Postal Code.
|
-| | optional | string | Public ID of a related Postal Code.
|
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesautocompleteresponse.html b/dist/documentation/schemas/woosmap_http_schema_localitiesautocompleteresponse.html
deleted file mode 100644
index 287f4c90..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesautocompleteresponse.html
+++ /dev/null
@@ -1,240 +0,0 @@
-
-
-
- LocalitiesAutocompleteResponse
-
-
- Attributes describing a locality. Not all attributes will be available for all
- locality types.
-
-
-
-
- Field
- Required
- Type
- Description
-
-
-
-
-
-
- description
-
-
- optional
- string
-
-
-
- Concatenation of name, admin_1,
- admin_0 to be used as suggestion in drop-down list if
- needed. The description can vary depending on the type requested.
-
-
-
-
-
-
-
- has_addresses
-
-
- optional
- boolean
-
-
-
- On the specific territory of United Kingdom, Localities autocomplete
- request can return the additional attribute
- has_addresses for a postal code, which indicates if a
- postal code bears addresses. When has_addresses is
- true, it is possible to display a list of the available
- addresses by requesting details with the Localities
- public_id. To get the details of an address you will
- need to request again /details endpoint passing in the
- dedicated address public_id.
-
-
-
-
-
-
-
- matched_substrings
-
-
- optional
-
- LocalitiesAutocompleteMatchedFields
-
-
- See
- LocalitiesAutocompleteMatchedFields
- for more information.
-
-
-
-
-
- public_id
-
-
- optional
- string
-
-
-
- Contains a unique ID for each suggestion. Please use this ID if you
- need to give us feedback on results. This ID is also required to
- perform a Localities Details Request.
-
-
-
-
-
-
-
-
- optional
-
- LocalitiesAutocompleteRelated
-
-
- See
- LocalitiesAutocompleteRelated
- for more information.
-
-
-
-
-
- type
-
-
- optional
- string
-
-
-
-
- This field might be removed in the future, please use the
- types field which is more exhaustive.
-
-
-
-
-
-
-
- types
-
-
- optional
-
- Array<LocalitiesTypesAll >
-
-
-
-
An array containing the types of the result
-
- See LocalitiesTypesAll for more
- information.
-
-
-
-
-
-
-
- Example
-
-
-{
- "public_id": "Ch6qA8cLmvyvEEoFy6nYeFcEdNU=",
- "description": "London, City of London, United Kingdom",
- "type": "locality",
- "matched_substrings": {
- "description": [
- {
- "offset": 0,
- "length": 6
- },
- {
- "offset": 16,
- "length": 6
- }
- ]
- }
-}
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesautocompleteresponse.md b/dist/documentation/schemas/woosmap_http_schema_localitiesautocompleteresponse.md
deleted file mode 100644
index b767ca56..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesautocompleteresponse.md
+++ /dev/null
@@ -1,42 +0,0 @@
-
-
-LocalitiesAutocompleteResponse
-
-Attributes describing a locality. Not all attributes will be available for all locality types.
-
-| Field | Required | Type | Description |
-| :-------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| description | optional | string | Concatenation of name, admin_1, admin_0 to be used as suggestion in drop-down list if needed. The description can vary depending on the type requested.
|
-| has_addresses | optional | boolean | On the specific territory of United Kingdom, Localities autocomplete request can return the additional attribute has_addresses for a postal code, which indicates if a postal code bears addresses. When has_addresses is true, it is possible to display a list of the available addresses by requesting details with the Localities public_id. To get the details of an address you will need to request again /details endpoint passing in the dedicated address public_id.
|
-| matched_substrings | optional | [LocalitiesAutocompleteMatchedFields](#LocalitiesAutocompleteMatchedFields "LocalitiesAutocompleteMatchedFields") | See [LocalitiesAutocompleteMatchedFields](#LocalitiesAutocompleteMatchedFields "LocalitiesAutocompleteMatchedFields") for more information. |
-| public_id | optional | string | Contains a unique ID for each suggestion. Please use this ID if you need to give us feedback on results. This ID is also required to perform a Localities Details Request.
|
-| | optional | [LocalitiesAutocompleteRelated](#LocalitiesAutocompleteRelated "LocalitiesAutocompleteRelated") | See [LocalitiesAutocompleteRelated](#LocalitiesAutocompleteRelated "LocalitiesAutocompleteRelated") for more information. |
-| type | optional | string | This field might be removed in the future, please use the types field which is more exhaustive.
|
-| types | optional | Array\<[LocalitiesTypesAll](#LocalitiesTypesAll "LocalitiesTypesAll")\> | |
-
-Example
-
-{
- "public_id": "Ch6qA8cLmvyvEEoFy6nYeFcEdNU=",
- "description": "London, City of London, United Kingdom",
- "type": "locality",
- "matched_substrings": {
- "description": [
- {
- "offset": 0,
- "length": 6
- },
- {
- "offset": 16,
- "length": 6
- }
- ]
- }
-}
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesdetailsresponse.html b/dist/documentation/schemas/woosmap_http_schema_localitiesdetailsresponse.html
deleted file mode 100644
index b3ec8795..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesdetailsresponse.html
+++ /dev/null
@@ -1,145 +0,0 @@
-
-
-
- LocalitiesDetailsResponse
-
-
- Attributes describing a locality. Not all attributes are available for all
- locality types.
-
-
-
-
- Field
- Required
- Type
- Description
-
-
-
-
-
-
- result
-
-
- optional
- object
-
-
-
The Root Node for Localities Details
-
-
-
-
-
-
- Example
-
-
-{
- "result": {
- "public_id": "cG9zdGFsX2NvZGU6Z2I6OmNDN0N0ZUF2MW9YRi9KLzlnS2cremJndktFaz0=",
- "types": [
- "postal_code"
- ],
- "formatted_address": "SW1A 0AA, City of London",
- "name": "SW1A 0AA",
- "geometry": {
- "location": {
- "lat": 51.499842,
- "lng": -0.124638
- },
- "accuracy": "GEOMETRIC_CENTER"
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United Kingdom",
- "short_name": "GB"
- },
- {
- "types": [
- "state",
- "division_level_1"
- ],
- "long_name": "England",
- "short_name": "England"
- },
- {
- "types": [
- "administrative_area_level_1",
- "county",
- "division_level_2"
- ],
- "long_name": "City of London",
- "short_name": "City of London"
- },
- {
- "types": [
- "district",
- "division_level_3"
- ],
- "long_name": "Westminster",
- "short_name": "Westminster"
- },
- {
- "types": [
- "postal_codes"
- ],
- "long_name": "SW1A 0AA",
- "short_name": "SW1A 0AA"
- }
- ],
- "addresses": {
- "pagination": {
- "page": 1,
- "page_count": 1,
- "addresses_per_page": 1,
- "address_count": 1
- },
- "list": [
- {
- "public_id": "TVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPV9fTVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPQ==",
- "description": "House Of Commons, Houses Of Parliament London, SW1A 0AA"
- }
- ]
- }
- }
-}
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesdetailsresponse.md b/dist/documentation/schemas/woosmap_http_schema_localitiesdetailsresponse.md
deleted file mode 100644
index 5d2053ac..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesdetailsresponse.md
+++ /dev/null
@@ -1,93 +0,0 @@
-
-
-LocalitiesDetailsResponse
-
-Attributes describing a locality. Not all attributes are available for all locality types.
-
-| Field | Required | Type | Description |
-| :------------------------------------------------------------------------------------------------------------- | -------- | ------ | ------------------------------------------------------------------------------------------ |
-| result | optional | object | The Root Node for Localities Details
|
-
-Example
-
-{
- "result": {
- "public_id": "cG9zdGFsX2NvZGU6Z2I6OmNDN0N0ZUF2MW9YRi9KLzlnS2cremJndktFaz0=",
- "types": [
- "postal_code"
- ],
- "formatted_address": "SW1A 0AA, City of London",
- "name": "SW1A 0AA",
- "geometry": {
- "location": {
- "lat": 51.499842,
- "lng": -0.124638
- },
- "accuracy": "GEOMETRIC_CENTER"
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United Kingdom",
- "short_name": "GB"
- },
- {
- "types": [
- "state",
- "division_level_1"
- ],
- "long_name": "England",
- "short_name": "England"
- },
- {
- "types": [
- "administrative_area_level_1",
- "county",
- "division_level_2"
- ],
- "long_name": "City of London",
- "short_name": "City of London"
- },
- {
- "types": [
- "district",
- "division_level_3"
- ],
- "long_name": "Westminster",
- "short_name": "Westminster"
- },
- {
- "types": [
- "postal_codes"
- ],
- "long_name": "SW1A 0AA",
- "short_name": "SW1A 0AA"
- }
- ],
- "addresses": {
- "pagination": {
- "page": 1,
- "page_count": 1,
- "addresses_per_page": 1,
- "address_count": 1
- },
- "list": [
- {
- "public_id": "TVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPV9fTVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPQ==",
- "description": "House Of Commons, Houses Of Parliament London, SW1A 0AA"
- }
- ]
- }
- }
-}
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesgeocodecollectionresponse.html b/dist/documentation/schemas/woosmap_http_schema_localitiesgeocodecollectionresponse.html
deleted file mode 100644
index 38fcc815..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesgeocodecollectionresponse.html
+++ /dev/null
@@ -1,154 +0,0 @@
-
-
-
- LocalitiesGeocodeCollectionResponse
-
-
- Localities Geocode Collection Response. Contains one or more detailed
- Localities or Addresses in FR or in the UK, with coordinates (default to one
- result for reverse geocoding)
-
-
-
- Example
-
-
-{
- "results": [
- {
- "public_id": "0+FTYd/1MsiBSxLAKq+/Fiyy+uM=",
- "types": [
- "address",
- "route"
- ],
- "formatted_address": "Place Jeanne D'Arc, 75013, Paris",
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "France",
- "short_name": "FR"
- },
- {
- "types": [
- "state",
- "division_level_1"
- ],
- "long_name": "Île-de-France",
- "short_name": "Île-de-France"
- },
- {
- "types": [
- "administrative_area_level_1",
- "county",
- "division_level_2"
- ],
- "long_name": "Paris",
- "short_name": "Paris"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "Paris",
- "short_name": "Paris"
- },
- {
- "types": [
- "postal_codes"
- ],
- "long_name": "75013",
- "short_name": "75013"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Place Jeanne D'Arc",
- "short_name": "Place Jeanne D'Arc"
- }
- ],
- "geometry": {
- "location": {
- "lat": 48.829405,
- "lng": 2.367944
- },
- "location_type": "GEOMETRIC_CENTER"
- },
- "scores_per_components": {
- "street_name": 1
- }
- }
- ]
-}
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesgeocodecollectionresponse.md b/dist/documentation/schemas/woosmap_http_schema_localitiesgeocodecollectionresponse.md
deleted file mode 100644
index 82fdc379..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesgeocodecollectionresponse.md
+++ /dev/null
@@ -1,90 +0,0 @@
-
-
-LocalitiesGeocodeCollectionResponse
-
-Localities Geocode Collection Response. Contains one or more detailed Localities or Addresses in FR or in the UK, with coordinates (default to one result for reverse geocoding)
-
-| Field | Required | Type | Description |
-| :------------------------------------------------------------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
-| results | optional | Array\<[LocalitiesGeocodeResponse](#LocalitiesGeocodeResponse "LocalitiesGeocodeResponse")\> | See [LocalitiesGeocodeResponse](#LocalitiesGeocodeResponse "LocalitiesGeocodeResponse") for more information. |
-
-Example
-
-{
- "results": [
- {
- "public_id": "0+FTYd/1MsiBSxLAKq+/Fiyy+uM=",
- "types": [
- "address",
- "route"
- ],
- "formatted_address": "Place Jeanne D'Arc, 75013, Paris",
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "France",
- "short_name": "FR"
- },
- {
- "types": [
- "state",
- "division_level_1"
- ],
- "long_name": "Île-de-France",
- "short_name": "Île-de-France"
- },
- {
- "types": [
- "administrative_area_level_1",
- "county",
- "division_level_2"
- ],
- "long_name": "Paris",
- "short_name": "Paris"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "Paris",
- "short_name": "Paris"
- },
- {
- "types": [
- "postal_codes"
- ],
- "long_name": "75013",
- "short_name": "75013"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Place Jeanne D'Arc",
- "short_name": "Place Jeanne D'Arc"
- }
- ],
- "geometry": {
- "location": {
- "lat": 48.829405,
- "lng": 2.367944
- },
- "location_type": "GEOMETRIC_CENTER"
- },
- "scores_per_components": {
- "street_name": 1
- }
- }
- ]
-}
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesgeocoderesponse.html b/dist/documentation/schemas/woosmap_http_schema_localitiesgeocoderesponse.html
deleted file mode 100644
index f7cb61c9..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesgeocoderesponse.html
+++ /dev/null
@@ -1,297 +0,0 @@
-
-
-
- LocalitiesGeocodeResponse
-
-
- Attributes describing a locality. Not all attributes will be available for all
- locality types.
-
-
-
-
- Field
- Required
- Type
- Description
-
-
-
-
-
-
- address_components
-
-
- optional
-
- AddressComponents
-
-
- See
- AddressComponents
- for more information.
-
-
-
-
-
- administrative_area_label
-
-
- optional
-
- AdministrativeAreaLabel
-
-
- See
- AdministrativeAreaLabel
- for more information.
-
-
-
-
-
- distance
-
-
- optional
- number
-
-
-
- When reverse geocoding, this field represents the distance (in
- meter) to the requested latlng
-
-
-
-
-
-
-
-
- optional
-
- FormattedAddress
-
-
- See
- FormattedAddress
- for more information.
-
-
-
-
-
- geometry
-
-
- optional
-
- LocalitiesAddressGeometry
-
-
- See
- LocalitiesAddressGeometry
- for more information.
-
-
-
-
-
- public_id
-
-
- optional
- string
-
-
-
- Contains a unique ID for each suggestion. Please use this ID to give
- feedback on results.
-
-
-
-
-
-
-
- scores_per_components
-
-
- optional
-
- LocalitiesScoresPerComponents
-
-
-
-
- For each component (street_name, postal_code, and locality), it
- indicates the degree of correspondence with the original query. This
- value ranges from 0 to 1, with 0 indicating no match with the
- original query, and enables you to assess the quality of the
- Geocode's result.
-
-
- See
- LocalitiesScoresPerComponents
- for more information.
-
-
-
-
-
-
-
- status
-
-
- optional
-
- LocalitiesStatus
-
-
- See
- LocalitiesStatus
- for more information.
-
-
-
-
-
- sub_buildings
-
-
- optional
-
- Array<LocalitiesAddressSummary >
-
-
-
-
- When reverse geocoding with list_sub_buildings=true,
- this field will contain a list of precise addresses that can be
- found at that location, i.e. all flats within a building.
-
-
- See
- LocalitiesAddressSummary for
- more information.
-
-
-
-
-
-
-
- types
-
-
- optional
-
- Array<LocalitiesTypesAll >
-
-
-
-
An array containing the types of the result
-
- See LocalitiesTypesAll for more
- information.
-
-
-
-
-
-
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesgeocoderesponse.md b/dist/documentation/schemas/woosmap_http_schema_localitiesgeocoderesponse.md
deleted file mode 100644
index 5b3ac003..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesgeocoderesponse.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-
-LocalitiesGeocodeResponse
-
-Attributes describing a locality. Not all attributes will be available for all locality types.
-
-| Field | Required | Type | Description |
-| :--------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| address_components | optional | [AddressComponents](#AddressComponents "AddressComponents") | See [AddressComponents](#AddressComponents "AddressComponents") for more information. |
-| administrative_area_label | optional | [AdministrativeAreaLabel](#AdministrativeAreaLabel "AdministrativeAreaLabel") | See [AdministrativeAreaLabel](#AdministrativeAreaLabel "AdministrativeAreaLabel") for more information. |
-| distance | optional | number | When reverse geocoding, this field represents the distance (in meter) to the requested latlng
|
-| | optional | [FormattedAddress](#FormattedAddress "FormattedAddress") | See [FormattedAddress](#FormattedAddress "FormattedAddress") for more information. |
-| geometry | optional | [LocalitiesAddressGeometry](#LocalitiesAddressGeometry "LocalitiesAddressGeometry") | See [LocalitiesAddressGeometry](#LocalitiesAddressGeometry "LocalitiesAddressGeometry") for more information. |
-| public_id | optional | string | Contains a unique ID for each suggestion. Please use this ID to give feedback on results.
|
-| scores_per_components | optional | [LocalitiesScoresPerComponents](#LocalitiesScoresPerComponents "LocalitiesScoresPerComponents") | For each component (street_name, postal_code, and locality), it indicates the degree of correspondence with the original query. This value ranges from 0 to 1, with 0 indicating no match with the original query, and enables you to assess the quality of the Geocode's result.
See LocalitiesScoresPerComponents for more information.
|
-| status | optional | [LocalitiesStatus](#LocalitiesStatus "LocalitiesStatus") | See [LocalitiesStatus](#LocalitiesStatus "LocalitiesStatus") for more information. |
-| sub_buildings | optional | Array\<[LocalitiesAddressSummary](#LocalitiesAddressSummary "LocalitiesAddressSummary")\> | When reverse geocoding with list_sub_buildings=true, this field will contain a list of precise addresses that can be found at that location, i.e. all flats within a building.
See LocalitiesAddressSummary for more information.
|
-| types | optional | Array\<[LocalitiesTypesAll](#LocalitiesTypesAll "LocalitiesTypesAll")\> | |
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesnearbycollectionresponse.html b/dist/documentation/schemas/woosmap_http_schema_localitiesnearbycollectionresponse.html
deleted file mode 100644
index 9c8b10f7..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesnearbycollectionresponse.html
+++ /dev/null
@@ -1,502 +0,0 @@
-
-
-
- LocalitiesNearbyCollectionResponse
-
-Collection of nearby points of interest.
-
-
-
- Field
- Required
- Type
- Description
-
-
-
-
-
-
-
- optional
- object
-
-
-
Helps to navigate through paginated results.
-
-
-
-
-
-
- results
-
-
- optional
-
- Array<LocalitiesNearbyResponse >
-
-
-
-
-
-
-
-
- Example
-
-
-{
- "results": [
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6ZTc2ZDA1YzBiM2M0M2NmNmVkNTJjNGQyZDFiZDE3Nzc0OTZkNjlmOA==",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.fast_food"
- ],
- "categories": [
- "business.food_and_drinks.fast_food"
- ],
- "name": "Pret A Manger",
- "formatted_address": "Broadway, New York",
- "geometry": {
- "location": {
- "lat": 40.715905992166256,
- "lng": -74.00508673226767
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Broadway",
- "short_name": "Broadway"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6MzBlMGYxMzVhNGUzZDQ4MzRiMmNlNDMzMWJiYjZkOTY0MWJhN2E0Zg==",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.fast_food"
- ],
- "categories": [
- "business.food_and_drinks.fast_food"
- ],
- "name": "Dunkin'",
- "formatted_address": "Broadway, New York",
- "geometry": {
- "location": {
- "lat": 40.71602115951586,
- "lng": -74.00494482664695
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Broadway",
- "short_name": "Broadway"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmJlMWNkMTE2ZDQwM2E0Y2YwNGQ5NWQ2OTlmZWRmM2FhZTExNGU3ZWY=",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.restaurant"
- ],
- "categories": [
- "business.food_and_drinks.restaurant"
- ],
- "name": "Chambers",
- "formatted_address": "Chambers Street, New York",
- "geometry": {
- "location": {
- "lat": 40.71461844801976,
- "lng": -74.00754036678366
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Chambers Street",
- "short_name": "Chambers Street"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLnNob3AuZ3JvY2VyeTo1YTczMjYxOTQyYjVlZmUwOGEzZjQ1NGZmMTMwMmJjNjA4ODE3NmRk",
- "types": [
- "point_of_interest",
- "business.shop.grocery"
- ],
- "categories": [
- "business.shop.grocery"
- ],
- "name": "City Hall Oasis",
- "geometry": {
- "location": {
- "lat": 40.71283012706819,
- "lng": -74.00727837935057
- },
- "viewport": {
- "northeast": {
- "lat": 40.71286059528623,
- "lng": -74.00724213866874
- },
- "southwest": {
- "lat": 40.71279957503111,
- "lng": -74.00731464213119
- }
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZpbmFuY2UuYmFuazpiOGY5MDE4Nzc2ZDZjNmEwZTljOGM4YWM0OTAxZWZlNzNmODZkM2M3",
- "types": [
- "point_of_interest",
- "business.finance.bank"
- ],
- "categories": [
- "business.finance.bank"
- ],
- "name": "Citibank",
- "formatted_address": "Broadway, New York",
- "geometry": {
- "location": {
- "lat": 40.7130414767567,
- "lng": -74.0074818610995
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Broadway",
- "short_name": "Broadway"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQzMTMzZTJkODdiOGJjMGE3ZjI2YTdiMWVjYTZlZmI1MjQyYWE3MTE=",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.restaurant"
- ],
- "categories": [
- "business.food_and_drinks.restaurant"
- ],
- "name": "Saffron",
- "geometry": {
- "location": {
- "lat": 40.71467049963849,
- "lng": -74.00767187884445
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQ1NjMyN2RiM2EyNWJlYmIwNjJjZjNlYWYwMDE3ZDIyYzEyNWNlMjY=",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.restaurant"
- ],
- "categories": [
- "business.food_and_drinks.restaurant"
- ],
- "name": "Gran Morsi",
- "geometry": {
- "location": {
- "lat": 40.71432885326513,
- "lng": -74.00778746528921
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5iYXI6MDE5ZGUzNTdiZDkyNzAyZDM4ZDUyOWQ0YmJiZjBmODQ5YWEzZmY1NA==",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.bar"
- ],
- "categories": [
- "business.food_and_drinks.bar"
- ],
- "name": "Bon Courage",
- "formatted_address": "Reade Street, New York",
- "geometry": {
- "location": {
- "lat": 40.71541472882126,
- "lng": -74.00719193106873
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Reade Street",
- "short_name": "Reade Street"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6OGIyNDY5MDM4M2JhYzE1NmY4OGRiMGQzYmIyYzNjMTVmOTk0NDQwZQ==",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.fast_food"
- ],
- "categories": [
- "business.food_and_drinks.fast_food"
- ],
- "name": "Burger King",
- "formatted_address": "Broadway, New York",
- "geometry": {
- "location": {
- "lat": 40.71619516782573,
- "lng": -74.00480635760651
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Broadway",
- "short_name": "Broadway"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLnRoZWF0cmU6MTU1Yjk5YmEwY2FiYzIzZjYxYWYyYTViYzI0ZDViYTVlNmVmZTAwNA==",
- "types": [
- "point_of_interest",
- "business.theatre"
- ],
- "categories": [
- "business.theatre"
- ],
- "name": "The Flea",
- "formatted_address": "Thomas Street, New York",
- "geometry": {
- "location": {
- "lat": 40.71609349534023,
- "lng": -74.00589281989586
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Thomas Street",
- "short_name": "Thomas Street"
- }
- ]
- }
- ],
- "pagination": {
- "previous_page": 2,
- "next_page": 4
- }
-}
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesnearbycollectionresponse.md b/dist/documentation/schemas/woosmap_http_schema_localitiesnearbycollectionresponse.md
deleted file mode 100644
index 4e6d50a9..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesnearbycollectionresponse.md
+++ /dev/null
@@ -1,423 +0,0 @@
-
-
-LocalitiesNearbyCollectionResponse
-
-Collection of nearby points of interest.
-
-| Field | Required | Type | Description |
-| :------------------------------------------------------------------------------------------------------------------------------ | -------- | ----------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| | optional | object | Helps to navigate through paginated results.
|
-| results | optional | Array\<[LocalitiesNearbyResponse](#LocalitiesNearbyResponse "LocalitiesNearbyResponse")\> | |
-
-Example
-
-{
- "results": [
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6ZTc2ZDA1YzBiM2M0M2NmNmVkNTJjNGQyZDFiZDE3Nzc0OTZkNjlmOA==",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.fast_food"
- ],
- "categories": [
- "business.food_and_drinks.fast_food"
- ],
- "name": "Pret A Manger",
- "formatted_address": "Broadway, New York",
- "geometry": {
- "location": {
- "lat": 40.715905992166256,
- "lng": -74.00508673226767
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Broadway",
- "short_name": "Broadway"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6MzBlMGYxMzVhNGUzZDQ4MzRiMmNlNDMzMWJiYjZkOTY0MWJhN2E0Zg==",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.fast_food"
- ],
- "categories": [
- "business.food_and_drinks.fast_food"
- ],
- "name": "Dunkin'",
- "formatted_address": "Broadway, New York",
- "geometry": {
- "location": {
- "lat": 40.71602115951586,
- "lng": -74.00494482664695
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Broadway",
- "short_name": "Broadway"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmJlMWNkMTE2ZDQwM2E0Y2YwNGQ5NWQ2OTlmZWRmM2FhZTExNGU3ZWY=",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.restaurant"
- ],
- "categories": [
- "business.food_and_drinks.restaurant"
- ],
- "name": "Chambers",
- "formatted_address": "Chambers Street, New York",
- "geometry": {
- "location": {
- "lat": 40.71461844801976,
- "lng": -74.00754036678366
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Chambers Street",
- "short_name": "Chambers Street"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLnNob3AuZ3JvY2VyeTo1YTczMjYxOTQyYjVlZmUwOGEzZjQ1NGZmMTMwMmJjNjA4ODE3NmRk",
- "types": [
- "point_of_interest",
- "business.shop.grocery"
- ],
- "categories": [
- "business.shop.grocery"
- ],
- "name": "City Hall Oasis",
- "geometry": {
- "location": {
- "lat": 40.71283012706819,
- "lng": -74.00727837935057
- },
- "viewport": {
- "northeast": {
- "lat": 40.71286059528623,
- "lng": -74.00724213866874
- },
- "southwest": {
- "lat": 40.71279957503111,
- "lng": -74.00731464213119
- }
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZpbmFuY2UuYmFuazpiOGY5MDE4Nzc2ZDZjNmEwZTljOGM4YWM0OTAxZWZlNzNmODZkM2M3",
- "types": [
- "point_of_interest",
- "business.finance.bank"
- ],
- "categories": [
- "business.finance.bank"
- ],
- "name": "Citibank",
- "formatted_address": "Broadway, New York",
- "geometry": {
- "location": {
- "lat": 40.7130414767567,
- "lng": -74.0074818610995
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Broadway",
- "short_name": "Broadway"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQzMTMzZTJkODdiOGJjMGE3ZjI2YTdiMWVjYTZlZmI1MjQyYWE3MTE=",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.restaurant"
- ],
- "categories": [
- "business.food_and_drinks.restaurant"
- ],
- "name": "Saffron",
- "geometry": {
- "location": {
- "lat": 40.71467049963849,
- "lng": -74.00767187884445
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQ1NjMyN2RiM2EyNWJlYmIwNjJjZjNlYWYwMDE3ZDIyYzEyNWNlMjY=",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.restaurant"
- ],
- "categories": [
- "business.food_and_drinks.restaurant"
- ],
- "name": "Gran Morsi",
- "geometry": {
- "location": {
- "lat": 40.71432885326513,
- "lng": -74.00778746528921
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5iYXI6MDE5ZGUzNTdiZDkyNzAyZDM4ZDUyOWQ0YmJiZjBmODQ5YWEzZmY1NA==",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.bar"
- ],
- "categories": [
- "business.food_and_drinks.bar"
- ],
- "name": "Bon Courage",
- "formatted_address": "Reade Street, New York",
- "geometry": {
- "location": {
- "lat": 40.71541472882126,
- "lng": -74.00719193106873
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Reade Street",
- "short_name": "Reade Street"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6OGIyNDY5MDM4M2JhYzE1NmY4OGRiMGQzYmIyYzNjMTVmOTk0NDQwZQ==",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.fast_food"
- ],
- "categories": [
- "business.food_and_drinks.fast_food"
- ],
- "name": "Burger King",
- "formatted_address": "Broadway, New York",
- "geometry": {
- "location": {
- "lat": 40.71619516782573,
- "lng": -74.00480635760651
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Broadway",
- "short_name": "Broadway"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLnRoZWF0cmU6MTU1Yjk5YmEwY2FiYzIzZjYxYWYyYTViYzI0ZDViYTVlNmVmZTAwNA==",
- "types": [
- "point_of_interest",
- "business.theatre"
- ],
- "categories": [
- "business.theatre"
- ],
- "name": "The Flea",
- "formatted_address": "Thomas Street, New York",
- "geometry": {
- "location": {
- "lat": 40.71609349534023,
- "lng": -74.00589281989586
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Thomas Street",
- "short_name": "Thomas Street"
- }
- ]
- }
- ],
- "pagination": {
- "previous_page": 2,
- "next_page": 4
- }
-}
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesnearbyresponse.html b/dist/documentation/schemas/woosmap_http_schema_localitiesnearbyresponse.html
deleted file mode 100644
index 917568e7..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesnearbyresponse.html
+++ /dev/null
@@ -1,203 +0,0 @@
-
-
-
- LocalitiesNearbyResponse
-
-Attributes describing a point of interest.
-
-
-
- Field
- Required
- Type
- Description
-
-
-
-
-
-
- address_components
-
-
- optional
-
- AddressComponents
-
-
- See
- AddressComponents
- for more information.
-
-
-
-
-
- categories
-
-
- optional
-
- Array<LocalitiesTypesPoi >
-
-
-
-
- An array containing the categories of the result. This information
- is now available in the types field and will be
- removed.
-
-
- See LocalitiesTypesPoi for more
- information.
-
-
-
-
-
-
-
-
- optional
-
- FormattedAddress
-
-
- See
- FormattedAddress
- for more information.
-
-
-
-
-
- geometry
-
-
- optional
- object
-
-
-
- The location of the result, in latitude and longitude, eventually
- associated with a Viewport.
-
-
-
-
-
-
-
- name
-
-
- optional
- string
-
-
-
The name of the result.
-
-
-
-
-
-
- public_id
-
-
- optional
- string
-
-
-
- Contains a unique ID for each result. Please use this ID to give
- feedback on results.
-
-
-
-
-
-
-
- types
-
-
- optional
-
- Array<LocalitiesTypesPoi >
-
-
-
-
An array containing the types of the result.
-
- See LocalitiesTypesPoi for more
- information.
-
-
-
-
-
-
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesnearbyresponse.md b/dist/documentation/schemas/woosmap_http_schema_localitiesnearbyresponse.md
deleted file mode 100644
index d866091f..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesnearbyresponse.md
+++ /dev/null
@@ -1,22 +0,0 @@
-
-
-LocalitiesNearbyResponse
-
-Attributes describing a point of interest.
-
-| Field | Required | Type | Description |
-| :-------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| address_components | optional | [AddressComponents](#AddressComponents "AddressComponents") | See [AddressComponents](#AddressComponents "AddressComponents") for more information. |
-| categories | optional | Array\<[LocalitiesTypesPoi](#LocalitiesTypesPoi "LocalitiesTypesPoi")\> | An array containing the categories of the result. This information is now available in the types field and will be removed.
See LocalitiesTypesPoi for more information.
|
-| | optional | [FormattedAddress](#FormattedAddress "FormattedAddress") | See [FormattedAddress](#FormattedAddress "FormattedAddress") for more information. |
-| geometry | optional | object | The location of the result, in latitude and longitude, eventually associated with a Viewport.
|
-| name | optional | string | |
-| public_id | optional | string | Contains a unique ID for each result. Please use this ID to give feedback on results.
|
-| types | optional | Array\<[LocalitiesTypesPoi](#LocalitiesTypesPoi "LocalitiesTypesPoi")\> | |
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesscorespercomponents.html b/dist/documentation/schemas/woosmap_http_schema_localitiesscorespercomponents.html
deleted file mode 100644
index 78ece0fe..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesscorespercomponents.html
+++ /dev/null
@@ -1,102 +0,0 @@
-
-
-
- LocalitiesScoresPerComponents
-
-
-
-
- Field
- Required
- Type
- Description
-
-
-
-
-
-
- locality
-
-
- optional
- number
-
-
-
-
-
-
-
- postal_code
-
-
- optional
- number
-
-
-
-
-
-
-
- street_name
-
-
- optional
- number
-
-
-
-
-
-
-
- Example
-
-
-{
- "scores_per_components": {
- "street_name": 0.6153846153846154,
- "postal_code": 0.8,
- "locality": 1
- }
-}
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesscorespercomponents.md b/dist/documentation/schemas/woosmap_http_schema_localitiesscorespercomponents.md
deleted file mode 100644
index 985c183d..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesscorespercomponents.md
+++ /dev/null
@@ -1,26 +0,0 @@
-
-
-LocalitiesScoresPerComponents
-
-| Field | Required | Type | Description |
-| :--------------------------------------------------------------------------------------------------------------------------- | -------- | ------ | ----------------------------------------------------------------------- |
-| locality | optional | number | |
-| postal_code | optional | number | |
-| street_name | optional | number | |
-
-Example
-
-{
- "scores_per_components": {
- "street_name": 0.6153846153846154,
- "postal_code": 0.8,
- "locality": 1
- }
-}
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesstatus.html b/dist/documentation/schemas/woosmap_http_schema_localitiesstatus.html
deleted file mode 100644
index ade0e4a3..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesstatus.html
+++ /dev/null
@@ -1,35 +0,0 @@
-
-
-LocalitiesStatus
-
- This optional field is only available for UK addresses referenced as not yet
- built by Royal Mail.
-
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiesstatus.md b/dist/documentation/schemas/woosmap_http_schema_localitiesstatus.md
deleted file mode 100644
index 47810b3f..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiesstatus.md
+++ /dev/null
@@ -1,12 +0,0 @@
-
-
-LocalitiesStatus
-
-This optional field is only available for UK addresses referenced as not yet built by Royal Mail.
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiestypes.html b/dist/documentation/schemas/woosmap_http_schema_localitiestypes.html
deleted file mode 100644
index e64fe12e..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiestypes.html
+++ /dev/null
@@ -1,37 +0,0 @@
-
-
-LocalitiesTypes
-
- Common types unrelated to points of interest (POI). The
- locality type serves as an alias grouping various settlement
- types (see enum for details). This grouping enables flexible and
- efficient querying of related geographic data.
-
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiestypes.md b/dist/documentation/schemas/woosmap_http_schema_localitiestypes.md
deleted file mode 100644
index c9fc7857..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiestypes.md
+++ /dev/null
@@ -1,12 +0,0 @@
-
-
-LocalitiesTypes
-
-Common types unrelated to points of interest (POI). The `locality` type serves as an alias grouping various settlement types (see `enum` for details). This grouping enables flexible and efficient querying of related geographic data.
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiestypesall.html b/dist/documentation/schemas/woosmap_http_schema_localitiestypesall.html
deleted file mode 100644
index a380ff46..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiestypesall.html
+++ /dev/null
@@ -1,37 +0,0 @@
-
-
-LocalitiesTypesAll
-
- A comprehensive string type that encompasses all supported locality
- classifications. This includes standard locality types (e.g., cities,
- regions), points of interest (POI) categories, and POI aliases for flexible
- geographic data representation and querying.
-
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiestypesall.md b/dist/documentation/schemas/woosmap_http_schema_localitiestypesall.md
deleted file mode 100644
index b4e67575..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiestypesall.md
+++ /dev/null
@@ -1,12 +0,0 @@
-
-
-LocalitiesTypesAll
-
-A comprehensive string type that encompasses all supported locality classifications. This includes standard locality types (e.g., cities, regions), points of interest (POI) categories, and POI aliases for flexible geographic data representation and querying.
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiestypespoi.html b/dist/documentation/schemas/woosmap_http_schema_localitiestypespoi.html
deleted file mode 100644
index ab457cc3..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiestypespoi.html
+++ /dev/null
@@ -1,35 +0,0 @@
-
-
-LocalitiesTypesPoi
-
- Categories of points of interest (POI) supported for detailed classification
- in geographic data queries.
-
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiestypespoi.md b/dist/documentation/schemas/woosmap_http_schema_localitiestypespoi.md
deleted file mode 100644
index 033d0b13..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiestypespoi.md
+++ /dev/null
@@ -1,12 +0,0 @@
-
-
-LocalitiesTypesPoi
-
-Categories of points of interest (POI) supported for detailed classification in geographic data queries.
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiestypespoialias.html b/dist/documentation/schemas/woosmap_http_schema_localitiestypespoialias.html
deleted file mode 100644
index 68a06b60..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiestypespoialias.html
+++ /dev/null
@@ -1,43 +0,0 @@
-
-
-
- LocalitiesTypesPoiAlias
-
-
- Aliases for some point_of_interest types. These aliases are deprecated and
- should be replaced with the corresponding types in
- LocalitiesTypesPoi. For example:
-
-
- airport → transit.station.airport
- train_station → transit.station.rail.train
-
-This ensures consistency and alignment with the updated schema.
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_localitiestypespoialias.md b/dist/documentation/schemas/woosmap_http_schema_localitiestypespoialias.md
deleted file mode 100644
index fdd347f0..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_localitiestypespoialias.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-
-LocalitiesTypesPoiAlias
-
-Aliases for some point_of_interest types. These aliases are deprecated and should be replaced with the corresponding types in `LocalitiesTypesPoi`. For example:
-
-- `airport` → `transit.station.airport`
-- `train_station` → `transit.station.rail.train`
-
-This ensures consistency and alignment with the updated schema.
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_position.html b/dist/documentation/schemas/woosmap_http_schema_position.html
deleted file mode 100644
index d8ff5add..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_position.html
+++ /dev/null
@@ -1,32 +0,0 @@
-
-
-Position
-an array containing longitude, latitude, in that order.
-
- Generated from the
- OpenAPI specification .
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_position.md b/dist/documentation/schemas/woosmap_http_schema_position.md
deleted file mode 100644
index ed171fd7..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_position.md
+++ /dev/null
@@ -1,12 +0,0 @@
-
-
-Position
-
-an array containing longitude, latitude, in that order.
-
-Generated from the OpenAPI specification .
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/merged-woosmap-openapi3.json b/dist/merged-woosmap-openapi3.json
index 8a805aa4..e33254d1 100755
--- a/dist/merged-woosmap-openapi3.json
+++ b/dist/merged-woosmap-openapi3.json
@@ -15,7 +15,7 @@
"tags": [
{
"name": "Search",
- "description": "Store Search lets you query the Assets which are returned as a [GeoJson](https://geojson.org/). Request is done over HTTPS using GET. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/support/api-keys/). If your request returns a high number of assets, the result will be paginated. If so, you can request assets by page using `page` and `stores_by_page` parameters (Default is **100**, max is **300**).\n",
+ "description": "Store Search lets you query the Assets which are returned as a [GeoJson](https://geojson.org/). Request is done over HTTPS using GET. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/api-reference/authentication/). If your request returns a high number of assets, the result will be paginated. If so, you can request assets by page using `page` and `stores_by_page` parameters (Default is **100**, max is **300**).\n",
"externalDocs": {
"url": "https://developers.woosmap.com/products/stores-api/overview/"
}
@@ -36,18 +36,11 @@
},
{
"name": "Geolocation API",
- "description": "Geolocation API returns a location (or nearby stores) and accuracy radius based on an IP address. Request is done over HTTPS using GET. Response is formatted as JSON. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/support/api-keys/).\n",
+ "description": "Geolocation API returns a location (or nearby stores) and accuracy radius based on an IP address. Request is done over HTTPS using GET. Response is formatted as JSON. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/api-reference/authentication/).\n",
"externalDocs": {
"url": "https://developers.woosmap.com/products/geolocation-api/location/"
}
},
- {
- "name": "Localities API",
- "description": "Woosmap Localities API is a web service that returns a great amount of geographical places in response to an HTTP request. Among others are city names, postal codes, suburbs, addresses or airports. Request is done over HTTPS using GET. Response is formatted as JSON. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/support/api-keys/).\n",
- "externalDocs": {
- "url": "https://developers.woosmap.com/products/localities/get-started/"
- }
- },
{
"name": "Store Search"
},
@@ -99,6 +92,10 @@
"externalDocs": {
"url": "https://developers.woosmap.com/products/distance-api/get-started/"
}
+ },
+ {
+ "name": "Localities API",
+ "description": "Worldwide address, locality, postal code and POI search: autocomplete, geocode, details and nearby."
}
],
"paths": {
@@ -1245,7 +1242,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_application_kit__fastapi__responses__HTTPErrorModel"
}
}
}
@@ -1377,7 +1374,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_application_kit__fastapi__responses__HTTPErrorModel"
}
}
}
@@ -1507,7 +1504,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_application_kit__fastapi__responses__HTTPErrorModel"
}
}
}
@@ -1637,7 +1634,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_application_kit__fastapi__responses__HTTPErrorModel"
}
}
}
@@ -1745,7 +1742,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_application_kit__fastapi__responses__HTTPErrorModel"
}
}
}
@@ -1868,7 +1865,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_application_kit__fastapi__responses__HTTPErrorModel"
}
}
}
@@ -1991,7 +1988,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_application_kit__fastapi__responses__HTTPErrorModel"
}
}
}
@@ -2085,7 +2082,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_application_kit__fastapi__responses__HTTPErrorModel"
}
}
}
@@ -2263,7 +2260,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_application_kit__fastapi__responses__HTTPErrorModel"
}
}
}
@@ -2526,7 +2523,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_application_kit__fastapi__responses__HTTPErrorModel"
}
}
}
@@ -2789,7 +2786,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_application_kit__fastapi__responses__HTTPErrorModel"
}
}
}
@@ -3052,7 +3049,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_application_kit__fastapi__responses__HTTPErrorModel"
}
}
}
@@ -3265,7 +3262,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_application_kit__fastapi__responses__HTTPErrorModel"
}
}
}
@@ -3431,7 +3428,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_application_kit__fastapi__responses__HTTPErrorModel"
}
}
}
@@ -8171,76 +8168,254 @@
"/localities/autocomplete": {
"servers": [
{
- "url": "https://api.woosmap.com"
+ "url": "https://api.woosmap.com",
+ "description": "Production"
}
],
"get": {
- "summary": "Autocomplete for Localities",
- "operationId": "localitiesAutocomplete",
- "servers": [
- {
- "url": "https://api.woosmap.com"
- }
- ],
"tags": [
"Localities API"
],
- "description": "Autocomplete on worldwide suggestions for text-based geographic searches. It can match on full words as well as substrings. You can therefore send queries as the user types, to provide on-the-fly addresses, city names, postal codes or suburb name suggestions.\n",
+ "summary": "Autocomplete",
+ "description": "Returns worldwide place suggestions for a text query, matching on whole words or substrings. Designed for as-you-type input: addresses, cities, postal codes, suburbs, and more.\n\n**Ratelimit:** 50/1s",
+ "operationId": "autocomplete_localities_autocomplete_get",
"security": [
{
- "Woosmap_Platform_API_Reference_PublicApiKeyAuth": [],
- "Woosmap_Platform_API_Reference_RefererHeader": []
+ "Localities_PublicAPIKey": []
},
{
- "Woosmap_Platform_API_Reference_PrivateApiKeyAuth": []
+ "Localities_PrivateApiKey": []
},
{
- "Woosmap_Platform_API_Reference_PrivateApiKeyHeaderAuth": []
+ "Localities_PrivateApiKeyHeader": []
}
],
"parameters": [
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_input"
+ "name": "language",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "description": "Language code (ISO 639-1, two letters) for the response.\n\nResolution order:\n1. `language` (this parameter)\n2. The request's `Accept-Language` header\n3. locale default\n4. English (when neither is recognised)\n\nOnly part of the address components are translated; not required for postal-code requests.",
+ "examples": [
+ "en"
+ ],
+ "default": "",
+ "title": "Language"
+ },
+ "description": "Language code (ISO 639-1, two letters) for the response.\n\nResolution order:\n1. `language` (this parameter)\n2. The request's `Accept-Language` header\n3. locale default\n4. English (when neither is recognised)\n\nOnly part of the address components are translated; not required for postal-code requests."
+ },
+ {
+ "name": "data",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "$ref": "#/components/schemas/Localities_DatasetMode",
+ "description": "Selects the postal-code dataset. `advanced` extends the default Western-Europe coverage to worldwide postal codes.\n\n***Requires a dedicated license option subject to specific billing — please contact us.***",
+ "examples": [
+ "advanced"
+ ],
+ "default": "standard"
+ },
+ "description": "Selects the postal-code dataset. `advanced` extends the default Western-Europe coverage to worldwide postal codes.\n\n***Requires a dedicated license option subject to specific billing — please contact us.***"
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_types"
+ "name": "components",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Restricts results to one or more countries. Pass each country as a `country:` filter. Use `|` to provide multiple values.",
+ "examples": [
+ "country:gb",
+ "country:fr|country:es"
+ ],
+ "title": "Components"
+ },
+ "description": "Restricts results to one or more countries. Pass each country as a `country:` filter. Use `|` to provide multiple values."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_excluded_types"
+ "name": "types",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Localities_LocalitiesTypes"
+ },
+ {
+ "$ref": "#/components/schemas/Localities_LocalitiesTypesPoi"
+ },
+ {
+ "$ref": "#/components/schemas/Localities_LocalitiesTypesPoiAlias"
+ }
+ ],
+ "description": "Restricts results to one or more types. Use `|` to provide multiple values.",
+ "examples": [
+ "address",
+ "locality|airport|admin_level"
+ ],
+ "default": "locality|postal_code",
+ "title": "Types"
+ },
+ "description": "Restricts results to one or more types. Use `|` to provide multiple values."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_localities_components"
+ "name": "excluded_types",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Localities_LocalitiesTypes"
+ },
+ {
+ "$ref": "#/components/schemas/Localities_LocalitiesTypesPoi"
+ },
+ {
+ "$ref": "#/components/schemas/Localities_LocalitiesTypesPoiAlias"
+ }
+ ],
+ "description": "Restricts results by excluding one or more types. Use `|` to provide multiple values.",
+ "examples": [
+ "suburb|quarter|neighbourhood"
+ ],
+ "title": "Excluded Types"
+ },
+ "description": "Restricts results by excluding one or more types. Use `|` to provide multiple values."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_language-2"
+ "name": "input",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "$ref": "#/components/schemas/Localities_LocalitiesInput",
+ "maxLength": 150,
+ "description": "Text to search for. Predictions are matched on this string and ordered by relevance.\n\nOnly the first 20 tokens (within 150 characters) are processed.",
+ "examples": [
+ "London"
+ ]
+ },
+ "description": "Text to search for. Predictions are matched on this string and ordered by relevance.\n\nOnly the first 20 tokens (within 150 characters) are processed."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_location"
+ "name": "custom_description",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Overrides the suggestion description format per type. Available fields depend on the type. Use `|` to provide multiple values.",
+ "examples": [
+ "locality:\"{name} - {administrative_area_level_0}\"|postal_code:\"{name} ({administrative_area_level_1})\""
+ ],
+ "title": "Custom Description"
+ },
+ "description": "Overrides the suggestion description format per type. Available fields depend on the type. Use `|` to provide multiple values."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_radius-2"
+ "name": "extended",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Allows a refined search over locality names sharing the same leading postal_code. Suggestion descriptions switch to `name (postal code), admin_1, admin_0`. Avoid combining with the `postal_code` type to prevent duplicate locations.\n\nSupported countries: France, Monaco, Italy, Spain, Belgium, Switzerland, Luxembourg.",
+ "examples": [
+ "postal_code"
+ ],
+ "enum": [
+ "postal_code"
+ ],
+ "title": "Extended"
+ },
+ "description": "Allows a refined search over locality names sharing the same leading postal_code. Suggestion descriptions switch to `name (postal code), admin_1, admin_0`. Avoid combining with the `postal_code` type to prevent duplicate locations.\n\nSupported countries: France, Monaco, Italy, Spain, Belgium, Switzerland, Luxembourg."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_data"
+ "name": "location",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Biases results toward a point, specified as `latitude,longitude`. Pair with `radius`.",
+ "examples": [
+ "52.479699,-1.902691"
+ ],
+ "title": "Location"
+ },
+ "description": "Biases results toward a point, specified as `latitude,longitude`. Pair with `radius`."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_extended"
+ "name": "radius",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 10,
+ "description": "Radius in meters around `location` to prioritise results. Results outside this radius may still appear.",
+ "examples": [
+ 200000
+ ],
+ "default": 100000,
+ "title": "Radius"
+ },
+ "description": "Radius in meters around `location` to prioritise results. Results outside this radius may still appear."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_custom_description"
+ "name": "accept-language",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Accept-Language"
+ }
}
],
"responses": {
"200": {
- "description": "Autocompletion Localities successfully retrieved",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesAutocompleteCollectionResponse"
+ "$ref": "#/components/schemas/Localities_AutocompleteResponse"
},
"examples": {
- "default": {
- "summary": "Autocomplete localities results for input `Lond` and components `country:gb`",
+ "custom": {
+ "summary": "Example response",
"value": {
"localities": [
{
@@ -8336,60 +8511,58 @@
}
},
"401": {
- "description": "Unauthorized. Incorrect authentication credentials.",
+ "description": "Unable to locate credentials.",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Error401"
- },
- "examples": {
- "Unauthorized": {
- "summary": "Error 401",
- "value": {
- "detail": "Incorrect authentication credentials. Please check or use a valid API Key"
- }
- }
+ "$ref": "#/components/schemas/Localities_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "402": {
+ "description": "Out of free quota.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Localities_AuthenticationErrorResponse"
}
}
}
},
"403": {
- "description": "Forbidden. This Woosmap API is not enabled for this project.",
+ "description": "Credentials found, but not matching.",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Error403"
- },
- "examples": {
- "Forbidden": {
- "summary": "Error 403",
- "value": {
- "detail": "This Woosmap API is not enabled for this project."
- }
- }
+ "$ref": "#/components/schemas/Localities_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Localities_HTTPValidationError"
}
}
}
},
"429": {
- "description": "Too Many Requests. The rate limit for this endpoint has been exceeded.",
+ "description": "Rate limit reached",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Error429"
- },
- "examples": {
- "Forbidden": {
- "summary": "Error 429",
- "value": {
- "detail": "The rate limit for this endpoint has been exceeded"
- }
- }
+ "$ref": "#/components/schemas/Localities_HTTPErrorModel"
}
}
}
}
},
+ "x-ratelimit-limit": 50,
+ "x-ratelimit-window-seconds": 1,
"x-codeSamples": [
{
"lang": "curl",
@@ -8412,60 +8585,127 @@
"/localities/details": {
"servers": [
{
- "url": "https://api.woosmap.com"
+ "url": "https://api.woosmap.com",
+ "description": "Production"
}
],
"get": {
- "summary": "Details of a Locality",
- "operationId": "localitiesDetails",
- "servers": [
- {
- "url": "https://api.woosmap.com"
- }
- ],
"tags": [
"Localities API"
],
- "description": "Provides details of an autocomplete suggestion (using the suggestion’s `public_id`).\n",
+ "summary": "Details",
+ "description": "Returns the full details of a suggestion, looked up by its `public_id`.\n\n**Ratelimit:** 50/1s",
+ "operationId": "details_localities_details_get",
"security": [
{
- "Woosmap_Platform_API_Reference_PublicApiKeyAuth": [],
- "Woosmap_Platform_API_Reference_RefererHeader": []
+ "Localities_PublicAPIKey": []
},
{
- "Woosmap_Platform_API_Reference_PrivateApiKeyAuth": []
+ "Localities_PrivateApiKey": []
},
{
- "Woosmap_Platform_API_Reference_PrivateApiKeyHeaderAuth": []
+ "Localities_PrivateApiKeyHeader": []
}
],
"parameters": [
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_public_id"
- },
- {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_language-2"
- },
- {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_fields"
- },
- {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_cc_format"
- },
- {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_page-2"
+ "name": "fields",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "enum": [
+ "geometry",
+ "address_components",
+ "shape"
+ ]
+ }
+ ],
+ "description": "Restricts the response to a subset of fields. Use `|` to provide multiple values.",
+ "examples": [
+ "shape"
+ ],
+ "default": "geometry|address_components",
+ "title": "Fields"
+ },
+ "description": "Restricts the response to a subset of fields. Use `|` to provide multiple values."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_addresses_per_page"
+ "name": "language",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "description": "Language code (ISO 639-1, two letters) for the response.\n\nResolution order:\n1. `language` (this parameter)\n2. The request's `Accept-Language` header\n3. locale default\n4. English (when neither is recognised)\n\nOnly part of the address components are translated; not required for postal-code requests.",
+ "examples": [
+ "en"
+ ],
+ "default": "",
+ "title": "Language"
+ },
+ "description": "Language code (ISO 639-1, two letters) for the response.\n\nResolution order:\n1. `language` (this parameter)\n2. The request's `Accept-Language` header\n3. locale default\n4. English (when neither is recognised)\n\nOnly part of the address components are translated; not required for postal-code requests."
+ },
+ {
+ "name": "cc_format",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Localities_CountryCodeFormat"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Format of the country code returned in `address_components`. When unset, mirrors the format used in `components`, or `alpha2` if `components` is not provided.",
+ "examples": [
+ "alpha3"
+ ],
+ "title": "Cc Format"
+ },
+ "description": "Format of the country code returned in `address_components`. When unset, mirrors the format used in `components`, or `alpha2` if `components` is not provided."
+ },
+ {
+ "name": "public_id",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "description": "Identifier of the place to retrieve details for. Use the `public_id` returned by the [Autocomplete](https://developers.woosmap.com/products/localities/autocomplete/) endpoint.",
+ "examples": [
+ "cG9zdGFsX2NvZGU6Z2I6OmNDN0N0ZUF2MW9YRi9KLzlnS2cremJndktFaz0="
+ ],
+ "title": "Public Id"
+ },
+ "description": "Identifier of the place to retrieve details for. Use the `public_id` returned by the [Autocomplete](https://developers.woosmap.com/products/localities/autocomplete/) endpoint."
+ },
+ {
+ "name": "accept-language",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Accept-Language"
+ }
}
],
"responses": {
"200": {
- "description": "Details Localities successfully retrieved",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesDetailsResponse"
+ "$ref": "#/components/schemas/Localities_DetailsResponse"
},
"examples": {
"Address": {
@@ -8633,60 +8873,58 @@
}
},
"401": {
- "description": "Unauthorized. Incorrect authentication credentials.",
+ "description": "Unable to locate credentials.",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Error401"
- },
- "examples": {
- "Unauthorized": {
- "summary": "Error 401",
- "value": {
- "detail": "Incorrect authentication credentials. Please check or use a valid API Key"
- }
- }
+ "$ref": "#/components/schemas/Localities_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "402": {
+ "description": "Out of free quota.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Localities_AuthenticationErrorResponse"
}
}
}
},
"403": {
- "description": "Forbidden. This Woosmap API is not enabled for this project.",
+ "description": "Credentials found, but not matching.",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Error403"
- },
- "examples": {
- "Forbidden": {
- "summary": "Error 403",
- "value": {
- "detail": "This Woosmap API is not enabled for this project."
- }
- }
+ "$ref": "#/components/schemas/Localities_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Localities_HTTPValidationError"
}
}
}
},
"429": {
- "description": "Too Many Requests. The rate limit for this endpoint has been exceeded.",
+ "description": "Rate limit reached",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Error429"
- },
- "examples": {
- "Forbidden": {
- "summary": "Error 429",
- "value": {
- "detail": "The rate limit for this endpoint has been exceeded"
- }
- }
+ "$ref": "#/components/schemas/Localities_HTTPErrorModel"
}
}
}
}
},
+ "x-ratelimit-limit": 50,
+ "x-ratelimit-window-seconds": 1,
"x-codeSamples": [
{
"lang": "curl",
@@ -8709,72 +8947,265 @@
"/localities/geocode": {
"servers": [
{
- "url": "https://api.woosmap.com"
+ "url": "https://api.woosmap.com",
+ "description": "Production"
}
],
"get": {
- "summary": "Geocode a locality or Reverse Geocode a latlng",
- "operationId": "localitiesGeocode",
- "servers": [
- {
- "url": "https://api.woosmap.com"
- }
- ],
"tags": [
"Localities API"
],
- "description": "Provides details for an address or a geographic position. Either parameter `address` **or** `latlng` is required.\n",
+ "summary": "Geocode",
+ "description": "Geocodes an `address` into coordinates, or reverse geocodes a `latlng` position into an address. Provide exactly one of `address` or `latlng`.\n\n**Ratelimit:** 50/1s",
+ "operationId": "geocode_localities_geocode_get",
"security": [
{
- "Woosmap_Platform_API_Reference_PublicApiKeyAuth": [],
- "Woosmap_Platform_API_Reference_RefererHeader": []
+ "Localities_PublicAPIKey": []
},
{
- "Woosmap_Platform_API_Reference_PrivateApiKeyAuth": []
+ "Localities_PrivateApiKey": []
},
{
- "Woosmap_Platform_API_Reference_PrivateApiKeyHeaderAuth": []
+ "Localities_PrivateApiKeyHeader": []
}
],
"parameters": [
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_address"
+ "name": "fields",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "enum": [
+ "geometry",
+ "address_components",
+ "shape"
+ ]
+ }
+ ],
+ "description": "Restricts the response to a subset of fields. Use `|` to provide multiple values.",
+ "examples": [
+ "shape"
+ ],
+ "default": "geometry|address_components",
+ "title": "Fields"
+ },
+ "description": "Restricts the response to a subset of fields. Use `|` to provide multiple values."
+ },
+ {
+ "name": "language",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "description": "Language code (ISO 639-1, two letters) for the response.\n\nResolution order:\n1. `language` (this parameter)\n2. The request's `Accept-Language` header\n3. locale default\n4. English (when neither is recognised)\n\nOnly part of the address components are translated; not required for postal-code requests.",
+ "examples": [
+ "en"
+ ],
+ "default": "",
+ "title": "Language"
+ },
+ "description": "Language code (ISO 639-1, two letters) for the response.\n\nResolution order:\n1. `language` (this parameter)\n2. The request's `Accept-Language` header\n3. locale default\n4. English (when neither is recognised)\n\nOnly part of the address components are translated; not required for postal-code requests."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_latlng"
+ "name": "cc_format",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Localities_CountryCodeFormat"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Format of the country code returned in `address_components`. When unset, mirrors the format used in `components`, or `alpha2` if `components` is not provided.",
+ "examples": [
+ "alpha3"
+ ],
+ "title": "Cc Format"
+ },
+ "description": "Format of the country code returned in `address_components`. When unset, mirrors the format used in `components`, or `alpha2` if `components` is not provided."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_geocode_types"
+ "name": "data",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "$ref": "#/components/schemas/Localities_DatasetMode",
+ "description": "Selects the postal-code dataset. `advanced` extends the default Western-Europe coverage to worldwide postal codes.\n\n***Requires a dedicated license option subject to specific billing — please contact us.***",
+ "examples": [
+ "advanced"
+ ],
+ "default": "standard"
+ },
+ "description": "Selects the postal-code dataset. `advanced` extends the default Western-Europe coverage to worldwide postal codes.\n\n***Requires a dedicated license option subject to specific billing — please contact us.***"
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_excluded_types"
+ "name": "components",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Restricts results to one or more countries. Pass each country as a `country:` filter. Use `|` to provide multiple values.",
+ "examples": [
+ "country:gb",
+ "country:fr|country:es"
+ ],
+ "title": "Components"
+ },
+ "description": "Restricts results to one or more countries. Pass each country as a `country:` filter. Use `|` to provide multiple values."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_list_sub_buildings"
+ "name": "types",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Localities_LocalitiesTypes"
+ },
+ {
+ "$ref": "#/components/schemas/Localities_LocalitiesTypesPoi"
+ },
+ {
+ "$ref": "#/components/schemas/Localities_LocalitiesTypesPoiAlias"
+ }
+ ],
+ "description": "Restricts results to one or more types. Use `|` to provide multiple values. Ignored when `latlng` is set.",
+ "examples": [
+ "address",
+ "locality|admin_level"
+ ],
+ "default": "locality|postal_code|address",
+ "title": "Types"
+ },
+ "description": "Restricts results to one or more types. Use `|` to provide multiple values. Ignored when `latlng` is set."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_localities_components"
+ "name": "excluded_types",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Localities_LocalitiesTypes"
+ },
+ {
+ "$ref": "#/components/schemas/Localities_LocalitiesTypesPoi"
+ },
+ {
+ "$ref": "#/components/schemas/Localities_LocalitiesTypesPoiAlias"
+ }
+ ],
+ "description": "Restricts results by excluding one or more types. Use `|` to provide multiple values.",
+ "examples": [
+ "suburb|quarter|neighbourhood"
+ ],
+ "title": "Excluded Types"
+ },
+ "description": "Restricts results by excluding one or more types. Use `|` to provide multiple values."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_language-2"
+ "name": "address",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Localities_LocalitiesInput",
+ "maxLength": 150
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Address, street, locality, or postal code to geocode.\n\nOnly the first 20 tokens (within 150 characters) are processed.",
+ "examples": [
+ "224%20Rue%20de%20Rivoli%2C%20Paris"
+ ],
+ "title": "Address"
+ },
+ "description": "Address, street, locality, or postal code to geocode.\n\nOnly the first 20 tokens (within 150 characters) are processed."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_fields"
+ "name": "latlng",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Point to reverse geocode, required if the `address` parameter is missing.",
+ "examples": [
+ "52.479699,-1.902691"
+ ],
+ "title": "Latlng"
+ },
+ "description": "Point to reverse geocode, required if the `address` parameter is missing."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_data"
+ "name": "list_sub_buildings",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "description": "Returns all addresses sharing the same street number or building in a `sub_buildings` field. Reverse geocoding only.",
+ "examples": [
+ true
+ ],
+ "default": false,
+ "title": "List Sub Buildings"
+ },
+ "description": "Returns all addresses sharing the same street number or building in a `sub_buildings` field. Reverse geocoding only."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_cc_format"
+ "name": "accept-language",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Accept-Language"
+ }
}
],
"responses": {
"200": {
- "description": "Request Localities Geocode successful",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesGeocodeCollectionResponse"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Localities_GeocodeResponse"
+ },
+ {
+ "$ref": "#/components/schemas/Localities_ReverseGeocodeResponse"
+ }
+ ],
+ "title": "Response Geocode Localities Geocode Get"
},
"examples": {
"geocode": {
@@ -9008,60 +9439,58 @@
}
},
"401": {
- "description": "Unauthorized. Incorrect authentication credentials.",
+ "description": "Unable to locate credentials.",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Error401"
- },
- "examples": {
- "Unauthorized": {
- "summary": "Error 401",
- "value": {
- "detail": "Incorrect authentication credentials. Please check or use a valid API Key"
- }
- }
+ "$ref": "#/components/schemas/Localities_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "402": {
+ "description": "Out of free quota.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Localities_AuthenticationErrorResponse"
}
}
}
},
"403": {
- "description": "Forbidden. This Woosmap API is not enabled for this project.",
+ "description": "Credentials found, but not matching.",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Error403"
- },
- "examples": {
- "Forbidden": {
- "summary": "Error 403",
- "value": {
- "detail": "This Woosmap API is not enabled for this project."
- }
- }
+ "$ref": "#/components/schemas/Localities_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Localities_HTTPValidationError"
}
}
}
},
"429": {
- "description": "Too Many Requests. The rate limit for this endpoint has been exceeded.",
+ "description": "Rate limit reached",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Error429"
- },
- "examples": {
- "Forbidden": {
- "summary": "Error 429",
- "value": {
- "detail": "The rate limit for this endpoint has been exceeded"
- }
- }
+ "$ref": "#/components/schemas/Localities_HTTPErrorModel"
}
}
}
}
},
+ "x-ratelimit-limit": 50,
+ "x-ratelimit-window-seconds": 1,
"x-codeSamples": [
{
"lang": "curl",
@@ -9084,98 +9513,180 @@
"/localities/nearby": {
"servers": [
{
- "url": "https://api.woosmap.com"
+ "url": "https://api.woosmap.com",
+ "description": "Production"
}
],
"get": {
- "summary": "Nearby points of interest",
- "operationId": "localitiesNearby",
- "servers": [
- {
- "url": "https://api.woosmap.com"
- }
- ],
"tags": [
"Localities API"
],
- "description": "Retrieve worldwide points of interest surrounding a given location. They can be filtered by categories.\n",
+ "summary": "Nearby",
+ "description": "Returns worldwide points of interest around a `location`, sorted by distance. Filter with `types` and `excluded_types`.\n\n**Ratelimit:** 50/1s",
+ "operationId": "poi_nearby_localities_nearby_get",
"security": [
{
- "Woosmap_Platform_API_Reference_PublicApiKeyAuth": [],
- "Woosmap_Platform_API_Reference_RefererHeader": []
+ "Localities_PublicAPIKey": []
},
{
- "Woosmap_Platform_API_Reference_PrivateApiKeyAuth": []
+ "Localities_PrivateApiKey": []
},
{
- "Woosmap_Platform_API_Reference_PrivateApiKeyHeaderAuth": []
+ "Localities_PrivateApiKeyHeader": []
}
],
"parameters": [
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_nearby_types"
+ "name": "cc_format",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Localities_CountryCodeFormat"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Format of the country code returned in `address_components`. When unset, mirrors the format used in `components`, or `alpha2` if `components` is not provided.",
+ "examples": [
+ "alpha3"
+ ],
+ "title": "Cc Format"
+ },
+ "description": "Format of the country code returned in `address_components`. When unset, mirrors the format used in `components`, or `alpha2` if `components` is not provided."
},
{
"name": "location",
- "description": "Center of the search circle.\n",
+ "in": "query",
+ "required": true,
"schema": {
- "type": "string"
+ "type": "string",
+ "description": "Center of the search circle.",
+ "examples": [
+ "40.71399,-74.00499"
+ ],
+ "title": "Location"
},
- "required": true,
- "example": "40.71399,-74.00499",
- "in": "query"
+ "description": "Center of the search circle."
},
{
"name": "radius",
- "description": "Radius of the search circle, in meters.\n",
+ "in": "query",
+ "required": false,
"schema": {
"type": "integer",
- "default": 1000,
+ "maximum": 50000,
"minimum": 10,
- "maximum": 50000
+ "description": "Radius of the search circle, in meters.",
+ "examples": [
+ 3000
+ ],
+ "default": 1000,
+ "title": "Radius"
+ },
+ "description": "Radius of the search circle, in meters."
+ },
+ {
+ "name": "types",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "description": "Restricts results to one or more types of points of interest. Use `|` to provide multiple values.",
+ "examples": [
+ "point_of_interest",
+ "business.shop"
+ ],
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Localities_LocalitiesTypesPoi"
+ }
+ ],
+ "title": "Types"
},
+ "description": "Restricts results to one or more types of points of interest. Use `|` to provide multiple values."
+ },
+ {
+ "name": "excluded_types",
"in": "query",
"required": false,
- "example": 3000
+ "schema": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Localities_LocalitiesTypesPoi"
+ }
+ ],
+ "description": "Restricts results by excluding one or more types of points of interest. Use `|` to provide multiple values.",
+ "examples": [
+ "business.food_and_drinks.fast_food|business.food_and_drinks.pub"
+ ],
+ "title": "Excluded Types"
+ },
+ "description": "Restricts results by excluding one or more types of points of interest. Use `|` to provide multiple values."
},
{
"name": "page",
- "description": "Use `page` to navigate through paginated results.\n",
+ "in": "query",
+ "required": false,
"schema": {
"type": "integer",
+ "minimum": 1,
+ "description": "Selects which page of paginated results to return.",
+ "examples": [
+ 7
+ ],
"default": 1,
- "minimum": 1
+ "title": "Page"
},
- "in": "query",
- "example": 7
+ "description": "Selects which page of paginated results to return."
},
{
"name": "limit",
- "description": "Defines how many results should be included in a page.\n",
+ "in": "query",
+ "required": false,
"schema": {
"type": "integer",
- "default": 10,
+ "maximum": 30,
"minimum": 1,
- "maximum": 30
+ "description": "Defines how many results should be included in a page.",
+ "examples": [
+ 15
+ ],
+ "default": 10,
+ "title": "Limit"
},
- "in": "query",
- "example": 15
+ "description": "Defines how many results should be included in a page."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_nearby_excluded_types"
+ "name": "accept-language",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Accept-Language"
+ }
}
],
"responses": {
"200": {
- "description": "Points of interest surrounding `location` and matching provided `types`, sorted by distance to `location`.",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesNearbyCollectionResponse"
+ "$ref": "#/components/schemas/Localities_NearbyResponse"
},
"examples": {
- "default": {
- "summary": "Nearby points of interest with category `business.shop` around New York center.",
+ "custom": {
+ "summary": "Example response",
"value": {
"results": [
{
@@ -9585,60 +10096,58 @@
}
},
"401": {
- "description": "Unauthorized. Incorrect authentication credentials.",
+ "description": "Unable to locate credentials.",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Error401"
- },
- "examples": {
- "Unauthorized": {
- "summary": "Error 401",
- "value": {
- "detail": "Incorrect authentication credentials. Please check or use a valid API Key"
- }
- }
+ "$ref": "#/components/schemas/Localities_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "402": {
+ "description": "Out of free quota.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Localities_AuthenticationErrorResponse"
}
}
}
},
"403": {
- "description": "Forbidden. This Woosmap API is not enabled for this project.",
+ "description": "Credentials found, but not matching.",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Error403"
- },
- "examples": {
- "Forbidden": {
- "summary": "Error 403",
- "value": {
- "detail": "This Woosmap API is not enabled for this project."
- }
- }
+ "$ref": "#/components/schemas/Localities_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Localities_HTTPValidationError"
}
}
}
},
"429": {
- "description": "Too Many Requests. The rate limit for this endpoint has been exceeded.",
+ "description": "Rate limit reached",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Error429"
- },
- "examples": {
- "Forbidden": {
- "summary": "Error 429",
- "value": {
- "detail": "The rate limit for this endpoint has been exceeded"
- }
- }
+ "$ref": "#/components/schemas/Localities_HTTPErrorModel"
}
}
}
}
},
+ "x-ratelimit-limit": 50,
+ "x-ratelimit-window-seconds": 1,
"x-codeSamples": [
{
"lang": "curl",
@@ -12247,281 +12756,65 @@
},
"in": "query"
},
- "Woosmap_Platform_API_Reference_input": {
- "name": "input",
- "description": "The text string on which to search, for example: \"london\" or \"123 Cross Road\".\nThe Woosmap Localities API will return predictions matches based on this string and order the results based on their perceived relevance.\nTo protect against illegitimate requests, only the 20 first tokens found in the first 150 characters will be used.\n",
+ "Woosmap_Platform_API_Reference_limit-3": {
+ "name": "limit",
+ "description": "To limit number of zones retrieved (max 50).\n",
"schema": {
- "type": "string",
- "maxLength": 150,
- "example": "London"
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 50,
+ "example": 10
},
- "required": true,
"in": "query"
},
- "Woosmap_Platform_API_Reference_types": {
- "name": "types",
- "description": "Specifies the types of suggestions to return in the query. Multiple types can be combined using the pipe character (`|`) as a separator. This parameter supports a wide range of locality classifications, including:\n - Standard locality types (e.g., cities, administrative areas, postal codes)\n - Points of Interest (POI) categories\n - POI aliases\n\nThese classifications enable flexible geographic data representation and querying.\n",
+ "Woosmap_Platform_API_Reference_offset": {
+ "name": "offset",
+ "description": "To retrieve zones starting from an offset value.\n",
"schema": {
- "default": "locality|postal_code",
- "example": "locality|airport|admin_level",
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesAll"
+ "type": "integer",
+ "minimum": 1,
+ "example": 20
},
"in": "query"
- },
- "Woosmap_Platform_API_Reference_excluded_types": {
- "name": "excluded_types",
- "description": "The types of suggestion to exclude. Multiple types can be passed using the pipe character (`|`) as a separator.\n",
- "schema": {
- "type": "string",
- "example": "suburb|quarter|neighbourhood"
+ }
+ },
+ "schemas": {
+ "Woosmap_Platform_API_Reference_LatLngLiteral": {
+ "title": "LatLngLiteral",
+ "type": "object",
+ "description": "An object describing a specific location with Latitude and Longitude in decimal degrees.",
+ "required": [
+ "lat",
+ "lng"
+ ],
+ "example": {
+ "lat": 43.3,
+ "lng": 3.46
},
- "in": "query"
+ "properties": {
+ "lat": {
+ "type": "number",
+ "description": "Latitude in decimal degrees",
+ "example": 42.3
+ },
+ "lng": {
+ "type": "number",
+ "description": "Longitude in decimal degrees",
+ "example": 3.46
+ }
+ }
},
- "Woosmap_Platform_API_Reference_localities_components": {
- "name": "components",
- "description": "A grouping of places to which you would like to restrict your results. Components can and should be used when applicable to filter over countries and retrieve more accurate results. Countries must be passed as an ISO 3166-1 Alpha-2 or Alpha-3 compatible country code. For example: `components=country:fr` or `components=country:fra` would restrict your results to places within France and `components=country:fr-fr` returns locations only in Metropolitan France. Multiple countries must be passed as multiple `country:XX` filters, with the pipe character (`|`) as a separator. For example: `components=country:gb|country:fr|country:be|country:sp|country:it` would restrict your results to city names or postal codes within the United Kingdom, France, Belgium, Spain and Italy.\n",
- "schema": {
- "type": "string",
- "example": "country:fr|country:es"
- },
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_language-2": {
- "name": "language",
- "description": "The language code, using ISO 639-2 Alpha-2 country codes, indicating in which language the results should be returned, if possible. If language is not supplied, first `Accept-Language` of the browser will be used. If neither the provided `language` or the `Accept-Language` are known, the Localities service uses the international default language (English). No `language` is necessary for a postal_code request. According to requested language, only parts of the address components might be translated.\n",
- "schema": {
- "type": "string",
- "example": "en"
- },
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_location": {
- "name": "location",
- "description": "This parameter is used to add a geographical bias to the query. The location defines the point around which to retrieve results in priority. It must be specified in the `latitude,longitude` string format.\n",
- "schema": {
- "type": "string",
- "example": "5.2,-2.3"
- },
- "required": false,
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_radius-2": {
- "name": "radius",
- "description": "This parameter may be used in addition to the `location` parameter to define the distance in meters within which the API will return results in priority. Results outside of the defined area may still be displayed. Default radius if this parameter is not set is 100000.\n",
- "schema": {
- "type": "integer",
- "example": 200000
- },
- "in": "query",
- "required": false
- },
- "Woosmap_Platform_API_Reference_data": {
- "name": "data",
- "description": "Two values for this parameter: `standard` or `advanced`. By default, if the parameter is not defined, value is set as `standard`. The `advanced` value opens suggestions to worldwide postal codes in addition to postal codes for Western Europe. ***A dedicated option subject to specific billing on your license is needed to use this parameter. Please contact us if you are interested in using this parameter and you do not have subscribed the proper option yet.***\n",
- "schema": {
- "type": "string",
- "enum": [
- "standard",
- "advanced"
- ],
- "example": "advanced"
- },
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_extended": {
- "name": "extended",
- "description": "If set, this parameter allows a refined search over locality names that bears the same postal code. By triggering this parameter, integrators will benefit from a search spectrum on the `locality` type that ***includes postal codes***. To avoid confusion, it is recommended not to activate this parameter along with the `postal_code` type which could lead to duplicate locations. Also, the default description returned by the API changes to `name (postal code), admin_1, admin_0`. It is only available for France, Monaco, Italy, Spain, Belgium, Switzerland and Luxembourg.\n",
- "schema": {
- "type": "string",
- "enum": [
- "postal_code"
- ],
- "example": "postal_code"
- },
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_custom_description": {
- "name": "custom_description",
- "description": "This parameter allows to choose the description format for all or some of the suggestion types selected. The custom formats are described as follows (available fields depend on the returned type): `custom_description=type_A:\"{field_1}, {field_2}, [...]\"|type_B:\"{field_1}, {field_2}, [...]\"`\n",
- "schema": {
- "type": "string",
- "example": "locality:\"{name} - {administrative_area_level_0}\"|postal_code:\"{name} ({administrative_area_level_1})\""
- },
- "required": false,
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_public_id": {
- "name": "public_id",
- "description": "A textual identifier that uniquely identifies a locality, returned from a [Localities Autocomplete](https://developers.woosmap.com/products/localities/autocomplete/).\n",
- "schema": {
- "type": "string",
- "example": "cG9zdGFsX2NvZGU6Z2I6OmNDN0N0ZUF2MW9YRi9KLzlnS2cremJndktFaz0="
- },
- "required": true,
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_fields": {
- "name": "fields",
- "description": "If set, it will limit the content of responses to the specified fields. This parameter can be any combination of `geometry`, `address_components` or `shape` (defaults to `geometry|address_components`).\n",
- "schema": {
- "type": "string",
- "enum": [
- "geometry"
- ],
- "example": "geometry"
- },
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_cc_format": {
- "name": "cc_format",
- "description": "To specify the format for the short [country code](https://en.wikipedia.org/wiki/ISO_3166-1) expected to be returned in the address_components field. Default is the format used to specify `components` or `alpha2` if no components are specified.\n",
- "schema": {
- "type": "string",
- "enum": [
- "alpha2",
- "alpha3"
- ],
- "example": "alpha2"
- },
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_page-2": {
- "name": "page",
- "description": "In a few cases, a postal code details may contain addresses (UK postal codes). The address list is paginated. In that case, you can navigate in the address list thanks to the `addresses_per_page` and `page` parameters. Notice: as all the addresses are now automatically returned in the response, the `page` parameter is deprecated and has been turned off on December 31, 2021.\n",
- "schema": {
- "type": "integer",
- "example": 1
- },
- "in": "query",
- "deprecated": true
- },
- "Woosmap_Platform_API_Reference_addresses_per_page": {
- "name": "addresses_per_page",
- "description": "In a few cases, a postal code details may contain addresses (UK postal codes). The address list is paginated. In that case, you can navigate in the address list thanks to the `addresses_per_page` and `page` parameters. Notice: as all the addresses are now automatically returned in the response, the `addresses_per_page` parameter is deprecated and has been turned off on December 31, 2021.\n",
- "schema": {
- "type": "integer",
- "example": 10
- },
- "in": "query",
- "deprecated": true
- },
- "Woosmap_Platform_API_Reference_address": {
- "name": "address",
- "description": "The input string to geocode. Can represent an address, a street, a locality or a postal code. The `address` parameter must be URL encoded.\nTo protect against illegitimate requests, only the 20 first tokens found in the first 150 characters will be used.\n",
- "schema": {
- "type": "string",
- "maxLength": 150,
- "example": "224%20Rue%20de%20Rivoli%2C%20Paris"
- },
- "required": false,
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_latlng": {
- "name": "latlng",
- "description": "The latlng parameter is used for reverse geocoding, it's required if the `address` parameter is missing.\n",
- "schema": {
- "type": "string",
- "example": "5.2,-2.3"
- },
- "required": false,
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_geocode_types": {
- "name": "types",
- "description": "When executing a geocode request with the `address` parameter, it specifies the types of suggestions to return in the query. Multiple types can be combined using the pipe character (`|`) as a separator. This parameter supports a wide range of locality classifications, including:\n - Standard locality types (e.g., cities, administrative areas, postal codes)\n - Points of Interest (POI) categories\n - POI aliases\n\nThese classifications enable flexible geographic data representation and querying.\nThis parameter is ignored when used with the `latlng` parameter.\n",
- "schema": {
- "default": "locality|postal_code|address",
- "example": "locality|admin_level",
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesAll"
- },
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_list_sub_buildings": {
- "name": "list_sub_buildings",
- "description": "When latlng parameter is used for reverse geocoding, setting `list_sub_building=true` allows to retrieve all addresses at the same location for a common street number or building. Results may contain an additional key \"sub_buildings\" with \"public_id\" and \"description\" values for every addresses at the same location sharing the same address components.\n",
- "schema": {
- "type": "boolean",
- "example": true
- },
- "required": false,
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_nearby_types": {
- "name": "types",
- "description": "The types of points of interest to return. Multiple types can be passed using the pipe character (`|`) as a separator. For example: `types=business.shop|medical.pharmacy|business.finance.bank`.\n",
- "schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesPoi"
- },
- "required": true,
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_nearby_excluded_types": {
- "name": "excluded_types",
- "description": "The types of points of interest to exclude from results. Results will match the specified `types`, if any, but will not match the specified `excluded_types`. Multiple types can be passed using the pipe character (`|`) as a separator. For example: `excluded_types=business.food_and_drinks.fast_food|business.food_and_drinks.pub`.\n",
- "schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesPoi"
- },
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_limit-3": {
- "name": "limit",
- "description": "To limit number of zones retrieved (max 50).\n",
- "schema": {
- "type": "integer",
- "minimum": 1,
- "maximum": 50,
- "example": 10
- },
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_offset": {
- "name": "offset",
- "description": "To retrieve zones starting from an offset value.\n",
- "schema": {
- "type": "integer",
- "minimum": 1,
- "example": 20
- },
- "in": "query"
- }
- },
- "schemas": {
- "Woosmap_Platform_API_Reference_LatLngLiteral": {
- "title": "LatLngLiteral",
- "type": "object",
- "description": "An object describing a specific location with Latitude and Longitude in decimal degrees.",
- "required": [
- "lat",
- "lng"
- ],
- "example": {
- "lat": 43.3,
- "lng": 3.46
- },
- "properties": {
- "lat": {
- "type": "number",
- "description": "Latitude in decimal degrees",
- "example": 42.3
- },
- "lng": {
- "type": "number",
- "description": "Longitude in decimal degrees",
- "example": 3.46
- }
- }
- },
- "Woosmap_Platform_API_Reference_Bounds": {
- "title": "Bounds",
- "type": "object",
- "description": "A rectangle in geographical coordinates from points at the southwest and northeast corners.",
- "properties": {
- "northeast": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LatLngLiteral"
- },
- "southwest": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LatLngLiteral"
- }
+ "Woosmap_Platform_API_Reference_Bounds": {
+ "title": "Bounds",
+ "type": "object",
+ "description": "A rectangle in geographical coordinates from points at the southwest and northeast corners.",
+ "properties": {
+ "northeast": {
+ "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LatLngLiteral"
+ },
+ "southwest": {
+ "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LatLngLiteral"
+ }
},
"example": {
"northeast": {
@@ -14292,1657 +14585,1022 @@
}
}
},
- "Woosmap_Platform_API_Reference_LocalitiesTypes": {
- "title": "LocalitiesTypes",
- "type": "string",
- "description": "Common types unrelated to points of interest (POI). The `locality` type serves as an alias grouping various settlement types (see `enum` for details). This grouping enables flexible and efficient querying of related geographic data.\n",
- "enum": [
- "country",
- "admin_level",
- "admin_level_1",
- "admin_level_2",
- "admin_level_3",
- "postal_code",
- "address",
- "route",
- "locality",
- "city",
- "town",
- "village",
- "hamlet",
- "borough",
- "suburb",
- "quarter",
- "neighbourhood"
- ]
+ "Woosmap_Platform_API_Reference_Zone": {
+ "title": "Zone",
+ "type": "object",
+ "description": "Attributes describing a Zone.",
+ "required": [
+ "store_id",
+ "zone_id",
+ "polygon"
+ ],
+ "properties": {
+ "zone_id": {
+ "description": "A textual identifier that uniquely identifies a Zone.",
+ "type": "string",
+ "example": "ZoneA"
+ },
+ "description": {
+ "type": "string",
+ "description": "Textual description of your Zone",
+ "example": "Delivery Zone for Store A"
+ },
+ "store_id": {
+ "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AssetId"
+ },
+ "polygon": {
+ "type": "string",
+ "description": "Zone geometry polygon as **Well Known Text**. WKT defines how to represent geometry of one object (cf. https://en.wikipedia.org/wiki/Well-known_text). Your zones could be complex and multipart polygons.",
+ "example": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))"
+ },
+ "types": {
+ "description": "Contains an array of types describing the Zone.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ "delivery",
+ "san_francisco_west"
+ ]
+ },
+ "status": {
+ "type": "string",
+ "description": "the status as string",
+ "example": "ok"
+ }
+ },
+ "example": {
+ "store_id": "STORE_ID_123456",
+ "zone_id": "ZoneA",
+ "polygon": "POLYGON ((-122.496116 37.7648181, -122.4954079 37.751518, -122.4635648 37.7530788, -122.4618481 37.7514501, -122.4601315 37.7521288, -122.4565266 37.7513144, -122.4540375 37.7566755, -122.4528359 37.7583041, -122.4515485 37.7595934, -122.4546384 37.774656, -122.4718903 37.7731635, -122.472577 37.772485, -122.4755811 37.7725529, -122.4791001 37.7723493, -122.4793576 37.7713995, -122.4784993 37.769839, -122.4783276 37.7680071, -122.4774693 37.766718, -122.4772118 37.7652931, -122.496116 37.7648181))",
+ "types": [
+ "delivery"
+ ],
+ "description": "Delivery Zone for Store A",
+ "status": "ok"
+ }
},
- "Woosmap_Platform_API_Reference_LocalitiesTypesPoi": {
- "title": "LocalitiesTypesPoi",
- "description": "Categories of points of interest (POI) supported for detailed classification in geographic data queries.\n",
- "type": "string",
- "enum": [
- "point_of_interest",
- "transit.station",
- "transit.station.airport",
- "transit.station.rail",
- "transit.station.rail.funicular",
- "transit.station.rail.light_rail",
- "transit.station.rail.monorail",
- "transit.station.rail.subway",
- "transit.station.rail.train",
- "transit.station.rail.tram",
- "beach",
- "business",
- "business.car_repair",
- "business.car_rental",
- "business.cinema",
- "business.conference_centre",
- "business.exhibition_centre",
- "business.theatre",
- "business.nightclub",
- "business.finance",
- "business.finance.bank",
- "business.fuel",
- "business.parking",
- "business.mall",
- "business.food_and_drinks",
- "business.food_and_drinks.bar",
- "business.food_and_drinks.biergarten",
- "business.food_and_drinks.cafe",
- "business.food_and_drinks.fast_food",
- "business.food_and_drinks.pub",
- "business.food_and_drinks.restaurant",
- "business.food_and_drinks.food_court",
- "business.shop",
- "business.shop.mall",
- "business.shop.bakery",
- "business.shop.butcher",
- "business.shop.library",
- "business.shop.grocery",
- "business.shop.sports",
- "business.shop.toys",
- "business.shop.clothes",
- "business.shop.furniture",
- "business.shop.electronics",
- "business.shop.doityourself",
- "business.shop.craft",
- "education",
- "education.school",
- "education.kindergarten",
- "education.university",
- "education.college",
- "education.library",
- "hospitality",
- "hospitality.hotel",
- "hospitality.hostel",
- "hospitality.guest_house",
- "hospitality.bed_and_breakfast",
- "hospitality.motel",
- "medical",
- "medical.hospital",
- "medical.pharmacy",
- "medical.clinic",
- "tourism",
- "tourism.attraction",
- "tourism.attraction.amusement_park",
- "tourism.attraction.zoo",
- "tourism.attraction.aquarium",
- "tourism.monument",
- "tourism.monument.castle",
- "tourism.museum",
- "government",
- "park",
- "park.national",
- "place_of_worship",
- "police",
- "post_office",
- "sports",
- "sports.golf",
- "sports.winter"
- ]
- },
- "Woosmap_Platform_API_Reference_LocalitiesTypesPoiAlias": {
- "title": "LocalitiesTypesPoiAlias",
- "type": "string",
- "description": "Aliases for some point_of_interest types. These aliases are deprecated and should be replaced with the corresponding types in `LocalitiesTypesPoi`. For example:\n - `airport` → `transit.station.airport`\n - `train_station` → `transit.station.rail.train`\n\nThis ensures consistency and alignment with the updated schema.\n",
- "enum": [
- "airport",
- "train_station",
- "metro_station",
- "shopping",
- "museum",
- "zoo",
- "amusement_park",
- "art_gallery",
- "tourist_attraction"
- ]
- },
- "Woosmap_Platform_API_Reference_LocalitiesTypesAll": {
- "title": "LocalitiesTypesAll",
- "type": "string",
- "description": "A comprehensive string type that encompasses all supported locality classifications. This includes standard locality types (e.g., cities, regions), points of interest (POI) categories, and POI aliases for flexible geographic data representation and querying.\n",
- "anyOf": [
- {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypes"
- },
- {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesPoi"
- },
- {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesPoiAlias"
- }
- ]
- },
- "Woosmap_Platform_API_Reference_LocalitiesAutocompleteMatchedFields": {
- "title": "LocalitiesAutocompleteMatchedFields",
- "type": "object",
- "description": "Contains a set of substrings in the `description` field that match elements in the `input`. It can be used to highlight those substrings. Each substring is identified by an `offset` and a `length`.",
- "properties": {
- "description": {
- "description": "match substrings for localities `description`",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_MatchedSubstring"
- }
- }
- }
- },
- "Woosmap_Platform_API_Reference_LocalitiesAutocompleteRelatedItem": {
- "title": "LocalitiesAutocompleteRelatedItem",
- "type": "object",
- "description": "Contains a set of related elements to the locality suggestion.",
- "properties": {
- "public_id": {
- "type": "string",
- "description": "Public ID of a related Postal Code."
- },
- "description": {
- "type": "string",
- "description": "Formatted description for the related Postal Code."
- }
- }
- },
- "Woosmap_Platform_API_Reference_LocalitiesAutocompleteRelated": {
- "title": "LocalitiesAutocompleteRelated",
- "type": "object",
- "description": "Contains a set of related elements to the locality suggestion.",
- "properties": {
- "postal_codes": {
- "description": "Postal codes related to the locality suggestion.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesAutocompleteRelatedItem"
- }
- }
- }
- },
- "Woosmap_Platform_API_Reference_LocalitiesAutocompleteResponse": {
- "title": "LocalitiesAutocompleteResponse",
+ "Woosmap_Platform_API_Reference_ZonesCollectionResponse": {
+ "title": "ZonesCollectionResponse",
"type": "object",
- "description": "Attributes describing a locality. Not all attributes will be available for all locality types.",
+ "description": "A Collection of Woosmap Zones retrieved in response to a get zones list.",
"properties": {
- "public_id": {
- "description": "Contains a unique ID for each suggestion. Please use this ID if you need to give us feedback on results. This ID is also required to perform a Localities Details Request.",
- "type": "string",
- "example": "MkvnYy6K6oVGqeqfWJGO/6eCgqo="
- },
- "types": {
- "description": "An array containing the types of the result",
+ "zones": {
+ "description": "The Zones collection",
"type": "array",
"items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesAll"
+ "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Zone"
}
},
- "type": {
- "deprecated": true,
- "description": "This field might be removed in the future, please use the `types` field which is more exhaustive.",
- "type": "string"
- },
- "description": {
- "description": "Concatenation of `name`, `admin_1`, `admin_0` to be used as suggestion in drop-down list if needed. The description can vary depending on the type requested.",
+ "status": {
"type": "string",
- "example": "20121, Milano, Italy"
- },
- "matched_substrings": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesAutocompleteMatchedFields"
- },
- "related": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesAutocompleteRelated"
- },
- "has_addresses": {
- "description": "On the specific territory of United Kingdom, Localities autocomplete request can return the additional attribute `has_addresses` for a postal code, which indicates if a postal code bears addresses. When `has_addresses` is `true`, it is possible to display a list of the available addresses by requesting `details` with the Localities `public_id`. To get the details of an address you will need to request again `/details` endpoint passing in the dedicated address `public_id`.\n",
- "type": "boolean",
- "example": true
+ "description": "the status as string",
+ "example": "ok"
}
},
"example": {
- "public_id": "Ch6qA8cLmvyvEEoFy6nYeFcEdNU=",
- "description": "London, City of London, United Kingdom",
- "type": "locality",
- "matched_substrings": {
- "description": [
- {
- "offset": 0,
- "length": 6
- },
- {
- "offset": 16,
- "length": 6
- }
- ]
- }
+ "zones": [
+ {
+ "store_id": "STORE_ID_123456",
+ "zone_id": "ZoneB",
+ "polygon": "POLYGON ((-122.4546384 37.774656, -122.4515485 37.7595934, -122.4354306 37.7602172, -122.4333707 37.7512596, -122.423071 37.7511239, -122.4242726 37.7687665, -122.4259893 37.7691736, -122.4289075 37.7732444, -122.4306241 37.7850483, -122.4472753 37.7830133, -122.445902 37.7759581, -122.4546384 37.774656))",
+ "types": [
+ "delivery"
+ ],
+ "description": "Delivery Zone for Store B"
+ },
+ {
+ "store_id": "STORE_ID_45678",
+ "zone_id": "ZoneC",
+ "polygon": "POLYGON ((-122.4758889 37.7524995, -122.4751594 37.7321718, -122.4688079 37.7299995, -122.4648597 37.7261979, -122.4519851 37.7228035, -122.4483802 37.7215815, -122.4458053 37.726741, -122.4365356 37.7310857, -122.4315574 37.7324433, -122.4246909 37.7312214, -122.4219444 37.731493, -122.423071 37.7511239, -122.4333707 37.7512596, -122.4354306 37.7602172, -122.4515485 37.7595934, -122.4528628 37.7582744, -122.4540375 37.7566755, -122.4565266 37.7513144, -122.4601315 37.7521288, -122.4618481 37.7514501, -122.4635648 37.7530788, -122.4758889 37.7524995))",
+ "types": [
+ "delivery"
+ ],
+ "description": "Delivery Zone for Store C"
+ }
+ ],
+ "status": "ok"
}
},
- "Woosmap_Platform_API_Reference_LocalitiesAutocompleteCollectionResponse": {
- "title": "LocalitiesAutocompleteCollectionResponse",
+ "Woosmap_Platform_API_Reference_ZonesCollectionRequest": {
+ "title": "ZonesCollectionRequest",
"type": "object",
- "description": "Localities Collection Response containing Localities",
+ "description": "A Collection of Woosmap Zones as expected for Data Management Data API.",
+ "required": [
+ "zones"
+ ],
"properties": {
- "localities": {
+ "zones": {
+ "description": "The Zones collection",
"type": "array",
"items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesAutocompleteResponse"
+ "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Zone"
}
}
},
"example": {
- "localities": [
- {
- "public_id": "Ch6qA8cLmvyvEEoFy6nYeFcEdNU=",
- "type": "locality",
- "types": [
- "locality",
- "city"
- ],
- "description": "London, City of London, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 0,
- "length": 4
- }
- ]
- }
- },
- {
- "public_id": "m/T2C4YI2LgszkKXrELBC+9dfC8=",
- "type": "locality",
- "types": [
- "locality",
- "city"
- ],
- "description": "Derry/Londonderry, Derry City and Strabane, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 6,
- "length": 4
- }
- ]
- }
- },
+ "zones": [
{
- "public_id": "J6eISGMjjvQwPkao8rsByB3aVwM=",
- "type": "locality",
+ "zone_id": "ZoneA",
+ "description": "Delivery Zone for Store A",
+ "store_id": "STORE_ID_123456",
+ "polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))",
"types": [
- "locality",
- "village"
- ],
- "description": "London Colney, Hertfordshire, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 0,
- "length": 4
- }
- ]
- }
+ "delivery"
+ ]
},
{
- "public_id": "52MnrbHVWH21CLWH8VY/YWKhqeM=",
- "type": "locality",
+ "zone_id": "ZoneB",
+ "description": "Delivery Zone for Store B",
+ "store_id": "STORE_ID_123456",
+ "polygon": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))",
"types": [
- "locality",
- "village"
- ],
- "description": "London Apprentice, Cornwall, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 0,
- "length": 4
- }
- ]
- }
+ "delivery"
+ ]
},
{
- "public_id": "S/5AkUmMBhX35qVI2jR38+dALwk=",
- "type": "locality",
+ "zone_id": "ZoneC",
+ "description": "Delivery Zone for Store C",
+ "store_id": "STORE_ID_45678",
+ "polygon": "POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))",
"types": [
- "locality",
- "city"
- ],
- "description": "City of London, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 8,
- "length": 4
- }
- ]
- }
+ "delivery"
+ ]
}
]
}
},
- "Woosmap_Platform_API_Reference_FormattedAddress": {
- "title": "FormattedAddress",
- "description": "Contains the readable text description of the result.",
- "type": "string",
- "example": "London, England, United Kingdom"
- },
- "Woosmap_Platform_API_Reference_Position": {
- "title": "Position",
- "description": "an array containing longitude, latitude, in that order.",
- "type": "array",
- "items": {
- "type": "number"
- },
- "minItems": 2,
- "maxItems": 2,
- "example": [
- 2.06984,
- 48.77919
- ]
- },
- "Woosmap_Platform_API_Reference_GeoJsonCoords": {
- "title": "GeoJsonCoords",
- "description": "an array containing Positions.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Position"
- },
- "example": [
- [
- 2.06984,
- 48.77919
- ],
- [
- 2.07984,
- 48.77919
- ],
- [
- 2.07984,
- 48.78919
- ],
- [
- 2.06984,
- 48.78919
- ],
- [
- 2.06984,
- 48.77919
- ]
- ]
- },
- "Woosmap_Platform_API_Reference_GeoJsonGeometry": {
- "title": "GeoJsonGeometry",
+ "Woosmap_Platform_API_Reference_SuccessZones": {
+ "title": "SuccessZones",
"type": "object",
- "description": "A GeoJSon Geometry representing the shape of the area, as specified in [RFC7946](https://datatracker.ietf.org/doc/html/rfc7946). \nTo display on the map, simply wrap this object in a feature:\n```json\n{\n \"type\": \"Feature\",\n \"geometry\": this_geojson_geometry\n}\n```\n",
+ "description": "Message returned to a success Zones request",
"properties": {
- "type": {
+ "status": {
"type": "string",
- "enum": [
- "Polygon",
- "MultiPoligon"
- ],
- "description": "the geometry type"
+ "description": "the status of the 2OO Zones response",
+ "example": "success"
},
- "coordinates": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_GeoJsonCoords"
- }
+ "message": {
+ "description": "message returned with the 2OO Zones request",
+ "example": "Zones successfully updated.",
+ "type": "string"
}
- },
- "example": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 2.06984,
- 48.77919
- ],
- [
- 2.07984,
- 48.77919
- ],
- [
- 2.07984,
- 48.78919
- ],
- [
- 2.06984,
- 48.78919
- ],
- [
- 2.06984,
- 48.77919
- ]
- ]
- ]
}
},
- "Woosmap_Platform_API_Reference_AddressComponents": {
- "title": "AddressComponents",
- "type": "array",
- "description": "An array containing Address Components with additional information",
- "items": {
- "type": "object",
- "description": "The address component object",
- "properties": {
- "long_name": {
- "oneOf": [
- {
- "type": "string"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ],
- "description": "The full text description or name of the address component, or a list of names (ie. list of postal codes).",
- "example": "United Kingdom"
- },
- "short_name": {
- "oneOf": [
- {
- "type": "string"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ],
- "description": "An abbreviated textual name for the address component, if available. For example, an address component for the state of United Kingdom may have a `long_name` of `United Kingdom` and a `short_name` of `UK` using the 2-letter postal abbreviation.",
- "example": "UK"
- },
- "types": {
- "description": "An array indicating the type of the address component.",
- "type": "array",
- "items": {
- "type": "string",
- "description": "address component type"
- },
- "example": [
- "country",
- "administrative_area_level_0"
- ]
- }
- },
- "example": {
- "types": [
- "country"
- ],
- "long_name": "United Kingdom",
- "short_name": "GBR"
+ "Maps_AuthenticationErrorResponse": {
+ "properties": {
+ "detail": {
+ "type": "string",
+ "title": "Detail"
}
},
- "example": [
- {
- "types": [
- "country"
- ],
- "long_name": "United Kingdom",
- "short_name": "GBR"
- },
- {
- "long_name": "London",
- "short_name": "London",
- "types": [
- "locality"
- ]
- }
- ]
- },
- "Woosmap_Platform_API_Reference_AdministrativeAreaLabel": {
- "title": "AdministrativeAreaLabel",
- "description": "Only available for `admin_level` suggestions, this contains the local english name of the administration level (\"department\" for France or \"federal_state\" for Germany).",
- "type": "string",
- "example": "district"
- },
- "Woosmap_Platform_API_Reference_LocalitiesStatus": {
- "title": "LocalitiesStatus",
- "type": "string",
- "description": "This optional field is only available for UK addresses referenced as not yet built by Royal Mail.",
- "enum": [
- "not_yet_built"
- ]
- },
- "Woosmap_Platform_API_Reference_LocalitiesAddressSummary": {
- "title": "LocalitiesAddressSummary",
"type": "object",
- "description": "A short description of an address",
"required": [
- "public_id",
- "description"
+ "detail"
],
- "example": {
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9faitia1pNNURnOWYvQmRjMUdweXl5SjdLZUZnPQ==",
- "description": "Flat 1, Radway House, Alfred Road, London, W2 5ER"
- },
+ "title": "AuthenticationErrorResponse",
+ "description": "AuthenticationErrorResponse is the base authentication error model."
+ },
+ "Maps_HTTPErrorModel": {
"properties": {
- "public_id": {
- "type": "string",
- "description": "The public_id of the address can be used to gather details on that specific address",
- "example": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9faitia1pNNURnOWYvQmRjMUdweXl5SjdLZUZnPQ=="
- },
- "description": {
+ "details": {
"type": "string",
- "description": "A human readable description of the address",
- "example": "Flat 1, Radway House, Alfred Road, London, W2 5ER"
+ "title": "Details"
}
- }
- },
- "Woosmap_Platform_API_Reference_LocalitiesDetailsResponse": {
- "title": "LocalitiesDetailsResponse",
+ },
"type": "object",
- "description": "Attributes describing a locality. Not all attributes are available for all locality types.",
+ "required": [
+ "details"
+ ],
+ "title": "HTTPErrorModel"
+ },
+ "Maps_HTTPValidationError": {
"properties": {
- "result": {
- "description": "The Root Node for Localities Details",
- "type": "object",
- "required": [
- "public_id",
- "formatted_address",
- "types",
- "geometry",
- "address_components"
- ],
- "properties": {
- "public_id": {
- "description": "Contains a unique ID for each suggestion. Please use this ID to give feedback on results.",
- "type": "string",
- "example": "MkvnYy6K6oVGqeqfWJGO/6eCgqo="
- },
- "formatted_address": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_FormattedAddress"
- },
- "types": {
- "description": "Available localities types.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesAll"
- }
- },
- "geometry": {
- "description": "The location of the PostalCode, in latitude and longitude, eventually associated with a Viewport and a shape.",
- "type": "object",
- "required": [
- "location"
- ],
- "properties": {
- "location": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LatLngLiteral"
- },
- "viewport": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Bounds"
- },
- "shape": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_GeoJsonGeometry"
- },
- "accuracy": {
- "type": "string",
- "description": "This accuracy represents the type of address returned - `DISTRICT` and `POSTAL_CODE` are for UK only.",
- "enum": [
- "ROOFTOP",
- "ROUTE",
- "GEOMETRIC_CENTER",
- "DISTRICT",
- "POSTAL_CODE",
- "RANGE_INTERPOLATED",
- "APPROXIMATE"
- ]
- }
- },
- "example": {
- "location": {
- "lat": 51.49984,
- "lng": -0.124663
- }
- }
- },
- "address_components": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AddressComponents"
- },
- "name": {
- "description": "The postal code name if result is a postal code.",
- "type": "string",
- "example": "SW1A 0AA"
- },
- "administrative_area_label": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AdministrativeAreaLabel"
- },
- "status": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesStatus"
- },
- "addresses": {
- "description": "For the UK only. When a postal code is returned, this field contains a list of addresses associated with this postal code.",
- "type": "object",
- "properties": {
- "pagination": {
- "type": "object",
- "deprecated": true,
- "description": "The pagination part of the response is deprecated as all the addresses are now automatically returned in the response. It will be turned off at some point. From now on, the pagination will systematically return `page=1`, `page_count=1`, `addresses_per_page=total addresses count` and `address_count=total addresses count`.",
- "properties": {
- "page": {
- "type": "integer",
- "description": "the request page",
- "deprecated": true
- },
- "page_count": {
- "type": "integer",
- "description": "the number of available pages",
- "deprecated": true
- },
- "addresses_per_page": {
- "type": "integer",
- "description": "the number of available addresses per page",
- "deprecated": true
- },
- "address_count": {
- "type": "integer",
- "description": "the number of available addresses",
- "deprecated": true
- }
- }
- },
- "list": {
- "type": "array",
- "description": "List of addresses",
- "items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesAddressSummary"
- }
- }
- }
- }
- }
+ "detail": {
+ "items": {
+ "$ref": "#/components/schemas/Maps_ValidationError"
+ },
+ "type": "array",
+ "title": "Detail"
}
},
- "example": {
- "result": {
- "public_id": "cG9zdGFsX2NvZGU6Z2I6OmNDN0N0ZUF2MW9YRi9KLzlnS2cremJndktFaz0=",
- "types": [
- "postal_code"
- ],
- "formatted_address": "SW1A 0AA, City of London",
- "name": "SW1A 0AA",
- "geometry": {
- "location": {
- "lat": 51.499842,
- "lng": -0.124638
- },
- "accuracy": "GEOMETRIC_CENTER"
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United Kingdom",
- "short_name": "GB"
- },
- {
- "types": [
- "state",
- "division_level_1"
- ],
- "long_name": "England",
- "short_name": "England"
- },
- {
- "types": [
- "administrative_area_level_1",
- "county",
- "division_level_2"
- ],
- "long_name": "City of London",
- "short_name": "City of London"
- },
- {
- "types": [
- "district",
- "division_level_3"
- ],
- "long_name": "Westminster",
- "short_name": "Westminster"
- },
- {
- "types": [
- "postal_codes"
- ],
- "long_name": "SW1A 0AA",
- "short_name": "SW1A 0AA"
- }
- ],
- "addresses": {
- "pagination": {
- "page": 1,
- "page_count": 1,
- "addresses_per_page": 1,
- "address_count": 1
- },
- "list": [
+ "type": "object",
+ "title": "HTTPValidationError"
+ },
+ "Maps_ValidationError": {
+ "properties": {
+ "loc": {
+ "items": {
+ "anyOf": [
{
- "public_id": "TVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPV9fTVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPQ==",
- "description": "House Of Commons, Houses Of Parliament London, SW1A 0AA"
+ "type": "string"
+ },
+ {
+ "type": "integer"
}
]
- }
- }
- }
- },
- "Woosmap_Platform_API_Reference_LocalitiesAddressGeometry": {
- "title": "LocalitiesAddressGeometry",
- "type": "object",
- "description": "The location of the result, in latitude and longitude. Accuracy is also provided.",
- "properties": {
- "location_type": {
- "description": "Specifies additional data about the geocoded location. The following values are currently supported: \n - `ROOFTOP` result is a precise geocode for which we have location information accurate down to street address precision.\n - `RANGE_INTERPOLATED` result reflects an approximation (usually on a road) interpolated between two precise points (such as intersections). Interpolated results are generally returned when rooftop geocodes are unavailable for a street address.\n - `GEOMETRIC_CENTER` result is the geometric center of a result such as a polyline (for example, a street) or polygon (city, region, …).\n - `APPROXIMATE` result is approximate (usually when no other above value applies)\n - `POSTAL_CODE` Address has inherited from the location of the postal code it is part of (for NYB addresses)\n - `DISTRICT` Address has inherited from the location of the district it is part of (for NYB addresses)\n",
+ },
+ "type": "array",
+ "title": "Location"
+ },
+ "msg": {
"type": "string",
- "enum": [
- "ROOFTOP",
- "RANGE_INTERPOLATED",
- "GEOMETRIC_CENTER",
- "APPROXIMATE",
- "POSTAL_CODE",
- "DISTRICT"
- ]
+ "title": "Message"
},
- "location": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LatLngLiteral"
+ "type": {
+ "type": "string",
+ "title": "Error Type"
},
- "viewport": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Bounds"
+ "input": {
+ "title": "Input"
},
- "shape": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_GeoJsonGeometry"
+ "ctx": {
+ "type": "object",
+ "title": "Context"
}
},
- "example": {
- "location": {
- "lat": 48.829405,
- "lng": 2.367944
- },
- "location_type": "GEOMETRIC_CENTER"
- }
- },
- "Woosmap_Platform_API_Reference_LocalitiesScoresPerComponents": {
- "title": "LocalitiesScoresPerComponents",
"type": "object",
+ "required": [
+ "loc",
+ "msg",
+ "type"
+ ],
+ "title": "ValidationError"
+ },
+ "Maps_MarkerWithUrlOptions": {
+ "example": {
+ "lat": 43.6,
+ "lng": 3.883,
+ "url": "https://webapp.woosmap.com/img/geolocated_marker.png?retina=yes"
+ },
"properties": {
- "street_name": {
- "description": "Street score",
- "type": "number"
- },
- "postal_code": {
- "description": "Postal code score",
+ "lat": {
+ "title": "Lat",
"type": "number"
},
- "locality": {
- "description": "Postal code score",
+ "lng": {
+ "title": "Lng",
"type": "number"
- }
- },
- "example": {
- "scores_per_components": {
- "street_name": 0.6153846153846154,
- "postal_code": 0.8,
- "locality": 1
- }
- }
- },
- "Woosmap_Platform_API_Reference_LocalitiesGeocodeResponse": {
- "title": "LocalitiesGeocodeResponse",
- "type": "object",
- "description": "Attributes describing a locality. Not all attributes will be available for all locality types.",
- "properties": {
- "formatted_address": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_FormattedAddress"
},
- "types": {
- "description": "An array containing the types of the result",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesAll"
- }
- },
- "administrative_area_label": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AdministrativeAreaLabel"
- },
- "public_id": {
- "description": "Contains a unique ID for each suggestion. Please use this ID to give feedback on results.",
- "type": "string",
- "example": "MkvnYy6K6oVGqeqfWJGO/6eCgqo="
- },
- "geometry": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesAddressGeometry"
+ "url": {
+ "anyOf": [
+ {
+ "format": "uri",
+ "maxLength": 2083,
+ "minLength": 1,
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "title": "Url"
+ }
+ },
+ "required": [
+ "lat",
+ "lng"
+ ],
+ "title": "MarkerWithUrlOptions",
+ "type": "object"
+ },
+ "Maps_PolylineOptions": {
+ "example": {
+ "color": "magenta",
+ "enc": "ydjiG_}jVjn@cjAf`AycBnc@mqCp\\ewBrQmlBzrAeuCreBw_C",
+ "weight": 4
+ },
+ "properties": {
+ "enc": {
+ "title": "Enc",
+ "type": "string"
},
- "status": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesStatus"
+ "color": {
+ "default": "rgb(65, 176, 246)",
+ "title": "Color",
+ "type": "string"
},
- "address_components": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AddressComponents"
+ "weight": {
+ "default": 1,
+ "title": "Weight",
+ "type": "number"
+ }
+ },
+ "required": [
+ "enc"
+ ],
+ "title": "PolylineOptions",
+ "type": "object"
+ },
+ "Maps_PolygonOptions": {
+ "example": {
+ "color": "rgba(199, 21, 133, 0.7)",
+ "fill_color": "rgba(255, 20, 147, 0.5)",
+ "shape": "ymgiGm|rV~uAtaB|dAefCqeBwuFu~@njC??"
+ },
+ "properties": {
+ "shape": {
+ "title": "Shape",
+ "type": "string"
},
- "distance": {
- "description": "When reverse geocoding, this field represents the distance (in meter) to the requested latlng",
- "type": "number",
- "example": 5.234
+ "color": {
+ "default": "rgb(65, 176, 246)",
+ "title": "Color",
+ "type": "string"
},
- "sub_buildings": {
- "description": "When reverse geocoding with `list_sub_buildings=true`, this field will contain a list of precise addresses that can be found at that location, i.e. all flats within a building.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesAddressSummary"
- }
+ "fill_color": {
+ "default": "rgba(65, 176, 246, 0.5)",
+ "title": "Fill Color",
+ "type": "string"
},
- "scores_per_components": {
- "description": "For each component (street_name, postal_code, and locality), it indicates the degree of correspondence with the original query. This value ranges from 0 to 1, with 0 indicating no match with the original query, and enables you to assess the quality of the Geocode's result.",
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesScoresPerComponents"
+ "weight": {
+ "default": 1,
+ "title": "Weight",
+ "type": "number"
}
- }
+ },
+ "required": [
+ "shape"
+ ],
+ "title": "PolygonOptions",
+ "type": "object"
},
- "Woosmap_Platform_API_Reference_LocalitiesGeocodeCollectionResponse": {
- "title": "LocalitiesGeocodeCollectionResponse",
- "type": "object",
- "description": "Localities Geocode Collection Response. Contains one or more detailed Localities or Addresses in FR or in the UK, with coordinates (default to one result for reverse geocoding)",
+ "Maps_MapStyle": {
"properties": {
- "results": {
- "type": "array",
+ "featureType": {
+ "title": "Featuretype",
+ "type": "string"
+ },
+ "elementType": {
+ "default": "all",
+ "title": "Elementtype",
+ "type": "string"
+ },
+ "stylers": {
"items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesGeocodeResponse"
- }
+ "$ref": "#/components/schemas/Maps_MapStyler"
+ },
+ "title": "Stylers",
+ "type": "array"
}
},
- "example": {
- "results": [
- {
- "public_id": "0+FTYd/1MsiBSxLAKq+/Fiyy+uM=",
- "types": [
- "address",
- "route"
- ],
- "formatted_address": "Place Jeanne D'Arc, 75013, Paris",
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "France",
- "short_name": "FR"
- },
- {
- "types": [
- "state",
- "division_level_1"
- ],
- "long_name": "Île-de-France",
- "short_name": "Île-de-France"
- },
- {
- "types": [
- "administrative_area_level_1",
- "county",
- "division_level_2"
- ],
- "long_name": "Paris",
- "short_name": "Paris"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "Paris",
- "short_name": "Paris"
- },
- {
- "types": [
- "postal_codes"
- ],
- "long_name": "75013",
- "short_name": "75013"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Place Jeanne D'Arc",
- "short_name": "Place Jeanne D'Arc"
- }
- ],
- "geometry": {
- "location": {
- "lat": 48.829405,
- "lng": 2.367944
- },
- "location_type": "GEOMETRIC_CENTER"
- },
- "scores_per_components": {
- "street_name": 1
- }
- }
- ]
- }
+ "required": [
+ "featureType",
+ "stylers"
+ ],
+ "title": "MapStyle",
+ "type": "object"
},
- "Woosmap_Platform_API_Reference_LocalitiesNearbyResponse": {
- "title": "LocalitiesNearbyResponse",
- "type": "object",
- "description": "Attributes describing a point of interest.",
+ "Maps_MapStyler": {
"properties": {
- "types": {
- "description": "An array containing the types of the result.",
- "type": "array",
- "example": [
- "point_of_interest",
- "transit.station.rail.train",
- "train_station"
+ "visibility": {
+ "anyOf": [
+ {
+ "enum": [
+ "on",
+ "off"
+ ],
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
],
- "items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesPoi"
- }
- },
- "name": {
- "description": "The name of the result.",
- "type": "string"
- },
- "public_id": {
- "description": "Contains a unique ID for each result. Please use this ID to give feedback on results.",
- "type": "string",
- "example": "NOAeiQADqqisOuN3NM7oXlhkROI="
+ "default": null,
+ "title": "Visibility"
},
- "geometry": {
- "description": "The location of the result, in latitude and longitude, eventually associated with a Viewport.",
- "type": "object",
- "properties": {
- "location": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LatLngLiteral"
+ "color": {
+ "anyOf": [
+ {
+ "type": "string"
},
- "viewport": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Bounds"
+ {
+ "type": "null"
}
- },
- "example": {
- "location": {
- "lat": 51.4998415,
- "lng": -0.1246375
+ ],
+ "default": null,
+ "title": "Color"
+ },
+ "hue": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
}
- }
+ ],
+ "default": null,
+ "title": "Hue"
},
- "address_components": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AddressComponents"
+ "saturation": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "title": "Saturation"
},
- "categories": {
- "description": "An array containing the categories of the result. This information is now available in the `types` field and will be removed.",
- "type": "array",
- "deprecated": true,
- "items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesPoi"
- }
+ "gamma": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "title": "Gamma"
},
- "formatted_address": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_FormattedAddress"
+ "lightness": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "title": "Lightness"
}
- }
+ },
+ "title": "MapStyler",
+ "type": "object"
},
- "Woosmap_Platform_API_Reference_LocalitiesNearbyCollectionResponse": {
- "title": "LocalitiesNearbyCollectionResponse",
+ "External-api-wrapper_what3words_AddressSummary": {
+ "properties": {
+ "public_id": {
+ "type": "string",
+ "title": "Public Id",
+ "description": "Public ID of address listed as sub_building"
+ },
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "Human readable address"
+ }
+ },
"type": "object",
- "description": "Collection of nearby points of interest.",
+ "required": [
+ "public_id",
+ "description"
+ ],
+ "title": "AddressSummary"
+ },
+ "External-api-wrapper_what3words_AuthenticationErrorResponse": {
"properties": {
- "results": {
- "description": "The array of nearby points of interest.",
- "type": "array",
+ "detail": {
+ "type": "string",
+ "title": "Detail"
+ }
+ },
+ "type": "object",
+ "required": [
+ "detail"
+ ],
+ "title": "AuthenticationErrorResponse",
+ "description": "AuthenticationErrorResponse is the base authentication error model."
+ },
+ "External-api-wrapper_what3words_AutoSuggestResponse": {
+ "properties": {
+ "suggestions": {
"items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesNearbyResponse"
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_AutoSuggestions"
+ },
+ "type": "array",
+ "title": "Suggestions"
+ }
+ },
+ "type": "object",
+ "required": [
+ "suggestions"
+ ],
+ "title": "AutoSuggestResponse",
+ "example": {
+ "suggestions": [
+ {
+ "country": "FR",
+ "distanceToFocusKm": 4,
+ "language": "en",
+ "nearestPlace": "Paris",
+ "rank": 1,
+ "words": "couches.spotted.alas"
+ },
+ {
+ "country": "FR",
+ "distanceToFocusKm": 8,
+ "language": "en",
+ "nearestPlace": "Paris",
+ "rank": 2,
+ "words": "couches.spotted.atom"
+ },
+ {
+ "country": "FR",
+ "distanceToFocusKm": 30,
+ "language": "en",
+ "nearestPlace": "Pontcarré, Seine-et-Marne",
+ "rank": 3,
+ "words": "couch.spotted.boat"
+ },
+ {
+ "country": "FR",
+ "distanceToFocusKm": 27,
+ "language": "en",
+ "nearestPlace": "Triel-sur-Seine, Yvelines",
+ "rank": 4,
+ "words": "vouch.spotted.dare"
}
+ ]
+ }
+ },
+ "External-api-wrapper_what3words_AutoSuggestions": {
+ "properties": {
+ "country": {
+ "type": "string",
+ "title": "Country",
+ "description": "Country Code"
},
- "pagination": {
- "description": "Helps to navigate through paginated results.",
- "type": "object",
- "properties": {
- "next_page": {
- "description": "If more results are available, this will contain the value to pass to the `page` parameter to get the next page",
- "type": [
- "integer",
- "null"
- ]
+ "nearestPlace": {
+ "type": "string",
+ "title": "Nearestplace",
+ "description": "Nearest Place"
+ },
+ "words": {
+ "type": "string",
+ "title": "Words",
+ "description": "The what3words address"
+ },
+ "distanceToFocusKm": {
+ "anyOf": [
+ {
+ "type": "integer"
},
- "previous_page": {
- "description": "If previous results are available, this will contain the value to pass to the `page` parameter to get the previous page",
- "type": [
- "integer",
- "null"
- ]
+ {
+ "type": "null"
}
- }
+ ],
+ "title": "Distancetofocuskm",
+ "description": "Distance to the Lat Lng focus (if provided)"
+ },
+ "rank": {
+ "type": "integer",
+ "title": "Rank",
+ "description": "Suggestion Rank"
+ },
+ "language": {
+ "type": "string",
+ "title": "Language",
+ "description": "Language Code"
+ }
+ },
+ "type": "object",
+ "required": [
+ "country",
+ "nearestPlace",
+ "words",
+ "rank",
+ "language"
+ ],
+ "title": "AutoSuggestions"
+ },
+ "External-api-wrapper_what3words_Coordinates": {
+ "properties": {
+ "lng": {
+ "type": "number",
+ "title": "Lng",
+ "description": "Longitude"
+ },
+ "lat": {
+ "type": "number",
+ "title": "Lat",
+ "description": "Latitude"
+ }
+ },
+ "type": "object",
+ "required": [
+ "lng",
+ "lat"
+ ],
+ "title": "Coordinates"
+ },
+ "External-api-wrapper_what3words_GeoJsonCoordinatesResponse": {
+ "properties": {
+ "features": {
+ "items": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_GeoJsonFeature"
+ },
+ "type": "array",
+ "title": "Features",
+ "description": "GeoJSON Features"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type",
+ "description": "GeoJSON Type"
}
},
+ "type": "object",
+ "required": [
+ "features",
+ "type"
+ ],
+ "title": "GeoJsonCoordinatesResponse",
"example": {
- "results": [
+ "features": [
{
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6ZTc2ZDA1YzBiM2M0M2NmNmVkNTJjNGQyZDFiZDE3Nzc0OTZkNjlmOA==",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.fast_food"
- ],
- "categories": [
- "business.food_and_drinks.fast_food"
+ "bbox": [
+ 2.294494,
+ 48.85829,
+ 2.294535,
+ 48.858317
],
- "name": "Pret A Manger",
- "formatted_address": "Broadway, New York",
"geometry": {
- "location": {
- "lat": 40.715905992166256,
- "lng": -74.00508673226767
- }
+ "coordinates": [
+ 2.294514,
+ 48.858304
+ ],
+ "type": "Point"
},
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Broadway",
- "short_name": "Broadway"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6MzBlMGYxMzVhNGUzZDQ4MzRiMmNlNDMzMWJiYjZkOTY0MWJhN2E0Zg==",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.fast_food"
- ],
- "categories": [
- "business.food_and_drinks.fast_food"
- ],
- "name": "Dunkin'",
- "formatted_address": "Broadway, New York",
- "geometry": {
- "location": {
- "lat": 40.71602115951586,
- "lng": -74.00494482664695
- }
+ "properties": {
+ "country": "FR",
+ "nearestPlace": "Paris",
+ "words": "couch.spotted.amended",
+ "language": "en",
+ "map": "https://w3w.co/couch.spotted.amended"
},
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Broadway",
- "short_name": "Broadway"
- }
- ]
+ "type": "Feature"
+ }
+ ],
+ "type": "FeatureCollection"
+ }
+ },
+ "External-api-wrapper_what3words_GeoJsonFeature": {
+ "properties": {
+ "bbox": {
+ "items": {
+ "type": "number"
},
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmJlMWNkMTE2ZDQwM2E0Y2YwNGQ5NWQ2OTlmZWRmM2FhZTExNGU3ZWY=",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.restaurant"
- ],
- "categories": [
- "business.food_and_drinks.restaurant"
- ],
- "name": "Chambers",
- "formatted_address": "Chambers Street, New York",
- "geometry": {
- "location": {
- "lat": 40.71461844801976,
- "lng": -74.00754036678366
- }
+ "type": "array",
+ "maxItems": 4,
+ "minItems": 4,
+ "title": "Bbox",
+ "description": "Bounding Box"
+ },
+ "geometry": {
+ "additionalProperties": true,
+ "type": "object",
+ "title": "Geometry",
+ "description": "Geometry"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type",
+ "description": "GeoJSON type"
+ },
+ "properties": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_Properties",
+ "description": "Feature Properties"
+ }
+ },
+ "type": "object",
+ "required": [
+ "bbox",
+ "geometry",
+ "type",
+ "properties"
+ ],
+ "title": "GeoJsonFeature"
+ },
+ "External-api-wrapper_what3words_HTTPErrorModel": {
+ "properties": {
+ "details": {
+ "type": "string",
+ "title": "Details"
+ }
+ },
+ "type": "object",
+ "required": [
+ "details"
+ ],
+ "title": "HTTPErrorModel"
+ },
+ "External-api-wrapper_what3words_HTTPValidationError": {
+ "properties": {
+ "detail": {
+ "items": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_ValidationError"
+ },
+ "type": "array",
+ "title": "Detail"
+ }
+ },
+ "type": "object",
+ "title": "HTTPValidationError"
+ },
+ "External-api-wrapper_what3words_JsonCoordinatesResponse": {
+ "properties": {
+ "country": {
+ "type": "string",
+ "title": "Country",
+ "description": "Country Code"
+ },
+ "nearestPlace": {
+ "type": "string",
+ "title": "Nearestplace",
+ "description": "Nearest Place"
+ },
+ "words": {
+ "type": "string",
+ "title": "Words",
+ "description": "The what3words address"
+ },
+ "language": {
+ "type": "string",
+ "title": "Language",
+ "description": "Language Code"
+ },
+ "locale": {
+ "anyOf": [
+ {
+ "type": "string"
},
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Locale",
+ "description": "Language Locale"
+ },
+ "map": {
+ "type": "string",
+ "title": "Map",
+ "description": "Link to what3words address on a map"
+ },
+ "square": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_Square",
+ "description": "Lat Lng coordinate Square"
+ },
+ "coordinates": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_Coordinates",
+ "description": "Lat Lng coordinate"
+ }
+ },
+ "type": "object",
+ "required": [
+ "country",
+ "nearestPlace",
+ "words",
+ "language",
+ "map",
+ "square",
+ "coordinates"
+ ],
+ "title": "JsonCoordinatesResponse",
+ "example": {
+ "coordinates": {
+ "lat": 48.858304,
+ "lng": 2.294514
+ },
+ "country": "FR",
+ "language": "en",
+ "map": "https://w3w.co/couch.spotted.amended",
+ "nearestPlace": "Paris",
+ "square": {
+ "northeast": {
+ "lat": 48.858317,
+ "lng": 2.294535
+ },
+ "southwest": {
+ "lat": 48.85829,
+ "lng": 2.294494
+ }
+ },
+ "words": "couch.spotted.amended"
+ }
+ },
+ "External-api-wrapper_what3words_LiteAddressResponse": {
+ "properties": {
+ "results": {
+ "items": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_LiteAddressResult"
+ },
+ "type": "array",
+ "title": "Results",
+ "description": "Results"
+ }
+ },
+ "type": "object",
+ "required": [
+ "results"
+ ],
+ "title": "LiteAddressResponse",
+ "example": {
+ "results": [
+ {
+ "description": "Radway House, Alfred Road, London, W2 5ER",
+ "public_id": "",
+ "sub_buildings": [
{
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
+ "description": "Flat 1, Radway House, Alfred Road, London, W2 5ER",
+ "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9faitia1pNNURnOWYvQmRjMUdweXl5SjdLZUZnPQ=="
},
{
- "types": [
- "route"
- ],
- "long_name": "Chambers Street",
- "short_name": "Chambers Street"
+ "description": "Flat 2, Radway House, Alfred Road, London, W2 5ER",
+ "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fbTRoZVpxYkhBYVVXSytqek04UGtGQ1VLTVI0PQ=="
}
+ ],
+ "types": [
+ "address"
]
},
{
- "public_id": "cG9pOnVzOmJ1c2luZXNzLnNob3AuZ3JvY2VyeTo1YTczMjYxOTQyYjVlZmUwOGEzZjQ1NGZmMTMwMmJjNjA4ODE3NmRk",
- "types": [
- "point_of_interest",
- "business.shop.grocery"
- ],
- "categories": [
- "business.shop.grocery"
- ],
- "name": "City Hall Oasis",
- "geometry": {
- "location": {
- "lat": 40.71283012706819,
- "lng": -74.00727837935057
+ "description": "Astley House, Alfred Road, London, W2 5EX",
+ "public_id": "",
+ "status": "not_yet_built",
+ "sub_buildings": [
+ {
+ "description": "Flat 1, Astley House, Alfred Road, London, W2 5EX",
+ "public_id": "N3VCclhUODduWjJxd2NCSUdFclJ6SnRseGxrPV9fSTBKM1YxOFBBWEJjRVNKb1J0T3hNTFNiLzhFPQ=="
},
- "viewport": {
- "northeast": {
- "lat": 40.71286059528623,
- "lng": -74.00724213866874
- },
- "southwest": {
- "lat": 40.71279957503111,
- "lng": -74.00731464213119
- }
- }
- },
- "address_components": [
{
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
+ "description": "Flat 2, Astley House, Alfred Road, London, W2 5EX",
+ "public_id": "N3VCclhUODduWjJxd2NCSUdFclJ6SnRseGxrPV9fN3VCclhUODduWjJxd2NCSUdFclJ6SnRseGxrPQ=="
}
+ ],
+ "types": [
+ "address"
]
},
{
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZpbmFuY2UuYmFuazpiOGY5MDE4Nzc2ZDZjNmEwZTljOGM4YWM0OTAxZWZlNzNmODZkM2M3",
- "types": [
- "point_of_interest",
- "business.finance.bank"
- ],
- "categories": [
- "business.finance.bank"
- ],
- "name": "Citibank",
- "formatted_address": "Broadway, New York",
- "geometry": {
- "location": {
- "lat": 40.7130414767567,
- "lng": -74.0074818610995
- }
- },
- "address_components": [
+ "description": "65 Alfred Road, London, W2 5EU",
+ "public_id": "",
+ "sub_buildings": [
{
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
+ "description": "Blaiz Ltd, 65 Alfred Road, London, W2 5EU",
+ "public_id": "MUVBZWttTlo4OUYxL2dQWmJteDdFV2VidmVvPV9fMUVBZWttTlo4OUYxL2dQWmJteDdFV2VidmVvPQ=="
},
{
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Broadway",
- "short_name": "Broadway"
+ "description": "Carnot Ltd, 65 Alfred Road, London, W2 5EU",
+ "public_id": "MUVBZWttTlo4OUYxL2dQWmJteDdFV2VidmVvPV9fRDRPb0VLd0UvNEZYMlpLR21EMC9xRGQvMUZJPQ=="
}
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQzMTMzZTJkODdiOGJjMGE3ZjI2YTdiMWVjYTZlZmI1MjQyYWE3MTE=",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.restaurant"
],
- "categories": [
- "business.food_and_drinks.restaurant"
- ],
- "name": "Saffron",
- "geometry": {
- "location": {
- "lat": 40.71467049963849,
- "lng": -74.00767187884445
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQ1NjMyN2RiM2EyNWJlYmIwNjJjZjNlYWYwMDE3ZDIyYzEyNWNlMjY=",
"types": [
- "point_of_interest",
- "business.food_and_drinks.restaurant"
- ],
- "categories": [
- "business.food_and_drinks.restaurant"
- ],
- "name": "Gran Morsi",
- "geometry": {
- "location": {
- "lat": 40.71432885326513,
- "lng": -74.00778746528921
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- }
+ "address"
]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5iYXI6MDE5ZGUzNTdiZDkyNzAyZDM4ZDUyOWQ0YmJiZjBmODQ5YWEzZmY1NA==",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.bar"
- ],
- "categories": [
- "business.food_and_drinks.bar"
- ],
- "name": "Bon Courage",
- "formatted_address": "Reade Street, New York",
- "geometry": {
- "location": {
- "lat": 40.71541472882126,
- "lng": -74.00719193106873
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Reade Street",
- "short_name": "Reade Street"
- }
+ }
+ ]
+ }
+ },
+ "External-api-wrapper_what3words_LiteAddressResult": {
+ "properties": {
+ "types": {
+ "items": {
+ "type": "string",
+ "enum": [
+ "address",
+ "route",
+ "named_place",
+ "locality",
+ "city",
+ "town",
+ "village",
+ "hamlet",
+ "borough",
+ "suburb",
+ "quarter",
+ "neighbourhood",
+ "postal_code",
+ "admin_level"
]
},
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6OGIyNDY5MDM4M2JhYzE1NmY4OGRiMGQzYmIyYzNjMTVmOTk0NDQwZQ==",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.fast_food"
- ],
- "categories": [
- "business.food_and_drinks.fast_food"
- ],
- "name": "Burger King",
- "formatted_address": "Broadway, New York",
- "geometry": {
- "location": {
- "lat": 40.71619516782573,
- "lng": -74.00480635760651
- }
+ "type": "array",
+ "title": "Types",
+ "description": "Address Types"
+ },
+ "formatted_address": {
+ "type": "string",
+ "title": "Formatted Address",
+ "description": "Human readable address"
+ },
+ "public_id": {
+ "type": "string",
+ "title": "Public Id",
+ "description": "Public ID of the POI"
+ },
+ "status": {
+ "anyOf": [
+ {
+ "type": "string",
+ "const": "not_yet_built"
},
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Status",
+ "description": "Address Status"
+ },
+ "sub_buildings": {
+ "anyOf": [
+ {
+ "items": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_AddressSummary"
},
- {
- "types": [
- "route"
- ],
- "long_name": "Broadway",
- "short_name": "Broadway"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLnRoZWF0cmU6MTU1Yjk5YmEwY2FiYzIzZjYxYWYyYTViYzI0ZDViYTVlNmVmZTAwNA==",
- "types": [
- "point_of_interest",
- "business.theatre"
- ],
- "categories": [
- "business.theatre"
- ],
- "name": "The Flea",
- "formatted_address": "Thomas Street, New York",
- "geometry": {
- "location": {
- "lat": 40.71609349534023,
- "lng": -74.00589281989586
- }
+ "type": "array"
},
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Thomas Street",
- "short_name": "Thomas Street"
- }
- ]
- }
- ],
- "pagination": {
- "previous_page": 2,
- "next_page": 4
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sub Buildings",
+ "description": "list of specific addresses at that location"
}
- }
- },
- "Woosmap_Platform_API_Reference_Zone": {
- "title": "Zone",
+ },
"type": "object",
- "description": "Attributes describing a Zone.",
"required": [
- "store_id",
- "zone_id",
- "polygon"
+ "types",
+ "formatted_address",
+ "public_id"
],
+ "title": "LiteAddressResult"
+ },
+ "External-api-wrapper_what3words_Properties": {
"properties": {
- "zone_id": {
- "description": "A textual identifier that uniquely identifies a Zone.",
+ "country": {
"type": "string",
- "example": "ZoneA"
+ "title": "Country",
+ "description": "Country Code"
},
- "description": {
+ "nearestPlace": {
"type": "string",
- "description": "Textual description of your Zone",
- "example": "Delivery Zone for Store A"
+ "title": "Nearestplace",
+ "description": "Nearest Place"
},
- "store_id": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AssetId"
+ "words": {
+ "type": "string",
+ "title": "Words",
+ "description": "The what3words address"
},
- "polygon": {
+ "language": {
"type": "string",
- "description": "Zone geometry polygon as **Well Known Text**. WKT defines how to represent geometry of one object (cf. https://en.wikipedia.org/wiki/Well-known_text). Your zones could be complex and multipart polygons.",
- "example": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))"
+ "title": "Language",
+ "description": "Language Code"
},
- "types": {
- "description": "Contains an array of types describing the Zone.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "example": [
- "delivery",
- "san_francisco_west"
- ]
+ "locale": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Locale",
+ "description": "Language Locale"
},
- "status": {
+ "map": {
"type": "string",
- "description": "the status as string",
- "example": "ok"
+ "title": "Map",
+ "description": "Link to what3words address on a map"
}
},
- "example": {
- "store_id": "STORE_ID_123456",
- "zone_id": "ZoneA",
- "polygon": "POLYGON ((-122.496116 37.7648181, -122.4954079 37.751518, -122.4635648 37.7530788, -122.4618481 37.7514501, -122.4601315 37.7521288, -122.4565266 37.7513144, -122.4540375 37.7566755, -122.4528359 37.7583041, -122.4515485 37.7595934, -122.4546384 37.774656, -122.4718903 37.7731635, -122.472577 37.772485, -122.4755811 37.7725529, -122.4791001 37.7723493, -122.4793576 37.7713995, -122.4784993 37.769839, -122.4783276 37.7680071, -122.4774693 37.766718, -122.4772118 37.7652931, -122.496116 37.7648181))",
- "types": [
- "delivery"
- ],
- "description": "Delivery Zone for Store A",
- "status": "ok"
- }
- },
- "Woosmap_Platform_API_Reference_ZonesCollectionResponse": {
- "title": "ZonesCollectionResponse",
- "type": "object",
- "description": "A Collection of Woosmap Zones retrieved in response to a get zones list.",
- "properties": {
- "zones": {
- "description": "The Zones collection",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Zone"
- }
- },
- "status": {
- "type": "string",
- "description": "the status as string",
- "example": "ok"
- }
- },
- "example": {
- "zones": [
- {
- "store_id": "STORE_ID_123456",
- "zone_id": "ZoneB",
- "polygon": "POLYGON ((-122.4546384 37.774656, -122.4515485 37.7595934, -122.4354306 37.7602172, -122.4333707 37.7512596, -122.423071 37.7511239, -122.4242726 37.7687665, -122.4259893 37.7691736, -122.4289075 37.7732444, -122.4306241 37.7850483, -122.4472753 37.7830133, -122.445902 37.7759581, -122.4546384 37.774656))",
- "types": [
- "delivery"
- ],
- "description": "Delivery Zone for Store B"
- },
- {
- "store_id": "STORE_ID_45678",
- "zone_id": "ZoneC",
- "polygon": "POLYGON ((-122.4758889 37.7524995, -122.4751594 37.7321718, -122.4688079 37.7299995, -122.4648597 37.7261979, -122.4519851 37.7228035, -122.4483802 37.7215815, -122.4458053 37.726741, -122.4365356 37.7310857, -122.4315574 37.7324433, -122.4246909 37.7312214, -122.4219444 37.731493, -122.423071 37.7511239, -122.4333707 37.7512596, -122.4354306 37.7602172, -122.4515485 37.7595934, -122.4528628 37.7582744, -122.4540375 37.7566755, -122.4565266 37.7513144, -122.4601315 37.7521288, -122.4618481 37.7514501, -122.4635648 37.7530788, -122.4758889 37.7524995))",
- "types": [
- "delivery"
- ],
- "description": "Delivery Zone for Store C"
- }
- ],
- "status": "ok"
- }
- },
- "Woosmap_Platform_API_Reference_ZonesCollectionRequest": {
- "title": "ZonesCollectionRequest",
"type": "object",
- "description": "A Collection of Woosmap Zones as expected for Data Management Data API.",
"required": [
- "zones"
+ "country",
+ "nearestPlace",
+ "words",
+ "language",
+ "map"
],
- "properties": {
- "zones": {
- "description": "The Zones collection",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Zone"
- }
- }
- },
- "example": {
- "zones": [
- {
- "zone_id": "ZoneA",
- "description": "Delivery Zone for Store A",
- "store_id": "STORE_ID_123456",
- "polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))",
- "types": [
- "delivery"
- ]
- },
- {
- "zone_id": "ZoneB",
- "description": "Delivery Zone for Store B",
- "store_id": "STORE_ID_123456",
- "polygon": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))",
- "types": [
- "delivery"
- ]
- },
- {
- "zone_id": "ZoneC",
- "description": "Delivery Zone for Store C",
- "store_id": "STORE_ID_45678",
- "polygon": "POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))",
- "types": [
- "delivery"
- ]
- }
- ]
- }
+ "title": "Properties"
},
- "Woosmap_Platform_API_Reference_SuccessZones": {
- "title": "SuccessZones",
- "type": "object",
- "description": "Message returned to a success Zones request",
+ "External-api-wrapper_what3words_Square": {
"properties": {
- "status": {
- "type": "string",
- "description": "the status of the 2OO Zones response",
- "example": "success"
+ "southwest": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_Coordinates",
+ "description": "Lat Lng coordinate"
},
- "message": {
- "description": "message returned with the 2OO Zones request",
- "example": "Zones successfully updated.",
- "type": "string"
- }
- }
- },
- "Maps_AuthenticationErrorResponse": {
- "properties": {
- "detail": {
- "type": "string",
- "title": "Detail"
- }
- },
- "type": "object",
- "required": [
- "detail"
- ],
- "title": "AuthenticationErrorResponse",
- "description": "AuthenticationErrorResponse is the base authentication error model."
- },
- "Maps_HTTPErrorModel": {
- "properties": {
- "details": {
- "type": "string",
- "title": "Details"
+ "northeast": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_Coordinates",
+ "description": "Lat Lng coordinate"
}
},
"type": "object",
"required": [
- "details"
+ "southwest",
+ "northeast"
],
- "title": "HTTPErrorModel"
- },
- "Maps_HTTPValidationError": {
- "properties": {
- "detail": {
- "items": {
- "$ref": "#/components/schemas/Maps_ValidationError"
- },
- "type": "array",
- "title": "Detail"
- }
- },
- "type": "object",
- "title": "HTTPValidationError"
+ "title": "Square"
},
- "Maps_ValidationError": {
+ "External-api-wrapper_what3words_ValidationError": {
"properties": {
"loc": {
"items": {
@@ -15965,13 +15623,6 @@
"type": {
"type": "string",
"title": "Error Type"
- },
- "input": {
- "title": "Input"
- },
- "ctx": {
- "type": "object",
- "title": "Context"
}
},
"type": "object",
@@ -15982,150 +15633,60 @@
],
"title": "ValidationError"
},
- "Maps_MarkerWithUrlOptions": {
- "example": {
- "lat": 43.6,
- "lng": 3.883,
- "url": "https://webapp.woosmap.com/img/geolocated_marker.png?retina=yes"
+ "Indoor_API_ErrorResponseSchema": {
+ "properties": {
+ "detail": {
+ "title": "Detail",
+ "type": "string"
+ }
},
+ "required": [
+ "detail"
+ ],
+ "title": "ErrorResponseSchema",
+ "type": "object"
+ },
+ "Indoor_API_Building": {
"properties": {
- "lat": {
- "title": "Lat",
- "type": "number"
- },
- "lng": {
- "title": "Lng",
- "type": "number"
+ "ref": {
+ "description": "Reference to identify Building",
+ "title": "Ref",
+ "type": "string"
},
- "url": {
+ "name": {
"anyOf": [
{
- "format": "uri",
- "maxLength": 2083,
- "minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
- "default": null,
- "title": "Url"
- }
- },
- "required": [
- "lat",
- "lng"
- ],
- "title": "MarkerWithUrlOptions",
- "type": "object"
- },
- "Maps_PolylineOptions": {
- "example": {
- "color": "magenta",
- "enc": "ydjiG_}jVjn@cjAf`AycBnc@mqCp\\ewBrQmlBzrAeuCreBw_C",
- "weight": 4
- },
- "properties": {
- "enc": {
- "title": "Enc",
- "type": "string"
+ "description": "Name of the Building",
+ "title": "Name"
},
- "color": {
- "default": "rgb(65, 176, 246)",
- "title": "Color",
- "type": "string"
+ "localized_name": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "default": {},
+ "description": "Translated names of the Building",
+ "title": "Localized Name",
+ "type": "object"
},
- "weight": {
- "default": 1,
- "title": "Weight",
- "type": "number"
- }
- },
- "required": [
- "enc"
- ],
- "title": "PolylineOptions",
- "type": "object"
- },
- "Maps_PolygonOptions": {
- "example": {
- "color": "rgba(199, 21, 133, 0.7)",
- "fill_color": "rgba(255, 20, 147, 0.5)",
- "shape": "ymgiGm|rV~uAtaB|dAefCqeBwuFu~@njC??"
- },
- "properties": {
- "shape": {
- "title": "Shape",
- "type": "string"
- },
- "color": {
- "default": "rgb(65, 176, 246)",
- "title": "Color",
- "type": "string"
- },
- "fill_color": {
- "default": "rgba(65, 176, 246, 0.5)",
- "title": "Fill Color",
- "type": "string"
- },
- "weight": {
- "default": 1,
- "title": "Weight",
- "type": "number"
- }
- },
- "required": [
- "shape"
- ],
- "title": "PolygonOptions",
- "type": "object"
- },
- "Maps_MapStyle": {
- "properties": {
- "featureType": {
- "title": "Featuretype",
- "type": "string"
- },
- "elementType": {
- "default": "all",
- "title": "Elementtype",
- "type": "string"
- },
- "stylers": {
- "items": {
- "$ref": "#/components/schemas/Maps_MapStyler"
- },
- "title": "Stylers",
- "type": "array"
- }
- },
- "required": [
- "featureType",
- "stylers"
- ],
- "title": "MapStyle",
- "type": "object"
- },
- "Maps_MapStyler": {
- "properties": {
- "visibility": {
+ "description": {
"anyOf": [
{
- "enum": [
- "on",
- "off"
- ],
"type": "string"
},
{
"type": "null"
}
],
- "default": null,
- "title": "Visibility"
+ "description": "Building Description",
+ "title": "Description"
},
- "color": {
+ "opening_hours": {
"anyOf": [
{
"type": "string"
@@ -16134,10 +15695,10 @@
"type": "null"
}
],
- "default": null,
- "title": "Color"
+ "description": "Building Opening Hours",
+ "title": "Opening Hours"
},
- "hue": {
+ "logo": {
"anyOf": [
{
"type": "string"
@@ -16146,342 +15707,489 @@
"type": "null"
}
],
- "default": null,
- "title": "Hue"
+ "description": "",
+ "title": "Logo"
},
- "saturation": {
+ "cover": {
"anyOf": [
{
- "type": "number"
+ "type": "string"
},
{
"type": "null"
}
],
- "default": null,
- "title": "Saturation"
+ "description": "",
+ "title": "Cover"
},
- "gamma": {
+ "levels": {
+ "description": "Levels associated with the Building",
+ "items": {
+ "$ref": "#/components/schemas/Indoor_API_Level"
+ },
+ "title": "Levels",
+ "type": "array"
+ }
+ },
+ "required": [
+ "ref",
+ "levels"
+ ],
+ "title": "Building",
+ "type": "object"
+ },
+ "Indoor_API_Level": {
+ "properties": {
+ "level": {
+ "description": "Floor level as a number",
+ "title": "Level",
+ "type": "integer"
+ },
+ "name": {
"anyOf": [
{
- "type": "number"
+ "type": "string"
},
{
"type": "null"
}
],
- "default": null,
- "title": "Gamma"
+ "description": "Name of the floor level",
+ "title": "Name"
},
- "lightness": {
+ "ref": {
"anyOf": [
{
- "type": "number"
+ "type": "string"
},
{
"type": "null"
}
],
- "default": null,
- "title": "Lightness"
- }
- },
- "title": "MapStyler",
- "type": "object"
- },
- "External-api-wrapper_what3words_AddressSummary": {
- "properties": {
- "public_id": {
- "type": "string",
- "title": "Public Id",
- "description": "Public ID of address listed as sub_building"
+ "description": "Reference to identify floor level",
+ "title": "Ref"
},
- "description": {
- "type": "string",
- "title": "Description",
- "description": "Human readable address"
- }
- },
- "type": "object",
- "required": [
- "public_id",
- "description"
- ],
- "title": "AddressSummary"
- },
- "External-api-wrapper_what3words_AuthenticationErrorResponse": {
- "properties": {
- "detail": {
- "type": "string",
- "title": "Detail"
- }
- },
- "type": "object",
- "required": [
- "detail"
- ],
- "title": "AuthenticationErrorResponse",
- "description": "AuthenticationErrorResponse is the base authentication error model."
- },
- "External-api-wrapper_what3words_AutoSuggestResponse": {
- "properties": {
- "suggestions": {
+ "bbox": {
+ "description": "Bounding Box of floor level",
"items": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_AutoSuggestions"
+ "type": "number"
},
- "type": "array",
- "title": "Suggestions"
+ "title": "Bbox",
+ "type": "array"
}
},
- "type": "object",
"required": [
- "suggestions"
+ "level",
+ "bbox"
],
- "title": "AutoSuggestResponse",
+ "title": "Level",
+ "type": "object"
+ },
+ "Indoor_API_VenueSchema": {
"example": {
- "suggestions": [
- {
- "country": "FR",
- "distanceToFocusKm": 4,
- "language": "en",
- "nearestPlace": "Paris",
- "rank": 1,
- "words": "couches.spotted.alas"
- },
- {
- "country": "FR",
- "distanceToFocusKm": 8,
- "language": "en",
- "nearestPlace": "Paris",
- "rank": 2,
- "words": "couches.spotted.atom"
- },
+ "bbox": [
+ -0.1258015,
+ 51.4981306,
+ -0.1236527,
+ 51.5008191
+ ],
+ "buildings": [
{
- "country": "FR",
- "distanceToFocusKm": 30,
- "language": "en",
- "nearestPlace": "Pontcarré, Seine-et-Marne",
- "rank": 3,
- "words": "couch.spotted.boat"
- },
+ "cover": null,
+ "description": null,
+ "levels": [
+ {
+ "bbox": [
+ -0.1258015,
+ 51.4981306,
+ -0.1236527,
+ 51.5008191
+ ],
+ "level": 1,
+ "name": "Palace of Westminster",
+ "ref": "Ground"
+ }
+ ],
+ "localized_name": {},
+ "logo": null,
+ "name": "Palace of Westminster",
+ "opening_hours": null,
+ "ref": "Palace of Westminster"
+ }
+ ],
+ "categories": [],
+ "languages": [],
+ "levels": [
{
- "country": "FR",
- "distanceToFocusKm": 27,
- "language": "en",
- "nearestPlace": "Triel-sur-Seine, Yvelines",
- "rank": 4,
- "words": "vouch.spotted.dare"
+ "bbox": [
+ -0.1258015,
+ 51.4981306,
+ -0.1236527,
+ 51.5008191
+ ],
+ "level": 1,
+ "name": "Palace of Westminster",
+ "ref": "Ground"
}
- ]
- }
- },
- "External-api-wrapper_what3words_AutoSuggestions": {
- "properties": {
- "country": {
- "type": "string",
- "title": "Country",
- "description": "Country Code"
- },
- "nearestPlace": {
- "type": "string",
- "title": "Nearestplace",
- "description": "Nearest Place"
+ ],
+ "name": "Westminster palace",
+ "routing_profiles": [],
+ "updated_at": "2023-07-17T13:11:32.267Z",
+ "venue_id": "west_pal"
+ },
+ "properties": {
+ "venue_id": {
+ "description": "ID of the Venue",
+ "title": "Venue Id",
+ "type": "string"
},
- "words": {
- "type": "string",
- "title": "Words",
- "description": "The what3words address"
+ "name": {
+ "description": "Name of the Venue",
+ "title": "Name",
+ "type": "string"
},
- "distanceToFocusKm": {
+ "bbox": {
"anyOf": [
{
- "type": "integer"
+ "maxItems": 4,
+ "minItems": 4,
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Distancetofocuskm",
- "description": "Distance to the Lat Lng focus (if provided)"
+ "description": "Bounding Box of Venue",
+ "title": "Bbox"
},
- "rank": {
- "type": "integer",
- "title": "Rank",
- "description": "Suggestion Rank"
+ "levels": {
+ "default": [],
+ "description": "Information on each level of the venue",
+ "items": {
+ "$ref": "#/components/schemas/Indoor_API_Level"
+ },
+ "title": "Levels",
+ "type": "array"
},
- "language": {
- "type": "string",
- "title": "Language",
- "description": "Language Code"
+ "routing_profiles": {
+ "default": [],
+ "description": "Available routing profiles for the venue",
+ "items": {
+ "type": "string"
+ },
+ "title": "Routing Profiles",
+ "type": "array"
+ },
+ "categories": {
+ "default": [],
+ "description": "",
+ "items": {
+ "type": "string"
+ },
+ "title": "Categories",
+ "type": "array"
+ },
+ "buildings": {
+ "default": [],
+ "description": "Buildings present at the venue",
+ "items": {
+ "$ref": "#/components/schemas/Indoor_API_Building"
+ },
+ "title": "Buildings",
+ "type": "array"
+ },
+ "languages": {
+ "description": "Language translations available for the venue",
+ "items": {
+ "type": "string"
+ },
+ "title": "Languages",
+ "type": "array"
+ },
+ "updated_at": {
+ "description": "When this venue was last updated",
+ "format": "date-time",
+ "title": "Updated At",
+ "type": "string"
}
},
- "type": "object",
"required": [
- "country",
- "nearestPlace",
- "words",
- "rank",
- "language"
+ "venue_id",
+ "name",
+ "bbox",
+ "languages",
+ "updated_at"
],
- "title": "AutoSuggestions"
+ "title": "VenueSchema",
+ "type": "object"
},
- "External-api-wrapper_what3words_Coordinates": {
+ "Indoor_API_VenueListSchema": {
+ "example": [
+ {
+ "bbox": [
+ -0.1258015,
+ 51.4981306,
+ -0.1236527,
+ 51.5008191
+ ],
+ "name": "Westminster palace",
+ "venue_id": "west_pal"
+ },
+ {
+ "bbox": [
+ 3.9215275,
+ 43.6062712,
+ 3.922097,
+ 43.606972
+ ],
+ "name": "Woosmap HQ",
+ "venue_id": "woosmap_wgs_office"
+ },
+ {
+ "bbox": [
+ 2.3537419,
+ 48.87969358511,
+ 2.3584085,
+ 48.8831854
+ ],
+ "name": "Gare Du Nord",
+ "venue_id": "woosmap_gdn"
+ }
+ ],
"properties": {
- "lng": {
- "type": "number",
- "title": "Lng",
- "description": "Longitude"
+ "venue_id": {
+ "description": "ID of the Venue",
+ "title": "Venue Id",
+ "type": "string"
},
- "lat": {
- "type": "number",
- "title": "Lat",
- "description": "Latitude"
+ "name": {
+ "description": "Name of the Venue",
+ "title": "Name",
+ "type": "string"
+ },
+ "bbox": {
+ "anyOf": [
+ {
+ "maxItems": 4,
+ "minItems": 4,
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Bounding Box of Venue",
+ "title": "Bbox"
}
},
- "type": "object",
"required": [
- "lng",
- "lat"
+ "venue_id",
+ "name",
+ "bbox"
],
- "title": "Coordinates"
+ "title": "VenueListSchema",
+ "type": "object"
},
- "External-api-wrapper_what3words_GeoJsonCoordinatesResponse": {
+ "Indoor_API_Distance": {
"properties": {
- "features": {
- "items": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_GeoJsonFeature"
- },
- "type": "array",
- "title": "Features",
- "description": "GeoJSON Features"
+ "value": {
+ "description": "Distance in metres",
+ "title": "Value",
+ "type": "number"
},
- "type": {
- "type": "string",
- "title": "Type",
- "description": "GeoJSON Type"
+ "text": {
+ "description": "Distance as text based response with unit type",
+ "title": "Text",
+ "type": "string"
}
},
- "type": "object",
"required": [
- "features",
- "type"
+ "value",
+ "text"
],
- "title": "GeoJsonCoordinatesResponse",
+ "title": "Distance",
+ "type": "object"
+ },
+ "Indoor_API_DistanceMatrixCollection": {
"example": {
- "features": [
- {
- "bbox": [
- 2.294494,
- 48.85829,
- 2.294535,
- 48.858317
- ],
- "geometry": {
- "coordinates": [
- 2.294514,
- 48.858304
- ],
- "type": "Point"
- },
- "properties": {
- "country": "FR",
- "nearestPlace": "Paris",
- "words": "couch.spotted.amended",
- "language": "en",
- "map": "https://w3w.co/couch.spotted.amended"
- },
- "type": "Feature"
- }
- ],
- "type": "FeatureCollection"
- }
- },
- "External-api-wrapper_what3words_GeoJsonFeature": {
+ "rows": [],
+ "status": "OK"
+ },
"properties": {
- "bbox": {
+ "status": {
+ "description": "A string to indicate the success of the request",
+ "title": "Status",
+ "type": "string"
+ },
+ "rows": {
"items": {
- "type": "number"
+ "$ref": "#/components/schemas/Indoor_API_DistanceMatrixRow"
},
- "type": "array",
- "maxItems": 4,
- "minItems": 4,
- "title": "Bbox",
- "description": "Bounding Box"
+ "title": "Rows",
+ "type": "array"
+ }
+ },
+ "required": [
+ "status",
+ "rows"
+ ],
+ "title": "DistanceMatrixCollection",
+ "type": "object"
+ },
+ "Indoor_API_DistanceMatrixElement": {
+ "properties": {
+ "status": {
+ "description": "A string to indicate if a path was found or not",
+ "title": "Status",
+ "type": "string"
},
- "geometry": {
- "additionalProperties": true,
- "type": "object",
- "title": "Geometry",
- "description": "Geometry"
+ "duration": {
+ "$ref": "#/components/schemas/Indoor_API_Duration"
},
- "type": {
- "type": "string",
- "title": "Type",
- "description": "GeoJSON type"
+ "distance": {
+ "$ref": "#/components/schemas/Indoor_API_Distance"
+ }
+ },
+ "required": [
+ "status",
+ "duration",
+ "distance"
+ ],
+ "title": "DistanceMatrixElement",
+ "type": "object"
+ },
+ "Indoor_API_DistanceMatrixRow": {
+ "properties": {
+ "elements": {
+ "items": {
+ "$ref": "#/components/schemas/Indoor_API_DistanceMatrixElement"
+ },
+ "title": "Elements",
+ "type": "array"
+ }
+ },
+ "required": [
+ "elements"
+ ],
+ "title": "DistanceMatrixRow",
+ "type": "object"
+ },
+ "Indoor_API_Duration": {
+ "properties": {
+ "value": {
+ "description": "Duration in seconds",
+ "title": "Value",
+ "type": "number"
},
- "properties": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_Properties",
- "description": "Feature Properties"
+ "text": {
+ "description": "Duration as text based response with unit type",
+ "title": "Text",
+ "type": "string"
}
},
- "type": "object",
"required": [
- "bbox",
- "geometry",
- "type",
- "properties"
+ "value",
+ "text"
],
- "title": "GeoJsonFeature"
+ "title": "Duration",
+ "type": "object"
},
- "External-api-wrapper_what3words_HTTPErrorModel": {
+ "Indoor_API_Instruction": {
"properties": {
- "details": {
- "type": "string",
- "title": "Details"
+ "summary": {
+ "title": "Summary",
+ "type": "string"
+ },
+ "instruction_type": {
+ "title": "Instruction Type",
+ "type": "string"
}
},
- "type": "object",
"required": [
- "details"
+ "summary",
+ "instruction_type"
],
- "title": "HTTPErrorModel"
+ "title": "Instruction",
+ "type": "object"
},
- "External-api-wrapper_what3words_HTTPValidationError": {
+ "Indoor_API_LatLngLevel": {
"properties": {
- "detail": {
- "items": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_ValidationError"
- },
- "type": "array",
- "title": "Detail"
+ "lat": {
+ "title": "Lat",
+ "type": "number"
+ },
+ "lng": {
+ "title": "Lng",
+ "type": "number"
+ },
+ "level": {
+ "title": "Level",
+ "type": "integer"
}
},
- "type": "object",
- "title": "HTTPValidationError"
+ "required": [
+ "lat",
+ "lng",
+ "level"
+ ],
+ "title": "LatLngLevel",
+ "type": "object"
},
- "External-api-wrapper_what3words_JsonCoordinatesResponse": {
+ "Indoor_API_Leg": {
"properties": {
- "country": {
- "type": "string",
- "title": "Country",
- "description": "Country Code"
+ "distance": {
+ "$ref": "#/components/schemas/Indoor_API_Distance",
+ "description": "Distance of this Leg"
},
- "nearestPlace": {
- "type": "string",
- "title": "Nearestplace",
- "description": "Nearest Place"
+ "duration": {
+ "$ref": "#/components/schemas/Indoor_API_Duration",
+ "description": "Duration of this Leg"
},
- "words": {
- "type": "string",
- "title": "Words",
- "description": "The what3words address"
+ "start_location": {
+ "$ref": "#/components/schemas/Indoor_API_LatLngLevel",
+ "description": "Starting Location of this Leg, as a Lat,Lng pair with a floor level number."
},
- "language": {
- "type": "string",
- "title": "Language",
- "description": "Language Code"
+ "end_location": {
+ "$ref": "#/components/schemas/Indoor_API_LatLngLevel",
+ "description": "End Location of this Leg, as a Lat,Lng pair with a floor level number."
},
- "locale": {
+ "steps": {
+ "description": "List of different steps of this Leg",
+ "items": {
+ "$ref": "#/components/schemas/Indoor_API_Step"
+ },
+ "title": "Steps",
+ "type": "array"
+ },
+ "waypoint": {
"anyOf": [
{
"type": "string"
@@ -16490,518 +16198,291 @@
"type": "null"
}
],
- "title": "Locale",
- "description": "Language Locale"
- },
- "map": {
- "type": "string",
- "title": "Map",
- "description": "Link to what3words address on a map"
- },
- "square": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_Square",
- "description": "Lat Lng coordinate Square"
- },
- "coordinates": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_Coordinates",
- "description": "Lat Lng coordinate"
+ "description": "If waypoints were provided, this gives the input waypoint for this leg.",
+ "title": "Waypoint"
}
},
- "type": "object",
"required": [
- "country",
- "nearestPlace",
- "words",
- "language",
- "map",
- "square",
- "coordinates"
+ "distance",
+ "duration",
+ "start_location",
+ "end_location",
+ "steps"
],
- "title": "JsonCoordinatesResponse",
- "example": {
- "coordinates": {
- "lat": 48.858304,
- "lng": 2.294514
- },
- "country": "FR",
- "language": "en",
- "map": "https://w3w.co/couch.spotted.amended",
- "nearestPlace": "Paris",
- "square": {
- "northeast": {
- "lat": 48.858317,
- "lng": 2.294535
- },
- "southwest": {
- "lat": 48.85829,
- "lng": 2.294494
- }
- },
- "words": "couch.spotted.amended"
- }
+ "title": "Leg",
+ "type": "object"
},
- "External-api-wrapper_what3words_LiteAddressResponse": {
+ "Indoor_API_Route": {
"properties": {
- "results": {
- "items": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_LiteAddressResult"
- },
- "type": "array",
- "title": "Results",
- "description": "Results"
- }
- },
- "type": "object",
- "required": [
- "results"
- ],
- "title": "LiteAddressResponse",
- "example": {
- "results": [
- {
- "description": "Radway House, Alfred Road, London, W2 5ER",
- "public_id": "",
- "sub_buildings": [
- {
- "description": "Flat 1, Radway House, Alfred Road, London, W2 5ER",
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9faitia1pNNURnOWYvQmRjMUdweXl5SjdLZUZnPQ=="
- },
- {
- "description": "Flat 2, Radway House, Alfred Road, London, W2 5ER",
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fbTRoZVpxYkhBYVVXSytqek04UGtGQ1VLTVI0PQ=="
- }
- ],
- "types": [
- "address"
- ]
- },
- {
- "description": "Astley House, Alfred Road, London, W2 5EX",
- "public_id": "",
- "status": "not_yet_built",
- "sub_buildings": [
- {
- "description": "Flat 1, Astley House, Alfred Road, London, W2 5EX",
- "public_id": "N3VCclhUODduWjJxd2NCSUdFclJ6SnRseGxrPV9fSTBKM1YxOFBBWEJjRVNKb1J0T3hNTFNiLzhFPQ=="
- },
- {
- "description": "Flat 2, Astley House, Alfred Road, London, W2 5EX",
- "public_id": "N3VCclhUODduWjJxd2NCSUdFclJ6SnRseGxrPV9fN3VCclhUODduWjJxd2NCSUdFclJ6SnRseGxrPQ=="
- }
- ],
- "types": [
- "address"
- ]
- },
- {
- "description": "65 Alfred Road, London, W2 5EU",
- "public_id": "",
- "sub_buildings": [
- {
- "description": "Blaiz Ltd, 65 Alfred Road, London, W2 5EU",
- "public_id": "MUVBZWttTlo4OUYxL2dQWmJteDdFV2VidmVvPV9fMUVBZWttTlo4OUYxL2dQWmJteDdFV2VidmVvPQ=="
- },
- {
- "description": "Carnot Ltd, 65 Alfred Road, London, W2 5EU",
- "public_id": "MUVBZWttTlo4OUYxL2dQWmJteDdFV2VidmVvPV9fRDRPb0VLd0UvNEZYMlpLR21EMC9xRGQvMUZJPQ=="
- }
- ],
- "types": [
- "address"
- ]
- }
- ]
- }
- },
- "External-api-wrapper_what3words_LiteAddressResult": {
- "properties": {
- "types": {
- "items": {
- "type": "string",
- "enum": [
- "address",
- "route",
- "named_place",
- "locality",
- "city",
- "town",
- "village",
- "hamlet",
- "borough",
- "suburb",
- "quarter",
- "neighbourhood",
- "postal_code",
- "admin_level"
- ]
- },
- "type": "array",
- "title": "Types",
- "description": "Address Types"
- },
- "formatted_address": {
- "type": "string",
- "title": "Formatted Address",
- "description": "Human readable address"
- },
- "public_id": {
- "type": "string",
- "title": "Public Id",
- "description": "Public ID of the POI"
- },
- "status": {
- "anyOf": [
+ "bounds": {
+ "description": "Bounding box of the route",
+ "maxItems": 4,
+ "minItems": 4,
+ "prefixItems": [
{
- "type": "string",
- "const": "not_yet_built"
+ "type": "number"
},
{
- "type": "null"
- }
- ],
- "title": "Status",
- "description": "Address Status"
- },
- "sub_buildings": {
- "anyOf": [
- {
- "items": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_AddressSummary"
- },
- "type": "array"
+ "type": "number"
},
{
- "type": "null"
- }
- ],
- "title": "Sub Buildings",
- "description": "list of specific addresses at that location"
- }
- },
- "type": "object",
- "required": [
- "types",
- "formatted_address",
- "public_id"
- ],
- "title": "LiteAddressResult"
- },
- "External-api-wrapper_what3words_Properties": {
- "properties": {
- "country": {
- "type": "string",
- "title": "Country",
- "description": "Country Code"
- },
- "nearestPlace": {
- "type": "string",
- "title": "Nearestplace",
- "description": "Nearest Place"
- },
- "words": {
- "type": "string",
- "title": "Words",
- "description": "The what3words address"
- },
- "language": {
- "type": "string",
- "title": "Language",
- "description": "Language Code"
- },
- "locale": {
- "anyOf": [
- {
- "type": "string"
+ "type": "number"
},
{
- "type": "null"
+ "type": "number"
}
],
- "title": "Locale",
- "description": "Language Locale"
- },
- "map": {
- "type": "string",
- "title": "Map",
- "description": "Link to what3words address on a map"
- }
- },
- "type": "object",
- "required": [
- "country",
- "nearestPlace",
- "words",
- "language",
- "map"
- ],
- "title": "Properties"
- },
- "External-api-wrapper_what3words_Square": {
- "properties": {
- "southwest": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_Coordinates",
- "description": "Lat Lng coordinate"
+ "title": "Bounds",
+ "type": "array"
},
- "northeast": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_Coordinates",
- "description": "Lat Lng coordinate"
- }
- },
- "type": "object",
- "required": [
- "southwest",
- "northeast"
- ],
- "title": "Square"
- },
- "External-api-wrapper_what3words_ValidationError": {
- "properties": {
- "loc": {
+ "legs": {
+ "description": "List of different legs of the journey",
"items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "integer"
- }
- ]
+ "$ref": "#/components/schemas/Indoor_API_Leg"
},
- "type": "array",
- "title": "Location"
- },
- "msg": {
- "type": "string",
- "title": "Message"
- },
- "type": {
- "type": "string",
- "title": "Error Type"
- }
- },
- "type": "object",
- "required": [
- "loc",
- "msg",
- "type"
- ],
- "title": "ValidationError"
- },
- "Indoor_API_ErrorResponseSchema": {
- "properties": {
- "detail": {
- "title": "Detail",
- "type": "string"
+ "title": "Legs",
+ "type": "array"
}
},
"required": [
- "detail"
+ "bounds",
+ "legs"
],
- "title": "ErrorResponseSchema",
+ "title": "Route",
"type": "object"
},
- "Indoor_API_Building": {
+ "Indoor_API_RouteCollection": {
+ "example": {
+ "routes": [
+ {
+ "bounds": [
+ -0.12493997331,
+ 51.498230882255,
+ -0.12456220772511746,
+ 51.49992534993494
+ ],
+ "legs": [
+ {
+ "distance": {
+ "text": "217 meters",
+ "value": 217.48
+ },
+ "duration": {
+ "text": "218 seconds",
+ "value": 218
+ },
+ "end_location": {
+ "lat": 51.499924944345,
+ "level": 1,
+ "lng": -0.12461392044974706
+ },
+ "start_location": {
+ "lat": 51.498230882255,
+ "level": 1,
+ "lng": -0.12456220772511746
+ },
+ "steps": [
+ {
+ "bearing_end": -84.2851734177303,
+ "bearing_start": -84.2851734177303,
+ "distance": {
+ "text": "2 meters",
+ "value": 2.07
+ },
+ "duration": {
+ "text": "2 seconds",
+ "value": 2
+ },
+ "end_location": {
+ "lat": 51.4982349155,
+ "level": 1,
+ "lng": -0.12461111274
+ },
+ "instruction": {
+ "instruction_type": "walk_straight_walk_past",
+ "summary": "Walk straight past Toilets"
+ },
+ "poi_id": 3623024,
+ "polyline": [
+ [
+ -0.12458141958,
+ 51.49823306561
+ ],
+ [
+ -0.12461111274,
+ 51.4982349155
+ ]
+ ],
+ "routing_profiles": [],
+ "start_location": {
+ "lat": 51.49823306561,
+ "level": 1,
+ "lng": -0.12458141958
+ }
+ },
+ {
+ "bearing_end": -81.48387948754326,
+ "bearing_start": -84.28520875361633,
+ "distance": {
+ "text": "1 meters",
+ "value": 1.47
+ },
+ "duration": {
+ "text": "2 seconds",
+ "value": 2
+ },
+ "end_location": {
+ "lat": 51.49823646981,
+ "level": 1,
+ "lng": -0.12463215818
+ },
+ "instruction": {
+ "instruction_type": "walk_straight_walk_past",
+ "summary": "Walk straight past Lord Chamberlain's Private Office"
+ },
+ "poi_id": 3624060,
+ "polyline": [
+ [
+ -0.12461111274,
+ 51.4982349155
+ ],
+ [
+ -0.12462429286,
+ 51.49823573662
+ ],
+ [
+ -0.12463215818,
+ 51.49823646981
+ ]
+ ],
+ "routing_profiles": [],
+ "start_location": {
+ "lat": 51.4982349155,
+ "level": 1,
+ "lng": -0.12461111274
+ }
+ }
+ ]
+ }
+ ]
+ }
+ ],
+ "status": "ok"
+ },
"properties": {
- "ref": {
- "description": "Reference to identify Building",
- "title": "Ref",
+ "status": {
+ "const": "ok",
+ "default": "ok",
+ "title": "Status",
"type": "string"
},
- "name": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Name of the Building",
- "title": "Name"
- },
- "localized_name": {
- "additionalProperties": {
- "type": "string"
+ "routes": {
+ "items": {
+ "$ref": "#/components/schemas/Indoor_API_Route"
},
- "default": {},
- "description": "Translated names of the Building",
- "title": "Localized Name",
- "type": "object"
+ "title": "Routes",
+ "type": "array"
+ }
+ },
+ "required": [
+ "routes"
+ ],
+ "title": "RouteCollection",
+ "type": "object"
+ },
+ "Indoor_API_Step": {
+ "properties": {
+ "distance": {
+ "$ref": "#/components/schemas/Indoor_API_Distance",
+ "description": "Distance of this Step"
},
- "description": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Building Description",
- "title": "Description"
+ "duration": {
+ "$ref": "#/components/schemas/Indoor_API_Duration",
+ "description": "Duration of this Step"
},
- "opening_hours": {
+ "poi_id": {
"anyOf": [
{
- "type": "string"
+ "type": "integer"
},
{
"type": "null"
}
],
- "description": "Building Opening Hours",
- "title": "Opening Hours"
+ "description": "If a POI exists, its ID is given.",
+ "title": "Poi Id"
},
- "logo": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "",
- "title": "Logo"
+ "bearing_start": {
+ "description": "TODO",
+ "title": "Bearing Start",
+ "type": "number"
},
- "cover": {
+ "bearing_end": {
+ "description": "TODO",
+ "title": "Bearing End",
+ "type": "number"
+ },
+ "start_location": {
+ "$ref": "#/components/schemas/Indoor_API_LatLngLevel",
+ "description": "Starting Location of this Step, as a Lat,Lng pair with a floor level number."
+ },
+ "end_location": {
+ "$ref": "#/components/schemas/Indoor_API_LatLngLevel",
+ "description": "End Location of this Step, as a Lat,Lng pair with a floor level number."
+ },
+ "polyline": {
+ "description": "TODO",
+ "items": {
+ "maxItems": 2,
+ "minItems": 2,
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "type": "array"
+ },
+ "title": "Polyline",
+ "type": "array"
+ },
+ "instruction": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/Indoor_API_Instruction"
},
{
"type": "null"
}
],
- "description": "",
- "title": "Cover"
+ "description": "A text based instruction for this step"
},
- "levels": {
- "description": "Levels associated with the Building",
+ "routing_profiles": {
+ "default": [],
"items": {
- "$ref": "#/components/schemas/Indoor_API_Level"
+ "type": "string"
},
- "title": "Levels",
+ "title": "Routing Profiles",
"type": "array"
}
},
"required": [
- "ref",
- "levels"
+ "distance",
+ "duration",
+ "bearing_start",
+ "bearing_end",
+ "start_location",
+ "end_location",
+ "polyline"
],
- "title": "Building",
+ "title": "Step",
"type": "object"
},
- "Indoor_API_Level": {
- "properties": {
- "level": {
- "description": "Floor level as a number",
- "title": "Level",
- "type": "integer"
- },
- "name": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Name of the floor level",
- "title": "Name"
- },
- "ref": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Reference to identify floor level",
- "title": "Ref"
- },
- "bbox": {
- "description": "Bounding Box of floor level",
- "items": {
- "type": "number"
- },
- "title": "Bbox",
- "type": "array"
- }
- },
- "required": [
- "level",
- "bbox"
- ],
- "title": "Level",
- "type": "object"
- },
- "Indoor_API_VenueSchema": {
- "example": {
- "bbox": [
- -0.1258015,
- 51.4981306,
- -0.1236527,
- 51.5008191
- ],
- "buildings": [
- {
- "cover": null,
- "description": null,
- "levels": [
- {
- "bbox": [
- -0.1258015,
- 51.4981306,
- -0.1236527,
- 51.5008191
- ],
- "level": 1,
- "name": "Palace of Westminster",
- "ref": "Ground"
- }
- ],
- "localized_name": {},
- "logo": null,
- "name": "Palace of Westminster",
- "opening_hours": null,
- "ref": "Palace of Westminster"
- }
- ],
- "categories": [],
- "languages": [],
- "levels": [
- {
- "bbox": [
- -0.1258015,
- 51.4981306,
- -0.1236527,
- 51.5008191
- ],
- "level": 1,
- "name": "Palace of Westminster",
- "ref": "Ground"
- }
- ],
- "name": "Westminster palace",
- "routing_profiles": [],
- "updated_at": "2023-07-17T13:11:32.267Z",
- "venue_id": "west_pal"
- },
+ "Indoor_API_GeometryCollection": {
+ "description": "GeometryCollection Model",
"properties": {
- "venue_id": {
- "description": "ID of the Venue",
- "title": "Venue Id",
- "type": "string"
- },
- "name": {
- "description": "Name of the Venue",
- "title": "Name",
- "type": "string"
- },
"bbox": {
"anyOf": [
{
@@ -17024,122 +16505,8 @@
"type": "array"
},
{
- "type": "null"
- }
- ],
- "description": "Bounding Box of Venue",
- "title": "Bbox"
- },
- "levels": {
- "default": [],
- "description": "Information on each level of the venue",
- "items": {
- "$ref": "#/components/schemas/Indoor_API_Level"
- },
- "title": "Levels",
- "type": "array"
- },
- "routing_profiles": {
- "default": [],
- "description": "Available routing profiles for the venue",
- "items": {
- "type": "string"
- },
- "title": "Routing Profiles",
- "type": "array"
- },
- "categories": {
- "default": [],
- "description": "",
- "items": {
- "type": "string"
- },
- "title": "Categories",
- "type": "array"
- },
- "buildings": {
- "default": [],
- "description": "Buildings present at the venue",
- "items": {
- "$ref": "#/components/schemas/Indoor_API_Building"
- },
- "title": "Buildings",
- "type": "array"
- },
- "languages": {
- "description": "Language translations available for the venue",
- "items": {
- "type": "string"
- },
- "title": "Languages",
- "type": "array"
- },
- "updated_at": {
- "description": "When this venue was last updated",
- "format": "date-time",
- "title": "Updated At",
- "type": "string"
- }
- },
- "required": [
- "venue_id",
- "name",
- "bbox",
- "languages",
- "updated_at"
- ],
- "title": "VenueSchema",
- "type": "object"
- },
- "Indoor_API_VenueListSchema": {
- "example": [
- {
- "bbox": [
- -0.1258015,
- 51.4981306,
- -0.1236527,
- 51.5008191
- ],
- "name": "Westminster palace",
- "venue_id": "west_pal"
- },
- {
- "bbox": [
- 3.9215275,
- 43.6062712,
- 3.922097,
- 43.606972
- ],
- "name": "Woosmap HQ",
- "venue_id": "woosmap_wgs_office"
- },
- {
- "bbox": [
- 2.3537419,
- 48.87969358511,
- 2.3584085,
- 48.8831854
- ],
- "name": "Gare Du Nord",
- "venue_id": "woosmap_gdn"
- }
- ],
- "properties": {
- "venue_id": {
- "description": "ID of the Venue",
- "title": "Venue Id",
- "type": "string"
- },
- "name": {
- "description": "Name of the Venue",
- "title": "Name",
- "type": "string"
- },
- "bbox": {
- "anyOf": [
- {
- "maxItems": 4,
- "minItems": 4,
+ "maxItems": 6,
+ "minItems": 6,
"prefixItems": [
{
"type": "number"
@@ -17150,6 +16517,12 @@
{
"type": "number"
},
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
{
"type": "number"
}
@@ -17160,482 +16533,416 @@
"type": "null"
}
],
- "description": "Bounding Box of Venue",
"title": "Bbox"
- }
- },
- "required": [
- "venue_id",
- "name",
- "bbox"
- ],
- "title": "VenueListSchema",
- "type": "object"
- },
- "Indoor_API_Distance": {
- "properties": {
- "value": {
- "description": "Distance in metres",
- "title": "Value",
- "type": "number"
},
- "text": {
- "description": "Distance as text based response with unit type",
- "title": "Text",
- "type": "string"
- }
- },
- "required": [
- "value",
- "text"
- ],
- "title": "Distance",
- "type": "object"
- },
- "Indoor_API_DistanceMatrixCollection": {
- "example": {
- "rows": [],
- "status": "OK"
- },
- "properties": {
- "status": {
- "description": "A string to indicate the success of the request",
- "title": "Status",
+ "type": {
+ "const": "GeometryCollection",
+ "title": "Type",
"type": "string"
},
- "rows": {
+ "geometries": {
"items": {
- "$ref": "#/components/schemas/Indoor_API_DistanceMatrixRow"
+ "discriminator": {
+ "mapping": {
+ "GeometryCollection": "#/components/schemas/Indoor_API_GeometryCollection",
+ "LineString": "#/components/schemas/Indoor_API_LineString",
+ "MultiLineString": "#/components/schemas/Indoor_API_MultiLineString",
+ "MultiPoint": "#/components/schemas/Indoor_API_MultiPoint",
+ "MultiPolygon": "#/components/schemas/Indoor_API_MultiPolygon",
+ "Point": "#/components/schemas/Indoor_API_Point",
+ "Polygon": "#/components/schemas/Indoor_API_Polygon"
+ },
+ "propertyName": "type"
+ },
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/Indoor_API_Point"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_MultiPoint"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_LineString"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_MultiLineString"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_Polygon"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_MultiPolygon"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_GeometryCollection"
+ }
+ ]
},
- "title": "Rows",
+ "title": "Geometries",
"type": "array"
}
},
"required": [
- "status",
- "rows"
+ "type",
+ "geometries"
],
- "title": "DistanceMatrixCollection",
+ "title": "GeometryCollection",
"type": "object"
},
- "Indoor_API_DistanceMatrixElement": {
+ "Indoor_API_IndoorFeatureSchema": {
"properties": {
- "status": {
- "description": "A string to indicate if a path was found or not",
- "title": "Status",
+ "properties": {
+ "type": "object",
+ "additionalProperties": true,
+ "description": "Additional properties associated with this feature",
+ "title": "Properties"
+ },
+ "type": {
+ "const": "Feature",
+ "default": "Feature",
+ "title": "Type",
"type": "string"
},
- "duration": {
- "$ref": "#/components/schemas/Indoor_API_Duration"
+ "geometry": {
+ "anyOf": [
+ {
+ "discriminator": {
+ "mapping": {
+ "GeometryCollection": "#/components/schemas/Indoor_API_GeometryCollection",
+ "LineString": "#/components/schemas/Indoor_API_LineString",
+ "MultiLineString": "#/components/schemas/Indoor_API_MultiLineString",
+ "MultiPoint": "#/components/schemas/Indoor_API_MultiPoint",
+ "MultiPolygon": "#/components/schemas/Indoor_API_MultiPolygon",
+ "Point": "#/components/schemas/Indoor_API_Point",
+ "Polygon": "#/components/schemas/Indoor_API_Polygon"
+ },
+ "propertyName": "type"
+ },
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/Indoor_API_Point"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_MultiPoint"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_LineString"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_MultiLineString"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_Polygon"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_MultiPolygon"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_GeometryCollection"
+ }
+ ]
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_GeometryCollection"
+ }
+ ],
+ "description": "GeoJSON Geometry or Geometry Collection",
+ "title": "Geometry"
+ },
+ "id": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Id"
},
"distance": {
- "$ref": "#/components/schemas/Indoor_API_Distance"
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Distance"
+ },
+ "duration": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Duration"
}
},
"required": [
- "status",
- "duration",
- "distance"
+ "properties",
+ "geometry"
],
- "title": "DistanceMatrixElement",
+ "title": "IndoorFeatureSchema",
"type": "object"
},
- "Indoor_API_DistanceMatrixRow": {
+ "Indoor_API_LineString": {
+ "description": "LineString Model",
"properties": {
- "elements": {
+ "bbox": {
+ "anyOf": [
+ {
+ "maxItems": 4,
+ "minItems": 4,
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "type": "array"
+ },
+ {
+ "maxItems": 6,
+ "minItems": 6,
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Bbox"
+ },
+ "type": {
+ "const": "LineString",
+ "title": "Type",
+ "type": "string"
+ },
+ "coordinates": {
"items": {
- "$ref": "#/components/schemas/Indoor_API_DistanceMatrixElement"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Indoor_API_Position2D"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_Position3D"
+ }
+ ]
},
- "title": "Elements",
+ "minItems": 2,
+ "title": "Coordinates",
"type": "array"
}
},
"required": [
- "elements"
+ "type",
+ "coordinates"
],
- "title": "DistanceMatrixRow",
+ "title": "LineString",
"type": "object"
},
- "Indoor_API_Duration": {
+ "Indoor_API_MultiLineString": {
+ "description": "MultiLineString Model",
"properties": {
- "value": {
- "description": "Duration in seconds",
- "title": "Value",
- "type": "number"
- },
- "text": {
- "description": "Duration as text based response with unit type",
- "title": "Text",
- "type": "string"
- }
- },
- "required": [
- "value",
- "text"
- ],
- "title": "Duration",
- "type": "object"
- },
- "Indoor_API_Instruction": {
- "properties": {
- "summary": {
- "title": "Summary",
- "type": "string"
- },
- "instruction_type": {
- "title": "Instruction Type",
- "type": "string"
- }
- },
- "required": [
- "summary",
- "instruction_type"
- ],
- "title": "Instruction",
- "type": "object"
- },
- "Indoor_API_LatLngLevel": {
- "properties": {
- "lat": {
- "title": "Lat",
- "type": "number"
- },
- "lng": {
- "title": "Lng",
- "type": "number"
- },
- "level": {
- "title": "Level",
- "type": "integer"
- }
- },
- "required": [
- "lat",
- "lng",
- "level"
- ],
- "title": "LatLngLevel",
- "type": "object"
- },
- "Indoor_API_Leg": {
- "properties": {
- "distance": {
- "$ref": "#/components/schemas/Indoor_API_Distance",
- "description": "Distance of this Leg"
- },
- "duration": {
- "$ref": "#/components/schemas/Indoor_API_Duration",
- "description": "Duration of this Leg"
- },
- "start_location": {
- "$ref": "#/components/schemas/Indoor_API_LatLngLevel",
- "description": "Starting Location of this Leg, as a Lat,Lng pair with a floor level number."
- },
- "end_location": {
- "$ref": "#/components/schemas/Indoor_API_LatLngLevel",
- "description": "End Location of this Leg, as a Lat,Lng pair with a floor level number."
- },
- "steps": {
- "description": "List of different steps of this Leg",
- "items": {
- "$ref": "#/components/schemas/Indoor_API_Step"
- },
- "title": "Steps",
- "type": "array"
- },
- "waypoint": {
+ "bbox": {
"anyOf": [
{
- "type": "string"
+ "maxItems": 4,
+ "minItems": 4,
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "type": "array"
+ },
+ {
+ "maxItems": 6,
+ "minItems": 6,
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "type": "array"
},
{
"type": "null"
}
],
- "description": "If waypoints were provided, this gives the input waypoint for this leg.",
- "title": "Waypoint"
+ "title": "Bbox"
+ },
+ "type": {
+ "const": "MultiLineString",
+ "title": "Type",
+ "type": "string"
+ },
+ "coordinates": {
+ "items": {
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Indoor_API_Position2D"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_Position3D"
+ }
+ ]
+ },
+ "minItems": 2,
+ "type": "array"
+ },
+ "title": "Coordinates",
+ "type": "array"
}
},
"required": [
- "distance",
- "duration",
- "start_location",
- "end_location",
- "steps"
+ "type",
+ "coordinates"
],
- "title": "Leg",
+ "title": "MultiLineString",
"type": "object"
},
- "Indoor_API_Route": {
+ "Indoor_API_MultiPoint": {
+ "description": "MultiPoint Model",
"properties": {
- "bounds": {
- "description": "Bounding box of the route",
- "maxItems": 4,
- "minItems": 4,
- "prefixItems": [
- {
- "type": "number"
- },
+ "bbox": {
+ "anyOf": [
{
- "type": "number"
+ "maxItems": 4,
+ "minItems": 4,
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "type": "array"
},
{
- "type": "number"
+ "maxItems": 6,
+ "minItems": 6,
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "type": "array"
},
{
- "type": "number"
+ "type": "null"
}
],
- "title": "Bounds",
- "type": "array"
+ "title": "Bbox"
},
- "legs": {
- "description": "List of different legs of the journey",
+ "type": {
+ "const": "MultiPoint",
+ "title": "Type",
+ "type": "string"
+ },
+ "coordinates": {
"items": {
- "$ref": "#/components/schemas/Indoor_API_Leg"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Indoor_API_Position2D"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_Position3D"
+ }
+ ]
},
- "title": "Legs",
+ "title": "Coordinates",
"type": "array"
}
},
"required": [
- "bounds",
- "legs"
+ "type",
+ "coordinates"
],
- "title": "Route",
+ "title": "MultiPoint",
"type": "object"
},
- "Indoor_API_RouteCollection": {
- "example": {
- "routes": [
- {
- "bounds": [
- -0.12493997331,
- 51.498230882255,
- -0.12456220772511746,
- 51.49992534993494
- ],
- "legs": [
- {
- "distance": {
- "text": "217 meters",
- "value": 217.48
- },
- "duration": {
- "text": "218 seconds",
- "value": 218
- },
- "end_location": {
- "lat": 51.499924944345,
- "level": 1,
- "lng": -0.12461392044974706
- },
- "start_location": {
- "lat": 51.498230882255,
- "level": 1,
- "lng": -0.12456220772511746
- },
- "steps": [
- {
- "bearing_end": -84.2851734177303,
- "bearing_start": -84.2851734177303,
- "distance": {
- "text": "2 meters",
- "value": 2.07
- },
- "duration": {
- "text": "2 seconds",
- "value": 2
- },
- "end_location": {
- "lat": 51.4982349155,
- "level": 1,
- "lng": -0.12461111274
- },
- "instruction": {
- "instruction_type": "walk_straight_walk_past",
- "summary": "Walk straight past Toilets"
- },
- "poi_id": 3623024,
- "polyline": [
- [
- -0.12458141958,
- 51.49823306561
- ],
- [
- -0.12461111274,
- 51.4982349155
- ]
- ],
- "routing_profiles": [],
- "start_location": {
- "lat": 51.49823306561,
- "level": 1,
- "lng": -0.12458141958
- }
- },
- {
- "bearing_end": -81.48387948754326,
- "bearing_start": -84.28520875361633,
- "distance": {
- "text": "1 meters",
- "value": 1.47
- },
- "duration": {
- "text": "2 seconds",
- "value": 2
- },
- "end_location": {
- "lat": 51.49823646981,
- "level": 1,
- "lng": -0.12463215818
- },
- "instruction": {
- "instruction_type": "walk_straight_walk_past",
- "summary": "Walk straight past Lord Chamberlain's Private Office"
- },
- "poi_id": 3624060,
- "polyline": [
- [
- -0.12461111274,
- 51.4982349155
- ],
- [
- -0.12462429286,
- 51.49823573662
- ],
- [
- -0.12463215818,
- 51.49823646981
- ]
- ],
- "routing_profiles": [],
- "start_location": {
- "lat": 51.4982349155,
- "level": 1,
- "lng": -0.12461111274
- }
- }
- ]
- }
- ]
- }
- ],
- "status": "ok"
- },
- "properties": {
- "status": {
- "const": "ok",
- "default": "ok",
- "title": "Status",
- "type": "string"
- },
- "routes": {
- "items": {
- "$ref": "#/components/schemas/Indoor_API_Route"
- },
- "title": "Routes",
- "type": "array"
- }
- },
- "required": [
- "routes"
- ],
- "title": "RouteCollection",
- "type": "object"
- },
- "Indoor_API_Step": {
- "properties": {
- "distance": {
- "$ref": "#/components/schemas/Indoor_API_Distance",
- "description": "Distance of this Step"
- },
- "duration": {
- "$ref": "#/components/schemas/Indoor_API_Duration",
- "description": "Duration of this Step"
- },
- "poi_id": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "description": "If a POI exists, its ID is given.",
- "title": "Poi Id"
- },
- "bearing_start": {
- "description": "TODO",
- "title": "Bearing Start",
- "type": "number"
- },
- "bearing_end": {
- "description": "TODO",
- "title": "Bearing End",
- "type": "number"
- },
- "start_location": {
- "$ref": "#/components/schemas/Indoor_API_LatLngLevel",
- "description": "Starting Location of this Step, as a Lat,Lng pair with a floor level number."
- },
- "end_location": {
- "$ref": "#/components/schemas/Indoor_API_LatLngLevel",
- "description": "End Location of this Step, as a Lat,Lng pair with a floor level number."
- },
- "polyline": {
- "description": "TODO",
- "items": {
- "maxItems": 2,
- "minItems": 2,
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
- }
- ],
- "type": "array"
- },
- "title": "Polyline",
- "type": "array"
- },
- "instruction": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/Indoor_API_Instruction"
- },
- {
- "type": "null"
- }
- ],
- "description": "A text based instruction for this step"
- },
- "routing_profiles": {
- "default": [],
- "items": {
- "type": "string"
- },
- "title": "Routing Profiles",
- "type": "array"
- }
- },
- "required": [
- "distance",
- "duration",
- "bearing_start",
- "bearing_end",
- "start_location",
- "end_location",
- "polyline"
- ],
- "title": "Step",
- "type": "object"
- },
- "Indoor_API_GeometryCollection": {
- "description": "GeometryCollection Model",
+ "Indoor_API_MultiPolygon": {
+ "description": "MultiPolygon Model",
"properties": {
"bbox": {
"anyOf": [
@@ -17690,162 +16997,73 @@
"title": "Bbox"
},
"type": {
- "const": "GeometryCollection",
+ "const": "MultiPolygon",
"title": "Type",
"type": "string"
},
- "geometries": {
+ "coordinates": {
"items": {
- "discriminator": {
- "mapping": {
- "GeometryCollection": "#/components/schemas/Indoor_API_GeometryCollection",
- "LineString": "#/components/schemas/Indoor_API_LineString",
- "MultiLineString": "#/components/schemas/Indoor_API_MultiLineString",
- "MultiPoint": "#/components/schemas/Indoor_API_MultiPoint",
- "MultiPolygon": "#/components/schemas/Indoor_API_MultiPolygon",
- "Point": "#/components/schemas/Indoor_API_Point",
- "Polygon": "#/components/schemas/Indoor_API_Polygon"
+ "items": {
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Indoor_API_Position2D"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_Position3D"
+ }
+ ]
},
- "propertyName": "type"
+ "minItems": 4,
+ "type": "array"
},
- "oneOf": [
- {
- "$ref": "#/components/schemas/Indoor_API_Point"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_MultiPoint"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_LineString"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_MultiLineString"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_Polygon"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_MultiPolygon"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_GeometryCollection"
- }
- ]
+ "type": "array"
},
- "title": "Geometries",
+ "title": "Coordinates",
"type": "array"
}
},
"required": [
"type",
- "geometries"
+ "coordinates"
],
- "title": "GeometryCollection",
+ "title": "MultiPolygon",
"type": "object"
},
- "Indoor_API_IndoorFeatureSchema": {
+ "Indoor_API_PaginationSchema": {
"properties": {
- "properties": {
- "type": "object",
- "additionalProperties": true,
- "description": "Additional properties associated with this feature",
- "title": "Properties"
- },
- "type": {
- "const": "Feature",
- "default": "Feature",
- "title": "Type",
- "type": "string"
- },
- "geometry": {
- "anyOf": [
- {
- "discriminator": {
- "mapping": {
- "GeometryCollection": "#/components/schemas/Indoor_API_GeometryCollection",
- "LineString": "#/components/schemas/Indoor_API_LineString",
- "MultiLineString": "#/components/schemas/Indoor_API_MultiLineString",
- "MultiPoint": "#/components/schemas/Indoor_API_MultiPoint",
- "MultiPolygon": "#/components/schemas/Indoor_API_MultiPolygon",
- "Point": "#/components/schemas/Indoor_API_Point",
- "Polygon": "#/components/schemas/Indoor_API_Polygon"
- },
- "propertyName": "type"
- },
- "oneOf": [
- {
- "$ref": "#/components/schemas/Indoor_API_Point"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_MultiPoint"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_LineString"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_MultiLineString"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_Polygon"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_MultiPolygon"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_GeometryCollection"
- }
- ]
- },
- {
- "$ref": "#/components/schemas/Indoor_API_GeometryCollection"
- }
- ],
- "description": "GeoJSON Geometry or Geometry Collection",
- "title": "Geometry"
+ "page": {
+ "description": "Current page number",
+ "title": "Page",
+ "type": "integer"
},
- "id": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Id"
+ "page_count": {
+ "description": "Total number of pages",
+ "title": "Page Count",
+ "type": "integer"
},
- "distance": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Distance"
+ "total": {
+ "description": "Total number of items",
+ "title": "Total",
+ "type": "integer"
},
- "duration": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Duration"
+ "per_page": {
+ "description": "Number of items per page",
+ "title": "Per Page",
+ "type": "integer"
}
},
"required": [
- "properties",
- "geometry"
+ "page",
+ "page_count",
+ "total",
+ "per_page"
],
- "title": "IndoorFeatureSchema",
+ "title": "PaginationSchema",
"type": "object"
},
- "Indoor_API_LineString": {
- "description": "LineString Model",
+ "Indoor_API_Point": {
+ "description": "Point Model",
"properties": {
"bbox": {
"anyOf": [
@@ -17900,35 +17118,31 @@
"title": "Bbox"
},
"type": {
- "const": "LineString",
+ "const": "Point",
"title": "Type",
"type": "string"
},
"coordinates": {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/Indoor_API_Position2D"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_Position3D"
- }
- ]
- },
- "minItems": 2,
- "title": "Coordinates",
- "type": "array"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Indoor_API_Position2D"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_Position3D"
+ }
+ ],
+ "title": "Coordinates"
}
},
"required": [
"type",
"coordinates"
],
- "title": "LineString",
+ "title": "Point",
"type": "object"
},
- "Indoor_API_MultiLineString": {
- "description": "MultiLineString Model",
+ "Indoor_API_Polygon": {
+ "description": "Polygon Model",
"properties": {
"bbox": {
"anyOf": [
@@ -17983,7 +17197,7 @@
"title": "Bbox"
},
"type": {
- "const": "MultiLineString",
+ "const": "Polygon",
"title": "Type",
"type": "string"
},
@@ -17999,7 +17213,7 @@
}
]
},
- "minItems": 2,
+ "minItems": 4,
"type": "array"
},
"title": "Coordinates",
@@ -18010,545 +17224,574 @@
"type",
"coordinates"
],
- "title": "MultiLineString",
+ "title": "Polygon",
"type": "object"
},
- "Indoor_API_MultiPoint": {
- "description": "MultiPoint Model",
- "properties": {
- "bbox": {
- "anyOf": [
- {
- "maxItems": 4,
- "minItems": 4,
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- }
- ],
- "type": "array"
- },
- {
- "maxItems": 6,
- "minItems": 6,
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- }
- ],
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "title": "Bbox"
- },
- "type": {
- "const": "MultiPoint",
- "title": "Type",
- "type": "string"
+ "Indoor_API_Position2D": {
+ "maxItems": 2,
+ "minItems": 2,
+ "prefixItems": [
+ {
+ "title": "Longitude",
+ "type": "number"
},
- "coordinates": {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/Indoor_API_Position2D"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_Position3D"
- }
- ]
- },
- "title": "Coordinates",
- "type": "array"
+ {
+ "title": "Latitude",
+ "type": "number"
}
- },
- "required": [
- "type",
- "coordinates"
],
- "title": "MultiPoint",
- "type": "object"
+ "type": "array"
},
- "Indoor_API_MultiPolygon": {
- "description": "MultiPolygon Model",
- "properties": {
- "bbox": {
- "anyOf": [
- {
- "maxItems": 4,
- "minItems": 4,
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- }
+ "Indoor_API_Position3D": {
+ "maxItems": 3,
+ "minItems": 3,
+ "prefixItems": [
+ {
+ "title": "Longitude",
+ "type": "number"
+ },
+ {
+ "title": "Latitude",
+ "type": "number"
+ },
+ {
+ "title": "Altitude",
+ "type": "number"
+ }
+ ],
+ "type": "array"
+ },
+ "Indoor_API_SearchPagination": {
+ "example": {
+ "features": [
+ {
+ "distance": null,
+ "duration": null,
+ "geometry": {
+ "bbox": null,
+ "coordinates": [
+ [
+ [
+ -0.12419943632,
+ 51.49927414881
+ ],
+ [
+ -0.12419342215,
+ 51.49930532278
+ ],
+ [
+ -0.12419141597,
+ 51.49931625597
+ ],
+ [
+ -0.12419943632,
+ 51.49927414881
+ ]
+ ]
],
- "type": "array"
+ "type": "Polygon"
},
- {
- "maxItems": 6,
- "minItems": 6,
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- }
- ],
- "type": "array"
+ "id": 3623459,
+ "properties": {
+ "name": "Painted Chamber",
+ "room": "office",
+ "level": "1",
+ "indoor": "area",
+ "building:ref": "Palace of Westminster",
+ "woosmap:logo": "https://woosmap-indoor-img.s3.amazonaws.com/Westminster/logo.png",
+ "woosmap:cover": "https://woosmap-indoor-img.s3.amazonaws.com/Westminster/paintedchamber.png",
+ "woosmap:label_id": 3623458,
+ "woosmap:zoom_icon_min": "16",
+ "woosmap:zoom_polygon_min": "16"
},
- {
- "type": "null"
- }
- ],
- "title": "Bbox"
- },
- "type": {
- "const": "MultiPolygon",
- "title": "Type",
- "type": "string"
+ "type": "Feature"
+ }
+ ],
+ "pagination": {
+ "page": 0,
+ "page_count": 1,
+ "per_page": 0,
+ "total": 1
+ }
+ },
+ "properties": {
+ "pagination": {
+ "$ref": "#/components/schemas/Indoor_API_PaginationSchema",
+ "description": "Pagination Information"
},
- "coordinates": {
+ "features": {
+ "default": [],
+ "description": "List of Indoor features",
"items": {
- "items": {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/Indoor_API_Position2D"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_Position3D"
- }
- ]
- },
- "minItems": 4,
- "type": "array"
- },
- "type": "array"
+ "$ref": "#/components/schemas/Indoor_API_IndoorFeatureSchema"
},
- "title": "Coordinates",
+ "title": "Features",
"type": "array"
}
},
"required": [
- "type",
- "coordinates"
+ "pagination"
],
- "title": "MultiPolygon",
+ "title": "SearchPagination",
"type": "object"
},
- "Indoor_API_PaginationSchema": {
- "properties": {
- "page": {
- "description": "Current page number",
- "title": "Page",
- "type": "integer"
- },
- "page_count": {
- "description": "Total number of pages",
- "title": "Page Count",
- "type": "integer"
+ "Indoor_API_AutocompletePagination": {
+ "example": {
+ "pagination": {
+ "page": 1,
+ "page_count": 1,
+ "per_page": 2,
+ "total": 2
},
- "total": {
- "description": "Total number of items",
- "title": "Total",
- "type": "integer"
+ "predictions": [
+ {
+ "building": "Palace of Westminster",
+ "category": null,
+ "distance": null,
+ "duration": null,
+ "id": 3623459,
+ "level": "1",
+ "name": "Painted Chamber",
+ "ref": null
+ },
+ {
+ "building": "Palace of Westminster",
+ "category": null,
+ "distance": null,
+ "duration": null,
+ "id": 3624060,
+ "level": "1",
+ "name": "Lord Chamberlain's Private Office",
+ "ref": null
+ }
+ ]
+ },
+ "properties": {
+ "pagination": {
+ "$ref": "#/components/schemas/Indoor_API_PaginationSchema",
+ "description": "Pagination Information"
},
- "per_page": {
- "description": "Number of items per page",
- "title": "Per Page",
- "type": "integer"
+ "predictions": {
+ "default": [],
+ "description": "List of Indoor features",
+ "items": {
+ "$ref": "#/components/schemas/Indoor_API_PredictionSchema"
+ },
+ "title": "Predictions",
+ "type": "array"
}
},
"required": [
- "page",
- "page_count",
- "total",
- "per_page"
+ "pagination"
],
- "title": "PaginationSchema",
+ "title": "AutocompletePagination",
"type": "object"
},
- "Indoor_API_Point": {
- "description": "Point Model",
+ "Indoor_API_PredictionSchema": {
"properties": {
- "bbox": {
+ "id": {
+ "description": "ID of the Feature",
+ "title": "Id",
+ "type": "integer"
+ },
+ "name": {
"anyOf": [
{
- "maxItems": 4,
- "minItems": 4,
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- }
- ],
- "type": "array"
+ "type": "string"
},
{
- "maxItems": 6,
- "minItems": 6,
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- }
- ],
- "type": "array"
+ "type": "null"
+ }
+ ],
+ "description": "Name of the Feature",
+ "title": "Name"
+ },
+ "distance": {
+ "anyOf": [
+ {
+ "type": "number"
},
{
"type": "null"
}
],
- "title": "Bbox"
+ "description": "If from location provided, is the distance in metres from that location",
+ "title": "Distance"
},
- "type": {
- "const": "Point",
- "title": "Type",
- "type": "string"
+ "duration": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "If from location provided, is the duration in seconds from that location",
+ "title": "Duration"
},
- "coordinates": {
+ "level": {
"anyOf": [
{
- "$ref": "#/components/schemas/Indoor_API_Position2D"
+ "type": "string"
},
{
- "$ref": "#/components/schemas/Indoor_API_Position3D"
+ "type": "null"
}
],
- "title": "Coordinates"
+ "description": "Level of the Feature",
+ "title": "Level"
+ },
+ "ref": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Reference of the Feature",
+ "title": "Ref"
+ },
+ "building": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Building the Feature is in",
+ "title": "Building"
+ },
+ "category": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Catagory of the Feature",
+ "title": "Category"
}
},
"required": [
- "type",
- "coordinates"
+ "id"
],
- "title": "Point",
+ "title": "PredictionSchema",
"type": "object"
},
- "Indoor_API_Polygon": {
- "description": "Polygon Model",
+ "Indoor_API_SingleIndoorFeatureSchema": {
+ "example": {
+ "distance": null,
+ "duration": null,
+ "geometry": {
+ "bbox": null,
+ "coordinates": [
+ [
+ [
+ -0.12419943632,
+ 51.49927414881
+ ],
+ [
+ -0.12419342215,
+ 51.49930532278
+ ],
+ [
+ -0.12419141597,
+ 51.49931625597
+ ],
+ [
+ -0.12419943632,
+ 51.49927414881
+ ]
+ ]
+ ],
+ "type": "Polygon"
+ },
+ "id": 3623459,
+ "properties": {
+ "name": "Painted Chamber",
+ "room": "office",
+ "level": "1",
+ "indoor": "area",
+ "building:ref": "Palace of Westminster",
+ "woosmap:logo": "https://woosmap-indoor-img.s3.amazonaws.com/Westminster/logo.png",
+ "woosmap:cover": "https://woosmap-indoor-img.s3.amazonaws.com/Westminster/paintedchamber.png",
+ "woosmap:label_id": 3623458,
+ "woosmap:zoom_icon_min": "16",
+ "woosmap:zoom_polygon_min": "16"
+ },
+ "type": "Feature"
+ },
"properties": {
- "bbox": {
+ "properties": {
+ "type": "object",
+ "additionalProperties": true,
+ "description": "Additional properties associated with this feature",
+ "title": "Properties"
+ },
+ "type": {
+ "const": "Feature",
+ "default": "Feature",
+ "title": "Type",
+ "type": "string"
+ },
+ "geometry": {
"anyOf": [
{
- "maxItems": 4,
- "minItems": 4,
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
+ "discriminator": {
+ "mapping": {
+ "GeometryCollection": "#/components/schemas/Indoor_API_GeometryCollection",
+ "LineString": "#/components/schemas/Indoor_API_LineString",
+ "MultiLineString": "#/components/schemas/Indoor_API_MultiLineString",
+ "MultiPoint": "#/components/schemas/Indoor_API_MultiPoint",
+ "MultiPolygon": "#/components/schemas/Indoor_API_MultiPolygon",
+ "Point": "#/components/schemas/Indoor_API_Point",
+ "Polygon": "#/components/schemas/Indoor_API_Polygon"
},
+ "propertyName": "type"
+ },
+ "oneOf": [
{
- "type": "number"
+ "$ref": "#/components/schemas/Indoor_API_Point"
},
{
- "type": "number"
- }
- ],
- "type": "array"
- },
- {
- "maxItems": 6,
- "minItems": 6,
- "prefixItems": [
- {
- "type": "number"
+ "$ref": "#/components/schemas/Indoor_API_MultiPoint"
},
{
- "type": "number"
+ "$ref": "#/components/schemas/Indoor_API_LineString"
},
{
- "type": "number"
+ "$ref": "#/components/schemas/Indoor_API_MultiLineString"
},
{
- "type": "number"
+ "$ref": "#/components/schemas/Indoor_API_Polygon"
},
{
- "type": "number"
+ "$ref": "#/components/schemas/Indoor_API_MultiPolygon"
},
{
- "type": "number"
+ "$ref": "#/components/schemas/Indoor_API_GeometryCollection"
}
- ],
- "type": "array"
+ ]
},
{
- "type": "null"
+ "$ref": "#/components/schemas/Indoor_API_GeometryCollection"
}
],
- "title": "Bbox"
- },
- "type": {
- "const": "Polygon",
- "title": "Type",
- "type": "string"
+ "description": "GeoJSON Geometry or Geometry Collection",
+ "title": "Geometry"
},
- "coordinates": {
- "items": {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/Indoor_API_Position2D"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_Position3D"
- }
- ]
- },
- "minItems": 4,
- "type": "array"
- },
- "title": "Coordinates",
- "type": "array"
+ "id": {
+ "description": "ID of the feature",
+ "title": "Id",
+ "type": "integer"
}
},
"required": [
- "type",
- "coordinates"
+ "properties",
+ "geometry",
+ "id"
],
- "title": "Polygon",
+ "title": "SingleIndoorFeatureSchema",
"type": "object"
},
- "Indoor_API_Position2D": {
- "maxItems": 2,
- "minItems": 2,
- "prefixItems": [
- {
- "title": "Longitude",
- "type": "number"
- },
- {
- "title": "Latitude",
- "type": "number"
+ "External-api-wrapper_AuthenticationErrorResponse": {
+ "properties": {
+ "detail": {
+ "type": "string",
+ "title": "Detail"
}
+ },
+ "type": "object",
+ "required": [
+ "detail"
],
- "type": "array"
+ "title": "AuthenticationErrorResponse",
+ "description": "AuthenticationErrorResponse is the base authentication error model."
},
- "Indoor_API_Position3D": {
- "maxItems": 3,
- "minItems": 3,
- "prefixItems": [
- {
- "title": "Longitude",
- "type": "number"
- },
- {
- "title": "Latitude",
- "type": "number"
- },
- {
- "title": "Altitude",
- "type": "number"
+ "External-api-wrapper_HTTPErrorModel": {
+ "properties": {
+ "details": {
+ "type": "string",
+ "title": "Details"
}
+ },
+ "type": "object",
+ "required": [
+ "details"
],
- "type": "array"
+ "title": "HTTPErrorModel"
},
- "Indoor_API_SearchPagination": {
- "example": {
- "features": [
- {
- "distance": null,
- "duration": null,
- "geometry": {
- "bbox": null,
- "coordinates": [
- [
- [
- -0.12419943632,
- 51.49927414881
- ],
- [
- -0.12419342215,
- 51.49930532278
- ],
- [
- -0.12419141597,
- 51.49931625597
- ],
- [
- -0.12419943632,
- 51.49927414881
- ]
- ]
- ],
- "type": "Polygon"
- },
- "id": 3623459,
- "properties": {
- "name": "Painted Chamber",
- "room": "office",
- "level": "1",
- "indoor": "area",
- "building:ref": "Palace of Westminster",
- "woosmap:logo": "https://woosmap-indoor-img.s3.amazonaws.com/Westminster/logo.png",
- "woosmap:cover": "https://woosmap-indoor-img.s3.amazonaws.com/Westminster/paintedchamber.png",
- "woosmap:label_id": 3623458,
- "woosmap:zoom_icon_min": "16",
- "woosmap:zoom_polygon_min": "16"
- },
- "type": "Feature"
- }
- ],
- "pagination": {
- "page": 0,
- "page_count": 1,
- "per_page": 0,
- "total": 1
+ "External-api-wrapper_HTTPValidationError": {
+ "properties": {
+ "detail": {
+ "items": {
+ "$ref": "#/components/schemas/External-api-wrapper_ValidationError"
+ },
+ "type": "array",
+ "title": "Detail"
}
},
+ "type": "object",
+ "title": "HTTPValidationError"
+ },
+ "External-api-wrapper_MatrixCheckResponse": {
"properties": {
- "pagination": {
- "$ref": "#/components/schemas/Indoor_API_PaginationSchema",
- "description": "Pagination Information"
+ "status": {
+ "type": "string",
+ "enum": [
+ "accepted",
+ "inProgress",
+ "completed",
+ "timeout",
+ "error"
+ ],
+ "title": "Status",
+ "description": "Status of the matrix calculation"
+ }
+ },
+ "type": "object",
+ "required": [
+ "status"
+ ],
+ "title": "MatrixCheckResponse"
+ },
+ "External-api-wrapper_MatrixRequest": {
+ "properties": {
+ "origins": {
+ "type": "string",
+ "title": "Origins",
+ "description": "The starting points. You can supply one or more locations, in the form of `latitude,longitude` coordinates, separated by the pipe character `|`. Ensure that no space exists between the latitude and longitude values.",
+ "examples": [
+ "48.709,2.403|48.768,2.338"
+ ]
},
- "features": {
- "default": [],
- "description": "List of Indoor features",
- "items": {
- "$ref": "#/components/schemas/Indoor_API_IndoorFeatureSchema"
- },
- "title": "Features",
- "type": "array"
+ "destinations": {
+ "type": "string",
+ "title": "Destinations",
+ "description": "The ending points. You can supply one or more locations, in the form of `latitude,longitude` coordinates, separated by the pipe character `|`. Ensure that no space exists between the latitude and longitude values.",
+ "examples": [
+ "48.709,2.403|48.768,2.338"
+ ]
+ },
+ "mode": {
+ "type": "string",
+ "enum": [
+ "driving",
+ "truck"
+ ],
+ "title": "Mode",
+ "description": "Specifies the mode of transport to use when calculating distance",
+ "default": "driving",
+ "examples": [
+ "driving"
+ ]
}
},
+ "type": "object",
"required": [
- "pagination"
+ "origins",
+ "destinations"
],
- "title": "SearchPagination",
- "type": "object"
+ "title": "MatrixRequest"
},
- "Indoor_API_AutocompletePagination": {
- "example": {
- "pagination": {
- "page": 1,
- "page_count": 1,
- "per_page": 2,
- "total": 2
+ "External-api-wrapper_MatrixResponse": {
+ "properties": {
+ "matrix_id": {
+ "type": "string",
+ "title": "Matrix Id",
+ "description": "Unique identifier for the matrix requested, this will be used to check the status and retrieve the completed calculation."
},
- "predictions": [
- {
- "building": "Palace of Westminster",
- "category": null,
- "distance": null,
- "duration": null,
- "id": 3623459,
- "level": "1",
- "name": "Painted Chamber",
- "ref": null
- },
- {
- "building": "Palace of Westminster",
- "category": null,
- "distance": null,
- "duration": null,
- "id": 3624060,
- "level": "1",
- "name": "Lord Chamberlain's Private Office",
- "ref": null
- }
- ]
+ "status": {
+ "type": "string",
+ "enum": [
+ "accepted",
+ "inProgress",
+ "completed",
+ "timeout",
+ "error"
+ ],
+ "title": "Status",
+ "description": "Status of the matrix calculation"
+ }
},
+ "type": "object",
+ "required": [
+ "matrix_id",
+ "status"
+ ],
+ "title": "MatrixResponse"
+ },
+ "External-api-wrapper_Transit": {
"properties": {
- "pagination": {
- "$ref": "#/components/schemas/Indoor_API_PaginationSchema",
- "description": "Pagination Information"
+ "status": {
+ "type": "string",
+ "title": "Status"
},
- "predictions": {
- "default": [],
- "description": "List of Indoor features",
+ "routes": {
"items": {
- "$ref": "#/components/schemas/Indoor_API_PredictionSchema"
+ "$ref": "#/components/schemas/External-api-wrapper_TransitRoute"
},
- "title": "Predictions",
- "type": "array"
+ "type": "array",
+ "title": "Routes",
+ "default": []
}
},
+ "type": "object",
"required": [
- "pagination"
+ "status"
],
- "title": "AutocompletePagination",
- "type": "object"
+ "title": "Transit"
},
- "Indoor_API_PredictionSchema": {
+ "External-api-wrapper_TransitAttributions": {
"properties": {
"id": {
- "description": "ID of the Feature",
- "title": "Id",
- "type": "integer"
+ "type": "string",
+ "title": "Id"
},
- "name": {
+ "href": {
+ "type": "string",
+ "title": "Href"
+ },
+ "text": {
+ "type": "string",
+ "title": "Text"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type"
+ }
+ },
+ "type": "object",
+ "required": [
+ "id",
+ "href",
+ "text",
+ "type"
+ ],
+ "title": "TransitAttributions"
+ },
+ "External-api-wrapper_TransitLeg": {
+ "properties": {
+ "travel_mode": {
+ "type": "string",
+ "title": "Travel Mode"
+ },
+ "duration": {
+ "type": "integer",
+ "title": "Duration"
+ },
+ "distance": {
+ "type": "number",
+ "title": "Distance"
+ },
+ "polyline": {
"anyOf": [
{
"type": "string"
@@ -18557,34 +17800,160 @@
"type": "null"
}
],
- "description": "Name of the Feature",
- "title": "Name"
+ "title": "Polyline"
},
- "distance": {
+ "start_location": {
+ "$ref": "#/components/schemas/External-api-wrapper_TransitPlace"
+ },
+ "end_location": {
+ "$ref": "#/components/schemas/External-api-wrapper_TransitPlace"
+ },
+ "transport": {
"anyOf": [
{
- "type": "number"
+ "$ref": "#/components/schemas/External-api-wrapper_TransitTransport"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "attributions": {
+ "anyOf": [
+ {
+ "items": {
+ "$ref": "#/components/schemas/External-api-wrapper_TransitAttributions"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "description": "If from location provided, is the distance in metres from that location",
- "title": "Distance"
+ "title": "Attributions"
+ }
+ },
+ "type": "object",
+ "required": [
+ "travel_mode",
+ "duration",
+ "distance",
+ "polyline",
+ "start_location",
+ "end_location"
+ ],
+ "title": "TransitLeg"
+ },
+ "External-api-wrapper_TransitPlace": {
+ "properties": {
+ "name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Name"
+ },
+ "type": {
+ "type": "string",
+ "title": "Type"
+ },
+ "location": {
+ "$ref": "#/components/schemas/External-api-wrapper_TransitPosition"
+ }
+ },
+ "type": "object",
+ "required": [
+ "type",
+ "location"
+ ],
+ "title": "TransitPlace"
+ },
+ "External-api-wrapper_TransitPosition": {
+ "properties": {
+ "lat": {
+ "anyOf": [
+ {
+ "type": "number",
+ "maximum": 90,
+ "minimum": -90
+ },
+ {
+ "type": "string",
+ "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
+ }
+ ],
+ "title": "Lat"
+ },
+ "lng": {
+ "anyOf": [
+ {
+ "type": "number",
+ "maximum": 180,
+ "minimum": -180
+ },
+ {
+ "type": "string",
+ "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
+ }
+ ],
+ "title": "Lng"
+ }
+ },
+ "type": "object",
+ "required": [
+ "lat",
+ "lng"
+ ],
+ "title": "TransitPosition"
+ },
+ "External-api-wrapper_TransitRoute": {
+ "properties": {
+ "notice": {
+ "type": "string",
+ "title": "Notice",
+ "default": ""
},
"duration": {
+ "type": "integer",
+ "title": "Duration"
+ },
+ "legs": {
+ "items": {
+ "$ref": "#/components/schemas/External-api-wrapper_TransitLeg"
+ },
+ "type": "array",
+ "title": "Legs",
+ "default": []
+ }
+ },
+ "type": "object",
+ "required": [
+ "duration"
+ ],
+ "title": "TransitRoute"
+ },
+ "External-api-wrapper_TransitTransport": {
+ "properties": {
+ "name": {
"anyOf": [
{
- "type": "number"
+ "type": "string"
},
{
"type": "null"
}
],
- "description": "If from location provided, is the duration in seconds from that location",
- "title": "Duration"
+ "title": "Name"
},
- "level": {
+ "mode": {
+ "type": "string",
+ "title": "Mode"
+ },
+ "category": {
"anyOf": [
{
"type": "string"
@@ -18593,10 +17962,9 @@
"type": "null"
}
],
- "description": "Level of the Feature",
- "title": "Level"
+ "title": "Category"
},
- "ref": {
+ "headsign": {
"anyOf": [
{
"type": "string"
@@ -18605,10 +17973,9 @@
"type": "null"
}
],
- "description": "Reference of the Feature",
- "title": "Ref"
+ "title": "Headsign"
},
- "building": {
+ "short_name": {
"anyOf": [
{
"type": "string"
@@ -18617,10 +17984,9 @@
"type": "null"
}
],
- "description": "Building the Feature is in",
- "title": "Building"
+ "title": "Short Name"
},
- "category": {
+ "long_name": {
"anyOf": [
{
"type": "string"
@@ -18629,133 +17995,71 @@
"type": "null"
}
],
- "description": "Catagory of the Feature",
- "title": "Category"
+ "title": "Long Name"
+ },
+ "color": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Color"
+ },
+ "text_color": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Text Color"
}
},
+ "type": "object",
"required": [
- "id"
+ "mode"
],
- "title": "PredictionSchema",
- "type": "object"
+ "title": "TransitTransport"
},
- "Indoor_API_SingleIndoorFeatureSchema": {
- "example": {
- "distance": null,
- "duration": null,
- "geometry": {
- "bbox": null,
- "coordinates": [
- [
- [
- -0.12419943632,
- 51.49927414881
- ],
- [
- -0.12419342215,
- 51.49930532278
- ],
- [
- -0.12419141597,
- 51.49931625597
- ],
- [
- -0.12419943632,
- 51.49927414881
- ]
- ]
- ],
- "type": "Polygon"
- },
- "id": 3623459,
- "properties": {
- "name": "Painted Chamber",
- "room": "office",
- "level": "1",
- "indoor": "area",
- "building:ref": "Palace of Westminster",
- "woosmap:logo": "https://woosmap-indoor-img.s3.amazonaws.com/Westminster/logo.png",
- "woosmap:cover": "https://woosmap-indoor-img.s3.amazonaws.com/Westminster/paintedchamber.png",
- "woosmap:label_id": 3623458,
- "woosmap:zoom_icon_min": "16",
- "woosmap:zoom_polygon_min": "16"
- },
- "type": "Feature"
- },
+ "External-api-wrapper_ValidationError": {
"properties": {
- "properties": {
- "type": "object",
- "additionalProperties": true,
- "description": "Additional properties associated with this feature",
- "title": "Properties"
- },
- "type": {
- "const": "Feature",
- "default": "Feature",
- "title": "Type",
- "type": "string"
- },
- "geometry": {
- "anyOf": [
- {
- "discriminator": {
- "mapping": {
- "GeometryCollection": "#/components/schemas/Indoor_API_GeometryCollection",
- "LineString": "#/components/schemas/Indoor_API_LineString",
- "MultiLineString": "#/components/schemas/Indoor_API_MultiLineString",
- "MultiPoint": "#/components/schemas/Indoor_API_MultiPoint",
- "MultiPolygon": "#/components/schemas/Indoor_API_MultiPolygon",
- "Point": "#/components/schemas/Indoor_API_Point",
- "Polygon": "#/components/schemas/Indoor_API_Polygon"
- },
- "propertyName": "type"
+ "loc": {
+ "items": {
+ "anyOf": [
+ {
+ "type": "string"
},
- "oneOf": [
- {
- "$ref": "#/components/schemas/Indoor_API_Point"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_MultiPoint"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_LineString"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_MultiLineString"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_Polygon"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_MultiPolygon"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_GeometryCollection"
- }
- ]
- },
- {
- "$ref": "#/components/schemas/Indoor_API_GeometryCollection"
- }
- ],
- "description": "GeoJSON Geometry or Geometry Collection",
- "title": "Geometry"
+ {
+ "type": "integer"
+ }
+ ]
+ },
+ "type": "array",
+ "title": "Location"
},
- "id": {
- "description": "ID of the feature",
- "title": "Id",
- "type": "integer"
+ "msg": {
+ "type": "string",
+ "title": "Message"
+ },
+ "type": {
+ "type": "string",
+ "title": "Error Type"
}
},
+ "type": "object",
"required": [
- "properties",
- "geometry",
- "id"
+ "loc",
+ "msg",
+ "type"
],
- "title": "SingleIndoorFeatureSchema",
- "type": "object"
+ "title": "ValidationError"
},
- "External-api-wrapper_AuthenticationErrorResponse": {
+ "Datasets_AuthenticationErrorResponse": {
"properties": {
"detail": {
"type": "string",
@@ -18769,378 +18073,374 @@
"title": "AuthenticationErrorResponse",
"description": "AuthenticationErrorResponse is the base authentication error model."
},
- "External-api-wrapper_HTTPErrorModel": {
+ "Datasets_DatasetCreateRequest": {
"properties": {
- "details": {
+ "name": {
"type": "string",
- "title": "Details"
+ "title": "Name",
+ "description": "The friendly name "
+ },
+ "url": {
+ "type": "string",
+ "maxLength": 2083,
+ "minLength": 1,
+ "format": "uri",
+ "title": "Url"
+ },
+ "schema_mapping": {
+ "anyOf": [
+ {
+ "items": {
+ "$ref": "#/components/schemas/Datasets_DatasetSchemaMapping"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Schema Mapping"
}
},
"type": "object",
"required": [
- "details"
+ "name",
+ "url"
],
- "title": "HTTPErrorModel"
+ "title": "DatasetCreateRequest",
+ "description": "DatasetCreateRequest represents the parameters for dataset creation."
},
- "External-api-wrapper_HTTPValidationError": {
+ "Datasets_DatasetListResponse": {
"properties": {
- "detail": {
+ "datasets": {
"items": {
- "$ref": "#/components/schemas/External-api-wrapper_ValidationError"
+ "$ref": "#/components/schemas/Datasets_DatasetSummaryResponse"
},
"type": "array",
- "title": "Detail"
- }
- },
- "type": "object",
- "title": "HTTPValidationError"
- },
- "External-api-wrapper_MatrixCheckResponse": {
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "accepted",
- "inProgress",
- "completed",
- "timeout",
- "error"
- ],
- "title": "Status",
- "description": "Status of the matrix calculation"
+ "title": "Datasets"
+ },
+ "pagination": {
+ "$ref": "#/components/schemas/Datasets_Pagination"
}
},
"type": "object",
"required": [
- "status"
+ "datasets",
+ "pagination"
],
- "title": "MatrixCheckResponse"
+ "title": "DatasetListResponse"
},
- "External-api-wrapper_MatrixRequest": {
+ "Datasets_DatasetLogEntry": {
"properties": {
- "origins": {
+ "created_at": {
"type": "string",
- "title": "Origins",
- "description": "The starting points. You can supply one or more locations, in the form of `latitude,longitude` coordinates, separated by the pipe character `|`. Ensure that no space exists between the latitude and longitude values.",
- "examples": [
- "48.709,2.403|48.768,2.338"
- ]
+ "format": "date-time",
+ "title": "Created At",
+ "description": "The date of the log entry."
},
- "destinations": {
+ "detail": {
"type": "string",
- "title": "Destinations",
- "description": "The ending points. You can supply one or more locations, in the form of `latitude,longitude` coordinates, separated by the pipe character `|`. Ensure that no space exists between the latitude and longitude values.",
- "examples": [
- "48.709,2.403|48.768,2.338"
- ]
+ "title": "Detail",
+ "description": "The detail of the log entry."
},
- "mode": {
- "type": "string",
- "enum": [
- "driving",
- "truck"
- ],
- "title": "Mode",
- "description": "Specifies the mode of transport to use when calculating distance",
- "default": "driving",
- "examples": [
- "driving"
- ]
+ "level": {
+ "$ref": "#/components/schemas/Datasets_LoggerLevel",
+ "description": "The level of the log entry."
}
},
"type": "object",
"required": [
- "origins",
- "destinations"
+ "created_at",
+ "detail",
+ "level"
],
- "title": "MatrixRequest"
+ "title": "DatasetLogEntry"
},
- "External-api-wrapper_MatrixResponse": {
+ "Datasets_DatasetResponse": {
"properties": {
- "matrix_id": {
+ "id": {
"type": "string",
- "title": "Matrix Id",
- "description": "Unique identifier for the matrix requested, this will be used to check the status and retrieve the completed calculation."
+ "format": "uuid",
+ "title": "Id"
},
- "status": {
- "type": "string",
- "enum": [
- "accepted",
- "inProgress",
- "completed",
- "timeout",
- "error"
- ],
- "title": "Status",
- "description": "Status of the matrix calculation"
- }
- },
- "type": "object",
- "required": [
- "matrix_id",
- "status"
- ],
- "title": "MatrixResponse"
- },
- "External-api-wrapper_Transit": {
- "properties": {
- "status": {
+ "name": {
"type": "string",
- "title": "Status"
+ "title": "Name"
},
- "routes": {
- "items": {
- "$ref": "#/components/schemas/External-api-wrapper_TransitRoute"
- },
- "type": "array",
- "title": "Routes",
- "default": []
- }
- },
- "type": "object",
- "required": [
- "status"
- ],
- "title": "Transit"
- },
- "External-api-wrapper_TransitAttributions": {
- "properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "href": {
- "type": "string",
- "title": "Href"
- },
- "text": {
- "type": "string",
- "title": "Text"
- },
- "type": {
- "type": "string",
- "title": "Type"
- }
- },
- "type": "object",
- "required": [
- "id",
- "href",
- "text",
- "type"
- ],
- "title": "TransitAttributions"
- },
- "External-api-wrapper_TransitLeg": {
- "properties": {
- "travel_mode": {
- "type": "string",
- "title": "Travel Mode"
- },
- "duration": {
- "type": "integer",
- "title": "Duration"
- },
- "distance": {
- "type": "number",
- "title": "Distance"
- },
- "polyline": {
+ "url": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "maxLength": 2083,
+ "minLength": 1,
+ "format": "uri"
},
{
"type": "null"
}
],
- "title": "Polyline"
- },
- "start_location": {
- "$ref": "#/components/schemas/External-api-wrapper_TransitPlace"
- },
- "end_location": {
- "$ref": "#/components/schemas/External-api-wrapper_TransitPlace"
+ "title": "Url",
+ "description": "The url of the data to fetch"
},
- "transport": {
+ "reimport_key": {
"anyOf": [
{
- "$ref": "#/components/schemas/External-api-wrapper_TransitTransport"
+ "type": "string",
+ "format": "uuid"
},
{
"type": "null"
}
- ]
+ ],
+ "title": "Reimport Key",
+ "description": "The reimport key to be used with the reimport hook endpoint."
},
- "attributions": {
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created At",
+ "description": "The date when the dataset was created."
+ },
+ "updated_at": {
"anyOf": [
{
- "items": {
- "$ref": "#/components/schemas/External-api-wrapper_TransitAttributions"
- },
- "type": "array"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Attributions"
- }
- },
- "type": "object",
- "required": [
- "travel_mode",
- "duration",
- "distance",
- "polyline",
- "start_location",
- "end_location"
- ],
- "title": "TransitLeg"
- },
- "External-api-wrapper_TransitPlace": {
- "properties": {
- "name": {
+ "title": "Updated At",
+ "description": "The date when the dataset was last updated."
+ },
+ "scheduled_for_deletion_after": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "date"
},
{
"type": "null"
}
],
- "title": "Name"
- },
- "type": {
- "type": "string",
- "title": "Type"
- },
- "location": {
- "$ref": "#/components/schemas/External-api-wrapper_TransitPosition"
+ "title": "Scheduled For Deletion After",
+ "description": "After this date the dataset will be automatically removed"
}
},
"type": "object",
"required": [
- "type",
- "location"
+ "id",
+ "name",
+ "created_at",
+ "updated_at"
],
- "title": "TransitPlace"
+ "title": "DatasetResponse"
},
- "External-api-wrapper_TransitPosition": {
+ "Datasets_DatasetSchemaMapping": {
"properties": {
- "lat": {
- "anyOf": [
- {
- "type": "number",
- "maximum": 90,
- "minimum": -90
- },
- {
- "type": "string",
- "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
- }
- ],
- "title": "Lat"
+ "schema_key": {
+ "$ref": "#/components/schemas/Datasets_SchemaKeys"
},
- "lng": {
- "anyOf": [
- {
- "type": "number",
- "maximum": 180,
- "minimum": -180
- },
- {
- "type": "string",
- "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
- }
- ],
- "title": "Lng"
+ "data_key": {
+ "type": "string",
+ "title": "Data Key"
}
},
"type": "object",
"required": [
- "lat",
- "lng"
+ "schema_key",
+ "data_key"
],
- "title": "TransitPosition"
+ "title": "DatasetSchemaMapping",
+ "description": "DatasetSchemaMapping defines a mapping between `schema_key` and user provided `data_key`."
},
- "External-api-wrapper_TransitRoute": {
+ "Datasets_DatasetStatusResponse": {
"properties": {
- "notice": {
+ "id": {
"type": "string",
- "title": "Notice",
- "default": ""
- },
- "duration": {
- "type": "integer",
- "title": "Duration"
+ "format": "uuid",
+ "title": "Id",
+ "description": "The id of the run, can be used in communication with the support to better identify the run."
},
- "legs": {
+ "steps": {
"items": {
- "$ref": "#/components/schemas/External-api-wrapper_TransitLeg"
+ "$ref": "#/components/schemas/Datasets_DatasetStatusStep"
},
"type": "array",
- "title": "Legs",
- "default": []
+ "title": "Steps",
+ "description": "The steps of the run, ordered by start date."
+ },
+ "status": {
+ "$ref": "#/components/schemas/Datasets_Status",
+ "description": "The status of the import run for the dataset."
}
},
"type": "object",
"required": [
- "duration"
+ "id",
+ "steps",
+ "status"
],
- "title": "TransitRoute"
- },
- "External-api-wrapper_TransitTransport": {
- "properties": {
- "name": {
- "anyOf": [
+ "title": "DatasetStatusResponse",
+ "examples": [
+ {
+ "id": "832eb97f-266c-4387-991d-52e77366dc99",
+ "status": "success",
+ "steps": [
{
- "type": "string"
+ "end": "2024-06-07T09:30:48.356003",
+ "entries": [
+ {
+ "created_at": "2024-06-07T09:30:36.741569",
+ "detail": "Fetching https://hostname.com/archive.zip...",
+ "level": "info"
+ },
+ {
+ "created_at": "2024-06-07T09:30:48.103825",
+ "detail": "Loading dataset...",
+ "level": "info"
+ },
+ {
+ "created_at": "2024-06-07T09:30:48.351829",
+ "detail": "Dataset loaded",
+ "level": "info"
+ }
+ ],
+ "name": "fetch",
+ "start": "2024-06-07T09:30:36.715881",
+ "status": "success"
},
{
- "type": "null"
+ "end": "2024-06-07T09:31:18.900746",
+ "entries": [
+ {
+ "created_at": "2024-06-07T09:30:48.366471",
+ "detail": "Will import 34867 features.",
+ "level": "info"
+ },
+ {
+ "created_at": "2024-06-07T09:31:18.785477",
+ "detail": "Successfully imported 34867 features.",
+ "level": "info"
+ }
+ ],
+ "name": "import",
+ "start": "2024-06-07T09:30:48.358285",
+ "status": "success"
}
- ],
- "title": "Name"
+ ]
+ }
+ ]
+ },
+ "Datasets_DatasetStatusStep": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "enum": [
+ "fetch",
+ "import"
+ ],
+ "title": "Name",
+ "description": "The name of the step. Currently can only be `fetch` of `import`"
},
- "mode": {
+ "start": {
"type": "string",
- "title": "Mode"
+ "format": "date-time",
+ "title": "Start",
+ "description": "The date at which the step started."
},
- "category": {
+ "end": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Category"
+ "title": "End",
+ "description": "The date at which the step ended or null if in progress."
},
- "headsign": {
+ "entries": {
+ "items": {
+ "$ref": "#/components/schemas/Datasets_DatasetLogEntry"
+ },
+ "type": "array",
+ "title": "Entries",
+ "description": "The log entries for the step."
+ },
+ "status": {
+ "$ref": "#/components/schemas/Datasets_Status",
+ "description": "The status of the step."
+ }
+ },
+ "type": "object",
+ "required": [
+ "name",
+ "start",
+ "end",
+ "entries",
+ "status"
+ ],
+ "title": "DatasetStatusStep"
+ },
+ "Datasets_DatasetSummaryResponse": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Id"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name"
+ },
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created At",
+ "description": "The date when the dataset was created."
+ },
+ "updated_at": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "title": "Headsign"
+ "title": "Updated At",
+ "description": "The date when the dataset was last updated."
},
- "short_name": {
+ "scheduled_for_deletion_after": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "date"
},
{
"type": "null"
}
],
- "title": "Short Name"
- },
- "long_name": {
+ "title": "Scheduled For Deletion After",
+ "description": "After this date the dataset will be automatically removed"
+ }
+ },
+ "type": "object",
+ "required": [
+ "id",
+ "name",
+ "created_at"
+ ],
+ "title": "DatasetSummaryResponse"
+ },
+ "Datasets_DatasetUpdate": {
+ "properties": {
+ "name": {
"anyOf": [
{
"type": "string"
@@ -19149,1760 +18449,2584 @@
"type": "null"
}
],
- "title": "Long Name"
+ "title": "Name",
+ "description": "The friendly name "
},
- "color": {
+ "url": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "maxLength": 2083,
+ "minLength": 1,
+ "format": "uri"
},
{
"type": "null"
}
],
- "title": "Color"
+ "title": "Url"
+ }
+ },
+ "type": "object",
+ "title": "DatasetUpdate"
+ },
+ "Datasets_FeatureRead": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Id"
},
- "text_color": {
+ "geometry": {
"anyOf": [
{
"type": "string"
},
{
- "type": "null"
+ "$ref": "#/components/schemas/Datasets_PointGeometry"
+ },
+ {
+ "$ref": "#/components/schemas/Datasets_LineStringGeometry"
+ },
+ {
+ "$ref": "#/components/schemas/Datasets_PolygonGeometry"
+ },
+ {
+ "$ref": "#/components/schemas/Datasets_MultiPointGeometry"
+ },
+ {
+ "$ref": "#/components/schemas/Datasets_MultiLineStringGeometry"
+ },
+ {
+ "$ref": "#/components/schemas/Datasets_MultiPolygonGeometry"
}
],
- "title": "Text Color"
- }
- },
- "type": "object",
- "required": [
- "mode"
- ],
- "title": "TransitTransport"
- },
- "External-api-wrapper_ValidationError": {
- "properties": {
- "loc": {
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "integer"
- }
- ]
- },
- "type": "array",
- "title": "Location"
- },
- "msg": {
- "type": "string",
- "title": "Message"
+ "title": "Geometry"
},
- "type": {
- "type": "string",
- "title": "Error Type"
- }
- },
- "type": "object",
- "required": [
- "loc",
- "msg",
- "type"
- ],
- "title": "ValidationError"
- },
- "Datasets_AuthenticationErrorResponse": {
- "properties": {
- "detail": {
- "type": "string",
- "title": "Detail"
+ "attributes": {
+ "additionalProperties": true,
+ "type": "object",
+ "title": "Attributes"
}
},
"type": "object",
"required": [
- "detail"
+ "id",
+ "geometry",
+ "attributes"
],
- "title": "AuthenticationErrorResponse",
- "description": "AuthenticationErrorResponse is the base authentication error model."
+ "title": "FeatureRead"
},
- "Datasets_DatasetCreateRequest": {
+ "Datasets_FeatureSummaryResponse": {
"properties": {
- "name": {
+ "id": {
"type": "string",
- "title": "Name",
- "description": "The friendly name "
+ "format": "uuid",
+ "title": "Id",
+ "description": "The feature ID."
},
- "url": {
- "type": "string",
- "maxLength": 2083,
- "minLength": 1,
- "format": "uri",
- "title": "Url"
+ "geometry": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/Datasets_PolygonGeometry"
+ },
+ {
+ "$ref": "#/components/schemas/Datasets_PointGeometry"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Geometry",
+ "description": "The geometry WKB base64-encoded"
},
- "schema_mapping": {
+ "attributes": {
"anyOf": [
{
- "items": {
- "$ref": "#/components/schemas/Datasets_DatasetSchemaMapping"
- },
- "type": "array"
+ "additionalProperties": true,
+ "type": "object"
},
{
"type": "null"
}
],
- "title": "Schema Mapping"
+ "title": "Attributes",
+ "description": "The feature attributes"
}
},
"type": "object",
"required": [
- "name",
- "url"
+ "id"
],
- "title": "DatasetCreateRequest",
- "description": "DatasetCreateRequest represents the parameters for dataset creation."
+ "title": "FeatureSummaryResponse",
+ "description": "FeatureSummaryResponse represents the minimal amount of information to be able to fetch a feature details."
},
- "Datasets_DatasetListResponse": {
+ "Datasets_HTTPValidationError": {
"properties": {
- "datasets": {
+ "detail": {
"items": {
- "$ref": "#/components/schemas/Datasets_DatasetSummaryResponse"
+ "$ref": "#/components/schemas/Datasets_ValidationError"
},
"type": "array",
- "title": "Datasets"
- },
- "pagination": {
- "$ref": "#/components/schemas/Datasets_Pagination"
+ "title": "Detail"
+ }
+ },
+ "type": "object",
+ "title": "HTTPValidationError"
+ },
+ "Datasets_ImportResponse": {
+ "properties": {
+ "dataset_id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Dataset Id",
+ "description": "The dataset id that was scheduled for import."
}
},
"type": "object",
"required": [
- "datasets",
- "pagination"
+ "dataset_id"
],
- "title": "DatasetListResponse"
+ "title": "ImportResponse"
},
- "Datasets_DatasetLogEntry": {
+ "Datasets_LineStringGeometry": {
"properties": {
- "created_at": {
+ "type": {
"type": "string",
- "format": "date-time",
- "title": "Created At",
- "description": "The date of the log entry."
+ "const": "LineString",
+ "title": "Type",
+ "default": "LineString"
},
- "detail": {
+ "coordinates": {
+ "items": {
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "type": "array",
+ "maxItems": 2,
+ "minItems": 2
+ },
+ "type": "array",
+ "title": "Coordinates"
+ }
+ },
+ "type": "object",
+ "required": [
+ "coordinates"
+ ],
+ "title": "LineStringGeometry"
+ },
+ "Datasets_LoggerLevel": {
+ "type": "string",
+ "enum": [
+ "info",
+ "warning",
+ "error"
+ ],
+ "title": "LoggerLevel"
+ },
+ "Datasets_MultiLineStringGeometry": {
+ "properties": {
+ "type": {
"type": "string",
- "title": "Detail",
- "description": "The detail of the log entry."
+ "const": "MultiLineString",
+ "title": "Type",
+ "default": "MultiLineString"
},
- "level": {
- "$ref": "#/components/schemas/Datasets_LoggerLevel",
- "description": "The level of the log entry."
+ "coordinates": {
+ "items": {
+ "items": {
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "type": "array",
+ "maxItems": 2,
+ "minItems": 2
+ },
+ "type": "array"
+ },
+ "type": "array",
+ "title": "Coordinates"
}
},
"type": "object",
"required": [
- "created_at",
- "detail",
- "level"
+ "coordinates"
],
- "title": "DatasetLogEntry"
+ "title": "MultiLineStringGeometry"
},
- "Datasets_DatasetResponse": {
+ "Datasets_MultiPointGeometry": {
"properties": {
- "id": {
+ "type": {
"type": "string",
- "format": "uuid",
- "title": "Id"
+ "const": "MultiPoint",
+ "title": "Type",
+ "default": "MultiPoint"
},
- "name": {
+ "coordinates": {
+ "items": {
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "type": "array",
+ "maxItems": 2,
+ "minItems": 2
+ },
+ "type": "array",
+ "title": "Coordinates"
+ }
+ },
+ "type": "object",
+ "required": [
+ "coordinates"
+ ],
+ "title": "MultiPointGeometry"
+ },
+ "Datasets_MultiPolygonGeometry": {
+ "properties": {
+ "type": {
"type": "string",
- "title": "Name"
+ "const": "MultiPolygon",
+ "title": "Type",
+ "default": "MultiPolygon"
},
- "url": {
+ "coordinates": {
+ "items": {
+ "items": {
+ "items": {
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "type": "array",
+ "maxItems": 2,
+ "minItems": 2
+ },
+ "type": "array"
+ },
+ "type": "array"
+ },
+ "type": "array",
+ "title": "Coordinates"
+ }
+ },
+ "type": "object",
+ "required": [
+ "coordinates"
+ ],
+ "title": "MultiPolygonGeometry"
+ },
+ "Datasets_Pagination": {
+ "properties": {
+ "prev": {
"anyOf": [
{
- "type": "string",
- "maxLength": 2083,
- "minLength": 1,
- "format": "uri"
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Url",
- "description": "The url of the data to fetch"
+ "title": "Prev",
+ "description": "The previous page number if any."
},
- "reimport_key": {
+ "next": {
"anyOf": [
{
- "type": "string",
- "format": "uuid"
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Reimport Key",
- "description": "The reimport key to be used with the reimport hook endpoint."
+ "title": "Next",
+ "description": "The next page number if any."
},
- "created_at": {
+ "page": {
+ "type": "integer",
+ "title": "Page",
+ "description": "The current page number."
+ }
+ },
+ "type": "object",
+ "required": [
+ "page"
+ ],
+ "title": "Pagination",
+ "description": "Pagination represents page information."
+ },
+ "Datasets_PointGeometry": {
+ "properties": {
+ "type": {
"type": "string",
- "format": "date-time",
- "title": "Created At",
- "description": "The date when the dataset was created."
- },
- "updated_at": {
- "anyOf": [
- {
- "type": "string",
- "format": "date-time"
- },
- {
- "type": "null"
- }
- ],
- "title": "Updated At",
- "description": "The date when the dataset was last updated."
+ "const": "Point",
+ "title": "Type",
+ "default": "Point"
},
- "scheduled_for_deletion_after": {
- "anyOf": [
+ "coordinates": {
+ "prefixItems": [
{
- "type": "string",
- "format": "date"
+ "type": "number"
},
{
- "type": "null"
+ "type": "number"
}
],
- "title": "Scheduled For Deletion After",
- "description": "After this date the dataset will be automatically removed"
+ "type": "array",
+ "maxItems": 2,
+ "minItems": 2,
+ "title": "Coordinates"
}
},
"type": "object",
"required": [
- "id",
- "name",
- "created_at",
- "updated_at"
+ "coordinates"
],
- "title": "DatasetResponse"
+ "title": "PointGeometry"
},
- "Datasets_DatasetSchemaMapping": {
+ "Datasets_PolygonGeometry": {
"properties": {
- "schema_key": {
- "$ref": "#/components/schemas/Datasets_SchemaKeys"
- },
- "data_key": {
- "type": "string",
- "title": "Data Key"
- }
- },
- "type": "object",
- "required": [
- "schema_key",
- "data_key"
- ],
- "title": "DatasetSchemaMapping",
- "description": "DatasetSchemaMapping defines a mapping between `schema_key` and user provided `data_key`."
- },
- "Datasets_DatasetStatusResponse": {
- "properties": {
- "id": {
+ "type": {
"type": "string",
- "format": "uuid",
- "title": "Id",
- "description": "The id of the run, can be used in communication with the support to better identify the run."
+ "const": "Polygon",
+ "title": "Type",
+ "default": "Polygon"
},
- "steps": {
+ "coordinates": {
"items": {
- "$ref": "#/components/schemas/Datasets_DatasetStatusStep"
- },
- "type": "array",
- "title": "Steps",
- "description": "The steps of the run, ordered by start date."
- },
- "status": {
- "$ref": "#/components/schemas/Datasets_Status",
- "description": "The status of the import run for the dataset."
- }
- },
- "type": "object",
- "required": [
- "id",
- "steps",
- "status"
- ],
- "title": "DatasetStatusResponse",
- "examples": [
- {
- "id": "832eb97f-266c-4387-991d-52e77366dc99",
- "status": "success",
- "steps": [
- {
- "end": "2024-06-07T09:30:48.356003",
- "entries": [
- {
- "created_at": "2024-06-07T09:30:36.741569",
- "detail": "Fetching https://hostname.com/archive.zip...",
- "level": "info"
- },
+ "items": {
+ "prefixItems": [
{
- "created_at": "2024-06-07T09:30:48.103825",
- "detail": "Loading dataset...",
- "level": "info"
+ "type": "number"
},
{
- "created_at": "2024-06-07T09:30:48.351829",
- "detail": "Dataset loaded",
- "level": "info"
+ "type": "number"
}
],
- "name": "fetch",
- "start": "2024-06-07T09:30:36.715881",
- "status": "success"
+ "type": "array",
+ "maxItems": 2,
+ "minItems": 2
},
- {
- "end": "2024-06-07T09:31:18.900746",
- "entries": [
- {
- "created_at": "2024-06-07T09:30:48.366471",
- "detail": "Will import 34867 features.",
- "level": "info"
- },
- {
- "created_at": "2024-06-07T09:31:18.785477",
- "detail": "Successfully imported 34867 features.",
- "level": "info"
- }
- ],
- "name": "import",
- "start": "2024-06-07T09:30:48.358285",
- "status": "success"
- }
- ]
+ "type": "array"
+ },
+ "type": "array",
+ "title": "Coordinates"
}
- ]
+ },
+ "type": "object",
+ "required": [
+ "coordinates"
+ ],
+ "title": "PolygonGeometry"
},
- "Datasets_DatasetStatusStep": {
+ "Datasets_SchemaKeys": {
+ "type": "string",
+ "enum": [
+ "title"
+ ],
+ "title": "SchemaKeys",
+ "description": "SchemaKeys are the allowed fields to be mapped."
+ },
+ "Datasets_SearchRequest": {
"properties": {
- "name": {
- "type": "string",
- "enum": [
- "fetch",
- "import"
- ],
- "title": "Name",
- "description": "The name of the step. Currently can only be `fetch` of `import`"
- },
- "start": {
+ "where": {
"type": "string",
- "format": "date-time",
- "title": "Start",
- "description": "The date at which the step started."
- },
- "end": {
- "anyOf": [
- {
- "type": "string",
- "format": "date-time"
- },
- {
- "type": "null"
- }
- ],
- "title": "End",
- "description": "The date at which the step ended or null if in progress."
- },
- "entries": {
- "items": {
- "$ref": "#/components/schemas/Datasets_DatasetLogEntry"
- },
- "type": "array",
- "title": "Entries",
- "description": "The log entries for the step."
- },
- "status": {
- "$ref": "#/components/schemas/Datasets_Status",
- "description": "The status of the step."
+ "title": "Where",
+ "description": "Applies a Woosmap filter on feature attributes.",
+ "examples": [
+ "cost_col:>32.3"
+ ]
}
},
"type": "object",
"required": [
- "name",
- "start",
- "end",
- "entries",
- "status"
+ "where"
],
- "title": "DatasetStatusStep"
+ "title": "SearchRequest"
},
- "Datasets_DatasetSummaryResponse": {
+ "Datasets_SearchRequestWithGeometry": {
"properties": {
- "id": {
- "type": "string",
- "format": "uuid",
- "title": "Id"
- },
- "name": {
- "type": "string",
- "title": "Name"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "title": "Created At",
- "description": "The date when the dataset was created."
- },
- "updated_at": {
+ "geometry": {
"anyOf": [
{
- "type": "string",
- "format": "date-time"
+ "type": "string"
},
{
- "type": "null"
+ "$ref": "#/components/schemas/Datasets_PointGeometry"
+ },
+ {
+ "$ref": "#/components/schemas/Datasets_LineStringGeometry"
+ },
+ {
+ "$ref": "#/components/schemas/Datasets_PolygonGeometry"
}
],
- "title": "Updated At",
- "description": "The date when the dataset was last updated."
+ "title": "Geometry",
+ "description": "\nA geometry can be passed as:\n- A GeoJSON geometry object, limited to Point, LineString and Polygon see [GeoJSON rfc7946](https://datatracker.ietf.org/doc/html/rfc7946#section-3.1) for more information.\n- A WKT geometry see [Well-known text representation](https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry) for more information\n- A google encoded polyline see [Google-encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) for more information\n- A bare point defined as lat,lng\n "
},
- "scheduled_for_deletion_after": {
+ "buffer": {
"anyOf": [
{
- "type": "string",
- "format": "date"
+ "type": "number"
},
{
"type": "null"
}
],
- "title": "Scheduled For Deletion After",
- "description": "After this date the dataset will be automatically removed"
+ "title": "Buffer",
+ "description": "When set applies a buffer operation to input geometry see [Buffer Analysis](https://en.wikipedia.org/wiki/Buffer_analysis)."
+ },
+ "where": {
+ "type": "string",
+ "title": "Where",
+ "description": "Applies a Woosmap filter on feature attributes.",
+ "examples": [
+ "cost_col:>32.3"
+ ]
}
},
"type": "object",
"required": [
- "id",
- "name",
- "created_at"
+ "geometry"
],
- "title": "DatasetSummaryResponse"
+ "title": "SearchRequestWithGeometry",
+ "description": "Subclass with the Point, LineString & Polygon geometry type"
},
- "Datasets_DatasetUpdate": {
+ "Datasets_SearchRequestWithPolygonGeometry": {
"properties": {
- "name": {
+ "geometry": {
"anyOf": [
{
"type": "string"
},
{
- "type": "null"
+ "$ref": "#/components/schemas/Datasets_PolygonGeometry"
}
],
- "title": "Name",
- "description": "The friendly name "
+ "title": "Geometry",
+ "description": "\nA geometry can be passed as:\n- A GeoJSON geometry object, limited to Polygon see [GeoJSON rfc7946](https://datatracker.ietf.org/doc/html/rfc7946#section-3.1) for more information.\n- A WKT geometry see [Well-known text representation](https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry) for more information\n "
},
- "url": {
+ "buffer": {
"anyOf": [
{
- "type": "string",
- "maxLength": 2083,
- "minLength": 1,
- "format": "uri"
+ "type": "number"
},
{
"type": "null"
}
],
- "title": "Url"
- }
- },
- "type": "object",
- "title": "DatasetUpdate"
- },
- "Datasets_FeatureRead": {
- "properties": {
- "id": {
- "type": "string",
- "format": "uuid",
- "title": "Id"
- },
- "geometry": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/Datasets_PointGeometry"
- },
- {
- "$ref": "#/components/schemas/Datasets_LineStringGeometry"
- },
- {
- "$ref": "#/components/schemas/Datasets_PolygonGeometry"
- },
- {
- "$ref": "#/components/schemas/Datasets_MultiPointGeometry"
- },
- {
- "$ref": "#/components/schemas/Datasets_MultiLineStringGeometry"
- },
- {
- "$ref": "#/components/schemas/Datasets_MultiPolygonGeometry"
- }
- ],
- "title": "Geometry"
- },
- "attributes": {
- "additionalProperties": true,
- "type": "object",
- "title": "Attributes"
+ "title": "Buffer",
+ "description": "When set applies a buffer operation to input geometry see [Buffer Analysis](https://en.wikipedia.org/wiki/Buffer_analysis)."
+ },
+ "where": {
+ "type": "string",
+ "title": "Where",
+ "description": "Applies a Woosmap filter on feature attributes.",
+ "examples": [
+ "cost_col:>32.3"
+ ]
}
},
"type": "object",
"required": [
- "id",
- "geometry",
- "attributes"
+ "geometry"
],
- "title": "FeatureRead"
+ "title": "SearchRequestWithPolygonGeometry",
+ "description": "Subclass with the Polygon geometry type"
},
- "Datasets_FeatureSummaryResponse": {
+ "Datasets_SearchResultResponse": {
"properties": {
- "id": {
- "type": "string",
- "format": "uuid",
- "title": "Id",
- "description": "The feature ID."
- },
- "geometry": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/Datasets_PolygonGeometry"
- },
- {
- "$ref": "#/components/schemas/Datasets_PointGeometry"
- },
- {
- "type": "null"
- }
- ],
- "title": "Geometry",
- "description": "The geometry WKB base64-encoded"
+ "features": {
+ "items": {
+ "$ref": "#/components/schemas/Datasets_FeatureSummaryResponse"
+ },
+ "type": "array",
+ "title": "Features",
+ "description": "The list of FeatureSummaryResponse that matched the search"
},
- "attributes": {
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "title": "Attributes",
- "description": "The feature attributes"
+ "pagination": {
+ "$ref": "#/components/schemas/Datasets_Pagination",
+ "description": "The pagination information"
}
},
"type": "object",
"required": [
- "id"
+ "features",
+ "pagination"
],
- "title": "FeatureSummaryResponse",
- "description": "FeatureSummaryResponse represents the minimal amount of information to be able to fetch a feature details."
+ "title": "SearchResultResponse"
},
- "Datasets_HTTPValidationError": {
+ "Datasets_Status": {
+ "type": "string",
+ "enum": [
+ "success",
+ "in_progress",
+ "failed"
+ ],
+ "title": "Status"
+ },
+ "Datasets_ValidationError": {
"properties": {
- "detail": {
+ "loc": {
"items": {
- "$ref": "#/components/schemas/Datasets_ValidationError"
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ }
+ ]
},
"type": "array",
- "title": "Detail"
+ "title": "Location"
+ },
+ "msg": {
+ "type": "string",
+ "title": "Message"
+ },
+ "type": {
+ "type": "string",
+ "title": "Error Type"
}
},
"type": "object",
- "title": "HTTPValidationError"
+ "required": [
+ "loc",
+ "msg",
+ "type"
+ ],
+ "title": "ValidationError"
},
- "Datasets_ImportResponse": {
+ "Datasets_application_kit__fastapi__responses__HTTPErrorModel": {
"properties": {
- "dataset_id": {
+ "detail": {
"type": "string",
- "format": "uuid",
- "title": "Dataset Id",
- "description": "The dataset id that was scheduled for import."
+ "title": "Detail"
}
},
"type": "object",
"required": [
- "dataset_id"
+ "detail"
],
- "title": "ImportResponse"
+ "title": "HTTPErrorModel"
},
- "Datasets_LineStringGeometry": {
+ "Datasets_features__internal__responses__HTTPErrorModel": {
"properties": {
- "type": {
+ "details": {
"type": "string",
- "const": "LineString",
- "title": "Type",
- "default": "LineString"
- },
- "coordinates": {
- "items": {
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
- }
- ],
- "type": "array",
- "maxItems": 2,
- "minItems": 2
- },
- "type": "array",
- "title": "Coordinates"
+ "title": "Details"
}
},
"type": "object",
"required": [
- "coordinates"
- ],
- "title": "LineStringGeometry"
- },
- "Datasets_LoggerLevel": {
- "type": "string",
- "enum": [
- "info",
- "warning",
- "error"
+ "details"
],
- "title": "LoggerLevel"
+ "title": "HTTPErrorModel"
},
- "Datasets_MultiLineStringGeometry": {
+ "Distance_AuthenticationErrorResponse": {
"properties": {
- "type": {
+ "detail": {
"type": "string",
- "const": "MultiLineString",
- "title": "Type",
- "default": "MultiLineString"
- },
- "coordinates": {
- "items": {
- "items": {
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
- }
- ],
- "type": "array",
- "maxItems": 2,
- "minItems": 2
- },
- "type": "array"
- },
- "type": "array",
- "title": "Coordinates"
+ "title": "Detail"
}
},
"type": "object",
"required": [
- "coordinates"
+ "detail"
],
- "title": "MultiLineStringGeometry"
+ "title": "AuthenticationErrorResponse",
+ "description": "AuthenticationErrorResponse is the base authentication error model."
},
- "Datasets_MultiPointGeometry": {
+ "Distance_BaseElementResponse": {
"properties": {
- "type": {
+ "status": {
"type": "string",
- "const": "MultiPoint",
- "title": "Type",
- "default": "MultiPoint"
- },
- "coordinates": {
- "items": {
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
- }
- ],
- "type": "array",
- "maxItems": 2,
- "minItems": 2
- },
- "type": "array",
- "title": "Coordinates"
+ "enum": [
+ "OK",
+ "NOT_FOUND",
+ "ZERO_RESULTS",
+ "ERROR"
+ ],
+ "title": "Status",
+ "description": "The status of each element.\n* `OK` The response contains a valid result.\n* `NOT_FOUND` The origin and/or destination of this pairing could not be matched to the network.\n* `ZERO_RESULTS` No route could be found between the origin and destination."
}
},
"type": "object",
"required": [
- "coordinates"
+ "status"
],
- "title": "MultiPointGeometry"
+ "title": "BaseElementResponse"
},
- "Datasets_MultiPolygonGeometry": {
+ "Distance_Bounds": {
"properties": {
- "type": {
- "type": "string",
- "const": "MultiPolygon",
- "title": "Type",
- "default": "MultiPolygon"
+ "northeast": {
+ "$ref": "#/components/schemas/Distance_LatLng"
},
- "coordinates": {
- "items": {
- "items": {
- "items": {
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
- }
- ],
- "type": "array",
- "maxItems": 2,
- "minItems": 2
- },
- "type": "array"
- },
- "type": "array"
- },
- "type": "array",
- "title": "Coordinates"
+ "southwest": {
+ "$ref": "#/components/schemas/Distance_LatLng"
}
},
"type": "object",
"required": [
- "coordinates"
+ "northeast",
+ "southwest"
],
- "title": "MultiPolygonGeometry"
+ "title": "Bounds"
},
- "Datasets_Pagination": {
+ "Distance_DistanceResponse": {
"properties": {
- "prev": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
- ],
- "title": "Prev",
- "description": "The previous page number if any."
- },
- "next": {
- "anyOf": [
- {
- "type": "integer"
- },
- {
- "type": "null"
- }
+ "status": {
+ "type": "string",
+ "enum": [
+ "OK",
+ "NOT_FOUND",
+ "ZERO_RESULTS",
+ "ERROR"
],
- "title": "Next",
- "description": "The next page number if any."
+ "title": "Status",
+ "description": "The status of each element.\n* `OK` The response contains a valid result.\n* `NOT_FOUND` The origin and/or destination of this pairing could not be matched to the network.\n* `ZERO_RESULTS` No route could be found between the origin and destination."
},
- "page": {
- "type": "integer",
- "title": "Page",
- "description": "The current page number."
+ "distance": {
+ "$ref": "#/components/schemas/Distance_MatrixDistanceDuration",
+ "description": "Returned when `elements=distance`. The `value` is the distance in meters and the `text` is a human readable representation of the distance."
}
},
"type": "object",
"required": [
- "page"
+ "status",
+ "distance"
],
- "title": "Pagination",
- "description": "Pagination represents page information."
+ "title": "DistanceResponse"
},
- "Datasets_PointGeometry": {
+ "Distance_DurationDistanceResponse": {
"properties": {
- "type": {
+ "status": {
"type": "string",
- "const": "Point",
- "title": "Type",
- "default": "Point"
- },
- "coordinates": {
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
- }
+ "enum": [
+ "OK",
+ "NOT_FOUND",
+ "ZERO_RESULTS",
+ "ERROR"
],
- "type": "array",
- "maxItems": 2,
- "minItems": 2,
- "title": "Coordinates"
+ "title": "Status",
+ "description": "The status of each element.\n* `OK` The response contains a valid result.\n* `NOT_FOUND` The origin and/or destination of this pairing could not be matched to the network.\n* `ZERO_RESULTS` No route could be found between the origin and destination."
+ },
+ "distance": {
+ "$ref": "#/components/schemas/Distance_MatrixDistanceDuration",
+ "description": "Returned when `elements=duration_distance`. The `value` is the distance in meters and the `text` is a human readable representation of the distance."
+ },
+ "duration": {
+ "$ref": "#/components/schemas/Distance_MatrixDistanceDuration",
+ "description": "Returned when `elements=duration_distance`. The `value` is the duration in seconds and the `text` is a human readable representation of the duration."
}
},
"type": "object",
"required": [
- "coordinates"
+ "status",
+ "distance",
+ "duration"
],
- "title": "PointGeometry"
+ "title": "DurationDistanceResponse"
},
- "Datasets_PolygonGeometry": {
+ "Distance_DurationResponse": {
"properties": {
- "type": {
+ "status": {
"type": "string",
- "const": "Polygon",
- "title": "Type",
- "default": "Polygon"
+ "enum": [
+ "OK",
+ "NOT_FOUND",
+ "ZERO_RESULTS",
+ "ERROR"
+ ],
+ "title": "Status",
+ "description": "The status of each element.\n* `OK` The response contains a valid result.\n* `NOT_FOUND` The origin and/or destination of this pairing could not be matched to the network.\n* `ZERO_RESULTS` No route could be found between the origin and destination."
},
- "coordinates": {
- "items": {
- "items": {
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
- }
- ],
- "type": "array",
- "maxItems": 2,
- "minItems": 2
- },
- "type": "array"
- },
- "type": "array",
- "title": "Coordinates"
+ "duration": {
+ "$ref": "#/components/schemas/Distance_MatrixDistanceDuration",
+ "description": "Returned when `elements=duration`. The `value` is the duration in seconds and the `text` is a human readable representation of the duration."
}
},
"type": "object",
"required": [
- "coordinates"
- ],
- "title": "PolygonGeometry"
- },
- "Datasets_SchemaKeys": {
- "type": "string",
- "enum": [
- "title"
+ "status",
+ "duration"
],
- "title": "SchemaKeys",
- "description": "SchemaKeys are the allowed fields to be mapped."
+ "title": "DurationResponse"
},
- "Datasets_SearchRequest": {
+ "Distance_HTTPErrorModel": {
"properties": {
- "where": {
+ "details": {
"type": "string",
- "title": "Where",
- "description": "Applies a Woosmap filter on feature attributes.",
- "examples": [
- "cost_col:>32.3"
- ]
+ "title": "Details"
}
},
"type": "object",
"required": [
- "where"
+ "details"
],
- "title": "SearchRequest"
+ "title": "HTTPErrorModel"
},
- "Datasets_SearchRequestWithGeometry": {
+ "Distance_HTTPValidationError": {
"properties": {
- "geometry": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/Datasets_PointGeometry"
- },
- {
- "$ref": "#/components/schemas/Datasets_LineStringGeometry"
- },
- {
- "$ref": "#/components/schemas/Datasets_PolygonGeometry"
- }
- ],
- "title": "Geometry",
- "description": "\nA geometry can be passed as:\n- A GeoJSON geometry object, limited to Point, LineString and Polygon see [GeoJSON rfc7946](https://datatracker.ietf.org/doc/html/rfc7946#section-3.1) for more information.\n- A WKT geometry see [Well-known text representation](https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry) for more information\n- A google encoded polyline see [Google-encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) for more information\n- A bare point defined as lat,lng\n "
- },
- "buffer": {
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "title": "Buffer",
- "description": "When set applies a buffer operation to input geometry see [Buffer Analysis](https://en.wikipedia.org/wiki/Buffer_analysis)."
- },
- "where": {
- "type": "string",
- "title": "Where",
- "description": "Applies a Woosmap filter on feature attributes.",
- "examples": [
- "cost_col:>32.3"
- ]
+ "detail": {
+ "items": {
+ "$ref": "#/components/schemas/Distance_ValidationError"
+ },
+ "type": "array",
+ "title": "Detail"
}
},
"type": "object",
- "required": [
- "geometry"
- ],
- "title": "SearchRequestWithGeometry",
- "description": "Subclass with the Point, LineString & Polygon geometry type"
+ "title": "HTTPValidationError"
},
- "Datasets_SearchRequestWithPolygonGeometry": {
+ "Distance_IsochroneRequest": {
"properties": {
- "geometry": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/Datasets_PolygonGeometry"
- }
+ "mode": {
+ "type": "string",
+ "enum": [
+ "driving",
+ "walking",
+ "cycling"
],
- "title": "Geometry",
- "description": "\nA geometry can be passed as:\n- A GeoJSON geometry object, limited to Polygon see [GeoJSON rfc7946](https://datatracker.ietf.org/doc/html/rfc7946#section-3.1) for more information.\n- A WKT geometry see [Well-known text representation](https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry) for more information\n "
+ "title": "Mode",
+ "description": "Specifies the mode of transport to use for the calculation.",
+ "default": "driving"
},
- "buffer": {
+ "method": {
+ "type": "string",
+ "enum": [
+ "time",
+ "distance"
+ ],
+ "title": "Method",
+ "description": "Specifies how to compute the route between the start point and the end point:\n* `time`: fastest route \n* `distance`: shortest route",
+ "default": "time"
+ },
+ "units": {
+ "type": "string",
+ "enum": [
+ "metric",
+ "imperial"
+ ],
+ "title": "Units",
+ "description": "Specifies the unit system to use when displaying results.",
+ "default": "metric"
+ },
+ "language": {
+ "type": "string",
+ "enum": [
+ "en",
+ "fr",
+ "bg",
+ "ca",
+ "cs",
+ "da",
+ "de",
+ "el",
+ "es",
+ "et",
+ "fi",
+ "he",
+ "hi",
+ "hu",
+ "it",
+ "ja",
+ "nb",
+ "nl",
+ "pl",
+ "pt",
+ "ro",
+ "ru",
+ "sk",
+ "sl",
+ "sv",
+ "tr",
+ "uk",
+ "zh"
+ ],
+ "title": "Language",
+ "description": "The language code, indicating in the language the response should be in. \n \nIf not defined the header `Accept-Language` of the request will be checked before defaulting to `en`.",
+ "default": "en"
+ },
+ "avoid": {
"anyOf": [
{
- "type": "number"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Buffer",
- "description": "When set applies a buffer operation to input geometry see [Buffer Analysis](https://en.wikipedia.org/wiki/Buffer_analysis)."
+ "title": "Avoid",
+ "description": "A list of features that you want to avoid. Valid values are `tolls`, `highways`, `ferries` or polygons coordinates whose vertex latlng are separated by a semicolon `;`. \n \nTo add multiple features, separate them with the pipe `|` character.",
+ "examples": [
+ "tolls",
+ "tolls|highways|43.3,3.4;42.1,3.5;41.4,3.6"
+ ]
},
- "where": {
+ "origin": {
"type": "string",
- "title": "Where",
- "description": "Applies a Woosmap filter on feature attributes.",
+ "title": "Origin",
+ "description": "The starting point. It should be supplied in the form of `latitude,longitude` coordinates. Ensure that no space exists between the latitude and longitude values.",
"examples": [
- "cost_col:>32.3"
+ "48.709,2.403"
]
+ },
+ "value": {
+ "type": "number",
+ "maximum": 120,
+ "minimum": 0,
+ "title": "Value",
+ "description": "The value to use for the isochrone contour. \n\nIf you specified `time` for `method` this value should be number of minutes\n\nIf you specified `distance` for `method` this value should be distance in kilometers."
}
},
"type": "object",
"required": [
- "geometry"
+ "origin",
+ "value"
],
- "title": "SearchRequestWithPolygonGeometry",
- "description": "Subclass with the Polygon geometry type"
+ "title": "IsochroneRequest"
},
- "Datasets_SearchResultResponse": {
+ "Distance_IsochroneResponse": {
"properties": {
- "features": {
- "items": {
- "$ref": "#/components/schemas/Datasets_FeatureSummaryResponse"
- },
- "type": "array",
- "title": "Features",
- "description": "The list of FeatureSummaryResponse that matched the search"
+ "status": {
+ "type": "string",
+ "enum": [
+ "OK",
+ "INVALID_REQUEST",
+ "MAX_ELEMENTS_EXCEEDED",
+ "MAX_ROUTE_LENGTH_EXCEEDED",
+ "REQUEST_DENIED",
+ "BACKEND_ERROR",
+ "OVER_QUERY_LIMIT",
+ "ZERO_RESULTS"
+ ],
+ "title": "Status",
+ "description": "The status of the response\n* `OK`: The response contains a valid result.\n* `INVALID_REQUEST`: The request could not be processed.\n* `MAX_ELEMENTS_EXCEEDED`: The product of origins and destinations exceeds the per-query limit (fixed at 200 elts/query).\n* `MAX_ROUTE_LENGTH_EXCEEDED`: One of requested routes is too long and the matrix/route cannot be processed (The limit is 500km).\n* `REQUEST_DENIED`: The API key provided is invalid or does not allow access to this service etc..\n* `BACKEND_ERROR`: The server encountered an unexpected error.\n* `OVER_QUERY_LIMIT`: The request was denied due to the rate limit (see [Usage Limits](https://developers.woosmap.com/products/distance-api/distance-matrix-endpoint/#usage-limits)).\n* `ZERO_RESULTS`: No route could be found between the origin and destination.\n ",
+ "default": "OK"
},
- "pagination": {
- "$ref": "#/components/schemas/Datasets_Pagination",
- "description": "The pagination information"
+ "isoline": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Distance_IsolineResponseTime"
+ },
+ {
+ "$ref": "#/components/schemas/Distance_IsolineResponseDistance"
+ }
+ ],
+ "title": "Isoline"
}
},
"type": "object",
"required": [
- "features",
- "pagination"
+ "isoline"
],
- "title": "SearchResultResponse"
+ "title": "IsochroneResponse",
+ "examples": [
+ {
+ "isoline": {
+ "distance": {
+ "text": "1 km",
+ "value": 1
+ },
+ "geometry": "s|ihHouuMZ`GdClCsA~QhCnQmBhEpCfF|HxGpBtFfEnBnHqJpH}AF_EeCcB@sBnEiEYiGmVyFaG{G[eFoCw@gAiIkDYg@_DwA@",
+ "origin": {
+ "lat": 48.709,
+ "lng": 2.403
+ }
+ },
+ "status": "OK"
+ }
+ ]
},
- "Datasets_Status": {
- "type": "string",
- "enum": [
- "success",
- "in_progress",
- "failed"
+ "Distance_IsochroneTimeDistance": {
+ "properties": {
+ "value": {
+ "type": "integer",
+ "title": "Value"
+ },
+ "text": {
+ "type": "string",
+ "title": "Text"
+ }
+ },
+ "type": "object",
+ "required": [
+ "value",
+ "text"
],
- "title": "Status"
+ "title": "IsochroneTimeDistance"
},
- "Datasets_ValidationError": {
+ "Distance_IsolineResponseDistance": {
"properties": {
- "loc": {
- "items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "integer"
- }
- ]
- },
- "type": "array",
- "title": "Location"
+ "origin": {
+ "$ref": "#/components/schemas/Distance_LatLng",
+ "description": "The origin point of the isochrone contour."
},
- "msg": {
+ "geometry": {
"type": "string",
- "title": "Message"
+ "title": "Geometry",
+ "description": "The polyline of the isoline (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm))."
},
- "type": {
- "type": "string",
- "title": "Error Type"
+ "distance": {
+ "$ref": "#/components/schemas/Distance_IsochroneTimeDistance",
+ "description": "Returned when `method=distance`. The `value` is the distance in kilometers and the `text` is a human readable representation of the distance in kilometers."
}
},
"type": "object",
"required": [
- "loc",
- "msg",
- "type"
+ "origin",
+ "geometry",
+ "distance"
],
- "title": "ValidationError"
+ "title": "IsolineResponseDistance"
},
- "Datasets_features__internal__responses__HTTPErrorModel": {
+ "Distance_IsolineResponseTime": {
"properties": {
- "details": {
+ "origin": {
+ "$ref": "#/components/schemas/Distance_LatLng",
+ "description": "The origin point of the isochrone contour."
+ },
+ "geometry": {
"type": "string",
- "title": "Details"
+ "title": "Geometry",
+ "description": "The polyline of the isoline (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm))."
+ },
+ "time": {
+ "$ref": "#/components/schemas/Distance_IsochroneTimeDistance",
+ "description": "Returned by default or when `method=time`. The `value` is the time in minutes and the `text` is a human readable representation of the time in minutes."
}
},
"type": "object",
"required": [
- "details"
+ "origin",
+ "geometry",
+ "time"
],
- "title": "HTTPErrorModel"
+ "title": "IsolineResponseTime"
},
- "Distance_AuthenticationErrorResponse": {
+ "Distance_LatLng": {
"properties": {
- "detail": {
- "type": "string",
- "title": "Detail"
+ "lat": {
+ "type": "number",
+ "title": "Lat",
+ "description": "The latitude of the point in decimal degrees, range is [-90, 90]."
+ },
+ "lng": {
+ "type": "number",
+ "title": "Lng",
+ "description": "The longitude of the point in decimal degrees, range is [-180, 180]."
}
},
"type": "object",
"required": [
- "detail"
+ "lat",
+ "lng"
],
- "title": "AuthenticationErrorResponse",
- "description": "AuthenticationErrorResponse is the base authentication error model."
+ "title": "LatLng"
},
- "Distance_BaseElementResponse": {
+ "Distance_MatrixDistanceDuration": {
"properties": {
- "status": {
- "type": "string",
+ "value": {
+ "type": "integer",
+ "title": "Value"
+ },
+ "text": {
+ "type": "string",
+ "title": "Text"
+ }
+ },
+ "type": "object",
+ "required": [
+ "value",
+ "text"
+ ],
+ "title": "MatrixDistanceDuration"
+ },
+ "Distance_MatrixRequest": {
+ "properties": {
+ "mode": {
+ "type": "string",
+ "enum": [
+ "driving",
+ "walking",
+ "cycling"
+ ],
+ "title": "Mode",
+ "description": "Specifies the mode of transport to use for the calculation.",
+ "default": "driving"
+ },
+ "method": {
+ "type": "string",
+ "enum": [
+ "time",
+ "distance"
+ ],
+ "title": "Method",
+ "description": "Specifies how to compute the route between the start point and the end point:\n* `time`: fastest route \n* `distance`: shortest route",
+ "default": "time"
+ },
+ "units": {
+ "type": "string",
+ "enum": [
+ "metric",
+ "imperial"
+ ],
+ "title": "Units",
+ "description": "Specifies the unit system to use when displaying results.",
+ "default": "metric"
+ },
+ "language": {
+ "type": "string",
+ "enum": [
+ "en",
+ "fr",
+ "bg",
+ "ca",
+ "cs",
+ "da",
+ "de",
+ "el",
+ "es",
+ "et",
+ "fi",
+ "he",
+ "hi",
+ "hu",
+ "it",
+ "ja",
+ "nb",
+ "nl",
+ "pl",
+ "pt",
+ "ro",
+ "ru",
+ "sk",
+ "sl",
+ "sv",
+ "tr",
+ "uk",
+ "zh"
+ ],
+ "title": "Language",
+ "description": "The language code, indicating in the language the response should be in. \n \nIf not defined the header `Accept-Language` of the request will be checked before defaulting to `en`.",
+ "default": "en"
+ },
+ "avoid": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Avoid",
+ "description": "A list of features that you want to avoid. Valid values are `tolls`, `highways`, `ferries` or polygons coordinates whose vertex latlng are separated by a semicolon `;`. \n \nTo add multiple features, separate them with the pipe `|` character.",
+ "examples": [
+ "tolls",
+ "tolls|highways|43.3,3.4;42.1,3.5;41.4,3.6"
+ ]
+ },
+ "origins": {
+ "type": "string",
+ "title": "Origins",
+ "description": "The starting points. You can supply one or more locations, in the form of `latitude,longitude` coordinates, separated by the pipe character `|`. Ensure that no space exists between the latitude and longitude values. \n \nIn order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc::`",
+ "examples": [
+ "48.709,2.403|48.768,2.338",
+ "enc:_p~iF~ps|U_ulLnnqC_mqNvxq`@:"
+ ]
+ },
+ "destinations": {
+ "type": "string",
+ "title": "Destinations",
+ "description": "The ending points. You can supply one or more locations, in the form of `latitude,longitude` coordinates, separated by the pipe character `|`. Ensure that no space exists between the latitude and longitude values. \n \nIn order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc::`",
+ "examples": [
+ "48.709,2.403|48.768,2.338",
+ "enc:_p~iF~ps|U_ulLnnqC_mqNvxq`@:"
+ ]
+ },
+ "arrival_time": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Arrival Time",
+ "description": "Specify your desired arrival time.\n\nBy using this parameter, Distance will calculate the duration with **traffic**. Valid values are a UNIX timestamp (e.g. `1600799173` for the date: `22/09/2020 20:26:13`) or `now`. \n\nUse either `arrival_time` or `departure_time`, not both.",
+ "examples": [
+ "1600799173",
+ "now"
+ ]
+ },
+ "departure_time": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Departure Time",
+ "description": "Specify your desired departure time.\n\nBy using this parameter, Distance will calculate the duration with **traffic**. Valid values are a UNIX timestamp (e.g. `1600799173` for the date: `22/09/2020 20:26:13`) or `now`. \n\nUse either `arrival_time` or `departure_time`, not both.",
+ "examples": [
+ "1600799173",
+ "now"
+ ]
+ },
+ "elements": {
+ "type": "string",
+ "enum": [
+ "distance",
+ "duration",
+ "duration_distance"
+ ],
+ "title": "Elements",
+ "description": "Specifies element values that will be part of the API response (`distance` and/or `duration`).",
+ "default": "distance"
+ }
+ },
+ "type": "object",
+ "required": [
+ "origins",
+ "destinations"
+ ],
+ "title": "MatrixRequest"
+ },
+ "Distance_MatrixResponse": {
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "OK",
+ "INVALID_REQUEST",
+ "MAX_ELEMENTS_EXCEEDED",
+ "MAX_ROUTE_LENGTH_EXCEEDED",
+ "REQUEST_DENIED",
+ "BACKEND_ERROR",
+ "OVER_QUERY_LIMIT",
+ "ZERO_RESULTS"
+ ],
+ "title": "Status",
+ "description": "The status of the response\n* `OK`: The response contains a valid result.\n* `INVALID_REQUEST`: The request could not be processed.\n* `MAX_ELEMENTS_EXCEEDED`: The product of origins and destinations exceeds the per-query limit (fixed at 200 elts/query).\n* `MAX_ROUTE_LENGTH_EXCEEDED`: One of requested routes is too long and the matrix/route cannot be processed (The limit is 500km).\n* `REQUEST_DENIED`: The API key provided is invalid or does not allow access to this service etc..\n* `BACKEND_ERROR`: The server encountered an unexpected error.\n* `OVER_QUERY_LIMIT`: The request was denied due to the rate limit (see [Usage Limits](https://developers.woosmap.com/products/distance-api/distance-matrix-endpoint/#usage-limits)).\n* `ZERO_RESULTS`: No route could be found between the origin and destination.\n ",
+ "default": "OK"
+ },
+ "rows": {
+ "items": {
+ "$ref": "#/components/schemas/Distance_MatrixRowsResponse"
+ },
+ "type": "array",
+ "title": "Rows",
+ "description": "Contains an array of elements for each pair of origin and destination"
+ }
+ },
+ "type": "object",
+ "required": [
+ "rows"
+ ],
+ "title": "MatrixResponse",
+ "examples": [
+ {
+ "rows": [
+ {
+ "elements": [
+ {
+ "distance": {
+ "text": "10.8 km",
+ "value": 10797
+ },
+ "duration": {
+ "text": "16 mins",
+ "value": 986
+ },
+ "status": "OK"
+ },
+ {
+ "distance": {
+ "text": "10.3 km",
+ "value": 10334
+ },
+ "duration": {
+ "text": "15 mins",
+ "value": 928
+ },
+ "status": "OK"
+ }
+ ]
+ }
+ ],
+ "status": "OK"
+ }
+ ]
+ },
+ "Distance_MatrixRowsResponse": {
+ "properties": {
+ "elements": {
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Distance_DistanceResponse"
+ },
+ {
+ "$ref": "#/components/schemas/Distance_DurationResponse"
+ },
+ {
+ "$ref": "#/components/schemas/Distance_DurationDistanceResponse"
+ },
+ {
+ "$ref": "#/components/schemas/Distance_BaseElementResponse"
+ }
+ ]
+ },
+ "type": "array",
+ "title": "Elements",
+ "description": "An array of each route element."
+ }
+ },
+ "type": "object",
+ "required": [
+ "elements"
+ ],
+ "title": "MatrixRowsResponse"
+ },
+ "Distance_Polyline": {
+ "properties": {
+ "points": {
+ "type": "string",
+ "title": "Points"
+ }
+ },
+ "type": "object",
+ "required": [
+ "points"
+ ],
+ "title": "Polyline"
+ },
+ "Distance_RouteDistanceDuration": {
+ "properties": {
+ "value": {
+ "type": "integer",
+ "title": "Value"
+ },
+ "text": {
+ "type": "string",
+ "title": "Text"
+ }
+ },
+ "type": "object",
+ "required": [
+ "value",
+ "text"
+ ],
+ "title": "RouteDistanceDuration"
+ },
+ "Distance_RouteInstruction": {
+ "properties": {
+ "action": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Action",
+ "description": "The action to take for the current step (turn left, merge, straight, etc.). See [list of available actions](https://developers.woosmap.com/products/distance-api/route-endpoint/#instructions)."
+ },
+ "type": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Type"
+ },
+ "summary": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Summary",
+ "description": "Written maneuver instruction."
+ },
+ "verbal_alert": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Verbal Alert",
+ "description": "The transition alert instruction will prepare the user for the forthcoming transition."
+ },
+ "verbal_succint": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Verbal Succint",
+ "description": "Text suitable for use as a verbal alert in a navigation application."
+ },
+ "verbal_before": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Verbal Before",
+ "description": "Text suitable for use as a verbal message immediately prior to the maneuver transition."
+ },
+ "verbal_after": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Verbal After",
+ "description": "Text suitable for use as a verbal message immediately after the maneuver transition."
+ }
+ },
+ "type": "object",
+ "title": "RouteInstruction"
+ },
+ "Distance_RouteLeg": {
+ "properties": {
+ "distance": {
+ "$ref": "#/components/schemas/Distance_RouteDistanceDuration",
+ "description": "The total distance of this leg expressed in meters (value) and as text. The textual value uses the unit system specified with the `units` parameter."
+ },
+ "duration": {
+ "$ref": "#/components/schemas/Distance_RouteDistanceDuration",
+ "description": "The total duration of this leg expressed in seconds (value) and as text. The textual value uses `lang` parameter if the langauge is available."
+ },
+ "duration_without_traffic": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Distance_RouteDistanceDuration"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "start_location": {
+ "$ref": "#/components/schemas/Distance_LatLng",
+ "description": "The starting location of this leg."
+ },
+ "end_location": {
+ "$ref": "#/components/schemas/Distance_LatLng",
+ "description": "The ending location of this leg."
+ },
+ "start_waypoint": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Start Waypoint",
+ "description": "The index of the waypoint that is the starting point of this leg."
+ },
+ "end_waypoint": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "End Waypoint",
+ "description": "The index of the waypoint that is the ending point of this leg."
+ },
+ "start_address": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Start Address",
+ "description": "The address of the starting point of this leg."
+ },
+ "end_address": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "End Address",
+ "description": "The address of the ending point of this leg."
+ },
+ "steps": {
+ "anyOf": [
+ {
+ "items": {
+ "$ref": "#/components/schemas/Distance_RouteStep"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Steps",
+ "description": "List of steps steps for this leg.\nSteps are returned when `details=full`. A step is the most atomic unit of a route, containing a single step describing a specific, single instruction on the journey. The step not only describes the instruction but also contains distance and duration information relating to how this step relates to the following step.\n "
+ }
+ },
+ "type": "object",
+ "required": [
+ "distance",
+ "duration",
+ "start_location",
+ "end_location"
+ ],
+ "title": "RouteLeg"
+ },
+ "Distance_RouteOption": {
+ "properties": {
+ "overview_polyline": {
+ "$ref": "#/components/schemas/Distance_Polyline",
+ "description": "The polyline of the route (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm))."
+ },
+ "bounds": {
+ "$ref": "#/components/schemas/Distance_Bounds",
+ "description": "A rectangle in geographical coordinates from points at the southwest and northeast corners."
+ },
+ "notice": {
+ "type": "string",
+ "title": "Notice",
+ "description": "Some noticeable information about the route."
+ },
+ "legs": {
+ "items": {
+ "$ref": "#/components/schemas/Distance_RouteLeg"
+ },
+ "type": "array",
+ "title": "Legs",
+ "description": "Contains an array of sections of the route."
+ },
+ "main_route_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Main Route Name",
+ "description": "The main route name based on the longest step length to differentiate routes when alternates are returned."
+ },
+ "recommended": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Recommended",
+ "description": "Only present and set to true when the route is the recommended route."
+ }
+ },
+ "type": "object",
+ "required": [
+ "overview_polyline",
+ "bounds",
+ "notice",
+ "legs"
+ ],
+ "title": "RouteOption"
+ },
+ "Distance_RouteResponse": {
+ "properties": {
+ "status": {
+ "type": "string",
"enum": [
"OK",
- "NOT_FOUND",
- "ZERO_RESULTS",
- "ERROR"
+ "INVALID_REQUEST",
+ "MAX_ELEMENTS_EXCEEDED",
+ "MAX_ROUTE_LENGTH_EXCEEDED",
+ "REQUEST_DENIED",
+ "BACKEND_ERROR",
+ "OVER_QUERY_LIMIT",
+ "ZERO_RESULTS"
+ ],
+ "title": "Status",
+ "description": "The status of the response\n* `OK`: The response contains a valid result.\n* `INVALID_REQUEST`: The request could not be processed.\n* `MAX_ELEMENTS_EXCEEDED`: The product of origins and destinations exceeds the per-query limit (fixed at 200 elts/query).\n* `MAX_ROUTE_LENGTH_EXCEEDED`: One of requested routes is too long and the matrix/route cannot be processed (The limit is 500km).\n* `REQUEST_DENIED`: The API key provided is invalid or does not allow access to this service etc..\n* `BACKEND_ERROR`: The server encountered an unexpected error.\n* `OVER_QUERY_LIMIT`: The request was denied due to the rate limit (see [Usage Limits](https://developers.woosmap.com/products/distance-api/distance-matrix-endpoint/#usage-limits)).\n* `ZERO_RESULTS`: No route could be found between the origin and destination.\n ",
+ "default": "OK"
+ },
+ "routes": {
+ "items": {
+ "$ref": "#/components/schemas/Distance_RouteOption"
+ },
+ "type": "array",
+ "title": "Routes",
+ "description": "Contains an array of route options if `alternatives=true` else a single route."
+ }
+ },
+ "type": "object",
+ "required": [
+ "routes"
+ ],
+ "title": "RouteResponse",
+ "examples": [
+ {
+ "routes": [
+ {
+ "bounds": {
+ "northeast": {
+ "lat": 49.315678,
+ "lng": 4.15292
+ },
+ "southwest": {
+ "lat": 49.31073,
+ "lng": 4.145162
+ }
+ },
+ "legs": [
+ {
+ "distance": {
+ "text": "1 km",
+ "value": 1038
+ },
+ "duration": {
+ "text": "1 min",
+ "value": 75
+ },
+ "end_address": "D 30",
+ "end_location": {
+ "lat": 49.31344,
+ "lng": 4.15293
+ },
+ "end_waypoint": 1,
+ "start_address": "D 151",
+ "start_location": {
+ "lat": 49.31067,
+ "lng": 4.14525
+ },
+ "start_waypoint": 0,
+ "steps": [
+ {
+ "distance": "676 m",
+ "duration": "1 min",
+ "end_location": {
+ "lat": 49.315679,
+ "lng": 4.149621
+ },
+ "instructions": {
+ "action": 2,
+ "summary": "Drive northeast on D 151.",
+ "verbal_after": "Continue for 700 meters.",
+ "verbal_before": "Drive northeast on D 151. Then Enter the roundabout and take the 2nd exit onto D 30.",
+ "verbal_succint": "Drive northeast. Then Enter the roundabout and take the 2nd exit onto D 30."
+ },
+ "polyline": "a_~kHgrhXu@yAe@y@c@q@e@q@c@o@e@m@y@eAa@g@a@c@Y[UUQQYUQOSOQKSKOKQISIWKSEUEMCQAa@CeA@[E}@EUAOEOGKKIOM[I]Ea@A[?Q",
+ "start_location": {
+ "lat": 49.31073,
+ "lng": 4.145163
+ },
+ "travel_mode": "DRIVING"
+ },
+ {
+ "distance": "22 m",
+ "duration": "1 min",
+ "end_location": {
+ "lat": 49.31563,
+ "lng": 4.149905
+ },
+ "instructions": {
+ "action": 26,
+ "summary": "Enter the roundabout and take the 2nd exit onto D 30.",
+ "verbal_alert": "Enter the roundabout and take the 2nd exit onto D 30.",
+ "verbal_before": "Enter the roundabout and take the 2nd exit onto D 30.",
+ "verbal_succint": "Enter the roundabout and take the 2nd exit."
+ },
+ "polyline": "}}~kHcniXBIBU?W",
+ "start_location": {
+ "lat": 49.315679,
+ "lng": 4.149621
+ },
+ "travel_mode": "DRIVING"
+ },
+ {
+ "distance": "198 m",
+ "duration": "1 min",
+ "end_location": {
+ "lat": 49.314292,
+ "lng": 4.151623
+ },
+ "instructions": {
+ "action": 27,
+ "summary": "Exit the roundabout onto D 30.",
+ "verbal_after": "Continue for 200 meters.",
+ "verbal_before": "Exit the roundabout onto D 30.",
+ "verbal_succint": "Exit the roundabout."
+ },
+ "polyline": "u}~kH{oiXFWDOLUP[P]j@y@^g@`@i@NUNONMJKJIFELC",
+ "start_location": {
+ "lat": 49.31563,
+ "lng": 4.149905
+ },
+ "travel_mode": "DRIVING"
+ },
+ {
+ "distance": "46 m",
+ "duration": "1 min",
+ "end_location": {
+ "lat": 49.314041,
+ "lng": 4.151976
+ },
+ "instructions": {
+ "action": 26,
+ "summary": "Enter the roundabout and take the 1st exit onto D 30.",
+ "verbal_alert": "Enter the roundabout and take the 1st exit onto D 30.",
+ "verbal_before": "Enter the roundabout and take the 1st exit onto D 30.",
+ "verbal_succint": "Enter the roundabout and take the 1st exit."
+ },
+ "polyline": "iu~kHsziXJBJAHGFIDMBSAS",
+ "start_location": {
+ "lat": 49.314292,
+ "lng": 4.151623
+ },
+ "travel_mode": "DRIVING"
+ },
+ {
+ "distance": "96 m",
+ "duration": "1 min",
+ "end_location": {
+ "lat": 49.313434,
+ "lng": 4.152921
+ },
+ "instructions": {
+ "action": 27,
+ "summary": "Exit the roundabout onto D 30.",
+ "verbal_after": "Continue for 100 meters.",
+ "verbal_before": "Exit the roundabout onto D 30. Then, in 100 meters, You will arrive at your destination.",
+ "verbal_succint": "Exit the roundabout. Then, in 100 meters, You will arrive at your destination."
+ },
+ "polyline": "ws~kHy|iXBKDILURa@LWt@eAHQ",
+ "start_location": {
+ "lat": 49.314041,
+ "lng": 4.151976
+ },
+ "travel_mode": "DRIVING"
+ },
+ {
+ "distance": "1 m",
+ "duration": "1 min",
+ "end_location": {
+ "lat": 49.313434,
+ "lng": 4.152921
+ },
+ "instructions": {
+ "action": 4,
+ "summary": "You have arrived at your destination.",
+ "verbal_alert": "You will arrive at your destination.",
+ "verbal_before": "You have arrived at your destination."
+ },
+ "polyline": "}o~kHwbjX",
+ "start_location": {
+ "lat": 49.313434,
+ "lng": 4.152921
+ },
+ "travel_mode": "DRIVING"
+ }
+ ]
+ }
+ ],
+ "notice": "",
+ "overview_polyline": {
+ "points": "a_~kHgrhXu@yAe@y@c@q@e@q@c@o@e@m@y@eAa@g@a@c@Y[UUQQYUQOSOQKSKOKQISIWKSEUEMCQAa@CeA@[E}@EUAOEOGKKIOM[I]Ea@A[?QBIBU?WFWDOLUP[P]j@y@^g@`@i@NUNONMJKJIFELCJBJAHGFIDMBSASBKDILURa@LWt@eAHQ"
+ }
+ }
],
- "title": "Status",
- "description": "The status of each element.\n* `OK` The response contains a valid result.\n* `NOT_FOUND` The origin and/or destination of this pairing could not be matched to the network.\n* `ZERO_RESULTS` No route could be found between the origin and destination."
- }
- },
- "type": "object",
- "required": [
- "status"
- ],
- "title": "BaseElementResponse"
- },
- "Distance_Bounds": {
- "properties": {
- "northeast": {
- "$ref": "#/components/schemas/Distance_LatLng"
- },
- "southwest": {
- "$ref": "#/components/schemas/Distance_LatLng"
+ "status": "OK"
}
- },
- "type": "object",
- "required": [
- "northeast",
- "southwest"
- ],
- "title": "Bounds"
+ ]
},
- "Distance_DistanceResponse": {
+ "Distance_RouteStep": {
"properties": {
- "status": {
- "type": "string",
- "enum": [
- "OK",
- "NOT_FOUND",
- "ZERO_RESULTS",
- "ERROR"
- ],
- "title": "Status",
- "description": "The status of each element.\n* `OK` The response contains a valid result.\n* `NOT_FOUND` The origin and/or destination of this pairing could not be matched to the network.\n* `ZERO_RESULTS` No route could be found between the origin and destination."
- },
"distance": {
- "$ref": "#/components/schemas/Distance_MatrixDistanceDuration",
- "description": "Returned when `elements=distance`. The `value` is the distance in meters and the `text` is a human readable representation of the distance."
- }
- },
- "type": "object",
- "required": [
- "status",
- "distance"
- ],
- "title": "DistanceResponse"
- },
- "Distance_DurationDistanceResponse": {
- "properties": {
- "status": {
"type": "string",
- "enum": [
- "OK",
- "NOT_FOUND",
- "ZERO_RESULTS",
- "ERROR"
- ],
- "title": "Status",
- "description": "The status of each element.\n* `OK` The response contains a valid result.\n* `NOT_FOUND` The origin and/or destination of this pairing could not be matched to the network.\n* `ZERO_RESULTS` No route could be found between the origin and destination."
- },
- "distance": {
- "$ref": "#/components/schemas/Distance_MatrixDistanceDuration",
- "description": "Returned when `elements=duration_distance`. The `value` is the distance in meters and the `text` is a human readable representation of the distance."
+ "title": "Distance",
+ "description": "The distance as text covered by this step until the next step."
},
"duration": {
- "$ref": "#/components/schemas/Distance_MatrixDistanceDuration",
- "description": "Returned when `elements=duration_distance`. The `value` is the duration in seconds and the `text` is a human readable representation of the duration."
- }
- },
- "type": "object",
- "required": [
- "status",
- "distance",
- "duration"
- ],
- "title": "DurationDistanceResponse"
- },
- "Distance_DurationResponse": {
- "properties": {
- "status": {
"type": "string",
- "enum": [
- "OK",
- "NOT_FOUND",
- "ZERO_RESULTS",
- "ERROR"
- ],
- "title": "Status",
- "description": "The status of each element.\n* `OK` The response contains a valid result.\n* `NOT_FOUND` The origin and/or destination of this pairing could not be matched to the network.\n* `ZERO_RESULTS` No route could be found between the origin and destination."
+ "title": "Duration",
+ "description": "The typical time as text required until the next step."
},
- "duration": {
- "$ref": "#/components/schemas/Distance_MatrixDistanceDuration",
- "description": "Returned when `elements=duration`. The `value` is the duration in seconds and the `text` is a human readable representation of the duration."
- }
- },
- "type": "object",
- "required": [
- "status",
- "duration"
- ],
- "title": "DurationResponse"
- },
- "Distance_HTTPErrorModel": {
- "properties": {
- "details": {
- "type": "string",
- "title": "Details"
- }
- },
- "type": "object",
- "required": [
- "details"
- ],
- "title": "HTTPErrorModel"
- },
- "Distance_HTTPValidationError": {
- "properties": {
- "detail": {
- "items": {
- "$ref": "#/components/schemas/Distance_ValidationError"
- },
- "type": "array",
- "title": "Detail"
- }
- },
- "type": "object",
- "title": "HTTPValidationError"
- },
- "Distance_IsochroneRequest": {
- "properties": {
- "mode": {
+ "polyline": {
"type": "string",
- "enum": [
- "driving",
- "walking",
- "cycling"
- ],
- "title": "Mode",
- "description": "Specifies the mode of transport to use for the calculation.",
- "default": "driving"
+ "title": "Polyline",
+ "description": "The polyline of the step (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm))."
},
- "method": {
- "type": "string",
- "enum": [
- "time",
- "distance"
- ],
- "title": "Method",
- "description": "Specifies how to compute the route between the start point and the end point:\n* `time`: fastest route \n* `distance`: shortest route",
- "default": "time"
+ "start_location": {
+ "$ref": "#/components/schemas/Distance_LatLng",
+ "description": "The starting location of this step."
},
- "units": {
- "type": "string",
- "enum": [
- "metric",
- "imperial"
- ],
- "title": "Units",
- "description": "Specifies the unit system to use when displaying results.",
- "default": "metric"
+ "end_location": {
+ "$ref": "#/components/schemas/Distance_LatLng",
+ "description": "The ending location of this step."
},
- "language": {
+ "travel_mode": {
"type": "string",
- "enum": [
- "en",
- "fr",
- "bg",
- "ca",
- "cs",
- "da",
- "de",
- "el",
- "es",
- "et",
- "fi",
- "he",
- "hi",
- "hu",
- "it",
- "ja",
- "nb",
- "nl",
- "pl",
- "pt",
- "ro",
- "ru",
- "sk",
- "sl",
- "sv",
- "tr",
- "uk",
- "zh"
- ],
- "title": "Language",
- "description": "The language code, indicating in the language the response should be in. \n \nIf not defined the header `Accept-Language` of the request will be checked before defaulting to `en`.",
- "default": "en"
+ "title": "Travel Mode",
+ "description": "The travel mode of this step."
},
- "avoid": {
+ "instructions": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/Distance_RouteInstruction"
},
{
"type": "null"
}
],
- "title": "Avoid",
- "description": "A list of features that you want to avoid. Valid values are `tolls`, `highways`, `ferries` or polygons coordinates whose vertex latlng are separated by a semicolon `;`. \n \nTo add multiple features, separate them with the pipe `|` character.",
- "examples": [
- "tolls",
- "tolls|highways|43.3,3.4;42.1,3.5;41.4,3.6"
- ]
+ "description": "The maneuver instructions for this step."
+ }
+ },
+ "type": "object",
+ "required": [
+ "distance",
+ "duration",
+ "polyline",
+ "start_location",
+ "end_location",
+ "travel_mode"
+ ],
+ "title": "RouteStep"
+ },
+ "Distance_TollLeg": {
+ "properties": {
+ "distance": {
+ "$ref": "#/components/schemas/Distance_RouteDistanceDuration"
},
- "origin": {
- "type": "string",
- "title": "Origin",
- "description": "The starting point. It should be supplied in the form of `latitude,longitude` coordinates. Ensure that no space exists between the latitude and longitude values.",
- "examples": [
- "48.709,2.403"
- ]
+ "duration": {
+ "$ref": "#/components/schemas/Distance_RouteDistanceDuration"
},
- "value": {
- "type": "number",
- "maximum": 120,
- "minimum": 0,
- "title": "Value",
- "description": "The value to use for the isochrone contour. \n\nIf you specified `time` for `method` this value should be number of minutes\n\nIf you specified `distance` for `method` this value should be distance in kilometers."
+ "start_location": {
+ "$ref": "#/components/schemas/Distance_LatLng"
+ },
+ "end_location": {
+ "$ref": "#/components/schemas/Distance_LatLng"
+ },
+ "tolls": {
+ "items": {
+ "$ref": "#/components/schemas/Distance_TollStep"
+ },
+ "type": "array",
+ "title": "Tolls"
+ },
+ "tollSystems": {
+ "items": {
+ "$ref": "#/components/schemas/Distance_TollSystem"
+ },
+ "type": "array",
+ "title": "Tollsystems"
}
},
"type": "object",
"required": [
- "origin",
- "value"
+ "distance",
+ "duration",
+ "start_location",
+ "end_location",
+ "tolls",
+ "tollSystems"
],
- "title": "IsochroneRequest"
+ "title": "TollLeg"
},
- "Distance_IsochroneResponse": {
+ "Distance_TollStep": {
+ "properties": {},
+ "additionalProperties": true,
+ "type": "object",
+ "title": "TollStep"
+ },
+ "Distance_TollSystem": {
+ "properties": {},
+ "additionalProperties": true,
+ "type": "object",
+ "title": "TollSystem"
+ },
+ "Distance_TollsResponse": {
"properties": {
"status": {
"type": "string",
- "enum": [
- "OK",
- "INVALID_REQUEST",
- "MAX_ELEMENTS_EXCEEDED",
- "MAX_ROUTE_LENGTH_EXCEEDED",
- "REQUEST_DENIED",
- "BACKEND_ERROR",
- "OVER_QUERY_LIMIT",
- "ZERO_RESULTS"
- ],
- "title": "Status",
- "description": "The status of the response\n* `OK`: The response contains a valid result.\n* `INVALID_REQUEST`: The request could not be processed.\n* `MAX_ELEMENTS_EXCEEDED`: The product of origins and destinations exceeds the per-query limit (fixed at 200 elts/query).\n* `MAX_ROUTE_LENGTH_EXCEEDED`: One of requested routes is too long and the matrix/route cannot be processed (The limit is 500km).\n* `REQUEST_DENIED`: The API key provided is invalid or does not allow access to this service etc..\n* `BACKEND_ERROR`: The server encountered an unexpected error.\n* `OVER_QUERY_LIMIT`: The request was denied due to the rate limit (see [Usage Limits](https://developers.woosmap.com/products/distance-api/distance-matrix-endpoint/#usage-limits)).\n* `ZERO_RESULTS`: No route could be found between the origin and destination.\n ",
- "default": "OK"
+ "title": "Status"
},
- "isoline": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/Distance_IsolineResponseTime"
- },
- {
- "$ref": "#/components/schemas/Distance_IsolineResponseDistance"
- }
- ],
- "title": "Isoline"
+ "routes": {
+ "items": {
+ "$ref": "#/components/schemas/Distance_TollsRoute"
+ },
+ "type": "array",
+ "title": "Routes"
}
},
"type": "object",
"required": [
- "isoline"
+ "status",
+ "routes"
],
- "title": "IsochroneResponse",
+ "title": "TollsResponse",
"examples": [
{
- "isoline": {
- "distance": {
- "text": "1 km",
- "value": 1
- },
- "geometry": "s|ihHouuMZ`GdClCsA~QhCnQmBhEpCfF|HxGpBtFfEnBnHqJpH}AF_EeCcB@sBnEiEYiGmVyFaG{G[eFoCw@gAiIkDYg@_DwA@",
- "origin": {
- "lat": 48.709,
- "lng": 2.403
+ "routes": [
+ {
+ "bounds": {
+ "northeast": {
+ "lat": 45.72083,
+ "lng": 4.89669
+ },
+ "southwest": {
+ "lat": 43.7022,
+ "lng": 4.11696
+ }
+ },
+ "legs": [
+ {
+ "distance": {
+ "text": "272 km",
+ "value": 272038
+ },
+ "duration": {
+ "text": "2 hours 27 mins",
+ "value": 8793
+ },
+ "end_location": {
+ "lat": 45.7196995,
+ "lng": 4.848819
+ },
+ "start_location": {
+ "lat": 43.7037977,
+ "lng": 4.121733
+ },
+ "tollSystems": [
+ {
+ "id": 7607,
+ "name": "ASF"
+ }
+ ],
+ "tolls": [
+ {
+ "countryCode": "FRA",
+ "fares": [
+ {
+ "id": "50d47ca7-59a3-4efd-b009-7a374aec7b21",
+ "name": "ASF",
+ "paymentMethods": [
+ "cash",
+ "bankCard",
+ "creditCard",
+ "transponder",
+ "travelCard"
+ ],
+ "price": {
+ "currency": "EUR",
+ "type": "value",
+ "value": 28.7
+ },
+ "reason": "toll",
+ "transponders": [
+ {
+ "system": "BipandGo"
+ },
+ {
+ "system": "BipandGo"
+ },
+ {
+ "system": "BipandGo IDVROOM carpoorling"
+ },
+ {
+ "system": "Cito30"
+ },
+ {
+ "system": "Easytrip pass"
+ },
+ {
+ "system": "Liane 30"
+ },
+ {
+ "system": "Liber-t"
+ },
+ {
+ "system": "Liber-t mobilitis"
+ },
+ {
+ "system": "Pass Pont-Pont"
+ },
+ {
+ "system": "Progressivi'T Maurienne"
+ },
+ {
+ "system": "TopEurop"
+ },
+ {
+ "system": "Tunnel Pass+"
+ },
+ {
+ "system": "Ulys"
+ },
+ {
+ "system": "Ulys Europe"
+ },
+ {
+ "system": "VIA-T"
+ },
+ {
+ "system": "Viaduc-t 30"
+ }
+ ]
+ }
+ ],
+ "tollCollectionLocations": [
+ {
+ "location": {
+ "lat": 43.70283,
+ "lng": 4.11987
+ },
+ "name": "MONTPELLIER (M.EST)"
+ },
+ {
+ "location": {
+ "lat": 45.4761,
+ "lng": 4.83378
+ },
+ "name": "VIENNE"
+ }
+ ],
+ "tollSystem": "ASF",
+ "tollSystemRef": 0,
+ "tollSystems": [
+ 0
+ ]
+ }
+ ]
+ }
+ ],
+ "overview_polyline": {
+ "points": "u{viGy_dXDAFGDEDIBMBO@U?QAQAIGWEIIKKGIAQ?I?ODGFKLEHETCZ@Z@JBNHLDDJHJDF@L@J?LBHBJBNLPVXh@Pd@|@dDNd@Jb@HTV~@t@lCD\\DRFXDVDVBV@T?VARAPEZGTKRKNIJIFKDIBI@I@M?MCQISOQOSQ]_@]WqBqCeAwAe@o@Ya@s@cAoBkCgA}AkBoCeCyDw@sA}CkFoA{BeBaD[m@iAuByAmCk@eA_@s@{@aBk@gAmA_C_AkBkC_FiAwBe@{@}HiO_EyHsB_Ea@w@c@y@iBkDiAwBsFkKa@y@_@u@c@{@a@w@]q@Yk@[o@_@u@_@w@a@{@[q@]w@]y@_@}@]{@[y@[{@[}@[_AY{@Y}@Y_AUw@W}@W}@U_AQu@Qu@Qw@S_AOq@Ow@UkAQaAOw@QgAIc@U}AMaAOiAMeAMgAKaAGm@I}@IaAIcAIgAG}@Eq@GiAGoAEcACo@Cu@EwAEcBCaBCkCAmBAkBCaIAuIAiCAeBAeAA}@AcAC_BC}AEkBE_BEyAEsAGaBG{AGsAGoAGmAGkAGgAIuAGcAG_AG}@IiAIgAIaAKmAMsAMsAk@mGK}@i@yEKu@_@uCAKWgBU}ASoAUwAWaBgAkGUsAWuAWoA]wA[kAMe@Mc@Qm@Ss@Oc@Uq@Si@Oe@Oa@Qc@Qc@O]eAaCoAcCmAuBc@s@}A}BsAcB}@eAu@w@i@i@q@m@kB}AUQk@a@{@m@q@a@u@c@aAg@u@]s@[w@[}Bu@aA[oBi@sBq@mDeA_Cy@gCgA_Aa@iAk@cAi@aBaAmAw@eAs@c@Ws@i@sBcByAsAUUsAoAwB_CiBwBqCwDoAiB_A{Am@eAa@q@gAqBoBgEqAyCmA_DiAcDgAeDW}@K]EOc@}AGSe@qBOk@Qw@]aBQ}@Ow@Oy@Ic@Ii@Km@Ig@U{AM}@Iq@Gg@Is@MmAKgAI_AIaAEi@Em@Eo@IuAGmAIcBEgAEyAEaBC_BA_B?q@?uA?cA@yA?i@@oAB_BFoBBu@Bs@D_ADw@H{AFcAHqAF_ADo@Fu@Di@Fy@HkAJwATiDTsCb@kGTaDJwA\\uE^kFTaD`@uFh@uH\\aFX_Ef@cHZqENkCHkBBy@@_@@q@BqB@_B?oAA{ACuACcAG{ACk@Ew@Ci@IoAIaAMkAKaAQuAQqA]uBOy@G[Os@Os@Oo@a@}AWaAQo@e@}Aa@mAi@wAq@aBg@iAm@qAWe@}@}AMUQYw@iAgBcC{@eASUq@s@mAkA{@y@eDwCwCkC][i@e@_BsAw@q@w@q@mC_CqBgBqBeBgB}AkAeA_CsBwC_CqBuAaBiAsAw@kAs@mBcAoAq@}BqAeBkAwBcByAqAq@o@a@e@{@aAm@u@o@y@q@aAc@q@k@_Am@eAk@gAYk@g@eA_@{@]y@Ws@Uo@[cAYaAOi@Qo@W_ASo@Qo@K][gA[iAc@}A_@oA[cA[aAc@qAm@gBi@yAe@qAe@kAe@eAk@qAi@iAm@mAg@cA{@_Bc@s@_@o@q@iAk@y@u@kA{@mAu@cAw@cAy@cA]a@SUs@w@aAcAi@i@o@k@a@c@w@s@mAgAy@q@e@a@oC_CwDcDaBwAu@s@cAeAe@e@oAyA{AeBq@{@q@{@q@}@g@s@eA}AYc@k@_AcAcBy@yAk@cAo@iA_CeEm@eAk@_AgAcBWc@W_@]e@a@i@a@i@_@e@c@i@e@k@c@e@e@i@k@o@e@g@iAkA_GiG_DcDwD}DmBmBsAuAs@o@o@m@aByAm@i@cA}@s@k@o@i@mByAgDeCoBwAqBwAYSuAeAm@i@_@_@i@g@c@a@YY{@_AiAsAe@o@[c@w@kA}@{Au@uAw@_Bq@}Aq@gB]_Aa@oA_@sAi@qBm@sCUkAKk@Mw@OaAUiB[mCMiASsBEa@g@{EEe@K_AGk@y@uHYeCGe@cAiIYyB[yBMw@OaAYkBUuAYcB[iBa@yBWuAa@sBuC_Na@iBi@{BmBaI_AyDqBcIkAaF}@_EuAmGo@sCo@mDo@kDG]Ie@E]]cBSkAWwAEW[yBM{@EUc@qCIa@e@mCi@uDm@qDk@qDIe@c@gCk@mD[iBKu@G[c@gCIi@Ig@c@_Co@mDSkASeA[cBSgAq@eDCMm@aDmA_Gu@iDs@cDw@oDQw@GY]uAw@eDy@iDyAwFe@kBqAwEw@sCy@sCw@oCm@qBUu@{@qC}@uCgAiDeAcDgAcDmAiDkAcDy@}Bs@kBc@kAc@iAm@}Ak@}As@iBi@qAk@wA[u@_@{@Ui@eAkCeAcC_CsFaFeL}CeHmAqC}@qBeAaCcA}BkAoCmAsCoAuCwAiDu@iB}A{DmA{CeAqCgAsCkAaDc@kASk@Sk@cAuCsB}FcCgHkDgKaByEWu@Ws@Uo@ISIUM[Oa@[w@a@aAi@mAi@kAo@sAs@uAi@_Au@sAq@gAw@iAiAaBe@m@g@o@m@s@e@k@k@m@aAaAu@u@o@k@q@o@e@a@a@]e@_@c@]o@e@WQ]UYQw@e@u@a@q@a@g@WYOi@YoAm@oAq@WMUK[MYM]OSIKEMGIEECIEICMI]QcAe@s@[sDeBq@[s@]k@Yk@[k@[o@]m@a@c@Yi@_@m@c@g@_@{@q@w@o@_Aw@}@w@oBeBwCiCwAoA[[mC_CcB{A{AsAgB_B_Ay@WSkBcBa@]_BuAsEcEw@o@{@y@u@q@gBaB_@]oAiAqBcBgB{AmBeBmBcBkAgAs@m@OM_@[k@g@cA}@oBeBkBcBaByAyBoBcA}@yAsAg@e@w@u@i@g@s@s@aAaAg@i@g@i@k@m@g@m@e@k@a@g@e@m@k@u@m@w@m@w@k@{@i@w@i@y@e@s@e@w@e@w@c@w@g@}@a@u@a@w@a@u@_@w@[o@_@y@Wk@[s@Ys@Ys@[w@Wq@Yu@a@gAgA{CmAqDoA_EaA{CkAwDmAyDeAcDq@uBY_AcBkFy@iCu@aCs@_Ce@wAw@gC]eAm@kBi@gBwAwEi@iB]oAu@uCq@qC[yA[{AWsAYcBa@}CYuBUgBW_CUaCOmBO{BO{CSaFK}DEkBEqBIyDGgEGiCMeEKqCKcCI}AIqAGy@Ei@Ei@Go@I_AKmAMwAKmAO{AKcAOsAOoAM}@K}@K{@OiAKu@QqA_@mCe@_Di@kDSgA]oBUsAUkAWsAWsA]cB_@gB_@eBm@oC_@cBaA{Dy@cD_AmDgAyDaAeDcAcDoAyDeA{CoAmDgAuCmAcDsA_Dy@mBo@yAmAmC{AcDg@eAYm@wAsCg@aAm@iAa@u@g@}@_@o@_@q@c@u@e@w@q@eAy@sAw@oAy@oA_AyAyAyBeBiCeBiCiBsCYc@Yc@c@s@Ua@i@_AwAkCe@aAcAuBkAqCi@sAe@sAu@yBe@yAs@cC[iAc@eB{@qDg@aCWqAm@iDKm@QeAQkAIk@UaBa@gD]wD]gDWcDK{AEk@OsBIsAG_Ai@}IIuAIaBQuC[{E_@cH]eGGoAU{DSuDGaAWiEOaCGmAOsCWmEa@iHIuAEs@e@wHQgC_@iFWcD_@sEUyBKaAIu@Is@Is@MaAMaAOeAYkBWaBUuAW{AQaAOw@UkA]gBEQOs@Ke@{@oDkAsEiA_Eu@cCs@uBWu@]aAmAsD{AaEuAiDk@{ASg@Yk@kDkHkCkFq@mAwAgCcBuCkAmBQUmB{CsB}CeEaGaHwJ{@mAmAcBqB{Cs@cA_A}AoA{BkBgDoA}BuAcCy@{AcEsHk@eAq@mA[k@q@mAmCaFgB_DiAuByAoCcB{CoA}B_@s@OWk@aAc@y@s@oAkAwBuAgC_AcBkBeDmCqE}A_Cq@aAqBqCuBkCuBcC{BcCaAeA}BcCa@c@c@e@s@w@Y[_AeAiBaCe@k@c@o@_@i@g@u@_@k@e@s@Wc@_@o@_@q@]o@_@s@a@w@]q@Yk@We@Ui@k@mA[q@i@iA}AoD}BcFIQ_AsBs@{A_@w@i@eAyAoCw@wAq@mA}AsCaAgBq@oAqAaCsAcCgAqByAkCMUg@y@cAiB_A_BO[{@}AiAqBs@mAYe@sAuBoAcByAeBk@m@iBiB_Aw@uAcAeBeA{BoAu@c@s@_@_Ag@mAm@e@Ws@_@{Ay@{A{@i@_@y@i@qA}@y@o@q@g@k@e@q@k@o@k@oCiCmAmAeAgAs@s@iBqBo@q@iBwBs@y@w@aAo@w@w@aAu@aAs@_As@_As@_AiBgCw@kA}@sAc@q@q@eAm@aAo@eAm@aAk@_Ao@iAm@eAa@s@_@q@We@_@o@u@yAmA}BuAgCuAoCQ_@[k@g@aAg@aAm@oAe@}@q@mAYi@y@}A}@aBa@s@m@aAi@}@cAaBa@u@mAmBaBgCyA}B_@i@Ya@e@s@q@aAm@y@s@cA{AuBqBsCgAaBm@}@a@m@c@q@}AgCYc@aAeBeBcDg@aAq@uAi@kAiAgCw@iBi@qAg@qAi@uAmAaDi@uAsAuDe@qAoAcDm@wAi@uAg@mAyAcD_AqB[q@[o@a@}@]s@[o@o@qAy@cB{@iBc@_Aa@}@_@y@e@eAc@eAo@}A]w@Ys@]_AcAmCi@yAa@eAg@{A_@gAc@uAe@wAi@gBc@wAkBoGaBwFoAeEgAmDiAmDw@{B{@aCm@aBe@mAiAuCyAmDw@gBaAyB{CsGq@uA}AyCq@sA_ByCqA_CqBmDgAiBqAuBuBeDmAkBkBuC_AsAu@eA]i@m@y@qAeBw@eA{@kAm@{@w@gAq@_A_B_CiAeBk@}@_BkCm@eAm@gA}@eB_@w@Wi@kAyB{@gBc@aAmAuCk@wAu@kBeAmCo@_BaAcCm@{Aw@mBm@yA]w@Ue@k@oA_AkBg@eA}AqCgB}CgCaEs@eAcBaCs@}@qCqDkByBeDsDkAoAiCsCmDwDsCkDmBgCi@s@yAuBeBoCw@mA{BsDg@y@g@_Au@qA{@_BgAuBk@gAYi@cAyB_AuBy@wB}@mCq@_CWeAg@}BUkAO{@[oBQqAMy@[eCSaBUaBi@oDO{@Q}@SaAe@yBi@qBc@sAy@{Bq@eBe@eAsAmCc@w@e@w@aBgCmAaBoCwDwAeBu@aAcB_CU[m@{@e@o@gAaBgDmFiAgBg@}@}@}Ai@aAcAkBiAyBoB}D}B}E}AoDaA_Ca@eAoAcDsAoDc@mAg@uAqBeGiAwDe@{Aa@uAiA}D}@cDa@{Ae@cBy@{CeAwDc@{Aa@qAgAcDi@yAe@oAk@sAg@gAm@qAi@aAs@qAo@cAu@eAs@aAyAoBoAwAqBqBaA{@w@m@aAs@QMm@a@}@k@aAi@aAg@cAe@cAa@cA[gA[gAWcASgAQkAOcAIgAEmAEeA?gADa@?e@BmAHgALcAHiCZkBRSBgBPg@D_@Bi@BU@kAD_@@kAB}@CaAEeAK{@KiASmAYk@SMEw@W]Me@QaAc@c@Qe@Wy@_@i@YoAo@}BkAgBw@}Aq@o@SmAWcAUcAO{AMw@Iu@C{A?m@?kAD_AFcALy@HeAR{@TgAZeCx@cAb@s@VkAf@u@Z_A`@gA^eA\\kAZy@TcARkAPmANw@FmADeA@gA?}@CcAGiAIqAQ{@OcAUiCs@aC}@m@U{@]cBq@o@WsAm@iGgCsDyAsB}@WKi@S{@a@}CqAcCeAeCeAmBy@u@[wAs@gCoAuBeA_CsAqD_CeCeB}BgB_CmBeB_BUUMMwAqAWWQQSQSWa@e@W[cAiA]_@Y]e@i@_@g@[]_AoA}AqBoAcByAmB_CcDsBqC{BwC_BqBa@e@_@e@UY{BiCwBaCw@y@_@a@k@g@sBgBuAgAs@i@y@k@o@c@yA_A}BoAiAi@aBw@kAe@kAc@qAc@u@UQGy@ScAYsAYu@Qy@Om@Ky@My@MsAQqC]cAMcAIkBQy@Iw@IiAGeAIs@CgAIgAGs@EuAG}@Eo@?q@?m@?aA?s@?sABm@@aAFo@Dy@F_AHu@Hm@HcAN_BXkATiAVkAZ}@RmAb@y@PqBd@m@Ns@NaARo@LYBYDc@Fa@Di@FWDc@@y@Bw@@u@@}@?_AA{@Ei@Eo@EKCq@Ii@Io@Kk@Mi@M_@Kc@Mk@Q_@My@[mAg@cAc@w@_@q@[k@Yg@WaAg@wAs@mB_AmB_AoBy@q@WcC_AcA]y@Ww@U{@UwA]eAUu@Oe@Ig@Ik@G}@M_AKk@Ec@CwAE_A?{@Bi@Bi@Fk@Ju@Ps@Rk@Ri@Vo@ZOJ]Pu@j@]Tk@f@e@f@e@l@a@h@gA~Aa@p@e@|@_@r@qAfC_@v@k@nAg@hAk@nAc@`AcBhDg@dAq@rAcAjBs@hAW`@U\\OTMRKPSZo@bA}@fAg@j@_@b@yAxAYXo@j@k@d@s@l@a@Zg@^s@f@}@l@cBbA{@f@gBdAwAx@w@b@qAr@yBnAaB`AkBfAiBfAs@`@c@VcAh@k@X}@`@_A`@q@X_A\\wAj@sAn@{@Zm@VIBsBx@yBz@o@TgBp@a@NcBf@c@TcBr@eDrAcA\\mBr@aE~AmBt@kAb@w@ZeA^aA^iBp@cC~@uBx@_A^mAh@aBv@q@^cAl@mBlAgAp@g@\\e@\\eAt@qBnAmBpAmBlAmBpAmBnA}@l@k@`@cBdAsBtAw@f@s@d@kBnA{@h@{DhCeFfDeAp@g@ZSLc@XcC`BsE|CuBxA{DhC[TcBfAiD|BkBlAcC~AsBvAeIjF{E~C}@l@gBjAiBlAiAv@{FtDiBpA{CzByBdBoB~AgA`A_DtCg@f@cB`BoAnAiBnBaBjBoB`CoA~AeArA{@hAw@fAu@dA}@pAkAfBqApBgAhBw@nAu@pAm@dAaCnEIN}A|C}@jBeA~B{AhDuElLqBjFk@zAeApCaAfCo@~A{@rBqArCy@bBcApBq@nAeAdBcA|Aa@h@iAzAmAvAeAfAkAdAaAx@eAv@q@`@_Ah@mAn@gAf@{@\\_A\\y@Vq@Pq@N}@PgAPgALaAHoAHiAB_B@kC?kCEmEGkA@_ADyADwBNkAL_ANoATe@Jq@N{@Ro@P]JaAZoAf@kBx@cAh@w@b@sAx@}@l@yAdAwAhAmAfAeC`CmAnAaAbAiBrB}AfBcJzKuCfDsD|DkBhBiAdA{@r@uAhAaBnAuAbAiBnAiBhAoAr@}Ax@uCtAgD|AmJdEqCjAWJ}Ap@oAf@{Aj@}@Z{Ad@gAX_ARsAVsATeBNiAJiADc@@qADcA?qBEq@CyAIqBOuBSyDc@yI}@iBSiHu@eBUgAQuAYeBa@wBm@sBs@eAa@uAq@kBcAmAu@eEmCaGyDkTwNoH{E_C}AoEuCwCoB_@W_C}AaDwB}E_DyDiCgMkIqRgM_KyGsZkSsE_DeCgBsFcEcG_F{FiFyBuBaD_DkBkBeAeA{@}@{@}@eAgAcBcBiBoBkBmBm@m@}@_AkHqH{GaHqFqFu@q@aA}@mAaAm@c@_@WWSo@c@q@c@_@U]S]S[Qm@[o@[oAk@uAi@kAe@aA[gAYqBe@yA[eAOuBYgBOaFUiAEoBGaAAoAEa@Ae@Aw@Ac@Ac@?kBG}AEw@CkCE{LWiCCmC@eBFoBHqALwAPeBZwAVwA^iA\\wAf@eBp@aBt@sDfBeDdB}BlAsAt@iB|@qCvAoFjCmD|AmBt@iBp@mA^_Bf@sA^cBb@_B`@iB\\eBZgBXs@Lm@Hy@Hw@Hs@H[Ba@FoDZkAFuAHmBNyBPeJl@aEVaF\\oCTmCPgBJ{BLu@DyBJuET_FRoDJs@DcCDoAFsABmBBuADoDDwA@uA@wDDiC@gB?cC?c@?eB?cA?cB?mA?iC?aA?oAA{A?}AAiC@kE@uB?oABm@DkA@uCDiCFsBFa@BiADeCLcDTmBLsBN}D^}CZiD`@mDd@kAP_AN}B`@gAP}AX}@P{Bd@}Bd@wDv@{M|CgKxBoEv@uDl@uEn@_CVqBRuANsE`@{OpAaIn@{E`@aF`@kBPs@DoAJmDXmD\\oNjAyPtAcCTeCR}@Fk@Dk@F_BLsAJ{AL_AJy@DyCTq@FaAH{@HkF\\o@FoAFk@DuDPoCNo@B{@BeBDgB@q@@gCB}BCkA?uAAm@As@A}@C{@C_@A]Aq@EeAE_AEs@AsAKk@E}@Gm@Ek@Eo@G{@Iu@Gw@IgCY}ASmBYuAQiEs@kAUk@Ki@Ke@I]IaB[k@Mm@Qy@S}@Ug@Ms@Ss@SkA[_AUm@SoA_@cA[m@So@Ui@Se@Qa@M]M]M[Ma@Q]Mc@Qe@Sc@Qq@Yo@Yq@Wg@Wk@Wi@Wa@SYOYM]Si@Yi@Yo@]e@Wy@e@e@We@[c@We@YsAy@m@[[U_@S]WUM_@Y_@WYSc@[y@m@UQWSi@a@q@m@o@i@c@_@q@i@a@]]Yk@g@q@m@_CuBw@s@g@i@m@m@a@a@g@g@e@e@WWWWWW]a@]_@WYY[Y[a@e@m@o@qA{AkC{C}@iAe@k@k@q@}@cAaBmBi@m@]_@UUk@k@o@q@_A}@s@u@i@g@o@i@m@m@_@]q@k@gA}@m@e@m@e@k@c@aBkAu@i@QM_Am@y@i@s@c@{@g@s@a@_@SqAq@g@Wk@Yk@Wq@[_Aa@cAa@wAi@mBq@_A[iA]cAYuAa@sA[y@S_AQo@Mk@Mq@My@UmASuCk@w@QiAQw@Se@GgDs@_B_@mAWq@Mq@Qq@Om@Og@Mo@Oo@Mu@Uu@Sy@U_AWi@Oc@M_@K_AYUGqAa@_Bg@uAe@y@YgA_@_@Me@O]M]Ke@Qg@U}CmAeBs@cBq@oB}@mAk@eBu@aCmAiB_Ak@[gCsA_EwB_B}@kC{A_E{BmC}AaBaAu@_@s@a@gAk@cAg@uAq@cAe@mAi@_A_@mAe@kAa@mAc@yAe@mA_@eAYw@Qu@Sw@Q}A[cASy@O_AOu@KiAOcAM{@K{@IeAIoAIqAIsAGg@CuAEwAEa@AuBA}CCoII]?eCCaCE]AkGIiAAoDGI?i@AqDC{DC{FIkBCiACaCEiCCoBCoAAkAC_CCsEGaAAmACm@CiAEw@Cw@Ce@Cg@Aq@Gu@EaAKu@Gk@G}@KeAOm@Ic@Gi@Ie@Ie@Ia@Gm@Oo@Mi@KkAWs@U_@Ki@O]Kc@Ma@Mq@Uu@Uk@Se@Qo@Uw@Ys@We@Uc@Sq@Wc@U_@Qk@Ya@Qc@We@W[QYMWQ_@Sc@Wm@]yA_Aq@c@k@a@w@k@c@Y]Ye@]WU[WYSYW]Y_@[i@e@s@m@k@i@m@k@k@k@]]YYUUWWa@c@[[o@u@oAwAs@_Aa@g@u@aAg@q@k@s@_@k@_AsAo@aAc@q@e@s@g@{@c@s@k@_A_@o@s@kAo@mAa@u@}@_Bc@y@a@s@a@w@]q@o@mAUc@We@_@w@i@aAg@aAk@kAg@aAS_@_@s@[k@We@a@w@a@y@s@wAu@uAWg@_@q@_AaB}CqFaBmCq@eAs@iAc@q@}@sA[e@y@iAu@cAgAyAkA}Ae@m@k@s@o@w@i@o@q@w@o@s@m@o@g@m@q@s@u@y@w@y@g@g@k@k@q@q@k@i@g@e@qAiAkAeAi@i@}@s@i@e@i@c@g@a@}@s@{@m@m@e@_@Yg@]mCkB{AaAcAo@}A_AsAw@wAy@m@]g@Yo@]}@c@}@c@kB}@cAe@_A_@gAg@w@YYMWKqAg@_C_ASI_Bq@eDmAuBu@oBs@mBo@iBq@kC}@qAc@mAa@sBo@sAe@w@Wu@U{E{AsBq@QGYIuAc@uHyBm@Q]KaD}@iBg@gBe@oA]aBa@oA[w@S}@SeASiASaAOuAWs@KmAOq@IaAKkAKwAK{AIcAEsAEo@A_DGeD?kB@kBDmCD}BHiCJ{BLiBH{AL{BNsALwANmCVeALmAL}@HcAL_BTqBX_BVgBZsATaAPgAR}@PaARwCl@mBb@eCn@yCt@uCx@oBj@uC|@eErAgFhBwGzBeKlDqE~AqBr@cDhA_Bj@WHq@V}Bv@eHbCeBn@oBp@]Jg@PuAh@kAb@kBt@u@Xo@Xs@Vg@R_Ab@oAh@{@\\u@ZwAp@s@Zk@VcAb@y@`@s@Z_@Ni@Xi@VkAj@gAh@k@VIDwAp@wCrA_@P{B`AgAd@{DzAuBv@s@V}@Zw@VaAZu@TaAX{Bl@sDz@g@LcAVaAV}@PcAR{AZyATsATgAPsBZqBVsAN_BRyCZgBNsAJ{ALeBLkAHwAHwAF}AHeBF_CHwDHcEDmIBcHAoNCS?M?}IAwBA}B@aCBaDBeDBiBBmBBoCDyBDeBFcBBaDHiDLiELcCJcBFmBFiBHuDRiCLkCNmAF{AFwADoAFiAB{@BmAD_@?c@@wEBw@?aCAgBCcBEmAEgAEmAEeBMmBMkHs@_@CwB[iC]}Ba@}AYiAUeAS_B_@SESC{Bi@OGyD_A_Ci@gAUqA[iAWmAYw@Oy@Sm@M_@Gi@Mw@Ow@Oi@Kg@Ks@Me@Ik@Ke@Ig@Io@I_AQs@Ki@Go@Ii@Gk@Ie@GcAMs@IaBOcCQoBQuCWaEU_DQs@AsCQ_CIgCUaAGq@EYAY?W?I?wC?mCMmGWaH[oAGs@Ck@AuBIaBC}BMcBIcBGgAE{@CcACgACmBC}B?iA@oABgADu@DmAH{@Fo@Fu@Ho@H{@Lw@Ly@NwAX}A\\q@Po@Pg@N_AZ_AZs@Xy@Xs@Xs@ZmAj@yAt@cAj@iAn@e@Xk@\\uA~@aBdAkAv@aEpC{@h@u@h@c@Vw@h@g@ZuCbB}@f@kE~B[N_@PwCrA}@^y@\\m@To@T_Cv@wBr@YH[LeAZ_AV_AR}@TcATcATaATs@LcARgATcANcAPmATwARcBXwATiBZ_BXgBZcDh@{GjAy@LkC\\w@Jo@HmDb@gD\\cAJYDi@BcEVs@DoDPq@B_GHqABcB?qA?gBCaBCqBEsAC{BIkAI_ACw@GwCOcCQoDUmDWqBO{@GaAI_BMuAKkAKw@Go@Gk@G{@Ka@Ea@Go@Ig@Im@M]G[Eo@Me@M]IWGe@Mu@S_@Kq@Oq@UoA_@cEoAeF}AuAc@y@S{@Uy@QaAW{@QoAUaAQ_AO{@MaAK_@Eg@Eg@CUE]C]C]Cg@Ci@A}@Es@Cu@A{@A}@?gA?u@?y@BgABy@Dw@DeAFsAHuAHwAJYDi@Bc@D{AJs@Dq@DgAFcAFeADmADkAB}@By@?cA?y@?m@Cq@Ag@Ak@AcACu@Gu@E}@GUCOAI?k@I}@K}@MgAOy@My@Mq@My@S_B_@oA[kA[sBo@q@U_A[{@_@aA_@y@]m@WaAa@iAg@_Bo@kB}@iAg@kAi@w@]yBcAwBaAkAg@yBaAeAc@u@[uAq@_CgA_CeAmCkAqAm@eCiAy@[wB_AsCqAwAo@gAe@QK[O_CiAaBw@eCkAm@[aAe@{@e@{CaBUM[Qy@a@]USMUMe@YqAy@{@k@_@WmAw@}@m@oA}@m@e@s@i@a@[s@i@u@q@a@]y@s@{@w@c@_@}@}@c@c@MMgAiAc@g@WYaAgA[a@o@w@m@w@m@{@_AqAa@m@q@cAQWwA_CcAgBk@cAWg@Wg@Yk@Uc@Ue@c@aAm@wAm@uAa@aAYu@Sk@Wq@Ws@Qg@GOIWQi@a@qAOe@Sq@c@{AQk@]oASy@WeAQs@]{AOo@Q{@a@sBWsAMq@WwA]qBW}ASqA]}BYiBQiAU}AU}AU}ASqAk@sDa@cCYaBWwAWsAScAWqAS_AUaASy@YgASs@YcA]kASo@Uw@Qi@Qi@Sm@Oc@Qg@Si@k@yAYs@[u@s@_BaAwBYk@Yi@Wi@Yi@e@{@e@y@g@}@g@y@e@s@i@y@e@q@c@k@c@o@a@i@}AmBY]]a@iAmAo@q@m@k@q@q@][_Ay@i@e@{@u@i@e@}@u@y@q@{@s@}@s@q@i@{@q@{@q@q@i@i@c@s@k@k@e@cAy@}@s@y@o@m@e@a@[YUIEwBgBoB_BcBuAkCwBmB_B}AmAmAaA{AmAiB{AcBsAy@o@k@e@_As@eAy@}@s@aAw@s@k@cAw@o@e@{@o@s@i@m@c@s@e@s@e@m@c@k@_@s@c@m@_@}@i@cAo@w@c@i@]q@_@w@c@kAm@qAo@_Ae@kAi@o@[eAe@a@QwAm@sAi@cA]{@]iAa@gA]gAa@gA]gBk@kAa@}@YaAY}Ag@kA_@gBi@uCy@eBi@sAa@eAYy@Sw@U_AScBc@wA[mAWu@OoAWaAQs@MoAWgAQyAWgBYaAOqASiAQmB[kAQcDe@}F_A{Eu@{Dk@cEq@yCc@{Es@oF}@aC]qEq@uEs@iFw@wASgBW{@MoAOmB[aBUeFs@}B[kBWoBWwCa@_BUqC_@mEm@wBYsC_@gBW_BU_AMqAOeBWiAOkBWwASaAMm@Iy@K}AScAMoBUeBSiBQ{@Io@Gg@Em@Es@Gq@Ey@Cy@Go@Au@E{@CeACo@?w@Cs@AkA?eA@y@B}@?}@@aAB{@Bm@Bw@DeAFe@BS@YBkE\\eBPg@F_CZqANqAPkAPwBZeBVqBZaAPaBRsAPm@Hs@H_AJy@HiALg@B}@Ho@Be@DsADoAF_@?}AB{B?aB?_BCyAGcAE}@E}@GcAI{@I_AKcAKiAOkAQaAOcAQy@Oq@M_AQsA[YKUGiF{Ae@OkC{@gBm@gBo@_FeBg@QsE_BkG{BiEyAoCaAkDkAuCeA_EwAoE}AmG{ByCcA_A[s@Ww@Yq@UmAa@cA]mC_AgA[s@Qm@SyAc@uEmAyDaAsDo@y@Os@Mg@Gs@MkDe@cBWMC_AMa@Ie@Gu@Iq@IoB[e@Iq@K{B]m@I{@MqB[sB[eC]gBUwAQcAK}@K_BOy@GoAGkAIy@CeAGaAC}@AiCCmBBaCBaCDwDL{G^}CLoCHsA?aA?_ACgAEq@Iu@Gu@IoASu@MaAQiAWkA[aA[eA_@m@Ug@SYM[MmAo@k@[g@[{@i@kAw@y@i@yBcBiCsBiByAi@_@iCsB_CiB]Y]WuAgAoEkDcBoA]YQOuBoBw@w@s@y@eByBY_@wAeBm@o@k@i@w@s@]WYWw@k@sC}AeAk@y@]k@Se@Oc@Ma@Ka@Ka@I_@Go@Ii@Ga@EYCg@CeAEyBK{AGw@CgBIgAGg@Cc@CeBKo@Eu@I]Ea@GgASq@Oi@Mu@Og@M}@ScASo@M}@Mc@C]E_@Ag@A_@?Y?a@@[@c@D]@WB]F_@D]Fc@L_@Ha@Lc@Nc@P]N]R_@P_@To@^s@b@o@Zc@Rc@P]La@L]L[Fa@J[H[FUDYF]B]DeAJ{@HkALaAJmAL_AJ}BTcAHoANOBy@Fs@Hi@Hw@Lq@Lw@NkAXmAV{A\\gB`@_B`@s@Nw@TeAVg@Ps@RyAh@aA`@aAb@m@Xi@Ve@TUL[Pk@Zo@^i@Te@Rg@Pa@Le@Lk@Li@Je@Fa@Dk@Fo@@g@@k@?]?}AKq@E_AIiAUcASgBa@sEaAuA[oAU_B[s@MkB]y@KeAImACu@CM?[?U@Q?a@@_@BW?_@BYBk@F[Da@F_@Fc@H_@HWF[H]HYHUJYH_@PSF]Lu@\\yB|@mAf@aCbAaC`AqAf@mAd@sBr@QD[H}@Xm@L]HYF[Hk@Hm@La@D_@F_@Fe@Fi@Fo@Hc@Fa@BYB]Da@@g@Bm@Bg@ByA@{CBiDBuEH_@@[@QBQ?[Ba@D_@D]FaALi@Fe@Hc@Hc@Hq@Pk@L_@Hi@Pa@La@J_@Li@Rc@Rg@Pe@Rc@Rc@T[Nc@Tg@Xi@\\k@Zm@Zm@\\o@\\a@Tc@Xg@V]Ra@Tc@T_@Rg@Vm@Z_@P[Ne@Tc@Ra@Pg@Tm@VYLWL[HcA`@}Ah@k@PmDdAoAZw@Nq@Nw@Nq@L]FYDwATsAReAPkALgAHoALkAFcAFm@BW@W@m@B}@@mABgA@_B?yAAoACuBEwBEiCCeDIwDIqDGoEIiBCqBEwBCcA?cA?uA@eABmAFw@@q@Fq@Bg@BeEVaCLcDPkCNiEVyAFaCLkBJmCL}@B_ABsCFsA@yB@}@?wA?o@AuAAeAAg@Aa@CUAyGUqCUyDY{Eg@yEk@{B_@qCe@mFkAaFeAe@KuGyAwDs@wB]iAOyAQy@IeAKy@GqBKiAGwBGuACkAAiA?iA@mBF_CDkADoAFoBJeDTkDPgCNkG\\kG\\cCNsAH_ETqAHgEVaBHUBK?iBL}@H}@HkAPsANoAReB\\eARqAZmAZs@Tq@Pw@Vy@XiA`@s@XaA`@{@^oAl@_Ad@o@^}@d@iAn@aCzAWPg@\\YRg@^k@b@k@d@k@h@_@Zk@f@[XWPi@d@k@f@w@t@oAjA{@z@{@t@[RiAx@_@Tm@\\WLWL]Pq@^y@X{@XoAVyAZ_ALcAHqAFmADqCIcACmAQqAQc@KIC{@SqA_@_A_@GCUK{Aw@m@]w@g@c@[o@e@c@]yAuAuA{AcBuBcB{Be@m@m@{@Ya@a@i@]e@}@oAg@m@_BgB_@e@k@m@oCcCWUoAeAkBsAkAs@]S]UkAo@mAm@{B_AqBq@cBk@yAa@wA[{AWgBUeEa@cCOeCIcCBeBJkD^oARcBb@eCh@yCr@_BPmANyALyABsBAgBG}AKmAOeBW}Ac@sA_@}Ak@qAi@{Ay@mAq@iCkBmA{@qB{AiCsByC}BuAgAk@c@_As@mAaAoAaAiA}@gAy@_Au@}@q@q@i@u@k@_@Yi@a@{EwDy@m@u@o@g@_@k@i@m@i@g@e@a@a@_@_@g@i@a@c@g@k@a@e@[_@k@q@mAyA{@eAkAyAiA{Am@u@aAmAy@cAs@{@s@y@]_@k@m@i@i@i@e@o@m@k@e@k@e@q@g@o@c@m@_@w@i@mAs@QKSKQIeAc@qAi@{B{@kA[oA[wB]_Ca@kBMmBMkBEyA@eA@yAJyBNkBVyBZkBb@wCn@}KhCgPrDaCj@gGtAeFjA{G|AyDdA}Af@s@Xe@Nc@Pq@Xi@Ti@X[L[Na@T_@Pi@X_@Re@Ve@VaAj@{@f@m@\\gAl@k@Zs@\\w@^a@P_@N[L]Li@Pe@N[J_AVg@Le@J[Hc@F]F[FYDa@Fg@F]De@De@Da@DY?g@B]@m@B}@?sB?kB?g@Co@C_BAcDIaDIyCGkBGqACeAAqCGk@AiGO{BGcAAi@Ak@CsAE{CGO?Y?[C{HOiNY_DEuDMsDI}ACcBC}BAuB?oA@}AD{@D_AFs@Fu@H{@JkANwAToAVi@Lo@P_AVcAZy@V_A\\y@Zs@X{@^k@XaAd@{@f@yAz@aBfAsA~@iBzAOLKJUR{@r@a@^gA|@URmAbAs@h@k@^g@\\a@Vi@Zu@^s@Zo@Za@Ls@V[Fq@Rg@Hk@J_AN{@J[DYBcANy@Pg@Hi@L_AViA^m@TYLUJ[Na@R_@Rc@V_@To@b@c@Z_@Xa@\\s@l@m@j@}@x@y@t@s@n@}@z@w@t@k@h@i@f@[Xc@^i@b@g@`@i@`@[T]V[P[P[R[L_@Pa@R_@Le@P]Lo@Rm@Pk@Lk@L{@L}@Hu@FoBHwA@yBK_AGu@MgB[mBe@wBs@y@[}Ae@uBi@}AYw@Ks@ImAGw@CgBBu@@e@B{@FqBVkATq@Rm@Na@LWJm@RYLYLc@Ra@Rk@Z]Rg@ZYR]Vu@j@u@p@[Xi@h@[\\]`@q@z@q@~@_@h@e@r@W`@[l@[j@Yj@Yn@Sd@O\\Qb@Qb@M\\Qh@Qh@Od@Y~@St@St@UdAS~@S~@I\\I\\Kd@K^I\\Mf@Md@K`@K\\Op@GRENGRGPKXKXKVIRITGLQ`@Sd@Qb@OZUd@Yj@Yh@o@dAo@~@m@x@k@r@q@t@w@x@w@r@w@p@q@h@{@h@u@d@a@Re@V_@Ng@Ti@RWJ[J[JWJc@LYHUDcAX{@VK@k@NyF~AgElA{Af@aA\\w@Xe@Pa@P_@L]NYL]Ng@Vc@Pg@Tm@Xg@Vs@^k@Zg@Xc@X]Pc@Vc@Vg@Zg@Zw@h@m@`@a@Vw@j@m@b@k@b@_@Za@ZSPWVWRYXWV[ZWX[\\YZQRUZ_@d@[^w@dA_AnA{@jAw@fAc@l@[`@_@f@_@d@WZWVo@r@e@f@]\\c@`@[XYV[Vc@^_@Z_@VUPUPOJ_@Va@X]P]R[P_@RYP]NWLm@Xw@\\{Ap@oAh@_Br@g@Pa@Rm@Ts@Xi@TgAd@eAb@aBp@cA`@cAb@s@Zq@Zk@Xi@Xg@ZQHa@X{@h@_Ar@u@l@u@r@k@l@u@|@m@r@_@h@UZi@x@]j@Yd@Yf@[l@Wh@_AnB{@`Bo@lAg@~@o@fAc@p@U^W^UZ_@b@[b@mArA_A`Au@r@u@n@kA`ASLq@d@g@^e@X[Re@TYNy@`@m@Xa@N_@Nm@R_@L[L[H[Hu@P_@Ha@J[Ha@Hc@Dm@Hw@Ji@B{@HgA@cABaAAi@Ak@AgAGi@Ci@Ey@GgAKw@IkBOyAMqBS}AMmIs@gFe@{AMkAIw@GkCMuAEgAAaAAiA@y@B{@By@DsAJs@Du@Fm@Hc@Fo@Jw@Lg@Jg@JaARk@Na@Jc@LcA\\e@Li@Pk@Rs@Xw@Zk@Vk@X]P_@R[Pe@Ve@X]PcAn@gAr@eBrAk@^a@Za@Zk@d@sBfBcBxAuBjBqAhAWVa@Ze@`@[Xg@d@o@f@y@p@_Ax@iCzB}BnBgDtCq@n@eDtCkGjFaAz@eB|AsAfAiA~@SLq@d@_@VOJu@b@q@\\w@\\u@Zy@Xw@Tq@Pw@Ps@Lo@Hy@Hy@Fu@B}@BeAAu@Cm@Ek@Em@GmBYaCi@oBc@mCs@wBm@sBi@yA_@wA]yA[{@Sy@O}@MeAIQA}@Cs@Cg@?e@Bg@?u@B{@Hq@Dy@Jm@Jo@Li@L]Hs@Rs@T}@\\k@Vi@Vi@Zc@To@`@k@`@c@Zi@b@s@n@g@h@m@l@k@n@q@x@a@h@g@r@i@x@iAfB_FlHoBxCsAnBy@hAo@x@k@p@c@f@e@h@q@p@q@n@iAdAy@r@}@p@sA~@_@Xm@\\s@b@_@PULQHo@Zq@ZqAd@}Ah@eAZ{A^aBZ{@LcALmALqAJ]@u@Dc@?c@?kA?eCEcCG{DQeACoLe@iIQ}CIUAQ?SAOAk@?yB@qD?aFF}HHQ?S?}@Bo@BmCJwAFi@BS@iCN_BHkBL_DVe@DgBNiAJw@Hq@JqALaALsAPkCZu@J_ALqATwBZkBZmAVqB\\oEv@{AXwGjA{B`@_APu@JyE|@}AZu@LiARmB^uDn@mLtBgBZcCb@sCh@sCd@iB\\mB`@]Hk@JgFbAcHfAwAT}@LeALkAJeAJsBHoADyA@aA?aAAi@Aw@Ck@Cg@Cc@Am@Ge@E}AMoBW_AKiD]wC_@kFm@s@I}B[aBW}AWa@Kw@OwCo@gAUYGaE}@mGuAeB[oBc@m@K[Ec@Ea@EYAq@A}@@i@Bg@F[Dw@L_@H[JYFy@Xg@Rg@Xu@`@c@Zg@`@g@f@[Z_A`AsBtBg@d@k@d@c@Zi@\\]Ra@Ra@P_@Pe@LUHWDg@Ja@H_@B[Bq@DaA?]Cc@Co@Ei@Ey@McC]oBWaAO}Cc@sAOaAMyAQ{B[qBQo@Ey@CgBIqAAsAAmA@aBDiAFeAFcBHqABcA?cAAoAE}@EUA_@Ci@Ce@G_AKm@GkASYEgASyA[aBe@}Bo@aA[}@[w@[aAc@}@a@q@]q@]m@[g@[c@Wk@_@qA{@w@k@k@a@{AmAo@i@YYo@m@o@m@sFeFo@k@wAsAgAeAyBqB}AwAuCmCeAcAuDiD_ByAYWs@q@yBsB{AuAi@i@mAiAgAcA}@w@yAwAkBeB_A}@_@]aA{@gAgA_A}@sCmCg@e@_FsEeHsGcA_AqBkBy@u@k@i@g@e@y@o@u@i@g@]}@k@k@c@qAo@kAi@cAc@{@[s@UyBm@}@Qy@Ok@Go@Ko@GoAKiAG{@?sA?kA@u@Bk@DiAF}@Jk@Ho@J_AP}@RcAVmA`@kBt@mAh@_A`@c@Tk@V_@PUJw@\\qAj@iBx@mBx@qAj@s@Zq@VcA\\[JaAZ{@Tw@PWFSDg@J{@Ns@Jq@Hu@JwAH_@BY@c@@k@@}@BgA?iAGqAK_BM_BQoASqEy@gAW}Bi@gCi@wA[eB]wIkBuFmAsAY}A]gB]mEaA}Be@}Cm@}@UeAUcB]yBe@uCm@}@S_AU}@Sa@I}@Qa@Ik@MuBe@kBa@u@O{@QeAUaAQgAWgDs@}@Qs@Qw@Q_ASaDq@_B]sCm@oCi@e@Ie@Mk@Mk@Me@IqA[}@UkCi@_@IcDo@qCe@qFw@_Ee@}AOiEYeDWe@Cw@EwBGqCM{BIuAAyA?kAAo@?q@@o@@q@@g@?e@@U@q@B}@B]@e@@uAD_@@_@@}@C_@?[Cw@C{CKkAAUAMAOMUOOMc@I[Ge@Es@Go@EWCQ?WBS?YBWDYBUD}@PUBWDWDYDWD]D]FW@WBc@@W?gCCmAAY?_@A_AGa@C_@E_@Gc@Ic@Ke@Me@Mc@MkA_@{Bs@i@Qi@Qi@Oi@Mi@Mk@Ke@Eg@Gk@Ck@?e@@c@Be@Dc@Fc@Hc@Je@Ne@Pc@Rk@X{EdCq@\\s@\\q@Zm@Vi@Rg@Pg@He@Fe@De@Be@@e@?i@Ag@Gc@Ec@Ka@Kc@Me@Qa@Qa@Sc@We@[a@[c@_@e@c@c@e@e@i@e@k@e@m@qBqCsBwCq@_A]e@y@kAa@k@W]U[_@g@YY_@c@MMQQUSUQ]WYQQIc@Qa@OQGWIYI]IMCOCOC[E_AIMCeAC}ABkBFgEReDFQ@q@BoBDu@AaAGm@Cc@IeASkAg@s@]SKm@a@m@e@_@_@EEEEg@m@g@o@e@q@]m@c@}@Se@KUQa@Si@[_Ak@_BWu@Qe@Uk@Yo@Ym@Yi@Q[Q[S[QWOSW[]_@_@c@g@g@c@c@gAaA_D_DeC{Bk@g@m@i@i@m@u@cA]i@g@_Ac@}@_@}@[y@_@gAq@yBw@oCc@{ASq@]uAc@wA}@}Cg@cBu@gC[}@a@eAYq@_@y@g@_Ai@{@a@i@i@q@k@m@o@q@e@a@s@e@k@a@{@c@s@]s@Uy@W_@I}@OkAIIAeBGgAGu@Ai@CYCa@Cm@E_@Ga@Gc@G_@Ke@Ms@Sq@Um@Uw@[k@Uy@[w@[u@W}@_@iBs@e@Qm@Se@Om@Qw@Qm@Mu@Mg@Ks@Ii@Em@E]Ao@Aw@?yA@_AFiALS@k@JuATs@Ri@Lk@Re@PSHa@Pk@V_@POHULQLm@\\c@Xc@Zs@h@q@h@cAx@oBdB_Ar@m@h@g@^g@\\_@Tg@Zg@X_@R]Rk@Vg@Rm@T]L{@ZyAh@aBh@_AZk@Rc@P{HhCkAb@kA^i@Rc@TUJi@Xk@^a@Z[XYX]`@Y^Y`@QZ]n@Wf@Wj@Ul@Sn@Qp@Ol@Qx@Kp@EVE\\Iz@Gx@Cb@ARCz@Cr@?v@@|@BdADhAF`BBj@Dz@DdAB|@@d@@l@?h@?|@Ah@AZAVCb@ARALCVCTEd@Gh@M|@Mz@UrAMl@g@~Bk@|Be@hBUz@]lAY`Aa@jAu@rB]`A[x@]z@q@bBKXKR}AtDa@x@{@hBu@vA]n@_@r@GHeAjBeAfBc@r@q@dA}@rAy@jAgDtEsAdBcApAkAxAs@z@_AhAkApAcAhA}@`A{@~@cAdAgAfAkDjDoAlAcC~BcB|AqBhB_BvAyH|Ga@Z{AlA{AlA{AlAsAdAwCzBaBlAyAdAw@j@gAt@gAr@iAr@y@d@w@d@m@ZgAh@u@ZaA\\sAf@oAf@{@^o@Zy@b@{@d@u@d@q@b@m@b@s@h@cAx@o@j@k@h@s@r@y@z@o@r@e@h@o@v@_@d@g@r@q@`Am@`Am@bAg@~@c@x@e@~@[p@]v@a@`A[v@i@tAiA`Dg@tA]~@Yr@[r@[n@Ub@Wd@[h@c@r@k@z@o@z@s@~@Y^]\\YXML]\\QNe@`@c@\\e@\\e@\\e@Zc@V_@Rc@Ti@Vg@VsDjBmEvBwAr@sHbDk@Ti@Rk@Vm@Vo@Vk@Ti@Vg@Pe@Pa@Rq@Tw@Ze@RYHq@VuBt@u@Vk@R[LmBn@eA^_@L}@VaAZ}@XoAZs@RSBg@LiD|@QDqE`AoB^g@Jk@HgG~@iEj@{AP_Ed@c@Di@DoAHK@s@DmCPkCL{@?iA@cBIkAKm@G{@Qy@Q}@Wq@Wo@We@Um@]a@U_@W_@WkAaAa@_@u@s@i@i@e@e@o@s@_BiBm@u@{AoB{AuBiBkC_EaGaC}CwAiBy@cAwBeCwCaDcCcCgCcC}@w@aA{@yBgBcBoAa@YiAu@iBoAkBiA_FuCsGmDwGcDeEqBuCoAyFyBsGaCiBs@kJkDsIaDeBq@cBs@_Aa@kIuDgB{@eAi@gFkCiBcAs@_@qAw@cEcCkAs@kBqA_C_B}CyB_CoB{@q@i@c@s@m@WUaCqB}AuAq@o@iBgB{@y@qBsBkDuD}@cAsAyAeDsDk@k@i@m@_EeEw@w@qCwCk@i@eAcAcAaAi@e@u@s@w@w@a@a@OMo@k@w@s@QOk@i@_Aw@cA}@oAeAkBaBaBuAwD}Cm@e@y@o@m@c@k@c@g@]mBuAc@[UOYS_Am@u@e@i@[w@e@iAm@s@_@{@c@g@Uc@U_@Oi@Wo@Yi@Sq@[g@Sk@Uo@Uk@So@Su@YeA]gA[_AWcAY{@Uo@QuDeA}@WaBg@gFaBkHgCmBs@mCeAwCmAaL_FeF}B_Bo@kBs@mA_@eAWyBi@{Bc@aCa@e@G_AKo@CWEqCMy@Ei@AmBC{ABu@@w@Be@BcEVs@FO@_Ih@gAHkHf@{BPeBLoBNc@FmAJy@Js@HqBV_Fr@o@Jy@LoC`@qJvAcBXu@LQBe@BWBY@[DSD_@L_@L_@L_@PMDYLoAd@oAZoB`@eANcAHs@BY@kAAs@G_@Eq@Mm@Qa@MyAg@qAc@e@OcA]q@Ma@Ig@Gk@Iq@GSAe@Ce@Ce@Ac@?u@?y@De@@_@Ba@Fq@Fa@FmAT[Dg@L[HYJi@NUJ}ChAwAf@aBb@c@L_@Dc@HYF_@Bc@D_@DiADoAFmFTqADaHXiCHu@Dm@BiCPoAHi@DgAD{@D}BFoADcA?m@@[@oA?KHM@c@@u@@eABk@Bo@Dk@FOB_@Hg@D[Fi@HWB}BZ]HaANYDODW@k@?WFWDUBk@Fk@Dk@Fm@@k@BWBk@Bk@?Y?Mq@XErCKlBG|@An@A?iAAWCuBCkCEeCAg@EwBEqBEgCA_AAg@CaACu@Co@AM?MA_@Cg@MDkAZQD"
+ }
}
- },
+ ],
"status": "OK"
}
]
},
- "Distance_IsochroneTimeDistance": {
+ "Distance_TollsRoute": {
"properties": {
- "value": {
- "type": "integer",
- "title": "Value"
+ "overview_polyline": {
+ "$ref": "#/components/schemas/Distance_Polyline"
+ },
+ "bounds": {
+ "$ref": "#/components/schemas/Distance_Bounds"
+ },
+ "legs": {
+ "items": {
+ "$ref": "#/components/schemas/Distance_TollLeg"
+ },
+ "type": "array",
+ "title": "Legs"
+ }
+ },
+ "type": "object",
+ "required": [
+ "overview_polyline",
+ "bounds",
+ "legs"
+ ],
+ "title": "TollsRoute"
+ },
+ "Distance_ValidationError": {
+ "properties": {
+ "loc": {
+ "items": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ }
+ ]
+ },
+ "type": "array",
+ "title": "Location"
},
- "text": {
+ "msg": {
"type": "string",
- "title": "Text"
+ "title": "Message"
+ },
+ "type": {
+ "type": "string",
+ "title": "Error Type"
}
},
"type": "object",
"required": [
- "value",
- "text"
+ "loc",
+ "msg",
+ "type"
],
- "title": "IsochroneTimeDistance"
+ "title": "ValidationError"
},
- "Distance_IsolineResponseDistance": {
+ "Localities_AddressComponent": {
"properties": {
- "origin": {
- "$ref": "#/components/schemas/Distance_LatLng",
- "description": "The origin point of the isochrone contour."
+ "types": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array",
+ "title": "Types"
},
- "geometry": {
- "type": "string",
- "title": "Geometry",
- "description": "The polyline of the isoline (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm))."
+ "long_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ ],
+ "title": "Long Name"
},
- "distance": {
- "$ref": "#/components/schemas/Distance_IsochroneTimeDistance",
- "description": "Returned when `method=distance`. The `value` is the distance in kilometers and the `text` is a human readable representation of the distance in kilometers."
+ "short_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ ],
+ "title": "Short Name"
}
},
"type": "object",
"required": [
- "origin",
- "geometry",
- "distance"
+ "types",
+ "long_name",
+ "short_name"
],
- "title": "IsolineResponseDistance"
+ "title": "AddressComponent"
},
- "Distance_IsolineResponseTime": {
+ "Localities_AddressSummary": {
"properties": {
- "origin": {
- "$ref": "#/components/schemas/Distance_LatLng",
- "description": "The origin point of the isochrone contour."
- },
- "geometry": {
+ "public_id": {
"type": "string",
- "title": "Geometry",
- "description": "The polyline of the isoline (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm))."
+ "title": "Public Id",
+ "description": "The public_id of the address can be used to gather details on that specific address"
},
- "time": {
- "$ref": "#/components/schemas/Distance_IsochroneTimeDistance",
- "description": "Returned by default or when `method=time`. The `value` is the time in minutes and the `text` is a human readable representation of the time in minutes."
+ "description": {
+ "type": "string",
+ "title": "Description",
+ "description": "A human readable description of the address"
}
},
"type": "object",
"required": [
- "origin",
- "geometry",
- "time"
+ "public_id",
+ "description"
],
- "title": "IsolineResponseTime"
+ "title": "AddressSummary",
+ "description": "A short description of an address"
},
- "Distance_LatLng": {
+ "Localities_AuthenticationErrorResponse": {
"properties": {
- "lat": {
- "type": "number",
- "title": "Lat",
- "description": "The latitude of the point in decimal degrees, range is [-90, 90]."
- },
- "lng": {
- "type": "number",
- "title": "Lng",
- "description": "The longitude of the point in decimal degrees, range is [-180, 180]."
+ "detail": {
+ "type": "string",
+ "title": "Detail"
}
},
"type": "object",
"required": [
- "lat",
- "lng"
+ "detail"
],
- "title": "LatLng"
+ "title": "AuthenticationErrorResponse",
+ "description": "AuthenticationErrorResponse is the base authentication error model."
},
- "Distance_MatrixDistanceDuration": {
+ "Localities_AutocompleteResponse": {
"properties": {
- "value": {
- "type": "integer",
- "title": "Value"
- },
- "text": {
- "type": "string",
- "title": "Text"
+ "localities": {
+ "items": {
+ "$ref": "#/components/schemas/Localities_AutocompleteResult"
+ },
+ "type": "array",
+ "title": "Localities"
}
},
"type": "object",
"required": [
- "value",
- "text"
+ "localities"
],
- "title": "MatrixDistanceDuration"
+ "title": "AutocompleteResponse",
+ "description": "Localities Collection Response containing Localities",
+ "examples": [
+ {
+ "localities": [
+ {
+ "description": "London, City of London, United Kingdom",
+ "matched_substrings": {
+ "description": [
+ {
+ "length": 4,
+ "offset": 0
+ }
+ ]
+ },
+ "public_id": "Ch6qA8cLmvyvEEoFy6nYeFcEdNU=",
+ "type": "locality",
+ "types": [
+ "locality",
+ "city"
+ ]
+ },
+ {
+ "description": "Derry/Londonderry, Derry City and Strabane, United Kingdom",
+ "matched_substrings": {
+ "description": [
+ {
+ "length": 4,
+ "offset": 6
+ }
+ ]
+ },
+ "public_id": "m/T2C4YI2LgszkKXrELBC+9dfC8=",
+ "type": "locality",
+ "types": [
+ "locality",
+ "city"
+ ]
+ },
+ {
+ "description": "London Colney, Hertfordshire, United Kingdom",
+ "matched_substrings": {
+ "description": [
+ {
+ "length": 4,
+ "offset": 0
+ }
+ ]
+ },
+ "public_id": "J6eISGMjjvQwPkao8rsByB3aVwM=",
+ "type": "locality",
+ "types": [
+ "locality",
+ "village"
+ ]
+ },
+ {
+ "description": "London Apprentice, Cornwall, United Kingdom",
+ "matched_substrings": {
+ "description": [
+ {
+ "length": 4,
+ "offset": 0
+ }
+ ]
+ },
+ "public_id": "52MnrbHVWH21CLWH8VY/YWKhqeM=",
+ "type": "locality",
+ "types": [
+ "locality",
+ "village"
+ ]
+ },
+ {
+ "description": "City of London, United Kingdom",
+ "matched_substrings": {
+ "description": [
+ {
+ "length": 4,
+ "offset": 8
+ }
+ ]
+ },
+ "public_id": "S/5AkUmMBhX35qVI2jR38+dALwk=",
+ "type": "locality",
+ "types": [
+ "locality",
+ "city"
+ ]
+ }
+ ]
+ }
+ ]
},
- "Distance_MatrixRequest": {
+ "Localities_AutocompleteResult": {
"properties": {
- "mode": {
+ "public_id": {
"type": "string",
- "enum": [
- "driving",
- "walking",
- "cycling"
- ],
- "title": "Mode",
- "description": "Specifies the mode of transport to use for the calculation.",
- "default": "driving"
+ "title": "Public Id",
+ "description": "Unique identifier for this place. Pass it to the `/details` endpoint to retrieve the full record."
},
- "method": {
+ "type": {
"type": "string",
- "enum": [
- "time",
- "distance"
- ],
- "title": "Method",
- "description": "Specifies how to compute the route between the start point and the end point:\n* `time`: fastest route \n* `distance`: shortest route",
- "default": "time"
+ "title": "Type",
+ "description": "This field might be removed in the future, please use the `types` field which is more exhaustive.",
+ "deprecated": true
},
- "units": {
+ "types": {
+ "items": {
+ "$ref": "#/components/schemas/Localities_LocalityTypeAll"
+ },
+ "type": "array",
+ "title": "Types",
+ "description": "An array containing the types of the result"
+ },
+ "description": {
"type": "string",
- "enum": [
- "metric",
- "imperial"
+ "title": "Description",
+ "description": "Concatenation of `name`, `admin_1`, `admin_0` to be used as suggestion in drop-down list if needed. The description can vary depending on the type requested."
+ },
+ "matched_substrings": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Localities_MatchedSubstrings"
+ },
+ {
+ "type": "null"
+ }
],
- "title": "Units",
- "description": "Specifies the unit system to use when displaying results.",
- "default": "metric"
+ "description": "Contains a set of substrings in the `description` field that match elements in the `input`. It can be used to highlight those substrings. Each substring is identified by an `offset` and a `length`."
},
- "language": {
- "type": "string",
- "enum": [
- "en",
- "fr",
- "bg",
- "ca",
- "cs",
- "da",
- "de",
- "el",
- "es",
- "et",
- "fi",
- "he",
- "hi",
- "hu",
- "it",
- "ja",
- "nb",
- "nl",
- "pl",
- "pt",
- "ro",
- "ru",
- "sk",
- "sl",
- "sv",
- "tr",
- "uk",
- "zh"
+ "has_addresses": {
+ "anyOf": [
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
],
- "title": "Language",
- "description": "The language code, indicating in the language the response should be in. \n \nIf not defined the header `Accept-Language` of the request will be checked before defaulting to `en`.",
- "default": "en"
+ "title": "Has Addresses",
+ "description": "Indicates whether a postal code has addresses you can drill into. Returned for postal codes in some territories (e.g. United Kingdom, Ireland). When `true`, call `/details` with this suggestion's `public_id` will list the addresses; each address carries its own `public_id` for a further `/details` lookup."
},
- "avoid": {
+ "related": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/Localities_Related"
},
{
"type": "null"
}
],
- "title": "Avoid",
- "description": "A list of features that you want to avoid. Valid values are `tolls`, `highways`, `ferries` or polygons coordinates whose vertex latlng are separated by a semicolon `;`. \n \nTo add multiple features, separate them with the pipe `|` character.",
- "examples": [
- "tolls",
- "tolls|highways|43.3,3.4;42.1,3.5;41.4,3.6"
- ]
- },
- "origins": {
- "type": "string",
- "title": "Origins",
- "description": "The starting points. You can supply one or more locations, in the form of `latitude,longitude` coordinates, separated by the pipe character `|`. Ensure that no space exists between the latitude and longitude values. \n \nIn order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc::`",
- "examples": [
- "48.709,2.403|48.768,2.338",
- "enc:_p~iF~ps|U_ulLnnqC_mqNvxq`@:"
- ]
- },
- "destinations": {
- "type": "string",
- "title": "Destinations",
- "description": "The ending points. You can supply one or more locations, in the form of `latitude,longitude` coordinates, separated by the pipe character `|`. Ensure that no space exists between the latitude and longitude values. \n \nIn order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc::`",
- "examples": [
- "48.709,2.403|48.768,2.338",
- "enc:_p~iF~ps|U_ulLnnqC_mqNvxq`@:"
+ "description": "Contains a set of related elements to the locality suggestion."
+ }
+ },
+ "type": "object",
+ "required": [
+ "public_id",
+ "type",
+ "types",
+ "description"
+ ],
+ "title": "AutocompleteResult"
+ },
+ "Localities_CountryCodeFormat": {
+ "type": "string",
+ "enum": [
+ "alpha2",
+ "alpha3"
+ ],
+ "title": "CountryCodeFormat"
+ },
+ "Localities_DatasetMode": {
+ "type": "string",
+ "enum": [
+ "advanced",
+ "standard"
+ ],
+ "title": "DatasetMode"
+ },
+ "Localities_DetailsGeometry": {
+ "properties": {
+ "location": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Localities_Location"
+ },
+ {
+ "type": "null"
+ }
]
},
- "arrival_time": {
+ "viewport": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/Localities_Viewport"
},
{
"type": "null"
}
- ],
- "title": "Arrival Time",
- "description": "Specify your desired arrival time.\n\nBy using this parameter, Distance will calculate the duration with **traffic**. Valid values are a UNIX timestamp (e.g. `1600799173` for the date: `22/09/2020 20:26:13`) or `now`. \n\nUse either `arrival_time` or `departure_time`, not both.",
- "examples": [
- "1600799173",
- "now"
]
},
- "departure_time": {
+ "shape": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/Localities_Shape"
},
{
"type": "null"
}
- ],
- "title": "Departure Time",
- "description": "Specify your desired departure time.\n\nBy using this parameter, Distance will calculate the duration with **traffic**. Valid values are a UNIX timestamp (e.g. `1600799173` for the date: `22/09/2020 20:26:13`) or `now`. \n\nUse either `arrival_time` or `departure_time`, not both.",
- "examples": [
- "1600799173",
- "now"
]
},
- "elements": {
- "type": "string",
- "enum": [
- "distance",
- "duration",
- "duration_distance"
+ "accuracy": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Localities_LocationTypeStr"
+ },
+ {
+ "type": "null"
+ }
],
- "title": "Elements",
- "description": "Specifies element values that will be part of the API response (`distance` and/or `duration`).",
- "default": "distance"
+ "description": "This accuracy represents the type of address returned - `DISTRICT` and `POSTAL_CODE` are for UK only."
}
},
"type": "object",
- "required": [
- "origins",
- "destinations"
- ],
- "title": "MatrixRequest"
+ "title": "DetailsGeometry"
},
- "Distance_MatrixResponse": {
+ "Localities_DetailsResponse": {
"properties": {
- "status": {
- "type": "string",
- "enum": [
- "OK",
- "INVALID_REQUEST",
- "MAX_ELEMENTS_EXCEEDED",
- "MAX_ROUTE_LENGTH_EXCEEDED",
- "REQUEST_DENIED",
- "BACKEND_ERROR",
- "OVER_QUERY_LIMIT",
- "ZERO_RESULTS"
- ],
- "title": "Status",
- "description": "The status of the response\n* `OK`: The response contains a valid result.\n* `INVALID_REQUEST`: The request could not be processed.\n* `MAX_ELEMENTS_EXCEEDED`: The product of origins and destinations exceeds the per-query limit (fixed at 200 elts/query).\n* `MAX_ROUTE_LENGTH_EXCEEDED`: One of requested routes is too long and the matrix/route cannot be processed (The limit is 500km).\n* `REQUEST_DENIED`: The API key provided is invalid or does not allow access to this service etc..\n* `BACKEND_ERROR`: The server encountered an unexpected error.\n* `OVER_QUERY_LIMIT`: The request was denied due to the rate limit (see [Usage Limits](https://developers.woosmap.com/products/distance-api/distance-matrix-endpoint/#usage-limits)).\n* `ZERO_RESULTS`: No route could be found between the origin and destination.\n ",
- "default": "OK"
- },
- "rows": {
- "items": {
- "$ref": "#/components/schemas/Distance_MatrixRowsResponse"
- },
- "type": "array",
- "title": "Rows",
- "description": "Contains an array of elements for each pair of origin and destination"
+ "result": {
+ "$ref": "#/components/schemas/Localities_DetailsResult"
}
},
"type": "object",
"required": [
- "rows"
+ "result"
],
- "title": "MatrixResponse",
+ "title": "DetailsResponse",
+ "description": "Attributes describing a locality. Not all attributes are available for all locality types.",
"examples": [
{
- "rows": [
- {
- "elements": [
- {
- "distance": {
- "text": "10.8 km",
- "value": 10797
- },
- "duration": {
- "text": "16 mins",
- "value": 986
- },
- "status": "OK"
- },
- {
- "distance": {
- "text": "10.3 km",
- "value": 10334
- },
- "duration": {
- "text": "15 mins",
- "value": 928
- },
- "status": "OK"
- }
- ]
- }
- ],
- "status": "OK"
- }
- ]
- },
- "Distance_MatrixRowsResponse": {
- "properties": {
- "elements": {
- "items": {
- "anyOf": [
+ "result": {
+ "address_components": [
{
- "$ref": "#/components/schemas/Distance_DistanceResponse"
+ "long_name": "United Kingdom",
+ "short_name": "GB",
+ "types": [
+ "country",
+ "administrative_area_level_0",
+ "division_level_0"
+ ]
},
{
- "$ref": "#/components/schemas/Distance_DurationResponse"
+ "long_name": "England",
+ "short_name": "England",
+ "types": [
+ "state",
+ "division_level_1"
+ ]
},
{
- "$ref": "#/components/schemas/Distance_DurationDistanceResponse"
+ "long_name": "City of London",
+ "short_name": "City of London",
+ "types": [
+ "administrative_area_level_1",
+ "county",
+ "division_level_2"
+ ]
},
{
- "$ref": "#/components/schemas/Distance_BaseElementResponse"
+ "long_name": "Westminster",
+ "short_name": "Westminster",
+ "types": [
+ "district",
+ "division_level_3"
+ ]
+ },
+ {
+ "long_name": "London",
+ "short_name": "London",
+ "types": [
+ "locality"
+ ]
+ },
+ {
+ "long_name": "SW1A 0AA",
+ "short_name": "SW1A 0AA",
+ "types": [
+ "postal_codes"
+ ]
+ },
+ {
+ "long_name": "Houses Of Parliament",
+ "short_name": "Houses Of Parliament",
+ "types": [
+ "premise"
+ ]
+ },
+ {
+ "long_name": "House Of Commons",
+ "short_name": "House Of Commons",
+ "types": [
+ "organisation"
+ ]
+ }
+ ],
+ "formatted_address": "House Of Commons, Houses Of Parliament, London, SW1A 0AA",
+ "geometry": {
+ "accuracy": "ROOFTOP",
+ "location": {
+ "lat": 51.4998415,
+ "lng": -0.1246375
}
+ },
+ "public_id": "TVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPV9fTVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPQ==",
+ "types": [
+ "address"
]
- },
- "type": "array",
- "title": "Elements",
- "description": "An array of each route element."
- }
- },
- "type": "object",
- "required": [
- "elements"
- ],
- "title": "MatrixRowsResponse"
- },
- "Distance_Polyline": {
- "properties": {
- "points": {
- "type": "string",
- "title": "Points"
+ }
+ },
+ {
+ "result": {
+ "address_components": [
+ {
+ "long_name": "United Kingdom",
+ "short_name": "GB",
+ "types": [
+ "country",
+ "administrative_area_level_0",
+ "division_level_0"
+ ]
+ },
+ {
+ "long_name": "England",
+ "short_name": "England",
+ "types": [
+ "state",
+ "division_level_1"
+ ]
+ },
+ {
+ "long_name": "City of London",
+ "short_name": "City of London",
+ "types": [
+ "locality"
+ ]
+ },
+ {
+ "long_name": "SW1A 0AA",
+ "short_name": "SW1A 0AA",
+ "types": [
+ "postal_codes"
+ ]
+ }
+ ],
+ "formatted_address": "SW1A 0AA, City of London",
+ "geometry": {
+ "accuracy": "POSTAL_CODE",
+ "location": {
+ "lat": 51.49984,
+ "lng": -0.124663
+ }
+ },
+ "name": "SW1A 0AA",
+ "public_id": "cG9zdGFsX2NvZGU6Z2I6OmNDN0N0ZUF2MW9YRi9KLzlnS2cremJndktFaz0=",
+ "types": [
+ "postal_code"
+ ]
+ }
}
- },
- "type": "object",
- "required": [
- "points"
- ],
- "title": "Polyline"
+ ]
},
- "Distance_RouteDistanceDuration": {
+ "Localities_DetailsResult": {
"properties": {
- "value": {
- "type": "integer",
- "title": "Value"
+ "public_id": {
+ "type": "string",
+ "title": "Public Id",
+ "description": "Unique identifier for this place."
},
- "text": {
+ "types": {
+ "items": {
+ "$ref": "#/components/schemas/Localities_LocalityTypeAll"
+ },
+ "type": "array",
+ "title": "Types",
+ "description": "Available localities types."
+ },
+ "formatted_address": {
"type": "string",
- "title": "Text"
- }
- },
- "type": "object",
- "required": [
- "value",
- "text"
- ],
- "title": "RouteDistanceDuration"
- },
- "Distance_RouteInstruction": {
- "properties": {
- "action": {
+ "title": "Formatted Address",
+ "description": "Contains the readable text description of the result."
+ },
+ "name": {
"anyOf": [
{
- "type": "integer"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Action",
- "description": "The action to take for the current step (turn left, merge, straight, etc.). See [list of available actions](https://developers.woosmap.com/products/distance-api/route-endpoint/#instructions)."
+ "title": "Name",
+ "description": "The postal code name if result is a postal code."
},
- "type": {
+ "administrative_area_label": {
"anyOf": [
{
"type": "string"
@@ -20911,731 +21035,1211 @@
"type": "null"
}
],
- "title": "Type"
+ "title": "Administrative Area Label",
+ "description": "Only available for `admin_level` suggestions, this contains the local english name of the administration level (\"department\" for France or \"federal_state\" for Germany)."
},
- "summary": {
+ "status": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "const": "not_yet_built"
},
{
"type": "null"
}
],
- "title": "Summary",
- "description": "Written maneuver instruction."
+ "title": "Status",
+ "description": "This optional field is only available for UK addresses referenced as not yet built by Royal Mail. Only one value yet."
},
- "verbal_alert": {
+ "geometry": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/Localities_DetailsGeometry"
},
{
"type": "null"
}
],
- "title": "Verbal Alert",
- "description": "The transition alert instruction will prepare the user for the forthcoming transition."
+ "description": "The location of the PostalCode, in latitude and longitude, eventually associated with a Viewport and a shape."
},
- "verbal_succint": {
+ "address_components": {
"anyOf": [
{
- "type": "string"
+ "items": {
+ "$ref": "#/components/schemas/Localities_AddressComponent"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Verbal Succint",
- "description": "Text suitable for use as a verbal alert in a navigation application."
+ "title": "Address Components"
},
- "verbal_before": {
+ "categories": {
"anyOf": [
{
- "type": "string"
+ "items": {
+ "$ref": "#/components/schemas/Localities_LocalitiesTypesPoi"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "Verbal Before",
- "description": "Text suitable for use as a verbal message immediately prior to the maneuver transition."
+ "title": "Categories"
},
- "verbal_after": {
+ "addresses": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/Localities_PostalCodeAddresses"
},
{
"type": "null"
}
],
- "title": "Verbal After",
- "description": "Text suitable for use as a verbal message immediately after the maneuver transition."
+ "description": "For the UK only. When a postal code is returned, this field contains a list of addresses associated with this postal code."
}
},
"type": "object",
- "title": "RouteInstruction"
+ "required": [
+ "public_id",
+ "types",
+ "formatted_address"
+ ],
+ "title": "DetailsResult",
+ "description": "The Root Node for Localities Details"
},
- "Distance_RouteLeg": {
+ "Localities_GeocodeGeometry": {
"properties": {
- "distance": {
- "$ref": "#/components/schemas/Distance_RouteDistanceDuration",
- "description": "The total distance of this leg expressed in meters (value) and as text. The textual value uses the unit system specified with the `units` parameter."
+ "location": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Localities_Location"
+ },
+ {
+ "type": "null"
+ }
+ ]
},
- "duration": {
- "$ref": "#/components/schemas/Distance_RouteDistanceDuration",
- "description": "The total duration of this leg expressed in seconds (value) and as text. The textual value uses `lang` parameter if the langauge is available."
+ "viewport": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Localities_Viewport"
+ },
+ {
+ "type": "null"
+ }
+ ]
},
- "duration_without_traffic": {
+ "shape": {
"anyOf": [
{
- "$ref": "#/components/schemas/Distance_RouteDistanceDuration"
+ "$ref": "#/components/schemas/Localities_Shape"
},
{
"type": "null"
}
]
},
- "start_location": {
- "$ref": "#/components/schemas/Distance_LatLng",
- "description": "The starting location of this leg."
+ "location_type": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Localities_LocationTypeStr"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Specifies additional data about the geocoded location. The following values are currently supported: \n - `ROOFTOP` result is a precise geocode for which we have location information accurate down to street address precision.\n - `RANGE_INTERPOLATED` result reflects an approximation (usually on a road) interpolated between two precise points (such as intersections). Interpolated results are generally returned when rooftop geocodes are unavailable for a street address.\n - `GEOMETRIC_CENTER` result is the geometric center of a result such as a polyline (for example, a street) or polygon (city, region, …).\n - `APPROXIMATE` result is approximate (usually when no other above value applies)\n - `POSTAL_CODE` Address has inherited from the location of the postal code it is part of (for NYB addresses)\n - `DISTRICT` Address has inherited from the location of the district it is part of (for NYB addresses)",
+ "default": "GEOMETRIC_CENTER"
+ }
+ },
+ "type": "object",
+ "title": "GeocodeGeometry",
+ "description": "The location of the result, in latitude and longitude. Accuracy is also provided."
+ },
+ "Localities_GeocodeResponse": {
+ "properties": {
+ "results": {
+ "items": {
+ "$ref": "#/components/schemas/Localities_GeocodeResult"
+ },
+ "type": "array",
+ "title": "Results"
+ }
+ },
+ "type": "object",
+ "required": [
+ "results"
+ ],
+ "title": "GeocodeResponse",
+ "description": "Localities Geocode Collection Response. Contains one or more detailed Localities or\nAddresses in FR or in the UK, with coordinates (default to one result for reverse geocoding)",
+ "examples": [
+ {
+ "results": [
+ {
+ "address_components": [
+ {
+ "long_name": "France",
+ "short_name": "FR",
+ "types": [
+ "country",
+ "administrative_area_level_0",
+ "division_level_0"
+ ]
+ },
+ {
+ "long_name": "Île-de-France",
+ "short_name": "Île-de-France",
+ "types": [
+ "state",
+ "division_level_1"
+ ]
+ },
+ {
+ "long_name": "Paris",
+ "short_name": "Paris",
+ "types": [
+ "administrative_area_level_1",
+ "county",
+ "division_level_2"
+ ]
+ },
+ {
+ "long_name": "Paris",
+ "short_name": "Paris",
+ "types": [
+ "locality"
+ ]
+ },
+ {
+ "long_name": "75013",
+ "short_name": "75013",
+ "types": [
+ "postal_codes"
+ ]
+ },
+ {
+ "long_name": "Place Jeanne D'Arc",
+ "short_name": "Place Jeanne D'Arc",
+ "types": [
+ "route"
+ ]
+ }
+ ],
+ "formatted_address": "Place Jeanne D'Arc, 75013, Paris",
+ "geometry": {
+ "location": {
+ "lat": 48.829405,
+ "lng": 2.367944
+ },
+ "location_type": "GEOMETRIC_CENTER"
+ },
+ "public_id": "0+FTYd/1MsiBSxLAKq+/Fiyy+uM=",
+ "scores_per_components": {
+ "street_name": 1
+ },
+ "types": [
+ "address",
+ "route"
+ ]
+ }
+ ]
+ }
+ ]
+ },
+ "Localities_GeocodeResult": {
+ "properties": {
+ "public_id": {
+ "type": "string",
+ "title": "Public Id",
+ "description": "Unique identifier for this place."
},
- "end_location": {
- "$ref": "#/components/schemas/Distance_LatLng",
- "description": "The ending location of this leg."
+ "types": {
+ "items": {
+ "$ref": "#/components/schemas/Localities_LocalityTypeAll"
+ },
+ "type": "array",
+ "title": "Types",
+ "description": "An array containing the types of the result"
},
- "start_waypoint": {
+ "formatted_address": {
+ "type": "string",
+ "title": "Formatted Address",
+ "description": "Contains the readable text description of the result."
+ },
+ "name": {
"anyOf": [
{
- "type": "integer"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Start Waypoint",
- "description": "The index of the waypoint that is the starting point of this leg."
+ "title": "Name",
+ "description": "Name of the result when available"
},
- "end_waypoint": {
+ "address_components": {
"anyOf": [
{
- "type": "integer"
+ "items": {
+ "$ref": "#/components/schemas/Localities_AddressComponent"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "title": "End Waypoint",
- "description": "The index of the waypoint that is the ending point of this leg."
+ "title": "Address Components"
},
- "start_address": {
+ "administrative_area_label": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Administrative Area Label",
+ "description": "Only available for `admin_level` suggestions, this contains the local english name of the administration level (\"department\" for France or \"federal_state\" for Germany)."
+ },
+ "status": {
+ "anyOf": [
+ {
+ "type": "string",
+ "const": "not_yet_built"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Status",
+ "description": "This optional field is only available for UK addresses referenced as not yet built by Royal Mail."
+ },
+ "geometry": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Localities_GeocodeGeometry"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "scores_per_components": {
+ "anyOf": [
+ {
+ "additionalProperties": {
+ "type": "number"
+ },
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Scores Per Components",
+ "description": "For each component (street_name, postal_code, and locality), it indicates the degree of correspondence with the original query. This value ranges from 0 to 1, with 0 indicating no match with the original query, and enables you to assess the quality of the Geocode's result."
+ }
+ },
+ "type": "object",
+ "required": [
+ "public_id",
+ "types",
+ "formatted_address"
+ ],
+ "title": "GeocodeResult",
+ "description": "Attributes describing a locality. Not all attributes will be available for all locality types."
+ },
+ "Localities_Geometry": {
+ "properties": {
+ "location": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/Localities_Location"
},
{
"type": "null"
}
- ],
- "title": "Start Address",
- "description": "The address of the starting point of this leg."
+ ]
},
- "end_address": {
+ "viewport": {
"anyOf": [
{
- "type": "string"
+ "$ref": "#/components/schemas/Localities_Viewport"
},
{
"type": "null"
}
- ],
- "title": "End Address",
- "description": "The address of the ending point of this leg."
+ ]
},
- "steps": {
+ "shape": {
"anyOf": [
{
- "items": {
- "$ref": "#/components/schemas/Distance_RouteStep"
- },
- "type": "array"
+ "$ref": "#/components/schemas/Localities_Shape"
},
{
"type": "null"
}
- ],
- "title": "Steps",
- "description": "List of steps steps for this leg.\nSteps are returned when `details=full`. A step is the most atomic unit of a route, containing a single step describing a specific, single instruction on the journey. The step not only describes the instruction but also contains distance and duration information relating to how this step relates to the following step.\n "
+ ]
+ }
+ },
+ "type": "object",
+ "title": "Geometry"
+ },
+ "Localities_HTTPErrorModel": {
+ "properties": {
+ "detail": {
+ "type": "string",
+ "title": "Detail"
}
},
"type": "object",
"required": [
- "distance",
- "duration",
- "start_location",
- "end_location"
+ "detail"
],
- "title": "RouteLeg"
+ "title": "HTTPErrorModel"
},
- "Distance_RouteOption": {
+ "Localities_HTTPValidationError": {
"properties": {
- "overview_polyline": {
- "$ref": "#/components/schemas/Distance_Polyline",
- "description": "The polyline of the route (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm))."
- },
- "bounds": {
- "$ref": "#/components/schemas/Distance_Bounds",
- "description": "A rectangle in geographical coordinates from points at the southwest and northeast corners."
- },
- "notice": {
- "type": "string",
- "title": "Notice",
- "description": "Some noticeable information about the route."
- },
- "legs": {
+ "detail": {
"items": {
- "$ref": "#/components/schemas/Distance_RouteLeg"
+ "$ref": "#/components/schemas/Localities_ValidationError"
},
"type": "array",
- "title": "Legs",
- "description": "Contains an array of sections of the route."
+ "title": "Detail"
+ }
+ },
+ "type": "object",
+ "title": "HTTPValidationError"
+ },
+ "Localities_LocalitiesInput": {
+ "type": "string",
+ "maxLength": 150
+ },
+ "Localities_LocalitiesTypes": {
+ "type": "string",
+ "enum": [
+ "country",
+ "admin_level",
+ "admin_level_1",
+ "admin_level_2",
+ "admin_level_3",
+ "postal_code",
+ "address",
+ "route",
+ "locality",
+ "city",
+ "town",
+ "village",
+ "hamlet",
+ "borough",
+ "suburb",
+ "quarter",
+ "neighbourhood"
+ ],
+ "title": "LocalitiesTypes"
+ },
+ "Localities_LocalitiesTypesPoi": {
+ "type": "string",
+ "enum": [
+ "point_of_interest",
+ "beach",
+ "government",
+ "park",
+ "park.national",
+ "place_of_worship",
+ "police",
+ "post_office",
+ "sports",
+ "sports.golf",
+ "sports.winter",
+ "transit",
+ "transit.station",
+ "transit.station.airport",
+ "transit.station.rail",
+ "transit.station.rail.subway",
+ "transit.station.rail.train",
+ "transit.station.rail.light_rail",
+ "transit.station.rail.monorail",
+ "transit.station.rail.funicular",
+ "transit.station.rail.tram",
+ "business",
+ "business.car_repair",
+ "business.car_rental",
+ "business.cinema",
+ "business.conference_centre",
+ "business.exhibition_centre",
+ "business.theatre",
+ "business.nightclub",
+ "business.finance",
+ "business.finance.bank",
+ "business.fuel",
+ "business.parking",
+ "business.mall",
+ "business.food_and_drinks",
+ "business.food_and_drinks.bar",
+ "business.food_and_drinks.biergarten",
+ "business.food_and_drinks.cafe",
+ "business.food_and_drinks.fast_food",
+ "business.food_and_drinks.pub",
+ "business.food_and_drinks.restaurant",
+ "business.food_and_drinks.food_court",
+ "business.shop",
+ "business.shop.mall",
+ "business.shop.bakery",
+ "business.shop.butcher",
+ "business.shop.library",
+ "business.shop.grocery",
+ "business.shop.sports",
+ "business.shop.toys",
+ "business.shop.clothes",
+ "business.shop.furniture",
+ "business.shop.electronics",
+ "business.shop.doityourself",
+ "business.shop.craft",
+ "education",
+ "education.school",
+ "education.kindergarten",
+ "education.university",
+ "education.college",
+ "education.library",
+ "hospitality",
+ "hospitality.hotel",
+ "hospitality.hostel",
+ "hospitality.guest_house",
+ "hospitality.bed_and_breakfast",
+ "hospitality.motel",
+ "medical",
+ "medical.hospital",
+ "medical.pharmacy",
+ "medical.clinic",
+ "tourism",
+ "tourism.art_gallery",
+ "tourism.attraction",
+ "tourism.attraction.amusement_park",
+ "tourism.attraction.zoo",
+ "tourism.attraction.aquarium",
+ "tourism.monument",
+ "tourism.monument.castle",
+ "tourism.museum"
+ ],
+ "title": "LocalitiesTypesPoi"
+ },
+ "Localities_LocalitiesTypesPoiAlias": {
+ "type": "string",
+ "enum": [
+ "airport",
+ "train_station",
+ "metro_station",
+ "shopping",
+ "museum",
+ "zoo",
+ "amusement_park",
+ "art_gallery",
+ "tourist_attraction"
+ ],
+ "title": "LocalitiesTypesPoiAlias"
+ },
+ "Localities_LocalityTypeAll": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Localities_LocalitiesTypes"
},
- "main_route_name": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Main Route Name",
- "description": "The main route name based on the longest step length to differentiate routes when alternates are returned."
+ {
+ "$ref": "#/components/schemas/Localities_LocalitiesTypesPoi"
},
- "recommended": {
- "anyOf": [
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "title": "Recommended",
- "description": "Only present and set to true when the route is the recommended route."
+ {
+ "$ref": "#/components/schemas/Localities_LocalitiesTypesPoiAlias"
+ }
+ ]
+ },
+ "Localities_Location": {
+ "properties": {
+ "lat": {
+ "type": "number",
+ "title": "Lat"
+ },
+ "lng": {
+ "type": "number",
+ "title": "Lng"
}
},
"type": "object",
"required": [
- "overview_polyline",
- "bounds",
- "notice",
- "legs"
+ "lat",
+ "lng"
],
- "title": "RouteOption"
+ "title": "Location"
},
- "Distance_RouteResponse": {
+ "Localities_LocationTypeStr": {
+ "type": "string",
+ "enum": [
+ "ROOFTOP",
+ "APPROXIMATE",
+ "RANGE_INTERPOLATED",
+ "GEOMETRIC_CENTER",
+ "POSTAL_CODE",
+ "DISTRICT"
+ ]
+ },
+ "Localities_MatchedPosition": {
"properties": {
- "status": {
- "type": "string",
- "enum": [
- "OK",
- "INVALID_REQUEST",
- "MAX_ELEMENTS_EXCEEDED",
- "MAX_ROUTE_LENGTH_EXCEEDED",
- "REQUEST_DENIED",
- "BACKEND_ERROR",
- "OVER_QUERY_LIMIT",
- "ZERO_RESULTS"
- ],
- "title": "Status",
- "description": "The status of the response\n* `OK`: The response contains a valid result.\n* `INVALID_REQUEST`: The request could not be processed.\n* `MAX_ELEMENTS_EXCEEDED`: The product of origins and destinations exceeds the per-query limit (fixed at 200 elts/query).\n* `MAX_ROUTE_LENGTH_EXCEEDED`: One of requested routes is too long and the matrix/route cannot be processed (The limit is 500km).\n* `REQUEST_DENIED`: The API key provided is invalid or does not allow access to this service etc..\n* `BACKEND_ERROR`: The server encountered an unexpected error.\n* `OVER_QUERY_LIMIT`: The request was denied due to the rate limit (see [Usage Limits](https://developers.woosmap.com/products/distance-api/distance-matrix-endpoint/#usage-limits)).\n* `ZERO_RESULTS`: No route could be found between the origin and destination.\n ",
- "default": "OK"
+ "offset": {
+ "type": "integer",
+ "title": "Offset"
},
- "routes": {
+ "length": {
+ "type": "integer",
+ "title": "Length"
+ }
+ },
+ "type": "object",
+ "required": [
+ "offset",
+ "length"
+ ],
+ "title": "MatchedPosition"
+ },
+ "Localities_MatchedSubstrings": {
+ "properties": {
+ "description": {
+ "items": {
+ "$ref": "#/components/schemas/Localities_MatchedPosition"
+ },
+ "type": "array",
+ "title": "Description",
+ "description": "Substrings of `description` that match the `input`, each given as an `offset` and `length`."
+ }
+ },
+ "type": "object",
+ "required": [
+ "description"
+ ],
+ "title": "MatchedSubstrings"
+ },
+ "Localities_NearbyResponse": {
+ "properties": {
+ "results": {
"items": {
- "$ref": "#/components/schemas/Distance_RouteOption"
+ "$ref": "#/components/schemas/Localities_NearbyResult"
},
"type": "array",
- "title": "Routes",
- "description": "Contains an array of route options if `alternatives=true` else a single route."
+ "title": "Results",
+ "description": "The array of nearby points of interest."
+ },
+ "pagination": {
+ "$ref": "#/components/schemas/Localities_Pagination",
+ "description": "Helps to navigate through paginated results."
}
},
"type": "object",
"required": [
- "routes"
+ "results",
+ "pagination"
],
- "title": "RouteResponse",
+ "title": "NearbyResponse",
+ "description": "Collection of nearby points of interest.",
"examples": [
{
- "routes": [
+ "pagination": {
+ "next_page": 4,
+ "previous_page": 2
+ },
+ "results": [
{
- "bounds": {
- "northeast": {
- "lat": 49.315678,
- "lng": 4.15292
+ "address_components": [
+ {
+ "long_name": "United States",
+ "short_name": "US",
+ "types": [
+ "country",
+ "administrative_area_level_0",
+ "division_level_0"
+ ]
},
- "southwest": {
- "lat": 49.31073,
- "lng": 4.145162
+ {
+ "long_name": "New York",
+ "short_name": "New York",
+ "types": [
+ "locality"
+ ]
+ },
+ {
+ "long_name": "Broadway",
+ "short_name": "Broadway",
+ "types": [
+ "route"
+ ]
+ }
+ ],
+ "categories": [
+ "business.food_and_drinks.fast_food"
+ ],
+ "formatted_address": "Broadway, New York",
+ "geometry": {
+ "location": {
+ "lat": 40.715905992166256,
+ "lng": -74.00508673226767
}
},
- "legs": [
+ "name": "Pret A Manger",
+ "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6ZTc2ZDA1YzBiM2M0M2NmNmVkNTJjNGQyZDFiZDE3Nzc0OTZkNjlmOA==",
+ "types": [
+ "point_of_interest",
+ "business.food_and_drinks.fast_food"
+ ]
+ },
+ {
+ "address_components": [
{
- "distance": {
- "text": "1 km",
- "value": 1038
- },
- "duration": {
- "text": "1 min",
- "value": 75
- },
- "end_address": "D 30",
- "end_location": {
- "lat": 49.31344,
- "lng": 4.15293
- },
- "end_waypoint": 1,
- "start_address": "D 151",
- "start_location": {
- "lat": 49.31067,
- "lng": 4.14525
- },
- "start_waypoint": 0,
- "steps": [
- {
- "distance": "676 m",
- "duration": "1 min",
- "end_location": {
- "lat": 49.315679,
- "lng": 4.149621
- },
- "instructions": {
- "action": 2,
- "summary": "Drive northeast on D 151.",
- "verbal_after": "Continue for 700 meters.",
- "verbal_before": "Drive northeast on D 151. Then Enter the roundabout and take the 2nd exit onto D 30.",
- "verbal_succint": "Drive northeast. Then Enter the roundabout and take the 2nd exit onto D 30."
- },
- "polyline": "a_~kHgrhXu@yAe@y@c@q@e@q@c@o@e@m@y@eAa@g@a@c@Y[UUQQYUQOSOQKSKOKQISIWKSEUEMCQAa@CeA@[E}@EUAOEOGKKIOM[I]Ea@A[?Q",
- "start_location": {
- "lat": 49.31073,
- "lng": 4.145163
- },
- "travel_mode": "DRIVING"
- },
- {
- "distance": "22 m",
- "duration": "1 min",
- "end_location": {
- "lat": 49.31563,
- "lng": 4.149905
- },
- "instructions": {
- "action": 26,
- "summary": "Enter the roundabout and take the 2nd exit onto D 30.",
- "verbal_alert": "Enter the roundabout and take the 2nd exit onto D 30.",
- "verbal_before": "Enter the roundabout and take the 2nd exit onto D 30.",
- "verbal_succint": "Enter the roundabout and take the 2nd exit."
- },
- "polyline": "}}~kHcniXBIBU?W",
- "start_location": {
- "lat": 49.315679,
- "lng": 4.149621
- },
- "travel_mode": "DRIVING"
- },
- {
- "distance": "198 m",
- "duration": "1 min",
- "end_location": {
- "lat": 49.314292,
- "lng": 4.151623
- },
- "instructions": {
- "action": 27,
- "summary": "Exit the roundabout onto D 30.",
- "verbal_after": "Continue for 200 meters.",
- "verbal_before": "Exit the roundabout onto D 30.",
- "verbal_succint": "Exit the roundabout."
- },
- "polyline": "u}~kH{oiXFWDOLUP[P]j@y@^g@`@i@NUNONMJKJIFELC",
- "start_location": {
- "lat": 49.31563,
- "lng": 4.149905
- },
- "travel_mode": "DRIVING"
- },
- {
- "distance": "46 m",
- "duration": "1 min",
- "end_location": {
- "lat": 49.314041,
- "lng": 4.151976
- },
- "instructions": {
- "action": 26,
- "summary": "Enter the roundabout and take the 1st exit onto D 30.",
- "verbal_alert": "Enter the roundabout and take the 1st exit onto D 30.",
- "verbal_before": "Enter the roundabout and take the 1st exit onto D 30.",
- "verbal_succint": "Enter the roundabout and take the 1st exit."
- },
- "polyline": "iu~kHsziXJBJAHGFIDMBSAS",
- "start_location": {
- "lat": 49.314292,
- "lng": 4.151623
- },
- "travel_mode": "DRIVING"
- },
- {
- "distance": "96 m",
- "duration": "1 min",
- "end_location": {
- "lat": 49.313434,
- "lng": 4.152921
- },
- "instructions": {
- "action": 27,
- "summary": "Exit the roundabout onto D 30.",
- "verbal_after": "Continue for 100 meters.",
- "verbal_before": "Exit the roundabout onto D 30. Then, in 100 meters, You will arrive at your destination.",
- "verbal_succint": "Exit the roundabout. Then, in 100 meters, You will arrive at your destination."
- },
- "polyline": "ws~kHy|iXBKDILURa@LWt@eAHQ",
- "start_location": {
- "lat": 49.314041,
- "lng": 4.151976
- },
- "travel_mode": "DRIVING"
- },
- {
- "distance": "1 m",
- "duration": "1 min",
- "end_location": {
- "lat": 49.313434,
- "lng": 4.152921
- },
- "instructions": {
- "action": 4,
- "summary": "You have arrived at your destination.",
- "verbal_alert": "You will arrive at your destination.",
- "verbal_before": "You have arrived at your destination."
- },
- "polyline": "}o~kHwbjX",
- "start_location": {
- "lat": 49.313434,
- "lng": 4.152921
- },
- "travel_mode": "DRIVING"
- }
+ "long_name": "United States",
+ "short_name": "US",
+ "types": [
+ "country",
+ "administrative_area_level_0",
+ "division_level_0"
+ ]
+ },
+ {
+ "long_name": "New York",
+ "short_name": "New York",
+ "types": [
+ "locality"
+ ]
+ },
+ {
+ "long_name": "Thomas Street",
+ "short_name": "Thomas Street",
+ "types": [
+ "route"
]
}
],
- "notice": "",
- "overview_polyline": {
- "points": "a_~kHgrhXu@yAe@y@c@q@e@q@c@o@e@m@y@eAa@g@a@c@Y[UUQQYUQOSOQKSKOKQISIWKSEUEMCQAa@CeA@[E}@EUAOEOGKKIOM[I]Ea@A[?QBIBU?WFWDOLUP[P]j@y@^g@`@i@NUNONMJKJIFELCJBJAHGFIDMBSASBKDILURa@LWt@eAHQ"
- }
+ "categories": [
+ "business.theatre"
+ ],
+ "formatted_address": "Thomas Street, New York",
+ "geometry": {
+ "location": {
+ "lat": 40.71609349534023,
+ "lng": -74.00589281989586
+ }
+ },
+ "name": "The Flea",
+ "public_id": "cG9pOnVzOmJ1c2luZXNzLnRoZWF0cmU6MTU1Yjk5YmEwY2FiYzIzZjYxYWYyYTViYzI0ZDViYTVlNmVmZTAwNA==",
+ "types": [
+ "point_of_interest",
+ "business.theatre"
+ ]
}
- ],
- "status": "OK"
+ ]
}
]
},
- "Distance_RouteStep": {
+ "Localities_NearbyResult": {
"properties": {
- "distance": {
+ "public_id": {
"type": "string",
- "title": "Distance",
- "description": "The distance as text covered by this step until the next step."
+ "title": "Public Id",
+ "description": "Unique identifier for this place."
},
- "duration": {
- "type": "string",
- "title": "Duration",
- "description": "The typical time as text required until the next step."
+ "types": {
+ "items": {
+ "$ref": "#/components/schemas/Localities_LocalitiesTypesPoi"
+ },
+ "type": "array",
+ "title": "Types",
+ "description": "An array containing the types of the result."
},
- "polyline": {
- "type": "string",
- "title": "Polyline",
- "description": "The polyline of the step (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm))."
+ "categories": {
+ "items": {
+ "$ref": "#/components/schemas/Localities_LocalitiesTypesPoi"
+ },
+ "type": "array",
+ "title": "Categories",
+ "description": "An array containing the categories of the result. This information is now available in the `types` field and will be removed.",
+ "deprecated": true
},
- "start_location": {
- "$ref": "#/components/schemas/Distance_LatLng",
- "description": "The starting location of this step."
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The name of the result."
},
- "end_location": {
- "$ref": "#/components/schemas/Distance_LatLng",
- "description": "The ending location of this step."
+ "formatted_address": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Formatted Address",
+ "description": "Contains the readable text description of the result."
},
- "travel_mode": {
- "type": "string",
- "title": "Travel Mode",
- "description": "The travel mode of this step."
+ "geometry": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Localities_Geometry"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "The location of the result, in latitude and longitude, eventually associated with a Viewport."
},
- "instructions": {
+ "address_components": {
"anyOf": [
{
- "$ref": "#/components/schemas/Distance_RouteInstruction"
+ "items": {
+ "$ref": "#/components/schemas/Localities_AddressComponent"
+ },
+ "type": "array"
},
{
"type": "null"
}
],
- "description": "The maneuver instructions for this step."
+ "title": "Address Components"
}
},
"type": "object",
"required": [
- "distance",
- "duration",
- "polyline",
- "start_location",
- "end_location",
- "travel_mode"
+ "public_id",
+ "types",
+ "categories",
+ "name"
],
- "title": "RouteStep"
+ "title": "NearbyResult",
+ "description": "Attributes describing a point of interest."
},
- "Distance_TollLeg": {
+ "Localities_Pagination": {
"properties": {
- "distance": {
- "$ref": "#/components/schemas/Distance_RouteDistanceDuration"
+ "previous_page": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Previous Page",
+ "description": "If previous results are available, this will contain the value to pass to the `page` parameter to get the previous page"
},
- "duration": {
- "$ref": "#/components/schemas/Distance_RouteDistanceDuration"
+ "next_page": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Next Page",
+ "description": "If more results are available, this will contain the value to pass to the `page` parameter to get the next page"
+ }
+ },
+ "type": "object",
+ "required": [
+ "previous_page",
+ "next_page"
+ ],
+ "title": "Pagination"
+ },
+ "Localities_PostalCodeAddressPagination": {
+ "properties": {
+ "page": {
+ "type": "integer",
+ "title": "Page",
+ "description": "the request page",
+ "deprecated": true
},
- "start_location": {
- "$ref": "#/components/schemas/Distance_LatLng"
+ "page_count": {
+ "type": "integer",
+ "title": "Page Count",
+ "description": "the number of available pages",
+ "deprecated": true
},
- "end_location": {
- "$ref": "#/components/schemas/Distance_LatLng"
+ "addresses_per_page": {
+ "type": "integer",
+ "title": "Addresses Per Page",
+ "description": "the number of available addresses per page",
+ "deprecated": true
},
- "tolls": {
- "items": {
- "$ref": "#/components/schemas/Distance_TollStep"
- },
- "type": "array",
- "title": "Tolls"
+ "address_count": {
+ "type": "integer",
+ "title": "Address Count",
+ "description": "the number of available addresses",
+ "deprecated": true
+ }
+ },
+ "type": "object",
+ "required": [
+ "page",
+ "page_count",
+ "addresses_per_page",
+ "address_count"
+ ],
+ "title": "PostalCodeAddressPagination"
+ },
+ "Localities_PostalCodeAddresses": {
+ "properties": {
+ "pagination": {
+ "$ref": "#/components/schemas/Localities_PostalCodeAddressPagination",
+ "description": "The pagination part of the response is deprecated as all the addresses are now automatically returned in the response. It will be turned off at some point. From now on, the pagination will systematically return `page=1`, `page_count=1`, `addresses_per_page=total addresses count` and `address_count=total addresses count`.",
+ "deprecated": true
},
- "tollSystems": {
+ "list": {
"items": {
- "$ref": "#/components/schemas/Distance_TollSystem"
+ "$ref": "#/components/schemas/Localities_AddressSummary"
},
"type": "array",
- "title": "Tollsystems"
+ "title": "List",
+ "description": "List of addresses"
}
},
"type": "object",
"required": [
- "distance",
- "duration",
- "start_location",
- "end_location",
- "tolls",
- "tollSystems"
+ "pagination",
+ "list"
],
- "title": "TollLeg"
- },
- "Distance_TollStep": {
- "properties": {},
- "additionalProperties": true,
- "type": "object",
- "title": "TollStep"
- },
- "Distance_TollSystem": {
- "properties": {},
- "additionalProperties": true,
- "type": "object",
- "title": "TollSystem"
+ "title": "PostalCodeAddresses"
},
- "Distance_TollsResponse": {
+ "Localities_Related": {
"properties": {
- "status": {
- "type": "string",
- "title": "Status"
- },
- "routes": {
+ "postal_codes": {
"items": {
- "$ref": "#/components/schemas/Distance_TollsRoute"
+ "$ref": "#/components/schemas/Localities_RelatedPostalCode"
},
"type": "array",
- "title": "Routes"
+ "title": "Postal Codes",
+ "description": "Postal codes related to the locality suggestion."
}
},
"type": "object",
"required": [
- "status",
- "routes"
- ],
- "title": "TollsResponse",
- "examples": [
- {
- "routes": [
- {
- "bounds": {
- "northeast": {
- "lat": 45.72083,
- "lng": 4.89669
- },
- "southwest": {
- "lat": 43.7022,
- "lng": 4.11696
- }
- },
- "legs": [
- {
- "distance": {
- "text": "272 km",
- "value": 272038
- },
- "duration": {
- "text": "2 hours 27 mins",
- "value": 8793
- },
- "end_location": {
- "lat": 45.7196995,
- "lng": 4.848819
- },
- "start_location": {
- "lat": 43.7037977,
- "lng": 4.121733
- },
- "tollSystems": [
- {
- "id": 7607,
- "name": "ASF"
- }
- ],
- "tolls": [
- {
- "countryCode": "FRA",
- "fares": [
- {
- "id": "50d47ca7-59a3-4efd-b009-7a374aec7b21",
- "name": "ASF",
- "paymentMethods": [
- "cash",
- "bankCard",
- "creditCard",
- "transponder",
- "travelCard"
- ],
- "price": {
- "currency": "EUR",
- "type": "value",
- "value": 28.7
- },
- "reason": "toll",
- "transponders": [
- {
- "system": "BipandGo"
- },
- {
- "system": "BipandGo"
- },
- {
- "system": "BipandGo IDVROOM carpoorling"
- },
- {
- "system": "Cito30"
- },
- {
- "system": "Easytrip pass"
- },
- {
- "system": "Liane 30"
- },
- {
- "system": "Liber-t"
- },
- {
- "system": "Liber-t mobilitis"
- },
- {
- "system": "Pass Pont-Pont"
- },
- {
- "system": "Progressivi'T Maurienne"
- },
- {
- "system": "TopEurop"
- },
- {
- "system": "Tunnel Pass+"
- },
- {
- "system": "Ulys"
- },
- {
- "system": "Ulys Europe"
- },
- {
- "system": "VIA-T"
- },
- {
- "system": "Viaduc-t 30"
- }
- ]
- }
- ],
- "tollCollectionLocations": [
- {
- "location": {
- "lat": 43.70283,
- "lng": 4.11987
- },
- "name": "MONTPELLIER (M.EST)"
- },
- {
- "location": {
- "lat": 45.4761,
- "lng": 4.83378
- },
- "name": "VIENNE"
- }
- ],
- "tollSystem": "ASF",
- "tollSystemRef": 0,
- "tollSystems": [
- 0
- ]
- }
+ "postal_codes"
+ ],
+ "title": "Related"
+ },
+ "Localities_RelatedPostalCode": {
+ "properties": {
+ "public_id": {
+ "type": "string",
+ "title": "Public Id"
+ },
+ "description": {
+ "type": "string",
+ "title": "Description"
+ }
+ },
+ "type": "object",
+ "required": [
+ "public_id",
+ "description"
+ ],
+ "title": "RelatedPostalCode"
+ },
+ "Localities_ReverseGeocodeResponse": {
+ "properties": {
+ "results": {
+ "items": {
+ "$ref": "#/components/schemas/Localities_ReverseGeocodeResult"
+ },
+ "type": "array",
+ "title": "Results"
+ }
+ },
+ "type": "object",
+ "required": [
+ "results"
+ ],
+ "title": "ReverseGeocodeResponse",
+ "description": "Localities Geocode Collection Response. Contains one or more detailed Localities or\nAddresses in FR or in the UK, with coordinates (default to one result for reverse geocoding)",
+ "examples": [
+ {
+ "results": [
+ {
+ "address_components": [
+ {
+ "long_name": "United Kingdom",
+ "short_name": "GB",
+ "types": [
+ "country",
+ "administrative_area_level_0",
+ "division_level_0"
+ ]
+ },
+ {
+ "long_name": "England",
+ "short_name": "England",
+ "types": [
+ "state",
+ "division_level_1"
+ ]
+ },
+ {
+ "long_name": "City of London",
+ "short_name": "City of London",
+ "types": [
+ "administrative_area_level_1",
+ "county",
+ "division_level_2"
+ ]
+ },
+ {
+ "long_name": "Westminster",
+ "short_name": "Westminster",
+ "types": [
+ "district",
+ "division_level_3"
+ ]
+ },
+ {
+ "long_name": "London",
+ "short_name": "London",
+ "types": [
+ "locality"
+ ]
+ },
+ {
+ "long_name": "W2 5ER",
+ "short_name": "W2 5ER",
+ "types": [
+ "postal_codes"
+ ]
+ },
+ {
+ "long_name": "Alfred Road",
+ "short_name": "Alfred Road",
+ "types": [
+ "route"
+ ]
+ },
+ {
+ "long_name": "Radway House",
+ "short_name": "Radway House",
+ "types": [
+ "premise"
]
}
],
- "overview_polyline": {
- "points": "u{viGy_dXDAFGDEDIBMBO@U?QAQAIGWEIIKKGIAQ?I?ODGFKLEHETCZ@Z@JBNHLDDJHJDF@L@J?LBHBJBNLPVXh@Pd@|@dDNd@Jb@HTV~@t@lCD\\DRFXDVDVBV@T?VARAPEZGTKRKNIJIFKDIBI@I@M?MCQISOQOSQ]_@]WqBqCeAwAe@o@Ya@s@cAoBkCgA}AkBoCeCyDw@sA}CkFoA{BeBaD[m@iAuByAmCk@eA_@s@{@aBk@gAmA_C_AkBkC_FiAwBe@{@}HiO_EyHsB_Ea@w@c@y@iBkDiAwBsFkKa@y@_@u@c@{@a@w@]q@Yk@[o@_@u@_@w@a@{@[q@]w@]y@_@}@]{@[y@[{@[}@[_AY{@Y}@Y_AUw@W}@W}@U_AQu@Qu@Qw@S_AOq@Ow@UkAQaAOw@QgAIc@U}AMaAOiAMeAMgAKaAGm@I}@IaAIcAIgAG}@Eq@GiAGoAEcACo@Cu@EwAEcBCaBCkCAmBAkBCaIAuIAiCAeBAeAA}@AcAC_BC}AEkBE_BEyAEsAGaBG{AGsAGoAGmAGkAGgAIuAGcAG_AG}@IiAIgAIaAKmAMsAMsAk@mGK}@i@yEKu@_@uCAKWgBU}ASoAUwAWaBgAkGUsAWuAWoA]wA[kAMe@Mc@Qm@Ss@Oc@Uq@Si@Oe@Oa@Qc@Qc@O]eAaCoAcCmAuBc@s@}A}BsAcB}@eAu@w@i@i@q@m@kB}AUQk@a@{@m@q@a@u@c@aAg@u@]s@[w@[}Bu@aA[oBi@sBq@mDeA_Cy@gCgA_Aa@iAk@cAi@aBaAmAw@eAs@c@Ws@i@sBcByAsAUUsAoAwB_CiBwBqCwDoAiB_A{Am@eAa@q@gAqBoBgEqAyCmA_DiAcDgAeDW}@K]EOc@}AGSe@qBOk@Qw@]aBQ}@Ow@Oy@Ic@Ii@Km@Ig@U{AM}@Iq@Gg@Is@MmAKgAI_AIaAEi@Em@Eo@IuAGmAIcBEgAEyAEaBC_BA_B?q@?uA?cA@yA?i@@oAB_BFoBBu@Bs@D_ADw@H{AFcAHqAF_ADo@Fu@Di@Fy@HkAJwATiDTsCb@kGTaDJwA\\uE^kFTaD`@uFh@uH\\aFX_Ef@cHZqENkCHkBBy@@_@@q@BqB@_B?oAA{ACuACcAG{ACk@Ew@Ci@IoAIaAMkAKaAQuAQqA]uBOy@G[Os@Os@Oo@a@}AWaAQo@e@}Aa@mAi@wAq@aBg@iAm@qAWe@}@}AMUQYw@iAgBcC{@eASUq@s@mAkA{@y@eDwCwCkC][i@e@_BsAw@q@w@q@mC_CqBgBqBeBgB}AkAeA_CsBwC_CqBuAaBiAsAw@kAs@mBcAoAq@}BqAeBkAwBcByAqAq@o@a@e@{@aAm@u@o@y@q@aAc@q@k@_Am@eAk@gAYk@g@eA_@{@]y@Ws@Uo@[cAYaAOi@Qo@W_ASo@Qo@K][gA[iAc@}A_@oA[cA[aAc@qAm@gBi@yAe@qAe@kAe@eAk@qAi@iAm@mAg@cA{@_Bc@s@_@o@q@iAk@y@u@kA{@mAu@cAw@cAy@cA]a@SUs@w@aAcAi@i@o@k@a@c@w@s@mAgAy@q@e@a@oC_CwDcDaBwAu@s@cAeAe@e@oAyA{AeBq@{@q@{@q@}@g@s@eA}AYc@k@_AcAcBy@yAk@cAo@iA_CeEm@eAk@_AgAcBWc@W_@]e@a@i@a@i@_@e@c@i@e@k@c@e@e@i@k@o@e@g@iAkA_GiG_DcDwD}DmBmBsAuAs@o@o@m@aByAm@i@cA}@s@k@o@i@mByAgDeCoBwAqBwAYSuAeAm@i@_@_@i@g@c@a@YY{@_AiAsAe@o@[c@w@kA}@{Au@uAw@_Bq@}Aq@gB]_Aa@oA_@sAi@qBm@sCUkAKk@Mw@OaAUiB[mCMiASsBEa@g@{EEe@K_AGk@y@uHYeCGe@cAiIYyB[yBMw@OaAYkBUuAYcB[iBa@yBWuAa@sBuC_Na@iBi@{BmBaI_AyDqBcIkAaF}@_EuAmGo@sCo@mDo@kDG]Ie@E]]cBSkAWwAEW[yBM{@EUc@qCIa@e@mCi@uDm@qDk@qDIe@c@gCk@mD[iBKu@G[c@gCIi@Ig@c@_Co@mDSkASeA[cBSgAq@eDCMm@aDmA_Gu@iDs@cDw@oDQw@GY]uAw@eDy@iDyAwFe@kBqAwEw@sCy@sCw@oCm@qBUu@{@qC}@uCgAiDeAcDgAcDmAiDkAcDy@}Bs@kBc@kAc@iAm@}Ak@}As@iBi@qAk@wA[u@_@{@Ui@eAkCeAcC_CsFaFeL}CeHmAqC}@qBeAaCcA}BkAoCmAsCoAuCwAiDu@iB}A{DmA{CeAqCgAsCkAaDc@kASk@Sk@cAuCsB}FcCgHkDgKaByEWu@Ws@Uo@ISIUM[Oa@[w@a@aAi@mAi@kAo@sAs@uAi@_Au@sAq@gAw@iAiAaBe@m@g@o@m@s@e@k@k@m@aAaAu@u@o@k@q@o@e@a@a@]e@_@c@]o@e@WQ]UYQw@e@u@a@q@a@g@WYOi@YoAm@oAq@WMUK[MYM]OSIKEMGIEECIEICMI]QcAe@s@[sDeBq@[s@]k@Yk@[k@[o@]m@a@c@Yi@_@m@c@g@_@{@q@w@o@_Aw@}@w@oBeBwCiCwAoA[[mC_CcB{A{AsAgB_B_Ay@WSkBcBa@]_BuAsEcEw@o@{@y@u@q@gBaB_@]oAiAqBcBgB{AmBeBmBcBkAgAs@m@OM_@[k@g@cA}@oBeBkBcBaByAyBoBcA}@yAsAg@e@w@u@i@g@s@s@aAaAg@i@g@i@k@m@g@m@e@k@a@g@e@m@k@u@m@w@m@w@k@{@i@w@i@y@e@s@e@w@e@w@c@w@g@}@a@u@a@w@a@u@_@w@[o@_@y@Wk@[s@Ys@Ys@[w@Wq@Yu@a@gAgA{CmAqDoA_EaA{CkAwDmAyDeAcDq@uBY_AcBkFy@iCu@aCs@_Ce@wAw@gC]eAm@kBi@gBwAwEi@iB]oAu@uCq@qC[yA[{AWsAYcBa@}CYuBUgBW_CUaCOmBO{BO{CSaFK}DEkBEqBIyDGgEGiCMeEKqCKcCI}AIqAGy@Ei@Ei@Go@I_AKmAMwAKmAO{AKcAOsAOoAM}@K}@K{@OiAKu@QqA_@mCe@_Di@kDSgA]oBUsAUkAWsAWsA]cB_@gB_@eBm@oC_@cBaA{Dy@cD_AmDgAyDaAeDcAcDoAyDeA{CoAmDgAuCmAcDsA_Dy@mBo@yAmAmC{AcDg@eAYm@wAsCg@aAm@iAa@u@g@}@_@o@_@q@c@u@e@w@q@eAy@sAw@oAy@oA_AyAyAyBeBiCeBiCiBsCYc@Yc@c@s@Ua@i@_AwAkCe@aAcAuBkAqCi@sAe@sAu@yBe@yAs@cC[iAc@eB{@qDg@aCWqAm@iDKm@QeAQkAIk@UaBa@gD]wD]gDWcDK{AEk@OsBIsAG_Ai@}IIuAIaBQuC[{E_@cH]eGGoAU{DSuDGaAWiEOaCGmAOsCWmEa@iHIuAEs@e@wHQgC_@iFWcD_@sEUyBKaAIu@Is@Is@MaAMaAOeAYkBWaBUuAW{AQaAOw@UkA]gBEQOs@Ke@{@oDkAsEiA_Eu@cCs@uBWu@]aAmAsD{AaEuAiDk@{ASg@Yk@kDkHkCkFq@mAwAgCcBuCkAmBQUmB{CsB}CeEaGaHwJ{@mAmAcBqB{Cs@cA_A}AoA{BkBgDoA}BuAcCy@{AcEsHk@eAq@mA[k@q@mAmCaFgB_DiAuByAoCcB{CoA}B_@s@OWk@aAc@y@s@oAkAwBuAgC_AcBkBeDmCqE}A_Cq@aAqBqCuBkCuBcC{BcCaAeA}BcCa@c@c@e@s@w@Y[_AeAiBaCe@k@c@o@_@i@g@u@_@k@e@s@Wc@_@o@_@q@]o@_@s@a@w@]q@Yk@We@Ui@k@mA[q@i@iA}AoD}BcFIQ_AsBs@{A_@w@i@eAyAoCw@wAq@mA}AsCaAgBq@oAqAaCsAcCgAqByAkCMUg@y@cAiB_A_BO[{@}AiAqBs@mAYe@sAuBoAcByAeBk@m@iBiB_Aw@uAcAeBeA{BoAu@c@s@_@_Ag@mAm@e@Ws@_@{Ay@{A{@i@_@y@i@qA}@y@o@q@g@k@e@q@k@o@k@oCiCmAmAeAgAs@s@iBqBo@q@iBwBs@y@w@aAo@w@w@aAu@aAs@_As@_As@_AiBgCw@kA}@sAc@q@q@eAm@aAo@eAm@aAk@_Ao@iAm@eAa@s@_@q@We@_@o@u@yAmA}BuAgCuAoCQ_@[k@g@aAg@aAm@oAe@}@q@mAYi@y@}A}@aBa@s@m@aAi@}@cAaBa@u@mAmBaBgCyA}B_@i@Ya@e@s@q@aAm@y@s@cA{AuBqBsCgAaBm@}@a@m@c@q@}AgCYc@aAeBeBcDg@aAq@uAi@kAiAgCw@iBi@qAg@qAi@uAmAaDi@uAsAuDe@qAoAcDm@wAi@uAg@mAyAcD_AqB[q@[o@a@}@]s@[o@o@qAy@cB{@iBc@_Aa@}@_@y@e@eAc@eAo@}A]w@Ys@]_AcAmCi@yAa@eAg@{A_@gAc@uAe@wAi@gBc@wAkBoGaBwFoAeEgAmDiAmDw@{B{@aCm@aBe@mAiAuCyAmDw@gBaAyB{CsGq@uA}AyCq@sA_ByCqA_CqBmDgAiBqAuBuBeDmAkBkBuC_AsAu@eA]i@m@y@qAeBw@eA{@kAm@{@w@gAq@_A_B_CiAeBk@}@_BkCm@eAm@gA}@eB_@w@Wi@kAyB{@gBc@aAmAuCk@wAu@kBeAmCo@_BaAcCm@{Aw@mBm@yA]w@Ue@k@oA_AkBg@eA}AqCgB}CgCaEs@eAcBaCs@}@qCqDkByBeDsDkAoAiCsCmDwDsCkDmBgCi@s@yAuBeBoCw@mA{BsDg@y@g@_Au@qA{@_BgAuBk@gAYi@cAyB_AuBy@wB}@mCq@_CWeAg@}BUkAO{@[oBQqAMy@[eCSaBUaBi@oDO{@Q}@SaAe@yBi@qBc@sAy@{Bq@eBe@eAsAmCc@w@e@w@aBgCmAaBoCwDwAeBu@aAcB_CU[m@{@e@o@gAaBgDmFiAgBg@}@}@}Ai@aAcAkBiAyBoB}D}B}E}AoDaA_Ca@eAoAcDsAoDc@mAg@uAqBeGiAwDe@{Aa@uAiA}D}@cDa@{Ae@cBy@{CeAwDc@{Aa@qAgAcDi@yAe@oAk@sAg@gAm@qAi@aAs@qAo@cAu@eAs@aAyAoBoAwAqBqBaA{@w@m@aAs@QMm@a@}@k@aAi@aAg@cAe@cAa@cA[gA[gAWcASgAQkAOcAIgAEmAEeA?gADa@?e@BmAHgALcAHiCZkBRSBgBPg@D_@Bi@BU@kAD_@@kAB}@CaAEeAK{@KiASmAYk@SMEw@W]Me@QaAc@c@Qe@Wy@_@i@YoAo@}BkAgBw@}Aq@o@SmAWcAUcAO{AMw@Iu@C{A?m@?kAD_AFcALy@HeAR{@TgAZeCx@cAb@s@VkAf@u@Z_A`@gA^eA\\kAZy@TcARkAPmANw@FmADeA@gA?}@CcAGiAIqAQ{@OcAUiCs@aC}@m@U{@]cBq@o@WsAm@iGgCsDyAsB}@WKi@S{@a@}CqAcCeAeCeAmBy@u@[wAs@gCoAuBeA_CsAqD_CeCeB}BgB_CmBeB_BUUMMwAqAWWQQSQSWa@e@W[cAiA]_@Y]e@i@_@g@[]_AoA}AqBoAcByAmB_CcDsBqC{BwC_BqBa@e@_@e@UY{BiCwBaCw@y@_@a@k@g@sBgBuAgAs@i@y@k@o@c@yA_A}BoAiAi@aBw@kAe@kAc@qAc@u@UQGy@ScAYsAYu@Qy@Om@Ky@My@MsAQqC]cAMcAIkBQy@Iw@IiAGeAIs@CgAIgAGs@EuAG}@Eo@?q@?m@?aA?s@?sABm@@aAFo@Dy@F_AHu@Hm@HcAN_BXkATiAVkAZ}@RmAb@y@PqBd@m@Ns@NaARo@LYBYDc@Fa@Di@FWDc@@y@Bw@@u@@}@?_AA{@Ei@Eo@EKCq@Ii@Io@Kk@Mi@M_@Kc@Mk@Q_@My@[mAg@cAc@w@_@q@[k@Yg@WaAg@wAs@mB_AmB_AoBy@q@WcC_AcA]y@Ww@U{@UwA]eAUu@Oe@Ig@Ik@G}@M_AKk@Ec@CwAE_A?{@Bi@Bi@Fk@Ju@Ps@Rk@Ri@Vo@ZOJ]Pu@j@]Tk@f@e@f@e@l@a@h@gA~Aa@p@e@|@_@r@qAfC_@v@k@nAg@hAk@nAc@`AcBhDg@dAq@rAcAjBs@hAW`@U\\OTMRKPSZo@bA}@fAg@j@_@b@yAxAYXo@j@k@d@s@l@a@Zg@^s@f@}@l@cBbA{@f@gBdAwAx@w@b@qAr@yBnAaB`AkBfAiBfAs@`@c@VcAh@k@X}@`@_A`@q@X_A\\wAj@sAn@{@Zm@VIBsBx@yBz@o@TgBp@a@NcBf@c@TcBr@eDrAcA\\mBr@aE~AmBt@kAb@w@ZeA^aA^iBp@cC~@uBx@_A^mAh@aBv@q@^cAl@mBlAgAp@g@\\e@\\eAt@qBnAmBpAmBlAmBpAmBnA}@l@k@`@cBdAsBtAw@f@s@d@kBnA{@h@{DhCeFfDeAp@g@ZSLc@XcC`BsE|CuBxA{DhC[TcBfAiD|BkBlAcC~AsBvAeIjF{E~C}@l@gBjAiBlAiAv@{FtDiBpA{CzByBdBoB~AgA`A_DtCg@f@cB`BoAnAiBnBaBjBoB`CoA~AeArA{@hAw@fAu@dA}@pAkAfBqApBgAhBw@nAu@pAm@dAaCnEIN}A|C}@jBeA~B{AhDuElLqBjFk@zAeApCaAfCo@~A{@rBqArCy@bBcApBq@nAeAdBcA|Aa@h@iAzAmAvAeAfAkAdAaAx@eAv@q@`@_Ah@mAn@gAf@{@\\_A\\y@Vq@Pq@N}@PgAPgALaAHoAHiAB_B@kC?kCEmEGkA@_ADyADwBNkAL_ANoATe@Jq@N{@Ro@P]JaAZoAf@kBx@cAh@w@b@sAx@}@l@yAdAwAhAmAfAeC`CmAnAaAbAiBrB}AfBcJzKuCfDsD|DkBhBiAdA{@r@uAhAaBnAuAbAiBnAiBhAoAr@}Ax@uCtAgD|AmJdEqCjAWJ}Ap@oAf@{Aj@}@Z{Ad@gAX_ARsAVsATeBNiAJiADc@@qADcA?qBEq@CyAIqBOuBSyDc@yI}@iBSiHu@eBUgAQuAYeBa@wBm@sBs@eAa@uAq@kBcAmAu@eEmCaGyDkTwNoH{E_C}AoEuCwCoB_@W_C}AaDwB}E_DyDiCgMkIqRgM_KyGsZkSsE_DeCgBsFcEcG_F{FiFyBuBaD_DkBkBeAeA{@}@{@}@eAgAcBcBiBoBkBmBm@m@}@_AkHqH{GaHqFqFu@q@aA}@mAaAm@c@_@WWSo@c@q@c@_@U]S]S[Qm@[o@[oAk@uAi@kAe@aA[gAYqBe@yA[eAOuBYgBOaFUiAEoBGaAAoAEa@Ae@Aw@Ac@Ac@?kBG}AEw@CkCE{LWiCCmC@eBFoBHqALwAPeBZwAVwA^iA\\wAf@eBp@aBt@sDfBeDdB}BlAsAt@iB|@qCvAoFjCmD|AmBt@iBp@mA^_Bf@sA^cBb@_B`@iB\\eBZgBXs@Lm@Hy@Hw@Hs@H[Ba@FoDZkAFuAHmBNyBPeJl@aEVaF\\oCTmCPgBJ{BLu@DyBJuET_FRoDJs@DcCDoAFsABmBBuADoDDwA@uA@wDDiC@gB?cC?c@?eB?cA?cB?mA?iC?aA?oAA{A?}AAiC@kE@uB?oABm@DkA@uCDiCFsBFa@BiADeCLcDTmBLsBN}D^}CZiD`@mDd@kAP_AN}B`@gAP}AX}@P{Bd@}Bd@wDv@{M|CgKxBoEv@uDl@uEn@_CVqBRuANsE`@{OpAaIn@{E`@aF`@kBPs@DoAJmDXmD\\oNjAyPtAcCTeCR}@Fk@Dk@F_BLsAJ{AL_AJy@DyCTq@FaAH{@HkF\\o@FoAFk@DuDPoCNo@B{@BeBDgB@q@@gCB}BCkA?uAAm@As@A}@C{@C_@A]Aq@EeAE_AEs@AsAKk@E}@Gm@Ek@Eo@G{@Iu@Gw@IgCY}ASmBYuAQiEs@kAUk@Ki@Ke@I]IaB[k@Mm@Qy@S}@Ug@Ms@Ss@SkA[_AUm@SoA_@cA[m@So@Ui@Se@Qa@M]M]M[Ma@Q]Mc@Qe@Sc@Qq@Yo@Yq@Wg@Wk@Wi@Wa@SYOYM]Si@Yi@Yo@]e@Wy@e@e@We@[c@We@YsAy@m@[[U_@S]WUM_@Y_@WYSc@[y@m@UQWSi@a@q@m@o@i@c@_@q@i@a@]]Yk@g@q@m@_CuBw@s@g@i@m@m@a@a@g@g@e@e@WWWWWW]a@]_@WYY[Y[a@e@m@o@qA{AkC{C}@iAe@k@k@q@}@cAaBmBi@m@]_@UUk@k@o@q@_A}@s@u@i@g@o@i@m@m@_@]q@k@gA}@m@e@m@e@k@c@aBkAu@i@QM_Am@y@i@s@c@{@g@s@a@_@SqAq@g@Wk@Yk@Wq@[_Aa@cAa@wAi@mBq@_A[iA]cAYuAa@sA[y@S_AQo@Mk@Mq@My@UmASuCk@w@QiAQw@Se@GgDs@_B_@mAWq@Mq@Qq@Om@Og@Mo@Oo@Mu@Uu@Sy@U_AWi@Oc@M_@K_AYUGqAa@_Bg@uAe@y@YgA_@_@Me@O]M]Ke@Qg@U}CmAeBs@cBq@oB}@mAk@eBu@aCmAiB_Ak@[gCsA_EwB_B}@kC{A_E{BmC}AaBaAu@_@s@a@gAk@cAg@uAq@cAe@mAi@_A_@mAe@kAa@mAc@yAe@mA_@eAYw@Qu@Sw@Q}A[cASy@O_AOu@KiAOcAM{@K{@IeAIoAIqAIsAGg@CuAEwAEa@AuBA}CCoII]?eCCaCE]AkGIiAAoDGI?i@AqDC{DC{FIkBCiACaCEiCCoBCoAAkAC_CCsEGaAAmACm@CiAEw@Cw@Ce@Cg@Aq@Gu@EaAKu@Gk@G}@KeAOm@Ic@Gi@Ie@Ie@Ia@Gm@Oo@Mi@KkAWs@U_@Ki@O]Kc@Ma@Mq@Uu@Uk@Se@Qo@Uw@Ys@We@Uc@Sq@Wc@U_@Qk@Ya@Qc@We@W[QYMWQ_@Sc@Wm@]yA_Aq@c@k@a@w@k@c@Y]Ye@]WU[WYSYW]Y_@[i@e@s@m@k@i@m@k@k@k@]]YYUUWWa@c@[[o@u@oAwAs@_Aa@g@u@aAg@q@k@s@_@k@_AsAo@aAc@q@e@s@g@{@c@s@k@_A_@o@s@kAo@mAa@u@}@_Bc@y@a@s@a@w@]q@o@mAUc@We@_@w@i@aAg@aAk@kAg@aAS_@_@s@[k@We@a@w@a@y@s@wAu@uAWg@_@q@_AaB}CqFaBmCq@eAs@iAc@q@}@sA[e@y@iAu@cAgAyAkA}Ae@m@k@s@o@w@i@o@q@w@o@s@m@o@g@m@q@s@u@y@w@y@g@g@k@k@q@q@k@i@g@e@qAiAkAeAi@i@}@s@i@e@i@c@g@a@}@s@{@m@m@e@_@Yg@]mCkB{AaAcAo@}A_AsAw@wAy@m@]g@Yo@]}@c@}@c@kB}@cAe@_A_@gAg@w@YYMWKqAg@_C_ASI_Bq@eDmAuBu@oBs@mBo@iBq@kC}@qAc@mAa@sBo@sAe@w@Wu@U{E{AsBq@QGYIuAc@uHyBm@Q]KaD}@iBg@gBe@oA]aBa@oA[w@S}@SeASiASaAOuAWs@KmAOq@IaAKkAKwAK{AIcAEsAEo@A_DGeD?kB@kBDmCD}BHiCJ{BLiBH{AL{BNsALwANmCVeALmAL}@HcAL_BTqBX_BVgBZsATaAPgAR}@PaARwCl@mBb@eCn@yCt@uCx@oBj@uC|@eErAgFhBwGzBeKlDqE~AqBr@cDhA_Bj@WHq@V}Bv@eHbCeBn@oBp@]Jg@PuAh@kAb@kBt@u@Xo@Xs@Vg@R_Ab@oAh@{@\\u@ZwAp@s@Zk@VcAb@y@`@s@Z_@Ni@Xi@VkAj@gAh@k@VIDwAp@wCrA_@P{B`AgAd@{DzAuBv@s@V}@Zw@VaAZu@TaAX{Bl@sDz@g@LcAVaAV}@PcAR{AZyATsATgAPsBZqBVsAN_BRyCZgBNsAJ{ALeBLkAHwAHwAF}AHeBF_CHwDHcEDmIBcHAoNCS?M?}IAwBA}B@aCBaDBeDBiBBmBBoCDyBDeBFcBBaDHiDLiELcCJcBFmBFiBHuDRiCLkCNmAF{AFwADoAFiAB{@BmAD_@?c@@wEBw@?aCAgBCcBEmAEgAEmAEeBMmBMkHs@_@CwB[iC]}Ba@}AYiAUeAS_B_@SESC{Bi@OGyD_A_Ci@gAUqA[iAWmAYw@Oy@Sm@M_@Gi@Mw@Ow@Oi@Kg@Ks@Me@Ik@Ke@Ig@Io@I_AQs@Ki@Go@Ii@Gk@Ie@GcAMs@IaBOcCQoBQuCWaEU_DQs@AsCQ_CIgCUaAGq@EYAY?W?I?wC?mCMmGWaH[oAGs@Ck@AuBIaBC}BMcBIcBGgAE{@CcACgACmBC}B?iA@oABgADu@DmAH{@Fo@Fu@Ho@H{@Lw@Ly@NwAX}A\\q@Po@Pg@N_AZ_AZs@Xy@Xs@Xs@ZmAj@yAt@cAj@iAn@e@Xk@\\uA~@aBdAkAv@aEpC{@h@u@h@c@Vw@h@g@ZuCbB}@f@kE~B[N_@PwCrA}@^y@\\m@To@T_Cv@wBr@YH[LeAZ_AV_AR}@TcATcATaATs@LcARgATcANcAPmATwARcBXwATiBZ_BXgBZcDh@{GjAy@LkC\\w@Jo@HmDb@gD\\cAJYDi@BcEVs@DoDPq@B_GHqABcB?qA?gBCaBCqBEsAC{BIkAI_ACw@GwCOcCQoDUmDWqBO{@GaAI_BMuAKkAKw@Go@Gk@G{@Ka@Ea@Go@Ig@Im@M]G[Eo@Me@M]IWGe@Mu@S_@Kq@Oq@UoA_@cEoAeF}AuAc@y@S{@Uy@QaAW{@QoAUaAQ_AO{@MaAK_@Eg@Eg@CUE]C]C]Cg@Ci@A}@Es@Cu@A{@A}@?gA?u@?y@BgABy@Dw@DeAFsAHuAHwAJYDi@Bc@D{AJs@Dq@DgAFcAFeADmADkAB}@By@?cA?y@?m@Cq@Ag@Ak@AcACu@Gu@E}@GUCOAI?k@I}@K}@MgAOy@My@Mq@My@S_B_@oA[kA[sBo@q@U_A[{@_@aA_@y@]m@WaAa@iAg@_Bo@kB}@iAg@kAi@w@]yBcAwBaAkAg@yBaAeAc@u@[uAq@_CgA_CeAmCkAqAm@eCiAy@[wB_AsCqAwAo@gAe@QK[O_CiAaBw@eCkAm@[aAe@{@e@{CaBUM[Qy@a@]USMUMe@YqAy@{@k@_@WmAw@}@m@oA}@m@e@s@i@a@[s@i@u@q@a@]y@s@{@w@c@_@}@}@c@c@MMgAiAc@g@WYaAgA[a@o@w@m@w@m@{@_AqAa@m@q@cAQWwA_CcAgBk@cAWg@Wg@Yk@Uc@Ue@c@aAm@wAm@uAa@aAYu@Sk@Wq@Ws@Qg@GOIWQi@a@qAOe@Sq@c@{AQk@]oASy@WeAQs@]{AOo@Q{@a@sBWsAMq@WwA]qBW}ASqA]}BYiBQiAU}AU}AU}ASqAk@sDa@cCYaBWwAWsAScAWqAS_AUaASy@YgASs@YcA]kASo@Uw@Qi@Qi@Sm@Oc@Qg@Si@k@yAYs@[u@s@_BaAwBYk@Yi@Wi@Yi@e@{@e@y@g@}@g@y@e@s@i@y@e@q@c@k@c@o@a@i@}AmBY]]a@iAmAo@q@m@k@q@q@][_Ay@i@e@{@u@i@e@}@u@y@q@{@s@}@s@q@i@{@q@{@q@q@i@i@c@s@k@k@e@cAy@}@s@y@o@m@e@a@[YUIEwBgBoB_BcBuAkCwBmB_B}AmAmAaA{AmAiB{AcBsAy@o@k@e@_As@eAy@}@s@aAw@s@k@cAw@o@e@{@o@s@i@m@c@s@e@s@e@m@c@k@_@s@c@m@_@}@i@cAo@w@c@i@]q@_@w@c@kAm@qAo@_Ae@kAi@o@[eAe@a@QwAm@sAi@cA]{@]iAa@gA]gAa@gA]gBk@kAa@}@YaAY}Ag@kA_@gBi@uCy@eBi@sAa@eAYy@Sw@U_AScBc@wA[mAWu@OoAWaAQs@MoAWgAQyAWgBYaAOqASiAQmB[kAQcDe@}F_A{Eu@{Dk@cEq@yCc@{Es@oF}@aC]qEq@uEs@iFw@wASgBW{@MoAOmB[aBUeFs@}B[kBWoBWwCa@_BUqC_@mEm@wBYsC_@gBW_BU_AMqAOeBWiAOkBWwASaAMm@Iy@K}AScAMoBUeBSiBQ{@Io@Gg@Em@Es@Gq@Ey@Cy@Go@Au@E{@CeACo@?w@Cs@AkA?eA@y@B}@?}@@aAB{@Bm@Bw@DeAFe@BS@YBkE\\eBPg@F_CZqANqAPkAPwBZeBVqBZaAPaBRsAPm@Hs@H_AJy@HiALg@B}@Ho@Be@DsADoAF_@?}AB{B?aB?_BCyAGcAE}@E}@GcAI{@I_AKcAKiAOkAQaAOcAQy@Oq@M_AQsA[YKUGiF{Ae@OkC{@gBm@gBo@_FeBg@QsE_BkG{BiEyAoCaAkDkAuCeA_EwAoE}AmG{ByCcA_A[s@Ww@Yq@UmAa@cA]mC_AgA[s@Qm@SyAc@uEmAyDaAsDo@y@Os@Mg@Gs@MkDe@cBWMC_AMa@Ie@Gu@Iq@IoB[e@Iq@K{B]m@I{@MqB[sB[eC]gBUwAQcAK}@K_BOy@GoAGkAIy@CeAGaAC}@AiCCmBBaCBaCDwDL{G^}CLoCHsA?aA?_ACgAEq@Iu@Gu@IoASu@MaAQiAWkA[aA[eA_@m@Ug@SYM[MmAo@k@[g@[{@i@kAw@y@i@yBcBiCsBiByAi@_@iCsB_CiB]Y]WuAgAoEkDcBoA]YQOuBoBw@w@s@y@eByBY_@wAeBm@o@k@i@w@s@]WYWw@k@sC}AeAk@y@]k@Se@Oc@Ma@Ka@Ka@I_@Go@Ii@Ga@EYCg@CeAEyBK{AGw@CgBIgAGg@Cc@CeBKo@Eu@I]Ea@GgASq@Oi@Mu@Og@M}@ScASo@M}@Mc@C]E_@Ag@A_@?Y?a@@[@c@D]@WB]F_@D]Fc@L_@Ha@Lc@Nc@P]N]R_@P_@To@^s@b@o@Zc@Rc@P]La@L]L[Fa@J[H[FUDYF]B]DeAJ{@HkALaAJmAL_AJ}BTcAHoANOBy@Fs@Hi@Hw@Lq@Lw@NkAXmAV{A\\gB`@_B`@s@Nw@TeAVg@Ps@RyAh@aA`@aAb@m@Xi@Ve@TUL[Pk@Zo@^i@Te@Rg@Pa@Le@Lk@Li@Je@Fa@Dk@Fo@@g@@k@?]?}AKq@E_AIiAUcASgBa@sEaAuA[oAU_B[s@MkB]y@KeAImACu@CM?[?U@Q?a@@_@BW?_@BYBk@F[Da@F_@Fc@H_@HWF[H]HYHUJYH_@PSF]Lu@\\yB|@mAf@aCbAaC`AqAf@mAd@sBr@QD[H}@Xm@L]HYF[Hk@Hm@La@D_@F_@Fe@Fi@Fo@Hc@Fa@BYB]Da@@g@Bm@Bg@ByA@{CBiDBuEH_@@[@QBQ?[Ba@D_@D]FaALi@Fe@Hc@Hc@Hq@Pk@L_@Hi@Pa@La@J_@Li@Rc@Rg@Pe@Rc@Rc@T[Nc@Tg@Xi@\\k@Zm@Zm@\\o@\\a@Tc@Xg@V]Ra@Tc@T_@Rg@Vm@Z_@P[Ne@Tc@Ra@Pg@Tm@VYLWL[HcA`@}Ah@k@PmDdAoAZw@Nq@Nw@Nq@L]FYDwATsAReAPkALgAHoALkAFcAFm@BW@W@m@B}@@mABgA@_B?yAAoACuBEwBEiCCeDIwDIqDGoEIiBCqBEwBCcA?cA?uA@eABmAFw@@q@Fq@Bg@BeEVaCLcDPkCNiEVyAFaCLkBJmCL}@B_ABsCFsA@yB@}@?wA?o@AuAAeAAg@Aa@CUAyGUqCUyDY{Eg@yEk@{B_@qCe@mFkAaFeAe@KuGyAwDs@wB]iAOyAQy@IeAKy@GqBKiAGwBGuACkAAiA?iA@mBF_CDkADoAFoBJeDTkDPgCNkG\\kG\\cCNsAH_ETqAHgEVaBHUBK?iBL}@H}@HkAPsANoAReB\\eARqAZmAZs@Tq@Pw@Vy@XiA`@s@XaA`@{@^oAl@_Ad@o@^}@d@iAn@aCzAWPg@\\YRg@^k@b@k@d@k@h@_@Zk@f@[XWPi@d@k@f@w@t@oAjA{@z@{@t@[RiAx@_@Tm@\\WLWL]Pq@^y@X{@XoAVyAZ_ALcAHqAFmADqCIcACmAQqAQc@KIC{@SqA_@_A_@GCUK{Aw@m@]w@g@c@[o@e@c@]yAuAuA{AcBuBcB{Be@m@m@{@Ya@a@i@]e@}@oAg@m@_BgB_@e@k@m@oCcCWUoAeAkBsAkAs@]S]UkAo@mAm@{B_AqBq@cBk@yAa@wA[{AWgBUeEa@cCOeCIcCBeBJkD^oARcBb@eCh@yCr@_BPmANyALyABsBAgBG}AKmAOeBW}Ac@sA_@}Ak@qAi@{Ay@mAq@iCkBmA{@qB{AiCsByC}BuAgAk@c@_As@mAaAoAaAiA}@gAy@_Au@}@q@q@i@u@k@_@Yi@a@{EwDy@m@u@o@g@_@k@i@m@i@g@e@a@a@_@_@g@i@a@c@g@k@a@e@[_@k@q@mAyA{@eAkAyAiA{Am@u@aAmAy@cAs@{@s@y@]_@k@m@i@i@i@e@o@m@k@e@k@e@q@g@o@c@m@_@w@i@mAs@QKSKQIeAc@qAi@{B{@kA[oA[wB]_Ca@kBMmBMkBEyA@eA@yAJyBNkBVyBZkBb@wCn@}KhCgPrDaCj@gGtAeFjA{G|AyDdA}Af@s@Xe@Nc@Pq@Xi@Ti@X[L[Na@T_@Pi@X_@Re@Ve@VaAj@{@f@m@\\gAl@k@Zs@\\w@^a@P_@N[L]Li@Pe@N[J_AVg@Le@J[Hc@F]F[FYDa@Fg@F]De@De@Da@DY?g@B]@m@B}@?sB?kB?g@Co@C_BAcDIaDIyCGkBGqACeAAqCGk@AiGO{BGcAAi@Ak@CsAE{CGO?Y?[C{HOiNY_DEuDMsDI}ACcBC}BAuB?oA@}AD{@D_AFs@Fu@H{@JkANwAToAVi@Lo@P_AVcAZy@V_A\\y@Zs@X{@^k@XaAd@{@f@yAz@aBfAsA~@iBzAOLKJUR{@r@a@^gA|@URmAbAs@h@k@^g@\\a@Vi@Zu@^s@Zo@Za@Ls@V[Fq@Rg@Hk@J_AN{@J[DYBcANy@Pg@Hi@L_AViA^m@TYLUJ[Na@R_@Rc@V_@To@b@c@Z_@Xa@\\s@l@m@j@}@x@y@t@s@n@}@z@w@t@k@h@i@f@[Xc@^i@b@g@`@i@`@[T]V[P[P[R[L_@Pa@R_@Le@P]Lo@Rm@Pk@Lk@L{@L}@Hu@FoBHwA@yBK_AGu@MgB[mBe@wBs@y@[}Ae@uBi@}AYw@Ks@ImAGw@CgBBu@@e@B{@FqBVkATq@Rm@Na@LWJm@RYLYLc@Ra@Rk@Z]Rg@ZYR]Vu@j@u@p@[Xi@h@[\\]`@q@z@q@~@_@h@e@r@W`@[l@[j@Yj@Yn@Sd@O\\Qb@Qb@M\\Qh@Qh@Od@Y~@St@St@UdAS~@S~@I\\I\\Kd@K^I\\Mf@Md@K`@K\\Op@GRENGRGPKXKXKVIRITGLQ`@Sd@Qb@OZUd@Yj@Yh@o@dAo@~@m@x@k@r@q@t@w@x@w@r@w@p@q@h@{@h@u@d@a@Re@V_@Ng@Ti@RWJ[J[JWJc@LYHUDcAX{@VK@k@NyF~AgElA{Af@aA\\w@Xe@Pa@P_@L]NYL]Ng@Vc@Pg@Tm@Xg@Vs@^k@Zg@Xc@X]Pc@Vc@Vg@Zg@Zw@h@m@`@a@Vw@j@m@b@k@b@_@Za@ZSPWVWRYXWV[ZWX[\\YZQRUZ_@d@[^w@dA_AnA{@jAw@fAc@l@[`@_@f@_@d@WZWVo@r@e@f@]\\c@`@[XYV[Vc@^_@Z_@VUPUPOJ_@Va@X]P]R[P_@RYP]NWLm@Xw@\\{Ap@oAh@_Br@g@Pa@Rm@Ts@Xi@TgAd@eAb@aBp@cA`@cAb@s@Zq@Zk@Xi@Xg@ZQHa@X{@h@_Ar@u@l@u@r@k@l@u@|@m@r@_@h@UZi@x@]j@Yd@Yf@[l@Wh@_AnB{@`Bo@lAg@~@o@fAc@p@U^W^UZ_@b@[b@mArA_A`Au@r@u@n@kA`ASLq@d@g@^e@X[Re@TYNy@`@m@Xa@N_@Nm@R_@L[L[H[Hu@P_@Ha@J[Ha@Hc@Dm@Hw@Ji@B{@HgA@cABaAAi@Ak@AgAGi@Ci@Ey@GgAKw@IkBOyAMqBS}AMmIs@gFe@{AMkAIw@GkCMuAEgAAaAAiA@y@B{@By@DsAJs@Du@Fm@Hc@Fo@Jw@Lg@Jg@JaARk@Na@Jc@LcA\\e@Li@Pk@Rs@Xw@Zk@Vk@X]P_@R[Pe@Ve@X]PcAn@gAr@eBrAk@^a@Za@Zk@d@sBfBcBxAuBjBqAhAWVa@Ze@`@[Xg@d@o@f@y@p@_Ax@iCzB}BnBgDtCq@n@eDtCkGjFaAz@eB|AsAfAiA~@SLq@d@_@VOJu@b@q@\\w@\\u@Zy@Xw@Tq@Pw@Ps@Lo@Hy@Hy@Fu@B}@BeAAu@Cm@Ek@Em@GmBYaCi@oBc@mCs@wBm@sBi@yA_@wA]yA[{@Sy@O}@MeAIQA}@Cs@Cg@?e@Bg@?u@B{@Hq@Dy@Jm@Jo@Li@L]Hs@Rs@T}@\\k@Vi@Vi@Zc@To@`@k@`@c@Zi@b@s@n@g@h@m@l@k@n@q@x@a@h@g@r@i@x@iAfB_FlHoBxCsAnBy@hAo@x@k@p@c@f@e@h@q@p@q@n@iAdAy@r@}@p@sA~@_@Xm@\\s@b@_@PULQHo@Zq@ZqAd@}Ah@eAZ{A^aBZ{@LcALmALqAJ]@u@Dc@?c@?kA?eCEcCG{DQeACoLe@iIQ}CIUAQ?SAOAk@?yB@qD?aFF}HHQ?S?}@Bo@BmCJwAFi@BS@iCN_BHkBL_DVe@DgBNiAJw@Hq@JqALaALsAPkCZu@J_ALqATwBZkBZmAVqB\\oEv@{AXwGjA{B`@_APu@JyE|@}AZu@LiARmB^uDn@mLtBgBZcCb@sCh@sCd@iB\\mB`@]Hk@JgFbAcHfAwAT}@LeALkAJeAJsBHoADyA@aA?aAAi@Aw@Ck@Cg@Cc@Am@Ge@E}AMoBW_AKiD]wC_@kFm@s@I}B[aBW}AWa@Kw@OwCo@gAUYGaE}@mGuAeB[oBc@m@K[Ec@Ea@EYAq@A}@@i@Bg@F[Dw@L_@H[JYFy@Xg@Rg@Xu@`@c@Zg@`@g@f@[Z_A`AsBtBg@d@k@d@c@Zi@\\]Ra@Ra@P_@Pe@LUHWDg@Ja@H_@B[Bq@DaA?]Cc@Co@Ei@Ey@McC]oBWaAO}Cc@sAOaAMyAQ{B[qBQo@Ey@CgBIqAAsAAmA@aBDiAFeAFcBHqABcA?cAAoAE}@EUA_@Ci@Ce@G_AKm@GkASYEgASyA[aBe@}Bo@aA[}@[w@[aAc@}@a@q@]q@]m@[g@[c@Wk@_@qA{@w@k@k@a@{AmAo@i@YYo@m@o@m@sFeFo@k@wAsAgAeAyBqB}AwAuCmCeAcAuDiD_ByAYWs@q@yBsB{AuAi@i@mAiAgAcA}@w@yAwAkBeB_A}@_@]aA{@gAgA_A}@sCmCg@e@_FsEeHsGcA_AqBkBy@u@k@i@g@e@y@o@u@i@g@]}@k@k@c@qAo@kAi@cAc@{@[s@UyBm@}@Qy@Ok@Go@Ko@GoAKiAG{@?sA?kA@u@Bk@DiAF}@Jk@Ho@J_AP}@RcAVmA`@kBt@mAh@_A`@c@Tk@V_@PUJw@\\qAj@iBx@mBx@qAj@s@Zq@VcA\\[JaAZ{@Tw@PWFSDg@J{@Ns@Jq@Hu@JwAH_@BY@c@@k@@}@BgA?iAGqAK_BM_BQoASqEy@gAW}Bi@gCi@wA[eB]wIkBuFmAsAY}A]gB]mEaA}Be@}Cm@}@UeAUcB]yBe@uCm@}@S_AU}@Sa@I}@Qa@Ik@MuBe@kBa@u@O{@QeAUaAQgAWgDs@}@Qs@Qw@Q_ASaDq@_B]sCm@oCi@e@Ie@Mk@Mk@Me@IqA[}@UkCi@_@IcDo@qCe@qFw@_Ee@}AOiEYeDWe@Cw@EwBGqCM{BIuAAyA?kAAo@?q@@o@@q@@g@?e@@U@q@B}@B]@e@@uAD_@@_@@}@C_@?[Cw@C{CKkAAUAMAOMUOOMc@I[Ge@Es@Go@EWCQ?WBS?YBWDYBUD}@PUBWDWDYDWD]D]FW@WBc@@W?gCCmAAY?_@A_AGa@C_@E_@Gc@Ic@Ke@Me@Mc@MkA_@{Bs@i@Qi@Qi@Oi@Mi@Mk@Ke@Eg@Gk@Ck@?e@@c@Be@Dc@Fc@Hc@Je@Ne@Pc@Rk@X{EdCq@\\s@\\q@Zm@Vi@Rg@Pg@He@Fe@De@Be@@e@?i@Ag@Gc@Ec@Ka@Kc@Me@Qa@Qa@Sc@We@[a@[c@_@e@c@c@e@e@i@e@k@e@m@qBqCsBwCq@_A]e@y@kAa@k@W]U[_@g@YY_@c@MMQQUSUQ]WYQQIc@Qa@OQGWIYI]IMCOCOC[E_AIMCeAC}ABkBFgEReDFQ@q@BoBDu@AaAGm@Cc@IeASkAg@s@]SKm@a@m@e@_@_@EEEEg@m@g@o@e@q@]m@c@}@Se@KUQa@Si@[_Ak@_BWu@Qe@Uk@Yo@Ym@Yi@Q[Q[S[QWOSW[]_@_@c@g@g@c@c@gAaA_D_DeC{Bk@g@m@i@i@m@u@cA]i@g@_Ac@}@_@}@[y@_@gAq@yBw@oCc@{ASq@]uAc@wA}@}Cg@cBu@gC[}@a@eAYq@_@y@g@_Ai@{@a@i@i@q@k@m@o@q@e@a@s@e@k@a@{@c@s@]s@Uy@W_@I}@OkAIIAeBGgAGu@Ai@CYCa@Cm@E_@Ga@Gc@G_@Ke@Ms@Sq@Um@Uw@[k@Uy@[w@[u@W}@_@iBs@e@Qm@Se@Om@Qw@Qm@Mu@Mg@Ks@Ii@Em@E]Ao@Aw@?yA@_AFiALS@k@JuATs@Ri@Lk@Re@PSHa@Pk@V_@POHULQLm@\\c@Xc@Zs@h@q@h@cAx@oBdB_Ar@m@h@g@^g@\\_@Tg@Zg@X_@R]Rk@Vg@Rm@T]L{@ZyAh@aBh@_AZk@Rc@P{HhCkAb@kA^i@Rc@TUJi@Xk@^a@Z[XYX]`@Y^Y`@QZ]n@Wf@Wj@Ul@Sn@Qp@Ol@Qx@Kp@EVE\\Iz@Gx@Cb@ARCz@Cr@?v@@|@BdADhAF`BBj@Dz@DdAB|@@d@@l@?h@?|@Ah@AZAVCb@ARALCVCTEd@Gh@M|@Mz@UrAMl@g@~Bk@|Be@hBUz@]lAY`Aa@jAu@rB]`A[x@]z@q@bBKXKR}AtDa@x@{@hBu@vA]n@_@r@GHeAjBeAfBc@r@q@dA}@rAy@jAgDtEsAdBcApAkAxAs@z@_AhAkApAcAhA}@`A{@~@cAdAgAfAkDjDoAlAcC~BcB|AqBhB_BvAyH|Ga@Z{AlA{AlA{AlAsAdAwCzBaBlAyAdAw@j@gAt@gAr@iAr@y@d@w@d@m@ZgAh@u@ZaA\\sAf@oAf@{@^o@Zy@b@{@d@u@d@q@b@m@b@s@h@cAx@o@j@k@h@s@r@y@z@o@r@e@h@o@v@_@d@g@r@q@`Am@`Am@bAg@~@c@x@e@~@[p@]v@a@`A[v@i@tAiA`Dg@tA]~@Yr@[r@[n@Ub@Wd@[h@c@r@k@z@o@z@s@~@Y^]\\YXML]\\QNe@`@c@\\e@\\e@\\e@Zc@V_@Rc@Ti@Vg@VsDjBmEvBwAr@sHbDk@Ti@Rk@Vm@Vo@Vk@Ti@Vg@Pe@Pa@Rq@Tw@Ze@RYHq@VuBt@u@Vk@R[LmBn@eA^_@L}@VaAZ}@XoAZs@RSBg@LiD|@QDqE`AoB^g@Jk@HgG~@iEj@{AP_Ed@c@Di@DoAHK@s@DmCPkCL{@?iA@cBIkAKm@G{@Qy@Q}@Wq@Wo@We@Um@]a@U_@W_@WkAaAa@_@u@s@i@i@e@e@o@s@_BiBm@u@{AoB{AuBiBkC_EaGaC}CwAiBy@cAwBeCwCaDcCcCgCcC}@w@aA{@yBgBcBoAa@YiAu@iBoAkBiA_FuCsGmDwGcDeEqBuCoAyFyBsGaCiBs@kJkDsIaDeBq@cBs@_Aa@kIuDgB{@eAi@gFkCiBcAs@_@qAw@cEcCkAs@kBqA_C_B}CyB_CoB{@q@i@c@s@m@WUaCqB}AuAq@o@iBgB{@y@qBsBkDuD}@cAsAyAeDsDk@k@i@m@_EeEw@w@qCwCk@i@eAcAcAaAi@e@u@s@w@w@a@a@OMo@k@w@s@QOk@i@_Aw@cA}@oAeAkBaBaBuAwD}Cm@e@y@o@m@c@k@c@g@]mBuAc@[UOYS_Am@u@e@i@[w@e@iAm@s@_@{@c@g@Uc@U_@Oi@Wo@Yi@Sq@[g@Sk@Uo@Uk@So@Su@YeA]gA[_AWcAY{@Uo@QuDeA}@WaBg@gFaBkHgCmBs@mCeAwCmAaL_FeF}B_Bo@kBs@mA_@eAWyBi@{Bc@aCa@e@G_AKo@CWEqCMy@Ei@AmBC{ABu@@w@Be@BcEVs@FO@_Ih@gAHkHf@{BPeBLoBNc@FmAJy@Js@HqBV_Fr@o@Jy@LoC`@qJvAcBXu@LQBe@BWBY@[DSD_@L_@L_@L_@PMDYLoAd@oAZoB`@eANcAHs@BY@kAAs@G_@Eq@Mm@Qa@MyAg@qAc@e@OcA]q@Ma@Ig@Gk@Iq@GSAe@Ce@Ce@Ac@?u@?y@De@@_@Ba@Fq@Fa@FmAT[Dg@L[HYJi@NUJ}ChAwAf@aBb@c@L_@Dc@HYF_@Bc@D_@DiADoAFmFTqADaHXiCHu@Dm@BiCPoAHi@DgAD{@D}BFoADcA?m@@[@oA?KHM@c@@u@@eABk@Bo@Dk@FOB_@Hg@D[Fi@HWB}BZ]HaANYDODW@k@?WFWDUBk@Fk@Dk@Fm@@k@BWBk@Bk@?Y?Mq@XErCKlBG|@An@A?iAAWCuBCkCEeCAg@EwBEqBEgCA_AAg@CaACu@Co@AM?MA_@Cg@MDkAZQD"
- }
+ "distance": 28.62347934634507,
+ "formatted_address": "Radway House, Alfred Road, London, W2 5ER",
+ "geometry": {
+ "location": {
+ "lat": 51.5211258,
+ "lng": -0.1956346
+ },
+ "location_type": "ROOFTOP"
+ },
+ "public_id": "",
+ "sub_buildings": [
+ {
+ "description": "Flat 1, Radway House, Alfred Road, London, W2 5ER",
+ "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9faitia1pNNURnOWYvQmRjMUdweXl5SjdLZUZnPQ=="
+ },
+ {
+ "description": "Flat 2, Radway House, Alfred Road, London, W2 5ER",
+ "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fbTRoZVpxYkhBYVVXSytqek04UGtGQ1VLTVI0PQ=="
+ },
+ {
+ "description": "Flat 3, Radway House, Alfred Road, London, W2 5ER",
+ "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fcmY1MHV6aE5kVytLWWZLV3JabzFzR2lnbThzPQ=="
+ }
+ ],
+ "types": [
+ "address"
+ ]
}
- ],
- "status": "OK"
+ ]
}
]
},
- "Distance_TollsRoute": {
+ "Localities_ReverseGeocodeResult": {
"properties": {
- "overview_polyline": {
- "$ref": "#/components/schemas/Distance_Polyline"
- },
- "bounds": {
- "$ref": "#/components/schemas/Distance_Bounds"
+ "public_id": {
+ "type": "string",
+ "title": "Public Id",
+ "description": "Unique identifier for this place."
},
- "legs": {
+ "types": {
"items": {
- "$ref": "#/components/schemas/Distance_TollLeg"
+ "$ref": "#/components/schemas/Localities_LocalityTypeAll"
},
"type": "array",
- "title": "Legs"
+ "title": "Types",
+ "description": "An array containing the types of the result"
+ },
+ "formatted_address": {
+ "type": "string",
+ "title": "Formatted Address",
+ "description": "Contains the readable text description of the result."
+ },
+ "name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Name",
+ "description": "Name of the result when available"
+ },
+ "address_components": {
+ "anyOf": [
+ {
+ "items": {
+ "$ref": "#/components/schemas/Localities_AddressComponent"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Address Components"
+ },
+ "administrative_area_label": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Administrative Area Label",
+ "description": "Only available for `admin_level` suggestions, this contains the local english name of the administration level (\"department\" for France or \"federal_state\" for Germany)."
+ },
+ "status": {
+ "anyOf": [
+ {
+ "type": "string",
+ "const": "not_yet_built"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Status",
+ "description": "This optional field is only available for UK addresses referenced as not yet built by Royal Mail."
+ },
+ "geometry": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Localities_GeocodeGeometry"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "distance": {
+ "type": "number",
+ "title": "Distance",
+ "description": "When reverse geocoding, this field represents the distance (in meter) to the requested latlng"
+ },
+ "sub_buildings": {
+ "anyOf": [
+ {
+ "items": {
+ "$ref": "#/components/schemas/Localities_AddressSummary"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Sub Buildings",
+ "description": "When reverse geocoding with `list_sub_buildings=true`, this field will contain a list of precise addresses that can be found at that location, i.e. all flats within a building."
}
},
"type": "object",
"required": [
- "overview_polyline",
- "bounds",
- "legs"
+ "public_id",
+ "types",
+ "formatted_address",
+ "distance"
],
- "title": "TollsRoute"
+ "title": "ReverseGeocodeResult",
+ "description": "Attributes describing a locality. Not all attributes will be available for all locality types."
},
- "Distance_ValidationError": {
+ "Localities_Shape": {
+ "properties": {
+ "type": {
+ "type": "string",
+ "enum": [
+ "Polygon",
+ "MultiPolygon"
+ ],
+ "title": "Type"
+ },
+ "coordinates": {
+ "anyOf": [
+ {
+ "items": {
+ "items": {
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "type": "array",
+ "maxItems": 2,
+ "minItems": 2
+ },
+ "type": "array"
+ },
+ "type": "array"
+ },
+ {
+ "items": {
+ "items": {
+ "items": {
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "type": "array",
+ "maxItems": 2,
+ "minItems": 2
+ },
+ "type": "array"
+ },
+ "type": "array"
+ },
+ "type": "array"
+ }
+ ],
+ "title": "Coordinates"
+ }
+ },
+ "type": "object",
+ "required": [
+ "type",
+ "coordinates"
+ ],
+ "title": "Shape"
+ },
+ "Localities_ValidationError": {
"properties": {
"loc": {
"items": {
@@ -21658,6 +22262,13 @@
"type": {
"type": "string",
"title": "Error Type"
+ },
+ "input": {
+ "title": "Input"
+ },
+ "ctx": {
+ "type": "object",
+ "title": "Context"
}
},
"type": "object",
@@ -21667,18 +22278,34 @@
"type"
],
"title": "ValidationError"
+ },
+ "Localities_Viewport": {
+ "properties": {
+ "northeast": {
+ "$ref": "#/components/schemas/Localities_Location"
+ },
+ "southwest": {
+ "$ref": "#/components/schemas/Localities_Location"
+ }
+ },
+ "type": "object",
+ "required": [
+ "northeast",
+ "southwest"
+ ],
+ "title": "Viewport"
}
},
"securitySchemes": {
"Woosmap_Platform_API_Reference_PrivateApiKeyAuth": {
- "description": "A Private key generated specifically to authenticate API requests on server side. Required for Data management API. See how to [register a Private API Key](https://developers.woosmap.com/support/api-keys/#registering-a-woosmap-private-api-key).",
+ "description": "A Private key generated specifically to authenticate API requests on server side. Required for Data management API. See how to [register a Private API Key](https://developers.woosmap.com/api-reference/authentication/#registering-a-woosmap-private-api-key).",
"type": "apiKey",
"in": "query",
"name": "private_key",
"x-displayName": "PrivateApiKeyAuth"
},
"Woosmap_Platform_API_Reference_PublicApiKeyAuth": {
- "description": "A Public key generated specifically to authenticate API requests on the front side. See how to [register a Public API Key](https://developers.woosmap.com/support/api-keys/#registering-a-woosmap-public-api-key).",
+ "description": "A Public key generated specifically to authenticate API requests on the front side. See how to [register a Public API Key](https://developers.woosmap.com/api-reference/authentication/#registering-a-woosmap-public-api-key).",
"type": "apiKey",
"in": "query",
"name": "key",
@@ -21692,7 +22319,7 @@
"x-displayName": "RefererHeader"
},
"Woosmap_Platform_API_Reference_PrivateApiKeyHeaderAuth": {
- "description": "A Private key to authenticate API requests through the Header instead of Query parameter. Use either PrivateApiKeyHeaderAuth or PrivateApiKeyAuth. See how to [register a Private API Key](https://developers.woosmap.com/support/api-keys/#registering-a-woosmap-private-api-key).",
+ "description": "A Private key to authenticate API requests through the Header instead of Query parameter. Use either PrivateApiKeyHeaderAuth or PrivateApiKeyAuth. See how to [register a Private API Key](https://developers.woosmap.com/api-reference/authentication/#registering-a-woosmap-private-api-key).",
"type": "apiKey",
"in": "header",
"name": "X-Api-Key",
@@ -21834,6 +22461,27 @@
"in": "header",
"name": "X-Api-Key",
"x-displayName": "PrivateApiKeyHeader"
+ },
+ "Localities_PublicAPIKey": {
+ "type": "apiKey",
+ "description": "Public key of the project usually starts with `woos-`",
+ "in": "query",
+ "name": "key",
+ "x-displayName": "PublicAPIKey"
+ },
+ "Localities_PrivateApiKey": {
+ "type": "apiKey",
+ "description": "Private key with or without write permission.",
+ "in": "query",
+ "name": "private_key",
+ "x-displayName": "PrivateApiKey"
+ },
+ "Localities_PrivateApiKeyHeader": {
+ "type": "apiKey",
+ "description": "Private key with or without write permission.",
+ "in": "header",
+ "name": "X-Api-Key",
+ "x-displayName": "PrivateApiKeyHeader"
}
}
},
diff --git a/dist/woosmap-openapi3.json b/dist/woosmap-openapi3.json
index 3ab67372..2a093615 100755
--- a/dist/woosmap-openapi3.json
+++ b/dist/woosmap-openapi3.json
@@ -32,7 +32,7 @@
"tags": [
{
"name": "Search",
- "description": "Store Search lets you query the Assets which are returned as a [GeoJson](https://geojson.org/). Request is done over HTTPS using GET. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/support/api-keys/). If your request returns a high number of assets, the result will be paginated. If so, you can request assets by page using `page` and `stores_by_page` parameters (Default is **100**, max is **300**).\n",
+ "description": "Store Search lets you query the Assets which are returned as a [GeoJson](https://geojson.org/). Request is done over HTTPS using GET. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/api-reference/authentication/). If your request returns a high number of assets, the result will be paginated. If so, you can request assets by page using `page` and `stores_by_page` parameters (Default is **100**, max is **300**).\n",
"externalDocs": {
"url": "https://developers.woosmap.com/products/stores-api/overview/"
}
@@ -53,17 +53,10 @@
},
{
"name": "Geolocation API",
- "description": "Geolocation API returns a location (or nearby stores) and accuracy radius based on an IP address. Request is done over HTTPS using GET. Response is formatted as JSON. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/support/api-keys/).\n",
+ "description": "Geolocation API returns a location (or nearby stores) and accuracy radius based on an IP address. Request is done over HTTPS using GET. Response is formatted as JSON. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/api-reference/authentication/).\n",
"externalDocs": {
"url": "https://developers.woosmap.com/products/geolocation-api/location/"
}
- },
- {
- "name": "Localities API",
- "description": "Woosmap Localities API is a web service that returns a great amount of geographical places in response to an HTTP request. Among others are city names, postal codes, suburbs, addresses or airports. Request is done over HTTPS using GET. Response is formatted as JSON. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/support/api-keys/).\n",
- "externalDocs": {
- "url": "https://developers.woosmap.com/products/localities/get-started/"
- }
}
],
"paths": {
@@ -2306,162 +2299,65 @@
]
}
},
- "/localities/autocomplete": {
+ "/zones": {
"get": {
- "summary": "Autocomplete for Localities",
- "operationId": "localitiesAutocomplete",
+ "summary": "List your Zones",
+ "operationId": "listZones",
"servers": [
{
"url": "https://api.woosmap.com"
}
],
"tags": [
- "Localities API"
+ "Zones"
],
- "description": "Autocomplete on worldwide suggestions for text-based geographic searches. It can match on full words as well as substrings. You can therefore send queries as the user types, to provide on-the-fly addresses, city names, postal codes or suburb name suggestions.\n",
+ "description": "List all zones for the current project, sorted by `zone_id`.\n",
"security": [
- {
- "PublicApiKeyAuth": [],
- "RefererHeader": []
- },
{
"PrivateApiKeyAuth": []
- },
- {
- "PrivateApiKeyHeaderAuth": []
}
],
"parameters": [
{
- "$ref": "#/components/parameters/input"
- },
- {
- "$ref": "#/components/parameters/types"
- },
- {
- "$ref": "#/components/parameters/excluded_types"
- },
- {
- "$ref": "#/components/parameters/localities_components"
- },
- {
- "$ref": "#/components/parameters/language-2"
- },
- {
- "$ref": "#/components/parameters/location"
- },
- {
- "$ref": "#/components/parameters/radius-2"
- },
- {
- "$ref": "#/components/parameters/data"
- },
- {
- "$ref": "#/components/parameters/extended"
+ "$ref": "#/components/parameters/limit-3"
},
{
- "$ref": "#/components/parameters/custom_description"
+ "$ref": "#/components/parameters/offset"
}
],
"responses": {
"200": {
- "description": "Autocompletion Localities successfully retrieved",
+ "description": "Zones successfully retrieved",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/LocalitiesAutocompleteCollectionResponse"
+ "$ref": "#/components/schemas/ZonesCollectionResponse"
},
"examples": {
"default": {
- "summary": "Autocomplete localities results for input `Lond` and components `country:gb`",
+ "summary": "Zones data",
"value": {
- "localities": [
- {
- "public_id": "Ch6qA8cLmvyvEEoFy6nYeFcEdNU=",
- "type": "locality",
- "types": [
- "locality",
- "city"
- ],
- "description": "London, City of London, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 0,
- "length": 4
- }
- ]
- }
- },
- {
- "public_id": "m/T2C4YI2LgszkKXrELBC+9dfC8=",
- "type": "locality",
- "types": [
- "locality",
- "city"
- ],
- "description": "Derry/Londonderry, Derry City and Strabane, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 6,
- "length": 4
- }
- ]
- }
- },
- {
- "public_id": "J6eISGMjjvQwPkao8rsByB3aVwM=",
- "type": "locality",
- "types": [
- "locality",
- "village"
- ],
- "description": "London Colney, Hertfordshire, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 0,
- "length": 4
- }
- ]
- }
- },
+ "zones": [
{
- "public_id": "52MnrbHVWH21CLWH8VY/YWKhqeM=",
- "type": "locality",
+ "store_id": "STORE_ID_123456",
+ "zone_id": "ZoneB",
+ "polygon": "POLYGON ((-122.4546384 37.774656, -122.4515485 37.7595934, -122.4354306 37.7602172, -122.4333707 37.7512596, -122.423071 37.7511239, -122.4242726 37.7687665, -122.4259893 37.7691736, -122.4289075 37.7732444, -122.4306241 37.7850483, -122.4472753 37.7830133, -122.445902 37.7759581, -122.4546384 37.774656))",
"types": [
- "locality",
- "village"
+ "delivery"
],
- "description": "London Apprentice, Cornwall, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 0,
- "length": 4
- }
- ]
- }
+ "description": "Delivery Zone for Store B"
},
{
- "public_id": "S/5AkUmMBhX35qVI2jR38+dALwk=",
- "type": "locality",
+ "store_id": "STORE_ID_45678",
+ "zone_id": "ZoneC",
+ "polygon": "POLYGON ((-122.4758889 37.7524995, -122.4751594 37.7321718, -122.4688079 37.7299995, -122.4648597 37.7261979, -122.4519851 37.7228035, -122.4483802 37.7215815, -122.4458053 37.726741, -122.4365356 37.7310857, -122.4315574 37.7324433, -122.4246909 37.7312214, -122.4219444 37.731493, -122.423071 37.7511239, -122.4333707 37.7512596, -122.4354306 37.7602172, -122.4515485 37.7595934, -122.4528628 37.7582744, -122.4540375 37.7566755, -122.4565266 37.7513144, -122.4601315 37.7521288, -122.4618481 37.7514501, -122.4635648 37.7530788, -122.4758889 37.7524995))",
"types": [
- "locality",
- "city"
+ "delivery"
],
- "description": "City of London, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 8,
- "length": 4
- }
- ]
- }
+ "description": "Delivery Zone for Store C"
}
- ]
+ ],
+ "status": "ok"
}
}
}
@@ -2527,233 +2423,117 @@
{
"lang": "curl",
"label": "cURL",
- "source": "curl -L 'https://api.woosmap.com/localities/autocomplete/?input=Lond&components=country%3Agb&no_deprecated_fields=true&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
+ "source": "curl -L 'https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY&limit=2&offset=1'"
},
{
"lang": "javascript",
"label": "JavaScript",
- "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/localities/autocomplete/?input=Lond&components=country%3Agb&no_deprecated_fields=true&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));"
+ "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY&limit=2&offset=1\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));"
},
{
"lang": "python",
"label": "Python",
- "source": "import requests\n\nurl = \"https://api.woosmap.com/localities/autocomplete/?input=Lond&components=country%3Agb&no_deprecated_fields=true&key=YOUR_PUBLIC_API_KEY\"\n\npayload = {}\nheaders = {\n 'Referer': 'http://localhost'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
+ "source": "import requests\n\nurl = \"https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY&limit=2&offset=1\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
}
]
- }
- },
- "/localities/details": {
- "get": {
- "summary": "Details of a Locality",
- "operationId": "localitiesDetails",
+ },
+ "post": {
+ "summary": "Create your Zones",
+ "operationId": "createZones",
"servers": [
{
"url": "https://api.woosmap.com"
}
],
"tags": [
- "Localities API"
+ "Zones"
],
- "description": "Provides details of an autocomplete suggestion (using the suggestion’s `public_id`).\n",
+ "description": "Used to batch create Zones to a specific project identified with the `private_key` parameter.\n",
"security": [
- {
- "PublicApiKeyAuth": [],
- "RefererHeader": []
- },
{
"PrivateApiKeyAuth": []
- },
- {
- "PrivateApiKeyHeaderAuth": []
}
],
- "parameters": [
- {
- "$ref": "#/components/parameters/public_id"
- },
- {
- "$ref": "#/components/parameters/language-2"
- },
- {
- "$ref": "#/components/parameters/fields"
- },
- {
- "$ref": "#/components/parameters/cc_format"
- },
- {
- "$ref": "#/components/parameters/page-2"
- },
- {
- "$ref": "#/components/parameters/addresses_per_page"
+ "requestBody": {
+ "description": "The request body of Zones Creation must be formatted as JSON.",
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ZonesCollectionRequest"
+ },
+ "examples": {
+ "default": {
+ "summary": "Zones data as JSON",
+ "value": {
+ "zones": [
+ {
+ "zone_id": "ZoneA",
+ "description": "Delivery Zone for Store A",
+ "store_id": "STORE_ID_123456",
+ "polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))",
+ "types": [
+ "delivery"
+ ]
+ },
+ {
+ "zone_id": "ZoneB",
+ "description": "Delivery Zone for Store B",
+ "store_id": "STORE_ID_123456",
+ "polygon": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))",
+ "types": [
+ "delivery"
+ ]
+ },
+ {
+ "zone_id": "ZoneC",
+ "description": "Delivery Zone for Store C",
+ "store_id": "STORE_ID_45678",
+ "polygon": "POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))",
+ "types": [
+ "delivery"
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
}
- ],
+ },
"responses": {
"200": {
- "description": "Details Localities successfully retrieved",
+ "description": "Zones successfully created",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/LocalitiesDetailsResponse"
+ "$ref": "#/components/schemas/SuccessZones"
},
"examples": {
- "Address": {
- "summary": "Localities Address details from a `public_id` retrieved using Localities autocomplete",
+ "default": {
+ "summary": "Success response for Zones Created",
"value": {
- "result": {
- "public_id": "TVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPV9fTVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPQ==",
- "types": [
- "address"
- ],
- "formatted_address": "House Of Commons, Houses Of Parliament, London, SW1A 0AA",
- "geometry": {
- "location": {
- "lat": 51.4998415,
- "lng": -0.1246375
- },
- "accuracy": "ROOFTOP"
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United Kingdom",
- "short_name": "GB"
- },
- {
- "types": [
- "state",
- "division_level_1"
- ],
- "long_name": "England",
- "short_name": "England"
- },
- {
- "types": [
- "administrative_area_level_1",
- "county",
- "division_level_2"
- ],
- "long_name": "City of London",
- "short_name": "City of London"
- },
- {
- "types": [
- "district",
- "division_level_3"
- ],
- "long_name": "Westminster",
- "short_name": "Westminster"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "London",
- "short_name": "London"
- },
- {
- "types": [
- "postal_codes"
- ],
- "long_name": "SW1A 0AA",
- "short_name": "SW1A 0AA"
- },
- {
- "types": [
- "premise"
- ],
- "long_name": "Houses Of Parliament",
- "short_name": "Houses Of Parliament"
- },
- {
- "types": [
- "organisation"
- ],
- "long_name": "House Of Commons",
- "short_name": "House Of Commons"
- }
- ]
- }
+ "status": "ok",
+ "message": "Zones successfully added."
}
- },
- "PostalCode": {
- "summary": "Localities Postal Code details from a `public_id` retrieved using Localities autocomplete",
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid. The data is not a valid JSON.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error400"
+ },
+ "examples": {
+ "Invalid": {
+ "summary": "Error 400",
"value": {
- "result": {
- "public_id": "cG9zdGFsX2NvZGU6Z2I6OmNDN0N0ZUF2MW9YRi9KLzlnS2cremJndktFaz0=",
- "types": [
- "postal_code"
- ],
- "formatted_address": "SW1A 0AA, City of London",
- "name": "SW1A 0AA",
- "geometry": {
- "location": {
- "lat": 51.499842,
- "lng": -0.124638
- },
- "accuracy": "GEOMETRIC_CENTER"
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United Kingdom",
- "short_name": "GB"
- },
- {
- "types": [
- "state",
- "division_level_1"
- ],
- "long_name": "England",
- "short_name": "England"
- },
- {
- "types": [
- "administrative_area_level_1",
- "county",
- "division_level_2"
- ],
- "long_name": "City of London",
- "short_name": "City of London"
- },
- {
- "types": [
- "district",
- "division_level_3"
- ],
- "long_name": "Westminster",
- "short_name": "Westminster"
- },
- {
- "types": [
- "postal_codes"
- ],
- "long_name": "SW1A 0AA",
- "short_name": "SW1A 0AA"
- }
- ],
- "addresses": {
- "pagination": {
- "page": 1,
- "page_count": 1,
- "addresses_per_page": 1,
- "address_count": 1
- },
- "list": [
- {
- "public_id": "TVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPV9fTVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPQ==",
- "description": "House Of Commons, Houses Of Parliament London, SW1A 0AA"
- }
- ]
- }
- }
+ "status": "error",
+ "value": "The request is invalid, the data is not a valid JSON."
}
}
}
@@ -2795,335 +2575,122 @@
}
}
}
- },
- "429": {
- "description": "Too Many Requests. The rate limit for this endpoint has been exceeded.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Error429"
- },
- "examples": {
- "Forbidden": {
- "summary": "Error 429",
- "value": {
- "detail": "The rate limit for this endpoint has been exceeded"
- }
- }
- }
- }
- }
}
},
"x-codeSamples": [
{
"lang": "curl",
"label": "cURL",
- "source": "curl -L 'https://api.woosmap.com/localities/details?public_id=TVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPV9fTVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPQ%3D%3D&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
- },
- {
- "lang": "javascript",
- "label": "JavaScript",
- "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/localities/details?public_id=TVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPV9fTVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPQ%3D%3D&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));"
+ "source": "curl -L 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneB\",\n \"description\": \"Delivery Zone for Store B\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneC\",\n \"description\": \"Delivery Zone for Store C\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n}'"
},
{
"lang": "python",
"label": "Python",
- "source": "import requests\n\nurl = \"https://api.woosmap.com/localities/details?public_id=TVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPV9fTVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPQ%3D%3D&key=YOUR_PUBLIC_API_KEY\"\n\npayload = {}\nheaders = {\n 'Referer': 'http://localhost'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
+ "source": "import requests\nimport json\n\nurl = \"https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneB\",\n \"description\": \"Delivery Zone for Store B\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneC\",\n \"description\": \"Delivery Zone for Store C\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
+ },
+ {
+ "lang": "nodejs",
+ "label": "NodeJS",
+ "source": "const axios = require('axios');\nlet data = JSON.stringify({\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneB\",\n \"description\": \"Delivery Zone for Store B\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneC\",\n \"description\": \"Delivery Zone for Store C\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n});\n\nlet config = {\n method: 'post',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY',\n headers: { \n 'content-type': 'application/json'\n },\n data : data\n};\n\naxios.request(config)\n.then((response) => {\n console.log(JSON.stringify(response.data));\n})\n.catch((error) => {\n console.log(error);\n});\n"
}
]
- }
- },
- "/localities/geocode": {
- "get": {
- "summary": "Geocode a locality or Reverse Geocode a latlng",
- "operationId": "localitiesGeocode",
+ },
+ "put": {
+ "summary": "Update the Zones",
+ "operationId": "updateZones",
"servers": [
{
"url": "https://api.woosmap.com"
}
],
"tags": [
- "Localities API"
+ "Zones"
],
- "description": "Provides details for an address or a geographic position. Either parameter `address` **or** `latlng` is required.\n",
+ "description": "Used to update zones in batch. `zone_id` must exists when using `PUT` method, if one zone does not exists, the batch will be refused.",
"security": [
- {
- "PublicApiKeyAuth": [],
- "RefererHeader": []
- },
{
"PrivateApiKeyAuth": []
- },
- {
- "PrivateApiKeyHeaderAuth": []
}
],
- "parameters": [
- {
- "$ref": "#/components/parameters/address"
- },
- {
- "$ref": "#/components/parameters/latlng"
- },
- {
- "$ref": "#/components/parameters/geocode_types"
- },
- {
- "$ref": "#/components/parameters/excluded_types"
- },
- {
- "$ref": "#/components/parameters/list_sub_buildings"
- },
- {
- "$ref": "#/components/parameters/localities_components"
- },
- {
- "$ref": "#/components/parameters/language-2"
- },
- {
- "$ref": "#/components/parameters/fields"
- },
- {
- "$ref": "#/components/parameters/data"
- },
- {
- "$ref": "#/components/parameters/cc_format"
+ "requestBody": {
+ "description": "The request body of Zones Update must be formatted as JSON.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ZonesCollectionRequest"
+ },
+ "examples": {
+ "default": {
+ "summary": "Zones data",
+ "value": {
+ "zones": [
+ {
+ "zone_id": "ZoneA",
+ "description": "Delivery Zone for Store A",
+ "store_id": "STORE_ID_123456",
+ "polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))",
+ "types": [
+ "delivery"
+ ]
+ },
+ {
+ "zone_id": "ZoneB",
+ "description": "Delivery Zone for Store B",
+ "store_id": "STORE_ID_123456",
+ "polygon": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))",
+ "types": [
+ "delivery"
+ ]
+ },
+ {
+ "zone_id": "ZoneC",
+ "description": "Delivery Zone for Store C",
+ "store_id": "STORE_ID_45678",
+ "polygon": "POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))",
+ "types": [
+ "delivery"
+ ]
+ }
+ ]
+ }
+ }
+ }
+ }
}
- ],
+ },
"responses": {
"200": {
- "description": "Request Localities Geocode successful",
+ "description": "Zones successfully updated",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/LocalitiesGeocodeCollectionResponse"
+ "$ref": "#/components/schemas/SuccessZones"
},
"examples": {
- "geocode": {
- "summary": "Geocode Results for address `Place Jeanne-d'Arc` with components `country:FR`",
+ "default": {
+ "summary": "Success response for Zones updated",
"value": {
- "results": [
- {
- "public_id": "0+FTYd/1MsiBSxLAKq+/Fiyy+uM=",
- "types": [
- "address",
- "route"
- ],
- "formatted_address": "Place Jeanne D'Arc, 75013, Paris",
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "France",
- "short_name": "FR"
- },
- {
- "types": [
- "state",
- "division_level_1"
- ],
- "long_name": "Île-de-France",
- "short_name": "Île-de-France"
- },
- {
- "types": [
- "administrative_area_level_1",
- "county",
- "division_level_2"
- ],
- "long_name": "Paris",
- "short_name": "Paris"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "Paris",
- "short_name": "Paris"
- },
- {
- "types": [
- "postal_codes"
- ],
- "long_name": "75013",
- "short_name": "75013"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Place Jeanne D'Arc",
- "short_name": "Place Jeanne D'Arc"
- }
- ],
- "geometry": {
- "location": {
- "lat": 48.829405,
- "lng": 2.367944
- },
- "location_type": "GEOMETRIC_CENTER"
- },
- "scores_per_components": {
- "street_name": 1
- }
- }
- ]
+ "status": "ok",
+ "message": "Zones successfully added."
}
- },
- "reverse": {
- "summary": "Reverse Geocode Results for latlng `51.52089223979333, -0.195460973340401` with list_sub_buildings `true`",
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Invalid. The data is not a valid JSON.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error400"
+ },
+ "examples": {
+ "Invalid": {
+ "summary": "Error 400",
"value": {
- "results": [
- {
- "public_id": "",
- "types": [
- "address"
- ],
- "formatted_address": "Radway House, Alfred Road, London, W2 5ER",
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United Kingdom",
- "short_name": "GB"
- },
- {
- "types": [
- "state",
- "division_level_1"
- ],
- "long_name": "England",
- "short_name": "England"
- },
- {
- "types": [
- "administrative_area_level_1",
- "county",
- "division_level_2"
- ],
- "long_name": "City of London",
- "short_name": "City of London"
- },
- {
- "types": [
- "district",
- "division_level_3"
- ],
- "long_name": "Westminster",
- "short_name": "Westminster"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "London",
- "short_name": "London"
- },
- {
- "types": [
- "postal_codes"
- ],
- "long_name": "W2 5ER",
- "short_name": "W2 5ER"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Alfred Road",
- "short_name": "Alfred Road"
- },
- {
- "types": [
- "premise"
- ],
- "long_name": "Radway House",
- "short_name": "Radway House"
- }
- ],
- "geometry": {
- "location": {
- "lat": 51.5211258,
- "lng": -0.1956346
- },
- "location_type": "ROOFTOP"
- },
- "distance": 28.62347934634507,
- "sub_buildings": [
- {
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9faitia1pNNURnOWYvQmRjMUdweXl5SjdLZUZnPQ==",
- "description": "Flat 1, Radway House, Alfred Road, London, W2 5ER"
- },
- {
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fbTRoZVpxYkhBYVVXSytqek04UGtGQ1VLTVI0PQ==",
- "description": "Flat 2, Radway House, Alfred Road, London, W2 5ER"
- },
- {
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fcmY1MHV6aE5kVytLWWZLV3JabzFzR2lnbThzPQ==",
- "description": "Flat 3, Radway House, Alfred Road, London, W2 5ER"
- },
- {
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fajlaWXJJUDFKSmI1Y0dpNElDanBQejF2YUg4PQ==",
- "description": "Flat 4, Radway House, Alfred Road, London, W2 5ER"
- },
- {
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fbkdEZTNOODZNL0VlWGtoR0pSa2tBS1NMYndVPQ==",
- "description": "Flat 5, Radway House, Alfred Road, London, W2 5ER"
- },
- {
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fTGxlWUlKN2NhU1JXcTBuSEs1RExiamliNlpNPQ==",
- "description": "Flat 6, Radway House, Alfred Road, London, W2 5ER"
- },
- {
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9feVZXa05ISjhzVGNHK2NQUHFpNlFIUWgvSnpJPQ==",
- "description": "Flat 7, Radway House, Alfred Road, London, W2 5ER"
- },
- {
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fTVc5NldSeWpuOENUS2xST21vZzdnNGxGQldrPQ==",
- "description": "Flat 8, Radway House, Alfred Road, London, W2 5ER"
- },
- {
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fN3RkdE9HeHBwT2M5R1hQMUFwNDJUc3NwRklZPQ==",
- "description": "Flat 9, Radway House, Alfred Road, London, W2 5ER"
- },
- {
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fR2RVRHpoYll4a2RlTldjLzF3NVNFTXNZYzlFPQ==",
- "description": "Flat 10, Radway House, Alfred Road, London, W2 5ER"
- },
- {
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fL3FXbnVZU2h4bjAwMDNKK3hJeU9OL3lnemFzPQ==",
- "description": "Flat 11, Radway House, Alfred Road, London, W2 5ER"
- },
- {
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fVVVCUWhpNVJQWWk2eTl1WFBTVTRmK3Zma3VBPQ==",
- "description": "Flat 12, Radway House, Alfred Road, London, W2 5ER"
- },
- {
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fV2hSUDNadnFMN3ZzaWJ6UFd2MWM3aW1qT3hBPQ==",
- "description": "Flat 13, Radway House, Alfred Road, London, W2 5ER"
- },
- {
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fcWxGbFRlcE1TVStZVElodzFSdVhiTGxZTXl3PQ==",
- "description": "Flat 14, Radway House, Alfred Road, London, W2 5ER"
- },
- {
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fYjR5VHRXMmZTQ0FOMGwwZHJNaFh5TFRnVHlnPQ==",
- "description": "Flat 15, Radway House, Alfred Road, London, W2 5ER"
- },
- {
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fNmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PQ==",
- "description": "Flat 16, Radway House, Alfred Road, London, W2 5ER"
- }
- ]
- }
- ]
+ "status": "error",
+ "value": "The request is invalid, the data is not a valid JSON."
}
}
}
@@ -3165,19 +2732,93 @@
}
}
}
+ }
+ },
+ "x-codeSamples": [
+ {
+ "lang": "curl",
+ "label": "cURL",
+ "source": "curl -L -X PUT 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n}'"
},
- "429": {
- "description": "Too Many Requests. The rate limit for this endpoint has been exceeded.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Error429"
- },
- "examples": {
- "Forbidden": {
- "summary": "Error 429",
+ {
+ "lang": "python",
+ "label": "Python",
+ "source": "import requests\nimport json\n\nurl = \"https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
+ },
+ {
+ "lang": "nodejs",
+ "label": "NodeJS",
+ "source": "const axios = require('axios');\nlet data = JSON.stringify({\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n});\n\nlet config = {\n method: 'put',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY',\n headers: { \n 'content-type': 'application/json'\n },\n data : data\n};\n\naxios.request(config)\n.then((response) => {\n console.log(JSON.stringify(response.data));\n})\n.catch((error) => {\n console.log(error);\n});\n"
+ }
+ ]
+ },
+ "delete": {
+ "summary": "Delete the Zones",
+ "operationId": "deleteZones",
+ "servers": [
+ {
+ "url": "https://api.woosmap.com"
+ }
+ ],
+ "tags": [
+ "Zones"
+ ],
+ "description": "Used to delete one or more Zones.",
+ "security": [
+ {
+ "PrivateApiKeyAuth": []
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Zones successfully deleted",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SuccessZones"
+ },
+ "examples": {
+ "default": {
+ "summary": "Success response for Zones deleted",
"value": {
- "detail": "The rate limit for this endpoint has been exceeded"
+ "status": "ok",
+ "message": "Zones deleted."
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized. Incorrect authentication credentials.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error401"
+ },
+ "examples": {
+ "Unauthorized": {
+ "summary": "Error 401",
+ "value": {
+ "detail": "Incorrect authentication credentials. Please check or use a valid API Key"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden. This Woosmap API is not enabled for this project.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error403"
+ },
+ "examples": {
+ "Forbidden": {
+ "summary": "Error 403",
+ "value": {
+ "detail": "This Woosmap API is not enabled for this project."
}
}
}
@@ -3189,513 +2830,178 @@
{
"lang": "curl",
"label": "cURL",
- "source": "curl -L 'https://api.woosmap.com/localities/geocode?address=Place%20Jeanne-d%27Arc&components=country%3AFR&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
- },
- {
- "lang": "javascript",
- "label": "JavaScript",
- "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/localities/geocode?address=Place%20Jeanne-d'Arc&components=country%3AFR&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));"
+ "source": "curl -L -X DELETE 'https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY'"
},
{
"lang": "python",
"label": "Python",
- "source": "import requests\n\nurl = \"https://api.woosmap.com/localities/geocode?address=Place%20Jeanne-d'Arc&components=country%3AFR&key=YOUR_PUBLIC_API_KEY\"\n\npayload = {}\nheaders = {\n 'Referer': 'http://localhost'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
+ "source": "import requests\n\nurl = \"https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"DELETE\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
+ },
+ {
+ "lang": "nodejs",
+ "label": "NodeJS",
+ "source": "const axios = require('axios');\n\nlet config = {\n method: 'delete',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY',\n headers: { }\n};\n\naxios.request(config)\n.then((response) => {\n console.log(JSON.stringify(response.data));\n})\n.catch((error) => {\n console.log(error);\n});\n"
}
]
}
},
- "/localities/nearby": {
+ "/zones/{zone_id}": {
"get": {
- "summary": "Nearby points of interest",
- "operationId": "localitiesNearby",
+ "summary": "Get Zone from ID",
+ "operationId": "getZone",
"servers": [
{
"url": "https://api.woosmap.com"
}
],
"tags": [
- "Localities API"
+ "Zones"
],
- "description": "Retrieve worldwide points of interest surrounding a given location. They can be filtered by categories.\n",
+ "description": "Used to retrieve a zone from his `zone_id`\n",
"security": [
- {
- "PublicApiKeyAuth": [],
- "RefererHeader": []
- },
{
"PrivateApiKeyAuth": []
- },
- {
- "PrivateApiKeyHeaderAuth": []
}
],
"parameters": [
{
- "$ref": "#/components/parameters/nearby_types"
- },
- {
- "name": "location",
- "description": "Center of the search circle.\n",
+ "in": "path",
+ "name": "zone_id",
"schema": {
"type": "string"
},
"required": true,
- "example": "40.71399,-74.00499",
- "in": "query"
+ "example": "ZoneA",
+ "description": "ID of the zone to get"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Zone successfully retrieved",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Zone"
+ },
+ "examples": {
+ "default": {
+ "summary": "Get a zone from its zone_id",
+ "value": {
+ "store_id": "STORE_ID_123456",
+ "zone_id": "ZoneA",
+ "polygon": "POLYGON ((-122.496116 37.7648181, -122.4954079 37.751518, -122.4635648 37.7530788, -122.4618481 37.7514501, -122.4601315 37.7521288, -122.4565266 37.7513144, -122.4540375 37.7566755, -122.4528359 37.7583041, -122.4515485 37.7595934, -122.4546384 37.774656, -122.4718903 37.7731635, -122.472577 37.772485, -122.4755811 37.7725529, -122.4791001 37.7723493, -122.4793576 37.7713995, -122.4784993 37.769839, -122.4783276 37.7680071, -122.4774693 37.766718, -122.4772118 37.7652931, -122.496116 37.7648181))",
+ "types": [
+ "delivery"
+ ],
+ "description": "Delivery Zone for Store A",
+ "status": "ok"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized. Incorrect authentication credentials.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error401"
+ },
+ "examples": {
+ "Unauthorized": {
+ "summary": "Error 401",
+ "value": {
+ "detail": "Incorrect authentication credentials. Please check or use a valid API Key"
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden. This Woosmap API is not enabled for this project.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Error403"
+ },
+ "examples": {
+ "Forbidden": {
+ "summary": "Error 403",
+ "value": {
+ "detail": "This Woosmap API is not enabled for this project."
+ }
+ }
+ }
+ }
+ }
},
+ "404": {
+ "description": "Not Found - `zone_id` do not exist."
+ }
+ },
+ "x-codeSamples": [
{
- "name": "radius",
- "description": "Radius of the search circle, in meters.\n",
- "schema": {
- "type": "integer",
- "default": 1000,
- "minimum": 10,
- "maximum": 50000
- },
- "in": "query",
- "required": false,
- "example": 3000
+ "lang": "curl",
+ "label": "cURL",
+ "source": "curl -L 'https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY'"
},
{
- "name": "page",
- "description": "Use `page` to navigate through paginated results.\n",
- "schema": {
- "type": "integer",
- "default": 1,
- "minimum": 1
- },
- "in": "query",
- "example": 7
+ "lang": "javascript",
+ "label": "JavaScript",
+ "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));"
},
{
- "name": "limit",
- "description": "Defines how many results should be included in a page.\n",
+ "lang": "python",
+ "label": "Python",
+ "source": "import requests\n\nurl = \"https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
+ }
+ ]
+ },
+ "delete": {
+ "summary": "Delete Zone from ID",
+ "operationId": "deleteZone",
+ "servers": [
+ {
+ "url": "https://api.woosmap.com"
+ }
+ ],
+ "tags": [
+ "Zones"
+ ],
+ "description": "Used to delete one Zone. The `zone_id` is the id of the zone to delete. To delete several zones, use the comma as a separator.",
+ "security": [
+ {
+ "PrivateApiKeyAuth": []
+ }
+ ],
+ "parameters": [
+ {
+ "in": "path",
+ "name": "zone_id",
"schema": {
- "type": "integer",
- "default": 10,
- "minimum": 1,
- "maximum": 30
+ "type": "string"
},
- "in": "query",
- "example": 15
- },
- {
- "$ref": "#/components/parameters/nearby_excluded_types"
+ "required": true,
+ "example": "ZoneA",
+ "description": "ID of the zone to delete"
}
],
"responses": {
"200": {
- "description": "Points of interest surrounding `location` and matching provided `types`, sorted by distance to `location`.",
+ "description": "Zones successfully deleted",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/LocalitiesNearbyCollectionResponse"
+ "$ref": "#/components/schemas/SuccessZones"
},
"examples": {
"default": {
- "summary": "Nearby points of interest with category `business.shop` around New York center.",
+ "summary": "Success response for Zones deleted",
"value": {
- "results": [
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6ZTc2ZDA1YzBiM2M0M2NmNmVkNTJjNGQyZDFiZDE3Nzc0OTZkNjlmOA==",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.fast_food"
- ],
- "categories": [
- "business.food_and_drinks.fast_food"
- ],
- "name": "Pret A Manger",
- "formatted_address": "Broadway, New York",
- "geometry": {
- "location": {
- "lat": 40.715905992166256,
- "lng": -74.00508673226767
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Broadway",
- "short_name": "Broadway"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6MzBlMGYxMzVhNGUzZDQ4MzRiMmNlNDMzMWJiYjZkOTY0MWJhN2E0Zg==",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.fast_food"
- ],
- "categories": [
- "business.food_and_drinks.fast_food"
- ],
- "name": "Dunkin'",
- "formatted_address": "Broadway, New York",
- "geometry": {
- "location": {
- "lat": 40.71602115951586,
- "lng": -74.00494482664695
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Broadway",
- "short_name": "Broadway"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmJlMWNkMTE2ZDQwM2E0Y2YwNGQ5NWQ2OTlmZWRmM2FhZTExNGU3ZWY=",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.restaurant"
- ],
- "categories": [
- "business.food_and_drinks.restaurant"
- ],
- "name": "Chambers",
- "formatted_address": "Chambers Street, New York",
- "geometry": {
- "location": {
- "lat": 40.71461844801976,
- "lng": -74.00754036678366
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Chambers Street",
- "short_name": "Chambers Street"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLnNob3AuZ3JvY2VyeTo1YTczMjYxOTQyYjVlZmUwOGEzZjQ1NGZmMTMwMmJjNjA4ODE3NmRk",
- "types": [
- "point_of_interest",
- "business.shop.grocery"
- ],
- "categories": [
- "business.shop.grocery"
- ],
- "name": "City Hall Oasis",
- "geometry": {
- "location": {
- "lat": 40.71283012706819,
- "lng": -74.00727837935057
- },
- "viewport": {
- "northeast": {
- "lat": 40.71286059528623,
- "lng": -74.00724213866874
- },
- "southwest": {
- "lat": 40.71279957503111,
- "lng": -74.00731464213119
- }
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZpbmFuY2UuYmFuazpiOGY5MDE4Nzc2ZDZjNmEwZTljOGM4YWM0OTAxZWZlNzNmODZkM2M3",
- "types": [
- "point_of_interest",
- "business.finance.bank"
- ],
- "categories": [
- "business.finance.bank"
- ],
- "name": "Citibank",
- "formatted_address": "Broadway, New York",
- "geometry": {
- "location": {
- "lat": 40.7130414767567,
- "lng": -74.0074818610995
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Broadway",
- "short_name": "Broadway"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQzMTMzZTJkODdiOGJjMGE3ZjI2YTdiMWVjYTZlZmI1MjQyYWE3MTE=",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.restaurant"
- ],
- "categories": [
- "business.food_and_drinks.restaurant"
- ],
- "name": "Saffron",
- "geometry": {
- "location": {
- "lat": 40.71467049963849,
- "lng": -74.00767187884445
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQ1NjMyN2RiM2EyNWJlYmIwNjJjZjNlYWYwMDE3ZDIyYzEyNWNlMjY=",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.restaurant"
- ],
- "categories": [
- "business.food_and_drinks.restaurant"
- ],
- "name": "Gran Morsi",
- "geometry": {
- "location": {
- "lat": 40.71432885326513,
- "lng": -74.00778746528921
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5iYXI6MDE5ZGUzNTdiZDkyNzAyZDM4ZDUyOWQ0YmJiZjBmODQ5YWEzZmY1NA==",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.bar"
- ],
- "categories": [
- "business.food_and_drinks.bar"
- ],
- "name": "Bon Courage",
- "formatted_address": "Reade Street, New York",
- "geometry": {
- "location": {
- "lat": 40.71541472882126,
- "lng": -74.00719193106873
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Reade Street",
- "short_name": "Reade Street"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6OGIyNDY5MDM4M2JhYzE1NmY4OGRiMGQzYmIyYzNjMTVmOTk0NDQwZQ==",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.fast_food"
- ],
- "categories": [
- "business.food_and_drinks.fast_food"
- ],
- "name": "Burger King",
- "formatted_address": "Broadway, New York",
- "geometry": {
- "location": {
- "lat": 40.71619516782573,
- "lng": -74.00480635760651
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Broadway",
- "short_name": "Broadway"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLnRoZWF0cmU6MTU1Yjk5YmEwY2FiYzIzZjYxYWYyYTViYzI0ZDViYTVlNmVmZTAwNA==",
- "types": [
- "point_of_interest",
- "business.theatre"
- ],
- "categories": [
- "business.theatre"
- ],
- "name": "The Flea",
- "formatted_address": "Thomas Street, New York",
- "geometry": {
- "location": {
- "lat": 40.71609349534023,
- "lng": -74.00589281989586
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Thomas Street",
- "short_name": "Thomas Street"
- }
- ]
- }
- ],
- "pagination": {
- "previous_page": 2,
- "next_page": 4
- }
+ "status": "ok",
+ "message": "Zone ZoneA deleted."
}
}
}
@@ -3737,892 +3043,109 @@
}
}
}
- },
- "429": {
- "description": "Too Many Requests. The rate limit for this endpoint has been exceeded.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Error429"
- },
- "examples": {
- "Forbidden": {
- "summary": "Error 429",
- "value": {
- "detail": "The rate limit for this endpoint has been exceeded"
- }
- }
- }
- }
- }
}
},
"x-codeSamples": [
{
"lang": "curl",
"label": "cURL",
- "source": "curl -L 'https://api.woosmap.com/localities/nearby?types=business&location=40.71399%2C-74.00499&page=3&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
- },
- {
- "lang": "javascript",
- "label": "JavaScript",
- "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/localities/nearby?types=business&location=40.71399%2C-74.00499&page=3&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));"
+ "source": "curl -L -X DELETE 'https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY'"
},
{
"lang": "python",
"label": "Python",
- "source": "import requests\n\nurl = \"https://api.woosmap.com/localities/nearby?types=business&location=40.71399%2C-74.00499&page=3&key=YOUR_PUBLIC_API_KEY\"\n\npayload = {}\nheaders = {\n 'Referer': 'http://localhost'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
- }
- ]
- }
- },
- "/zones": {
- "get": {
- "summary": "List your Zones",
- "operationId": "listZones",
- "servers": [
- {
- "url": "https://api.woosmap.com"
- }
- ],
- "tags": [
- "Zones"
- ],
- "description": "List all zones for the current project, sorted by `zone_id`.\n",
- "security": [
- {
- "PrivateApiKeyAuth": []
- }
- ],
- "parameters": [
- {
- "$ref": "#/components/parameters/limit-3"
+ "source": "import requests\n\nurl = \"https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload={}\nheaders = {}\n\nresponse = requests.request(\"DELETE\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
},
{
- "$ref": "#/components/parameters/offset"
- }
- ],
- "responses": {
- "200": {
- "description": "Zones successfully retrieved",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ZonesCollectionResponse"
- },
- "examples": {
- "default": {
- "summary": "Zones data",
- "value": {
- "zones": [
- {
- "store_id": "STORE_ID_123456",
- "zone_id": "ZoneB",
- "polygon": "POLYGON ((-122.4546384 37.774656, -122.4515485 37.7595934, -122.4354306 37.7602172, -122.4333707 37.7512596, -122.423071 37.7511239, -122.4242726 37.7687665, -122.4259893 37.7691736, -122.4289075 37.7732444, -122.4306241 37.7850483, -122.4472753 37.7830133, -122.445902 37.7759581, -122.4546384 37.774656))",
- "types": [
- "delivery"
- ],
- "description": "Delivery Zone for Store B"
- },
- {
- "store_id": "STORE_ID_45678",
- "zone_id": "ZoneC",
- "polygon": "POLYGON ((-122.4758889 37.7524995, -122.4751594 37.7321718, -122.4688079 37.7299995, -122.4648597 37.7261979, -122.4519851 37.7228035, -122.4483802 37.7215815, -122.4458053 37.726741, -122.4365356 37.7310857, -122.4315574 37.7324433, -122.4246909 37.7312214, -122.4219444 37.731493, -122.423071 37.7511239, -122.4333707 37.7512596, -122.4354306 37.7602172, -122.4515485 37.7595934, -122.4528628 37.7582744, -122.4540375 37.7566755, -122.4565266 37.7513144, -122.4601315 37.7521288, -122.4618481 37.7514501, -122.4635648 37.7530788, -122.4758889 37.7524995))",
- "types": [
- "delivery"
- ],
- "description": "Delivery Zone for Store C"
- }
- ],
- "status": "ok"
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized. Incorrect authentication credentials.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Error401"
- },
- "examples": {
- "Unauthorized": {
- "summary": "Error 401",
- "value": {
- "detail": "Incorrect authentication credentials. Please check or use a valid API Key"
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Forbidden. This Woosmap API is not enabled for this project.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Error403"
- },
- "examples": {
- "Forbidden": {
- "summary": "Error 403",
- "value": {
- "detail": "This Woosmap API is not enabled for this project."
- }
- }
- }
- }
- }
- },
- "429": {
- "description": "Too Many Requests. The rate limit for this endpoint has been exceeded.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Error429"
- },
- "examples": {
- "Forbidden": {
- "summary": "Error 429",
- "value": {
- "detail": "The rate limit for this endpoint has been exceeded"
- }
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "curl",
- "label": "cURL",
- "source": "curl -L 'https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY&limit=2&offset=1'"
- },
- {
- "lang": "javascript",
- "label": "JavaScript",
- "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY&limit=2&offset=1\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));"
- },
- {
- "lang": "python",
- "label": "Python",
- "source": "import requests\n\nurl = \"https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY&limit=2&offset=1\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
+ "lang": "nodejs",
+ "label": "NodeJS",
+ "source": "var axios = require('axios');\n\nvar config = {\n method: 'delete',\n url: 'https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY',\n headers: { }\n};\n\naxios(config)\n.then(function (response) {\n console.log(JSON.stringify(response.data));\n})\n.catch(function (error) {\n console.log(error);\n});\n"
}
]
+ }
+ }
+ },
+ "components": {
+ "parameters": {
+ "ip_address": {
+ "name": "ip_address",
+ "description": "The ip_address you want to geolocate. For **server call with private_key** only. Without this parameter, the API will geolocate the IP Address attached to the raw TCP request.\n",
+ "in": "query",
+ "schema": {
+ "type": "string",
+ "example": "75.134.29.90"
+ }
},
- "post": {
- "summary": "Create your Zones",
- "operationId": "createZones",
- "servers": [
- {
- "url": "https://api.woosmap.com"
- }
- ],
- "tags": [
- "Zones"
- ],
- "description": "Used to batch create Zones to a specific project identified with the `private_key` parameter.\n",
- "security": [
- {
- "PrivateApiKeyAuth": []
- }
- ],
- "requestBody": {
- "description": "The request body of Zones Creation must be formatted as JSON.",
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ZonesCollectionRequest"
- },
- "examples": {
- "default": {
- "summary": "Zones data as JSON",
- "value": {
- "zones": [
- {
- "zone_id": "ZoneA",
- "description": "Delivery Zone for Store A",
- "store_id": "STORE_ID_123456",
- "polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))",
- "types": [
- "delivery"
- ]
- },
- {
- "zone_id": "ZoneB",
- "description": "Delivery Zone for Store B",
- "store_id": "STORE_ID_123456",
- "polygon": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))",
- "types": [
- "delivery"
- ]
- },
- {
- "zone_id": "ZoneC",
- "description": "Delivery Zone for Store C",
- "store_id": "STORE_ID_45678",
- "polygon": "POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))",
- "types": [
- "delivery"
- ]
- }
- ]
- }
- }
- }
- }
- }
+ "limit": {
+ "name": "limit",
+ "description": "To limit number of assets retrieved from an IP location.\n",
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 300,
+ "example": 10
},
- "responses": {
- "200": {
- "description": "Zones successfully created",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/SuccessZones"
- },
- "examples": {
- "default": {
- "summary": "Success response for Zones Created",
- "value": {
- "status": "ok",
- "message": "Zones successfully added."
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Invalid. The data is not a valid JSON.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Error400"
- },
- "examples": {
- "Invalid": {
- "summary": "Error 400",
- "value": {
- "status": "error",
- "value": "The request is invalid, the data is not a valid JSON."
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized. Incorrect authentication credentials.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Error401"
- },
- "examples": {
- "Unauthorized": {
- "summary": "Error 401",
- "value": {
- "detail": "Incorrect authentication credentials. Please check or use a valid API Key"
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Forbidden. This Woosmap API is not enabled for this project.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Error403"
- },
- "examples": {
- "Forbidden": {
- "summary": "Error 403",
- "value": {
- "detail": "This Woosmap API is not enabled for this project."
- }
- }
- }
- }
- }
- }
+ "in": "query"
+ },
+ "query": {
+ "name": "query",
+ "in": "query",
+ "schema": {
+ "type": "string",
+ "example": "name:'My cool store'|type:'click_and_collect'"
},
- "x-codeSamples": [
- {
- "lang": "curl",
- "label": "cURL",
- "source": "curl -L 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneB\",\n \"description\": \"Delivery Zone for Store B\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneC\",\n \"description\": \"Delivery Zone for Store C\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n}'"
- },
- {
- "lang": "python",
- "label": "Python",
- "source": "import requests\nimport json\n\nurl = \"https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneB\",\n \"description\": \"Delivery Zone for Store B\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneC\",\n \"description\": \"Delivery Zone for Store C\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
- },
- {
- "lang": "nodejs",
- "label": "NodeJS",
- "source": "const axios = require('axios');\nlet data = JSON.stringify({\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneB\",\n \"description\": \"Delivery Zone for Store B\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneC\",\n \"description\": \"Delivery Zone for Store C\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n});\n\nlet config = {\n method: 'post',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY',\n headers: { \n 'content-type': 'application/json'\n },\n data : data\n};\n\naxios.request(config)\n.then((response) => {\n console.log(JSON.stringify(response.data));\n})\n.catch((error) => {\n console.log(error);\n});\n"
- }
- ]
+ "description": "Search query combining one or more search clauses. Each search clause is made up of three parts structured as `field` `:` `operator` `value`. , e.g. `name:=\"My cool store\"`\n### Vocabulary\n\n - **Field**: attribute of the Store that is searched, e.g. the attribute `name` of the store.\n\n - **Operator**: test that is performed on the data to provide a match, e.g. `=`.\n Each field has a default operator. If none operator follow the `:`, the default one is used.\n\n - **Value**: the content of the attribute that is tested, e.g. the name of the store `\"My cool store\"`.\n\nCombine clauses with the conjunctions `AND` or `OR`, and negate the query with `NOT`.\n### Fields\n\n - `type`: An element is contained within `type` collection. e.g. `type:\"myType\"`\n\n - `tag`: An element is contained within `tag` collection. e.g. `tag:\"myTag\"`\n\n - `city`: text matching: the value match the `city` field. e.g. `city:=\"Paris\"`\n\n - `country`: text matching: the value match the `countryCode` field. e.g. `country:=\"FR\"`\n\n - `name`: text matching: the value match the `name` field. e.g. `name:=\"myName\"`\n\n - `idstore`: text matching: the value match the `idstore` field. e.g. `idstore:=\"myIdStore\"`\n\n - `user`: concerns all fields inside `user_properties`. text matching or numerical comparison. e.g. `user.myAttribute:=\"myValue\"`\n\n - `localized`: used for [localizedNames](https://developers.woosmap.com/products/data-api/data-structure/#localizednames) to search in native language. text matching in collection: the value match one of the the `localizedNames`. e.g. `localized:=\"centro\"`\n\n> **userProperties** field has no restriction regarding the data you can put in it (Arrays, Object, Boolean, String, Numeric...) but you can only query for **text matching or numerical comparison**.\n### Operators\n\n - `:` : Default and mandatory operator. For `type` and `tag` fields, define that an element is contained within a collection.\n\n - `=` : The content of a string or a number is equal to the other.\n\n - `>` : A number is greater than another.\n\n - `<` : A number is smaller than another.\n\n - `>=` : A number is greater than or equal to another.\n\n - `<=` : A number is smaller than or equal to another.\n\n - `AND` : Return assets that match both clauses.\n\n - `OR` : Return assets that match either clauses.\n\n - `NOT` : Negates a search clause.\n\nFor compound clauses, you can use parentheses to group clauses together. For example: ```(type:\"type1\" OR type:\"type2\") AND tag:\"hockey\"```\nYou can use `NOT` operator to negates a search clause. For example: ```not type:\"type1\"```\n"
},
- "put": {
- "summary": "Update the Zones",
- "operationId": "updateZones",
- "servers": [
- {
- "url": "https://api.woosmap.com"
- }
- ],
- "tags": [
- "Zones"
- ],
- "description": "Used to update zones in batch. `zone_id` must exists when using `PUT` method, if one zone does not exists, the batch will be refused.",
- "security": [
- {
- "PrivateApiKeyAuth": []
- }
- ],
- "requestBody": {
- "description": "The request body of Zones Update must be formatted as JSON.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ZonesCollectionRequest"
- },
- "examples": {
- "default": {
- "summary": "Zones data",
- "value": {
- "zones": [
- {
- "zone_id": "ZoneA",
- "description": "Delivery Zone for Store A",
- "store_id": "STORE_ID_123456",
- "polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))",
- "types": [
- "delivery"
- ]
- },
- {
- "zone_id": "ZoneB",
- "description": "Delivery Zone for Store B",
- "store_id": "STORE_ID_123456",
- "polygon": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))",
- "types": [
- "delivery"
- ]
- },
- {
- "zone_id": "ZoneC",
- "description": "Delivery Zone for Store C",
- "store_id": "STORE_ID_45678",
- "polygon": "POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))",
- "types": [
- "delivery"
- ]
- }
- ]
- }
- }
- }
- }
- }
+ "lat": {
+ "name": "lat",
+ "description": "Latitude bias for the results. Should be pass with `lng`.\n",
+ "schema": {
+ "type": "number",
+ "example": 5.2
},
- "responses": {
- "200": {
- "description": "Zones successfully updated",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/SuccessZones"
- },
- "examples": {
- "default": {
- "summary": "Success response for Zones updated",
- "value": {
- "status": "ok",
- "message": "Zones successfully added."
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Invalid. The data is not a valid JSON.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Error400"
- },
- "examples": {
- "Invalid": {
- "summary": "Error 400",
- "value": {
- "status": "error",
- "value": "The request is invalid, the data is not a valid JSON."
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized. Incorrect authentication credentials.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Error401"
- },
- "examples": {
- "Unauthorized": {
- "summary": "Error 401",
- "value": {
- "detail": "Incorrect authentication credentials. Please check or use a valid API Key"
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Forbidden. This Woosmap API is not enabled for this project.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Error403"
- },
- "examples": {
- "Forbidden": {
- "summary": "Error 403",
- "value": {
- "detail": "This Woosmap API is not enabled for this project."
- }
- }
- }
- }
- }
- }
+ "in": "query"
+ },
+ "lng": {
+ "name": "lng",
+ "description": "Longitude bias for the results. Should be pass with `lat`.\n",
+ "schema": {
+ "type": "number",
+ "example": 3.5
},
- "x-codeSamples": [
- {
- "lang": "curl",
- "label": "cURL",
- "source": "curl -L -X PUT 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n}'"
- },
- {
- "lang": "python",
- "label": "Python",
- "source": "import requests\nimport json\n\nurl = \"https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
- },
- {
- "lang": "nodejs",
- "label": "NodeJS",
- "source": "const axios = require('axios');\nlet data = JSON.stringify({\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n});\n\nlet config = {\n method: 'put',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY',\n headers: { \n 'content-type': 'application/json'\n },\n data : data\n};\n\naxios.request(config)\n.then((response) => {\n console.log(JSON.stringify(response.data));\n})\n.catch((error) => {\n console.log(error);\n});\n"
- }
- ]
+ "in": "query"
},
- "delete": {
- "summary": "Delete the Zones",
- "operationId": "deleteZones",
- "servers": [
- {
- "url": "https://api.woosmap.com"
- }
- ],
- "tags": [
- "Zones"
- ],
- "description": "Used to delete one or more Zones.",
- "security": [
- {
- "PrivateApiKeyAuth": []
- }
- ],
- "responses": {
- "200": {
- "description": "Zones successfully deleted",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/SuccessZones"
- },
- "examples": {
- "default": {
- "summary": "Success response for Zones deleted",
- "value": {
- "status": "ok",
- "message": "Zones deleted."
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized. Incorrect authentication credentials.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Error401"
- },
- "examples": {
- "Unauthorized": {
- "summary": "Error 401",
- "value": {
- "detail": "Incorrect authentication credentials. Please check or use a valid API Key"
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Forbidden. This Woosmap API is not enabled for this project.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Error403"
- },
- "examples": {
- "Forbidden": {
- "summary": "Error 403",
- "value": {
- "detail": "This Woosmap API is not enabled for this project."
- }
- }
- }
- }
- }
- }
+ "radius": {
+ "name": "radius",
+ "description": "Unit in meters. Used to combine with lat/lng or encoded polyline. To bias the results within a given circular area. 3000 means to search for Assets that are at the most far from 3kms to search area (latlng or polyline).\n",
+ "schema": {
+ "type": "number",
+ "example": 3000
},
- "x-codeSamples": [
- {
- "lang": "curl",
- "label": "cURL",
- "source": "curl -L -X DELETE 'https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY'"
- },
- {
- "lang": "python",
- "label": "Python",
- "source": "import requests\n\nurl = \"https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"DELETE\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
- },
- {
- "lang": "nodejs",
- "label": "NodeJS",
- "source": "const axios = require('axios');\n\nlet config = {\n method: 'delete',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY',\n headers: { }\n};\n\naxios.request(config)\n.then((response) => {\n console.log(JSON.stringify(response.data));\n})\n.catch((error) => {\n console.log(error);\n});\n"
- }
- ]
- }
- },
- "/zones/{zone_id}": {
- "get": {
- "summary": "Get Zone from ID",
- "operationId": "getZone",
- "servers": [
- {
- "url": "https://api.woosmap.com"
- }
- ],
- "tags": [
- "Zones"
- ],
- "description": "Used to retrieve a zone from his `zone_id`\n",
- "security": [
- {
- "PrivateApiKeyAuth": []
- }
- ],
- "parameters": [
- {
- "in": "path",
- "name": "zone_id",
- "schema": {
- "type": "string"
- },
- "required": true,
- "example": "ZoneA",
- "description": "ID of the zone to get"
- }
- ],
- "responses": {
- "200": {
- "description": "Zone successfully retrieved",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Zone"
- },
- "examples": {
- "default": {
- "summary": "Get a zone from its zone_id",
- "value": {
- "store_id": "STORE_ID_123456",
- "zone_id": "ZoneA",
- "polygon": "POLYGON ((-122.496116 37.7648181, -122.4954079 37.751518, -122.4635648 37.7530788, -122.4618481 37.7514501, -122.4601315 37.7521288, -122.4565266 37.7513144, -122.4540375 37.7566755, -122.4528359 37.7583041, -122.4515485 37.7595934, -122.4546384 37.774656, -122.4718903 37.7731635, -122.472577 37.772485, -122.4755811 37.7725529, -122.4791001 37.7723493, -122.4793576 37.7713995, -122.4784993 37.769839, -122.4783276 37.7680071, -122.4774693 37.766718, -122.4772118 37.7652931, -122.496116 37.7648181))",
- "types": [
- "delivery"
- ],
- "description": "Delivery Zone for Store A",
- "status": "ok"
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized. Incorrect authentication credentials.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Error401"
- },
- "examples": {
- "Unauthorized": {
- "summary": "Error 401",
- "value": {
- "detail": "Incorrect authentication credentials. Please check or use a valid API Key"
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Forbidden. This Woosmap API is not enabled for this project.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Error403"
- },
- "examples": {
- "Forbidden": {
- "summary": "Error 403",
- "value": {
- "detail": "This Woosmap API is not enabled for this project."
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Not Found - `zone_id` do not exist."
- }
- },
- "x-codeSamples": [
- {
- "lang": "curl",
- "label": "cURL",
- "source": "curl -L 'https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY'"
- },
- {
- "lang": "javascript",
- "label": "JavaScript",
- "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));"
- },
- {
- "lang": "python",
- "label": "Python",
- "source": "import requests\n\nurl = \"https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
- }
- ]
+ "in": "query"
},
- "delete": {
- "summary": "Delete Zone from ID",
- "operationId": "deleteZone",
- "servers": [
- {
- "url": "https://api.woosmap.com"
- }
- ],
- "tags": [
- "Zones"
- ],
- "description": "Used to delete one Zone. The `zone_id` is the id of the zone to delete. To delete several zones, use the comma as a separator.",
- "security": [
- {
- "PrivateApiKeyAuth": []
- }
- ],
- "parameters": [
- {
- "in": "path",
- "name": "zone_id",
- "schema": {
- "type": "string"
- },
- "required": true,
- "example": "ZoneA",
- "description": "ID of the zone to delete"
- }
- ],
- "responses": {
- "200": {
- "description": "Zones successfully deleted",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/SuccessZones"
- },
- "examples": {
- "default": {
- "summary": "Success response for Zones deleted",
- "value": {
- "status": "ok",
- "message": "Zone ZoneA deleted."
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized. Incorrect authentication credentials.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Error401"
- },
- "examples": {
- "Unauthorized": {
- "summary": "Error 401",
- "value": {
- "detail": "Incorrect authentication credentials. Please check or use a valid API Key"
- }
- }
- }
- }
- }
- },
- "403": {
- "description": "Forbidden. This Woosmap API is not enabled for this project.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Error403"
- },
- "examples": {
- "Forbidden": {
- "summary": "Error 403",
- "value": {
- "detail": "This Woosmap API is not enabled for this project."
- }
- }
- }
- }
- }
- }
- },
- "x-codeSamples": [
- {
- "lang": "curl",
- "label": "cURL",
- "source": "curl -L -X DELETE 'https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY'"
- },
- {
- "lang": "python",
- "label": "Python",
- "source": "import requests\n\nurl = \"https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload={}\nheaders = {}\n\nresponse = requests.request(\"DELETE\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
- },
- {
- "lang": "nodejs",
- "label": "NodeJS",
- "source": "var axios = require('axios');\n\nvar config = {\n method: 'delete',\n url: 'https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY',\n headers: { }\n};\n\naxios(config)\n.then(function (response) {\n console.log(JSON.stringify(response.data));\n})\n.catch(function (error) {\n console.log(error);\n});\n"
- }
- ]
- }
- }
- },
- "components": {
- "parameters": {
- "ip_address": {
- "name": "ip_address",
- "description": "The ip_address you want to geolocate. For **server call with private_key** only. Without this parameter, the API will geolocate the IP Address attached to the raw TCP request.\n",
- "in": "query",
+ "encoded_polyline": {
+ "name": "encoded_polyline",
+ "description": "Find assets nearby an [encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) and inside a defined radius.\n",
"schema": {
"type": "string",
- "example": "75.134.29.90"
- }
+ "example": "_p~iF~ps|U_ulLnnqC_mqNvxq`@"
+ },
+ "in": "query"
},
- "limit": {
- "name": "limit",
- "description": "To limit number of assets retrieved from an IP location.\n",
+ "stores_by_page": {
+ "name": "stores_by_page",
+ "description": "If your request returns a high number of assets, the result will be paginated. If so, you can request assets by page using `page` and `stores_by_page` parameters (Default is 100, max is 300).\n",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 300,
- "example": 10
+ "example": 150
},
"in": "query"
},
- "query": {
- "name": "query",
- "in": "query",
- "schema": {
- "type": "string",
- "example": "name:'My cool store'|type:'click_and_collect'"
- },
- "description": "Search query combining one or more search clauses. Each search clause is made up of three parts structured as `field` `:` `operator` `value`. , e.g. `name:=\"My cool store\"`\n### Vocabulary\n\n - **Field**: attribute of the Store that is searched, e.g. the attribute `name` of the store.\n\n - **Operator**: test that is performed on the data to provide a match, e.g. `=`.\n Each field has a default operator. If none operator follow the `:`, the default one is used.\n\n - **Value**: the content of the attribute that is tested, e.g. the name of the store `\"My cool store\"`.\n\nCombine clauses with the conjunctions `AND` or `OR`, and negate the query with `NOT`.\n### Fields\n\n - `type`: An element is contained within `type` collection. e.g. `type:\"myType\"`\n\n - `tag`: An element is contained within `tag` collection. e.g. `tag:\"myTag\"`\n\n - `city`: text matching: the value match the `city` field. e.g. `city:=\"Paris\"`\n\n - `country`: text matching: the value match the `countryCode` field. e.g. `country:=\"FR\"`\n\n - `name`: text matching: the value match the `name` field. e.g. `name:=\"myName\"`\n\n - `idstore`: text matching: the value match the `idstore` field. e.g. `idstore:=\"myIdStore\"`\n\n - `user`: concerns all fields inside `user_properties`. text matching or numerical comparison. e.g. `user.myAttribute:=\"myValue\"`\n\n - `localized`: used for [localizedNames](https://developers.woosmap.com/products/data-api/data-structure/#localizednames) to search in native language. text matching in collection: the value match one of the the `localizedNames`. e.g. `localized:=\"centro\"`\n\n> **userProperties** field has no restriction regarding the data you can put in it (Arrays, Object, Boolean, String, Numeric...) but you can only query for **text matching or numerical comparison**.\n### Operators\n\n - `:` : Default and mandatory operator. For `type` and `tag` fields, define that an element is contained within a collection.\n\n - `=` : The content of a string or a number is equal to the other.\n\n - `>` : A number is greater than another.\n\n - `<` : A number is smaller than another.\n\n - `>=` : A number is greater than or equal to another.\n\n - `<=` : A number is smaller than or equal to another.\n\n - `AND` : Return assets that match both clauses.\n\n - `OR` : Return assets that match either clauses.\n\n - `NOT` : Negates a search clause.\n\nFor compound clauses, you can use parentheses to group clauses together. For example: ```(type:\"type1\" OR type:\"type2\") AND tag:\"hockey\"```\nYou can use `NOT` operator to negates a search clause. For example: ```not type:\"type1\"```\n"
- },
- "lat": {
- "name": "lat",
- "description": "Latitude bias for the results. Should be pass with `lng`.\n",
- "schema": {
- "type": "number",
- "example": 5.2
- },
- "in": "query"
- },
- "lng": {
- "name": "lng",
- "description": "Longitude bias for the results. Should be pass with `lat`.\n",
- "schema": {
- "type": "number",
- "example": 3.5
- },
- "in": "query"
- },
- "radius": {
- "name": "radius",
- "description": "Unit in meters. Used to combine with lat/lng or encoded polyline. To bias the results within a given circular area. 3000 means to search for Assets that are at the most far from 3kms to search area (latlng or polyline).\n",
- "schema": {
- "type": "number",
- "example": 3000
- },
- "in": "query"
- },
- "encoded_polyline": {
- "name": "encoded_polyline",
- "description": "Find assets nearby an [encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) and inside a defined radius.\n",
- "schema": {
- "type": "string",
- "example": "_p~iF~ps|U_ulLnnqC_mqNvxq`@"
- },
- "in": "query"
- },
- "stores_by_page": {
- "name": "stores_by_page",
- "description": "If your request returns a high number of assets, the result will be paginated. If so, you can request assets by page using `page` and `stores_by_page` parameters (Default is 100, max is 300).\n",
- "schema": {
- "type": "integer",
- "minimum": 1,
- "maximum": 300,
- "example": 150
- },
- "in": "query"
- },
- "page": {
- "name": "page",
- "description": "Page number when accessing paginated assets feature collection\n",
+ "page": {
+ "name": "page",
+ "description": "Page number when accessing paginated assets feature collection\n",
"schema": {
"type": "integer",
"example": 2
@@ -4658,222 +3181,6 @@
},
"in": "query"
},
- "input": {
- "name": "input",
- "description": "The text string on which to search, for example: \"london\" or \"123 Cross Road\".\nThe Woosmap Localities API will return predictions matches based on this string and order the results based on their perceived relevance.\nTo protect against illegitimate requests, only the 20 first tokens found in the first 150 characters will be used.\n",
- "schema": {
- "type": "string",
- "maxLength": 150,
- "example": "London"
- },
- "required": true,
- "in": "query"
- },
- "types": {
- "name": "types",
- "description": "Specifies the types of suggestions to return in the query. Multiple types can be combined using the pipe character (`|`) as a separator. This parameter supports a wide range of locality classifications, including:\n - Standard locality types (e.g., cities, administrative areas, postal codes)\n - Points of Interest (POI) categories\n - POI aliases\n\nThese classifications enable flexible geographic data representation and querying.\n",
- "schema": {
- "default": "locality|postal_code",
- "example": "locality|airport|admin_level",
- "$ref": "#/components/schemas/LocalitiesTypesAll"
- },
- "in": "query"
- },
- "excluded_types": {
- "name": "excluded_types",
- "description": "The types of suggestion to exclude. Multiple types can be passed using the pipe character (`|`) as a separator.\n",
- "schema": {
- "type": "string",
- "example": "suburb|quarter|neighbourhood"
- },
- "in": "query"
- },
- "localities_components": {
- "name": "components",
- "description": "A grouping of places to which you would like to restrict your results. Components can and should be used when applicable to filter over countries and retrieve more accurate results. Countries must be passed as an ISO 3166-1 Alpha-2 or Alpha-3 compatible country code. For example: `components=country:fr` or `components=country:fra` would restrict your results to places within France and `components=country:fr-fr` returns locations only in Metropolitan France. Multiple countries must be passed as multiple `country:XX` filters, with the pipe character (`|`) as a separator. For example: `components=country:gb|country:fr|country:be|country:sp|country:it` would restrict your results to city names or postal codes within the United Kingdom, France, Belgium, Spain and Italy.\n",
- "schema": {
- "type": "string",
- "example": "country:fr|country:es"
- },
- "in": "query"
- },
- "language-2": {
- "name": "language",
- "description": "The language code, using ISO 639-2 Alpha-2 country codes, indicating in which language the results should be returned, if possible. If language is not supplied, first `Accept-Language` of the browser will be used. If neither the provided `language` or the `Accept-Language` are known, the Localities service uses the international default language (English). No `language` is necessary for a postal_code request. According to requested language, only parts of the address components might be translated.\n",
- "schema": {
- "type": "string",
- "example": "en"
- },
- "in": "query"
- },
- "location": {
- "name": "location",
- "description": "This parameter is used to add a geographical bias to the query. The location defines the point around which to retrieve results in priority. It must be specified in the `latitude,longitude` string format.\n",
- "schema": {
- "type": "string",
- "example": "5.2,-2.3"
- },
- "required": false,
- "in": "query"
- },
- "radius-2": {
- "name": "radius",
- "description": "This parameter may be used in addition to the `location` parameter to define the distance in meters within which the API will return results in priority. Results outside of the defined area may still be displayed. Default radius if this parameter is not set is 100000.\n",
- "schema": {
- "type": "integer",
- "example": 200000
- },
- "in": "query",
- "required": false
- },
- "data": {
- "name": "data",
- "description": "Two values for this parameter: `standard` or `advanced`. By default, if the parameter is not defined, value is set as `standard`. The `advanced` value opens suggestions to worldwide postal codes in addition to postal codes for Western Europe. ***A dedicated option subject to specific billing on your license is needed to use this parameter. Please contact us if you are interested in using this parameter and you do not have subscribed the proper option yet.***\n",
- "schema": {
- "type": "string",
- "enum": [
- "standard",
- "advanced"
- ],
- "example": "advanced"
- },
- "in": "query"
- },
- "extended": {
- "name": "extended",
- "description": "If set, this parameter allows a refined search over locality names that bears the same postal code. By triggering this parameter, integrators will benefit from a search spectrum on the `locality` type that ***includes postal codes***. To avoid confusion, it is recommended not to activate this parameter along with the `postal_code` type which could lead to duplicate locations. Also, the default description returned by the API changes to `name (postal code), admin_1, admin_0`. It is only available for France, Monaco, Italy, Spain, Belgium, Switzerland and Luxembourg.\n",
- "schema": {
- "type": "string",
- "enum": [
- "postal_code"
- ],
- "example": "postal_code"
- },
- "in": "query"
- },
- "custom_description": {
- "name": "custom_description",
- "description": "This parameter allows to choose the description format for all or some of the suggestion types selected. The custom formats are described as follows (available fields depend on the returned type): `custom_description=type_A:\"{field_1}, {field_2}, [...]\"|type_B:\"{field_1}, {field_2}, [...]\"`\n",
- "schema": {
- "type": "string",
- "example": "locality:\"{name} - {administrative_area_level_0}\"|postal_code:\"{name} ({administrative_area_level_1})\""
- },
- "required": false,
- "in": "query"
- },
- "public_id": {
- "name": "public_id",
- "description": "A textual identifier that uniquely identifies a locality, returned from a [Localities Autocomplete](https://developers.woosmap.com/products/localities/autocomplete/).\n",
- "schema": {
- "type": "string",
- "example": "cG9zdGFsX2NvZGU6Z2I6OmNDN0N0ZUF2MW9YRi9KLzlnS2cremJndktFaz0="
- },
- "required": true,
- "in": "query"
- },
- "fields": {
- "name": "fields",
- "description": "If set, it will limit the content of responses to the specified fields. This parameter can be any combination of `geometry`, `address_components` or `shape` (defaults to `geometry|address_components`).\n",
- "schema": {
- "type": "string",
- "enum": [
- "geometry"
- ],
- "example": "geometry"
- },
- "in": "query"
- },
- "cc_format": {
- "name": "cc_format",
- "description": "To specify the format for the short [country code](https://en.wikipedia.org/wiki/ISO_3166-1) expected to be returned in the address_components field. Default is the format used to specify `components` or `alpha2` if no components are specified.\n",
- "schema": {
- "type": "string",
- "enum": [
- "alpha2",
- "alpha3"
- ],
- "example": "alpha2"
- },
- "in": "query"
- },
- "page-2": {
- "name": "page",
- "description": "In a few cases, a postal code details may contain addresses (UK postal codes). The address list is paginated. In that case, you can navigate in the address list thanks to the `addresses_per_page` and `page` parameters. Notice: as all the addresses are now automatically returned in the response, the `page` parameter is deprecated and has been turned off on December 31, 2021.\n",
- "schema": {
- "type": "integer",
- "example": 1
- },
- "in": "query",
- "deprecated": true
- },
- "addresses_per_page": {
- "name": "addresses_per_page",
- "description": "In a few cases, a postal code details may contain addresses (UK postal codes). The address list is paginated. In that case, you can navigate in the address list thanks to the `addresses_per_page` and `page` parameters. Notice: as all the addresses are now automatically returned in the response, the `addresses_per_page` parameter is deprecated and has been turned off on December 31, 2021.\n",
- "schema": {
- "type": "integer",
- "example": 10
- },
- "in": "query",
- "deprecated": true
- },
- "address": {
- "name": "address",
- "description": "The input string to geocode. Can represent an address, a street, a locality or a postal code. The `address` parameter must be URL encoded.\nTo protect against illegitimate requests, only the 20 first tokens found in the first 150 characters will be used.\n",
- "schema": {
- "type": "string",
- "maxLength": 150,
- "example": "224%20Rue%20de%20Rivoli%2C%20Paris"
- },
- "required": false,
- "in": "query"
- },
- "latlng": {
- "name": "latlng",
- "description": "The latlng parameter is used for reverse geocoding, it's required if the `address` parameter is missing.\n",
- "schema": {
- "type": "string",
- "example": "5.2,-2.3"
- },
- "required": false,
- "in": "query"
- },
- "geocode_types": {
- "name": "types",
- "description": "When executing a geocode request with the `address` parameter, it specifies the types of suggestions to return in the query. Multiple types can be combined using the pipe character (`|`) as a separator. This parameter supports a wide range of locality classifications, including:\n - Standard locality types (e.g., cities, administrative areas, postal codes)\n - Points of Interest (POI) categories\n - POI aliases\n\nThese classifications enable flexible geographic data representation and querying.\nThis parameter is ignored when used with the `latlng` parameter.\n",
- "schema": {
- "default": "locality|postal_code|address",
- "example": "locality|admin_level",
- "$ref": "#/components/schemas/LocalitiesTypesAll"
- },
- "in": "query"
- },
- "list_sub_buildings": {
- "name": "list_sub_buildings",
- "description": "When latlng parameter is used for reverse geocoding, setting `list_sub_building=true` allows to retrieve all addresses at the same location for a common street number or building. Results may contain an additional key \"sub_buildings\" with \"public_id\" and \"description\" values for every addresses at the same location sharing the same address components.\n",
- "schema": {
- "type": "boolean",
- "example": true
- },
- "required": false,
- "in": "query"
- },
- "nearby_types": {
- "name": "types",
- "description": "The types of points of interest to return. Multiple types can be passed using the pipe character (`|`) as a separator. For example: `types=business.shop|medical.pharmacy|business.finance.bank`.\n",
- "schema": {
- "$ref": "#/components/schemas/LocalitiesTypesPoi"
- },
- "required": true,
- "in": "query"
- },
- "nearby_excluded_types": {
- "name": "excluded_types",
- "description": "The types of points of interest to exclude from results. Results will match the specified `types`, if any, but will not match the specified `excluded_types`. Multiple types can be passed using the pipe character (`|`) as a separator. For example: `excluded_types=business.food_and_drinks.fast_food|business.food_and_drinks.pub`.\n",
- "schema": {
- "$ref": "#/components/schemas/LocalitiesTypesPoi"
- },
- "in": "query"
- },
"limit-3": {
"name": "limit",
"description": "To limit number of zones retrieved (max 50).\n",
@@ -4889,1161 +3196,73 @@
"name": "offset",
"description": "To retrieve zones starting from an offset value.\n",
"schema": {
- "type": "integer",
- "minimum": 1,
- "example": 20
- },
- "in": "query"
- }
- },
- "schemas": {
- "LatLngLiteral": {
- "title": "LatLngLiteral",
- "type": "object",
- "description": "An object describing a specific location with Latitude and Longitude in decimal degrees.",
- "required": [
- "lat",
- "lng"
- ],
- "example": {
- "lat": 43.3,
- "lng": 3.46
- },
- "properties": {
- "lat": {
- "type": "number",
- "description": "Latitude in decimal degrees",
- "example": 42.3
- },
- "lng": {
- "type": "number",
- "description": "Longitude in decimal degrees",
- "example": 3.46
- }
- }
- },
- "Bounds": {
- "title": "Bounds",
- "type": "object",
- "description": "A rectangle in geographical coordinates from points at the southwest and northeast corners.",
- "properties": {
- "northeast": {
- "$ref": "#/components/schemas/LatLngLiteral"
- },
- "southwest": {
- "$ref": "#/components/schemas/LatLngLiteral"
- }
- },
- "example": {
- "northeast": {
- "lat": 49.315678,
- "lng": 4.15292
- },
- "southwest": {
- "lat": 49.31073,
- "lng": 4.145162
- }
- }
- },
- "Timezone": {
- "title": "Timezone",
- "description": "Timezone for the Opening Hours of an Asset. It is used to compute the `open_now` property of an asset. see ",
- "type": "string",
- "example": "Europe/London"
- },
- "GeolocationResponse": {
- "title": "GeolocationResponse",
- "type": "object",
- "description": "A successful geolocation request will return a JSON-formatted response defining a location and radius.",
- "properties": {
- "viewport": {
- "$ref": "#/components/schemas/Bounds"
- },
- "accuracy": {
- "description": "The accuracy of the estimated location, in kilometers. This represents the radius of a circle around the given `location` where the IP address is likely to be. If your Geolocation response shows a low value in the `accuracy` field (<=50), the IP has strong chance to be correctly located.",
- "type": "number",
- "example": 5
- },
- "latitude": {
- "description": "Approximate latitude of the geographical area associated with the IP address",
- "type": "number",
- "example": 38.719
- },
- "longitude": {
- "description": "Approximate longitude of the geographical area associated with the IP address",
- "type": "number",
- "example": -77.1067
- },
- "country_code": {
- "description": "ISO 3166-1 Alpha-2 compatible country code",
- "type": [
- "string",
- "null"
- ],
- "example": "US"
- },
- "country_name": {
- "description": "Country name",
- "type": "string",
- "example": "United States"
- },
- "continent": {
- "description": "Continent name",
- "type": "string",
- "example": "North America"
- },
- "region_state": {
- "description": "Region name when available",
- "type": "string",
- "example": "Virginia"
- },
- "city": {
- "description": "City name when available",
- "type": "string",
- "example": "Alexandria"
- },
- "postal_code": {
- "description": "A postal code close to the user's location, when available",
- "type": "string",
- "example": "22309"
- },
- "timezone": {
- "$ref": "#/components/schemas/Timezone"
- },
- "raw_offset": {
- "description": "The offset from utc in seconds",
- "type": "integer",
- "example": -18000
- },
- "dst_offset": {
- "description": "The daylight saving time offset in seconds",
- "type": "integer",
- "example": 3600
- }
- },
- "example": {
- "country_code": "US",
- "country_name": "United States",
- "continent": "North America",
- "latitude": 38.719,
- "longitude": -77.1067,
- "viewport": {
- "northeast": {
- "lat": 38.763915764205976,
- "lng": -77.0491321464058
- },
- "southwest": {
- "lat": 38.674084235794034,
- "lng": -77.16426785359421
- }
- },
- "accuracy": 5,
- "city": "Alexandria",
- "region_state": "Virginia",
- "postal_code": "22309",
- "timezone": "America/New_York",
- "raw_offset": -18000,
- "dst_offset": 3600
- }
- },
- "Error401": {
- "title": "Error401",
- "type": "object",
- "description": "Authentication credentials are incorrect",
- "properties": {
- "detail": {
- "description": "Details for the credentials error",
- "example": "Incorrect authentication credentials. Please check or use a valid API Key",
- "type": "string"
- }
- }
- },
- "Error403": {
- "title": "Error403",
- "type": "object",
- "description": "API Request is authenticated but API Key don't have permission to access the resources",
- "properties": {
- "detail": {
- "description": "Details for the forbidden error message",
- "example": "This Woosmap API is not enabled for this project.",
- "type": "string"
- }
- }
- },
- "Error429": {
- "title": "Error429",
- "type": "object",
- "description": "Over Query Limit. Check the API Documentation for available QPS.",
- "properties": {
- "detail": {
- "description": "Details for the Over Query Limit error message",
- "example": "The rate limit for this endpoint has been exceeded",
- "type": "string"
- }
- }
- },
- "AssetName": {
- "title": "AssetName",
- "description": "The asset's name.",
- "type": "string",
- "example": "My Cool Store"
- },
- "AssetId": {
- "title": "AssetId",
- "description": "A textual identifier that uniquely identifies an Asset. It must matches the following regexp `[A-Za-z0-9]+`\n",
- "type": "string",
- "example": "STORE_ID_12345"
- },
- "AssetAddressLines": {
- "title": "AssetAddressLines",
- "description": "An Array for lines of an Asset Address",
- "type": "array",
- "example": [
- "Building Centre",
- "26 Store Street"
- ],
- "items": {
- "type": "string",
- "example": "26 Store Street"
- }
- },
- "AssetAddressResponse": {
- "title": "AssetAddressResponse",
- "type": "object",
- "description": "An object containing the separate components applicable to this address.",
- "properties": {
- "lines": {
- "$ref": "#/components/schemas/AssetAddressLines"
- },
- "country_code": {
- "description": "An ISO_3166-1 Country Code where the Asset is located (see for full list)",
- "type": [
- "string",
- "null"
- ],
- "example": "UK"
- },
- "city": {
- "description": "A City where belongs an Asset",
- "type": "string",
- "example": "London"
- },
- "zipcode": {
- "description": "An Zipcode / Postal code of an Asset Address",
- "type": "string",
- "example": "WC1E 7BT"
- }
- },
- "example": {
- "lines": [
- "8 Southwark St"
- ],
- "country_code": "UK",
- "city": "London",
- "zipcode": "SE1 1TL"
- }
- },
- "AssetContact": {
- "title": "AssetContact",
- "type": "object",
- "description": "An object containing the asset's contact available information.",
- "properties": {
- "website": {
- "description": "The website contact for this Asset, such as a business' homepage.",
- "type": "string",
- "example": "https://www.woosmap.com"
- },
- "phone": {
- "description": "Contains the Asset's phone number in its [local format](https://en.wikipedia.org/wiki/Local_conventions_for_writing_telephone_numbers).",
- "type": "string",
- "example": "+44 20 7693 4000"
- },
- "email": {
- "description": "Contains the Asset's email contact.",
- "type": "string",
- "example": "contact@woosmap.com"
- }
- },
- "example": {
- "website": "https://www.woosmap.com",
- "phone": "+44 20 7693 4000",
- "email": "contact@woosmap.com"
- }
- },
- "AssetOpeningHoursPeriod": {
- "title": "AssetOpeningHoursPeriod",
- "type": "object",
- "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)",
- "example": {
- "start": "08:30",
- "end": "19:30"
- },
- "required": [
- "start",
- "end"
- ],
- "properties": {
- "start": {
- "description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59",
- "type": "string",
- "example": "08:30"
- },
- "end": {
- "description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59",
- "type": "string",
- "example": "19:30"
- }
- }
- },
- "AssetOpenResponse": {
- "title": "AssetOpenResponse",
- "type": "object",
- "description": "The Current opening status for an Asset",
- "properties": {
- "current_slice": {
- "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
- },
- "open_hours": {
- "description": "the opening hours for the day",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
- }
- },
- "open_now": {
- "description": "Boolean value indicating the status of the opening hours",
- "type": "boolean"
- },
- "next_opening": {
- "description": "the next opening hours period",
- "type": "object",
- "properties": {
- "end": {
- "description": "the hours of next opening",
- "type": "string",
- "example": "17:30"
- },
- "start": {
- "description": "the hours of next closing",
- "type": "string",
- "example": "06:00"
- },
- "day": {
- "type": "string",
- "description": "the day of next opening",
- "example": "2021-11-16"
- }
- }
- },
- "week_day": {
- "description": "the day of the week starting from 1 to 7",
- "type": "integer",
- "minimum": 1,
- "maximum": 7
- }
- },
- "example": {
- "open_now": true,
- "open_hours": [
- {
- "end": "20:00",
- "start": "05:00"
- }
- ],
- "week_day": 1,
- "current_slice": {
- "end": "20:00",
- "start": "05:00"
- }
- }
- },
- "AssetWeeklyOpeningHoursPeriod": {
- "title": "AssetWeeklyOpeningHoursPeriod",
- "type": "object",
- "description": "The opening Hours for Monday",
- "properties": {
- "hours": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
- }
- },
- "isSpecial": {
- "type": "boolean",
- "description": "Define if the hours comes from a special opening hours day.",
- "example": false
- }
- },
- "example": {
- "hours": [
- {
- "start": "06:30",
- "end": "18:00"
- }
- ],
- "isSpecial": false
- }
- },
- "AssetWeeklyOpeningResponse": {
- "title": "AssetWeeklyOpeningResponse",
- "type": "object",
- "description": "The current Weekly Opening taking into account the special hours",
- "properties": {
- "1": {
- "$ref": "#/components/schemas/AssetWeeklyOpeningHoursPeriod"
- },
- "2": {
- "$ref": "#/components/schemas/AssetWeeklyOpeningHoursPeriod"
- },
- "3": {
- "$ref": "#/components/schemas/AssetWeeklyOpeningHoursPeriod"
- },
- "4": {
- "$ref": "#/components/schemas/AssetWeeklyOpeningHoursPeriod"
- },
- "5": {
- "$ref": "#/components/schemas/AssetWeeklyOpeningHoursPeriod"
- },
- "6": {
- "$ref": "#/components/schemas/AssetWeeklyOpeningHoursPeriod"
- },
- "7": {
- "$ref": "#/components/schemas/AssetWeeklyOpeningHoursPeriod"
- },
- "timezone": {
- "$ref": "#/components/schemas/Timezone"
- }
- },
- "example": {
- "1": {
- "hours": [],
- "isSpecial": false
- },
- "2": {
- "hours": [
- {
- "end": "22:00",
- "start": "08:30"
- }
- ],
- "isSpecial": false
- },
- "3": {
- "hours": [
- {
- "end": "22:00",
- "start": "08:30"
- }
- ],
- "isSpecial": false
- },
- "4": {
- "hours": [
- {
- "end": "22:00",
- "start": "08:30"
- }
- ],
- "isSpecial": false
- },
- "5": {
- "hours": [
- {
- "end": "22:00",
- "start": "08:30"
- }
- ],
- "isSpecial": false
- },
- "6": {
- "hours": [
- {
- "end": "22:00",
- "start": "08:30"
- }
- ],
- "isSpecial": false
- },
- "7": {
- "hours": [
- {
- "end": "22:00",
- "start": "08:30"
- }
- ],
- "isSpecial": false
- },
- "timezone": "Europe/London"
- }
- },
- "AssetTypes": {
- "title": "AssetTypes",
- "description": "Contains an array of types describing the Asset.",
- "type": "array",
- "items": {
- "type": "string",
- "example": "drive"
- },
- "example": [
- "drive",
- "click_and_collect"
- ]
- },
- "AssetTags": {
- "title": "AssetTags",
- "description": "Contains an array of tags describing the Asset. For example a list of available amenities.",
- "type": "array",
- "items": {
- "type": "string",
- "example": "wifi"
- },
- "example": [
- "wifi",
- "covered_parking"
- ]
- },
- "AssetOpeningHoursUsual": {
- "title": "AssetOpeningHoursUsual",
- "description": "An object describing the usual opening hours of an Asset.",
- "type": "object",
- "properties": {
- "1": {
- "description": "The opening Hours for Monday",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
- }
- },
- "2": {
- "description": "The opening Hours for Tuesday",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
- }
- },
- "3": {
- "description": "The opening Hours for Wednesday",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
- }
- },
- "4": {
- "description": "The opening Hours for Thursday",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
- }
- },
- "5": {
- "description": "The opening Hours for Friday",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
- }
- },
- "6": {
- "description": "The opening Hours for Saturday",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
- }
- },
- "7": {
- "description": "The opening Hours for Sunday",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
- }
- },
- "default": {
- "description": "Contains the default opening hours to apply to all week days",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
- }
- }
- }
- },
- "AssetOpeningHoursSpecial": {
- "title": "AssetOpeningHoursSpecial",
- "description": "An object describing the special opening hours of an Asset.",
- "type": "object",
- "properties": {
- "2015-02-07": {
- "description": "The format for defining opening and closing hours for a particular day is the same as the usual. Instead of using numeric week day for keys you must use a date YYYY-MM-DD like \"2015-03-08\" (see ISO-8601).\n",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
- }
- },
- "2015-02-08": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
- }
- }
- }
- },
- "AssetOpeningHours": {
- "title": "AssetOpeningHours",
- "type": [
- "object",
- "null"
- ],
- "description": "An object describing the opening hours of an Asset.",
- "properties": {
- "timezone": {
- "$ref": "#/components/schemas/Timezone"
- },
- "usual": {
- "$ref": "#/components/schemas/AssetOpeningHoursUsual"
- },
- "special": {
- "$ref": "#/components/schemas/AssetOpeningHoursSpecial"
- }
- },
- "example": {
- "timezone": "Europe/London",
- "usual": {
- "1": [],
- "default": [
- {
- "start": "08:30",
- "end": "22:00"
- }
- ]
- },
- "special": {
- "2015-02-07": [
- {
- "start": "08:00",
- "end": "23:00"
- }
- ]
- }
- }
- },
- "AssetResponse": {
- "title": "AssetResponse",
- "type": "object",
- "description": "Attributes describing an Asset.",
- "properties": {
- "name": {
- "$ref": "#/components/schemas/AssetName"
- },
- "store_id": {
- "$ref": "#/components/schemas/AssetId"
- },
- "address": {
- "$ref": "#/components/schemas/AssetAddressResponse"
- },
- "contact": {
- "$ref": "#/components/schemas/AssetContact"
- },
- "open": {
- "$ref": "#/components/schemas/AssetOpenResponse"
- },
- "weekly_opening": {
- "$ref": "#/components/schemas/AssetWeeklyOpeningResponse"
- },
- "types": {
- "$ref": "#/components/schemas/AssetTypes"
- },
- "tags": {
- "$ref": "#/components/schemas/AssetTags"
- },
- "last_updated": {
- "type": [
- "string",
- "null"
- ],
- "description": "the previous date timestamp when the asset has been updated",
- "example": "2022-11-08T15:48:08.556803+00:00"
- },
- "user_properties": {
- "description": "Contains all additional information relative to an Asset. If not set it returns null value.",
- "type": [
- "object",
- "null"
- ],
- "additionalProperties": true,
- "example": {
- "some_user_properties": "some_value"
- }
- },
- "opening_hours": {
- "$ref": "#/components/schemas/AssetOpeningHours"
- },
- "distance": {
- "description": "The distance in meters from the geolocated position or searched position if exist",
- "type": "number",
- "example": 544.581
- }
- }
- },
- "LatLngArrayString": {
- "title": "LatLngArrayString",
- "description": "An array of comma separated {latitude,longitude} strings.",
- "example": [
- 43.4,
- -2.1
- ],
- "type": "array",
- "minItems": 2,
- "maxItems": 2,
- "items": {
- "type": "number"
- }
- },
- "GeoJsonPoint": {
- "title": "GeoJsonPoint",
- "type": "object",
- "description": "GeoJSon Point Geometry",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "Point"
- ],
- "description": "the geometry type"
- },
- "coordinates": {
- "$ref": "#/components/schemas/LatLngArrayString"
- }
- },
- "example": {
- "type": "Point",
- "coordinates": [
- -0.14408,
- 51.5088
- ]
- }
- },
- "AssetFeatureResponse": {
- "title": "AssetFeatureResponse",
- "type": "object",
- "description": "Asset Response as a GeoJSon Feature with Asset properties",
- "properties": {
- "type": {
- "description": "the Geojson Type (only 'Feature')",
- "type": "string",
- "enum": [
- "Feature"
- ]
- },
- "properties": {
- "$ref": "#/components/schemas/AssetResponse"
- },
- "geometry": {
- "$ref": "#/components/schemas/GeoJsonPoint"
- }
- },
- "example": {
- "type": "Feature",
- "properties": {
- "store_id": "10031",
- "name": "Santa Rosa & Yolanda",
- "contact": {
- "phone": "707-527-1006",
- "website": "https://www.starbucks.com/store-locator/store/10031/santa-rosa-yolanda-2688-santa-rosa-ave-santa-rosa-ca-954077625-us"
- },
- "address": {
- "lines": [
- "2688 Santa Rosa Ave",
- "Santa Rosa, CA 95407"
- ],
- "country_code": "US",
- "city": "Santa Rosa",
- "zipcode": "954077625"
- },
- "user_properties": {
- "take_away": "available"
- },
- "tags": [
- "DT",
- "WA",
- "CD",
- "DR",
- "LB",
- "GO",
- "XO",
- "MX",
- "NB",
- "BE",
- "LU"
- ],
- "types": [
- "Coffee shop"
- ],
- "last_updated": "2022-11-10T13:26:55.066524+00:00",
- "open": {
- "open_now": false,
- "open_hours": [
- {
- "end": "20:00",
- "start": "05:00"
- }
- ],
- "week_day": 2,
- "next_opening": {
- "day": "2025-09-16",
- "start": "05:00",
- "end": "20:00"
- }
- },
- "weekly_opening": {
- "1": {
- "hours": [
- {
- "end": "20:00",
- "start": "05:00"
- }
- ],
- "isSpecial": false
- },
- "2": {
- "hours": [
- {
- "end": "20:00",
- "start": "05:00"
- }
- ],
- "isSpecial": false
- },
- "3": {
- "hours": [
- {
- "end": "20:00",
- "start": "05:00"
- }
- ],
- "isSpecial": false
- },
- "4": {
- "hours": [
- {
- "end": "20:00",
- "start": "05:00"
- }
- ],
- "isSpecial": false
- },
- "5": {
- "hours": [
- {
- "end": "20:00",
- "start": "05:00"
- }
- ],
- "isSpecial": false
- },
- "6": {
- "hours": [
- {
- "end": "20:00",
- "start": "05:00"
- }
- ],
- "isSpecial": false
- },
- "7": {
- "hours": [
- {
- "end": "20:00",
- "start": "05:00"
- }
- ],
- "isSpecial": false
- },
- "timezone": "America/Los_Angeles"
- },
- "opening_hours": {
- "usual": {
- "1": [
- {
- "end": "20:00",
- "start": "05:00"
- }
- ],
- "2": [
- {
- "end": "20:00",
- "start": "05:00"
- }
- ],
- "3": [
- {
- "end": "20:00",
- "start": "05:00"
- }
- ],
- "4": [
- {
- "end": "20:00",
- "start": "05:00"
- }
- ],
- "5": [
- {
- "end": "20:00",
- "start": "05:00"
- }
- ],
- "6": [
- {
- "end": "20:00",
- "start": "05:00"
- }
- ],
- "7": [
- {
- "end": "20:00",
- "start": "05:00"
- }
- ]
- },
- "special": {},
- "timezone": "America/Los_Angeles"
- }
- },
- "geometry": {
- "type": "Point",
- "coordinates": [
- -122.712924,
- 38.41244
- ]
- }
- }
- },
- "Pagination": {
- "title": "Pagination",
- "type": "object",
- "description": "Pagination to reach all returned assets. max 300 assets par page.",
- "properties": {
- "page": {
- "type": "integer",
- "description": "the request page",
- "example": 1
- },
- "pageCount": {
- "type": "integer",
- "description": "the number of available pages",
- "example": 10
- }
- }
- },
- "AssetFeatureCollectionResponse": {
- "title": "AssetFeatureCollectionResponse",
- "type": "object",
- "description": "Assets Collection Response as a GeoJSon FeatureCollection with Asset properties",
- "properties": {
- "type": {
- "description": "the Geojson Type (only 'FeatureCollection')",
- "type": "string",
- "enum": [
- "FeatureCollection"
- ]
- },
- "features": {
- "description": "the Assets Features",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AssetFeatureResponse"
- }
- },
- "pagination": {
- "$ref": "#/components/schemas/Pagination"
- }
- },
- "example": {
- "type": "FeatureCollection",
- "features": [
- {
- "type": "Feature",
- "properties": {
- "store_id": "2354",
- "name": "Berkeley Street/Berkeley Square",
- "contact": {
- "phone": "02076295779",
- "website": "https://www.starbucks.com/store-locator/store/2354/berkeley-street-berkeley-square-27-berkeley-st-berkeley-square-london-eng-w-1-x-5-"
- },
- "address": {
- "lines": [
- "27 Berkeley St",
- "London, ENG W1X 5AD"
- ],
- "country_code": "GB",
- "city": "London",
- "zipcode": "W1X 5AD"
- },
- "user_properties": {
- "take_away": "available"
- },
- "tags": [
- "WA",
- "WF",
- "CD",
- "DR",
- "XO"
- ],
- "types": [
- "Coffee shop"
- ],
- "last_updated": "2022-11-10T13:23:53.564829+00:00",
- "distance": 135.28682936,
- "open": {
- "open_now": true,
- "open_hours": [
- {
- "end": "18:00",
- "start": "06:30"
- }
- ],
- "week_day": 2,
- "current_slice": {
- "end": "18:00",
- "start": "06:30"
- }
- },
- "weekly_opening": {
- "1": {
- "hours": [
- {
- "end": "18:00",
- "start": "06:30"
- }
- ],
- "isSpecial": false
- },
- "2": {
- "hours": [
- {
- "end": "18:00",
- "start": "06:30"
- }
- ],
- "isSpecial": false
- },
- "3": {
- "hours": [
- {
- "end": "18:00",
- "start": "06:30"
- }
- ],
- "isSpecial": false
- },
- "4": {
- "hours": [
- {
- "end": "18:00",
- "start": "06:30"
- }
- ],
- "isSpecial": false
- },
- "5": {
- "hours": [
- {
- "end": "18:00",
- "start": "06:30"
- }
- ],
- "isSpecial": false
- },
- "6": {
- "hours": [
- {
- "end": "17:00",
- "start": "08:00"
- }
- ],
- "isSpecial": false
- },
- "7": {
- "hours": [
- {
- "end": "17:00",
- "start": "08:00"
- }
- ],
- "isSpecial": false
- },
- "timezone": "Europe/London"
- },
- "opening_hours": {
- "usual": {
- "1": [
- {
- "end": "18:00",
- "start": "06:30"
- }
- ],
- "2": [
- {
- "end": "18:00",
- "start": "06:30"
- }
- ],
- "3": [
- {
- "end": "18:00",
- "start": "06:30"
- }
- ],
- "4": [
- {
- "end": "18:00",
- "start": "06:30"
- }
- ],
- "5": [
- {
- "end": "18:00",
- "start": "06:30"
- }
- ],
- "6": [
- {
- "end": "17:00",
- "start": "08:00"
- }
- ],
- "7": [
- {
- "end": "17:00",
- "start": "08:00"
- }
- ]
- },
- "special": {},
- "timezone": "Europe/London"
- }
- },
- "geometry": {
- "type": "Point",
- "coordinates": [
- -0.14408,
- 51.5088
- ]
- }
- }
- ],
- "pagination": {
- "page": 1,
- "pageCount": 1
+ "type": "integer",
+ "minimum": 1,
+ "example": 20
+ },
+ "in": "query"
+ }
+ },
+ "schemas": {
+ "LatLngLiteral": {
+ "title": "LatLngLiteral",
+ "type": "object",
+ "description": "An object describing a specific location with Latitude and Longitude in decimal degrees.",
+ "required": [
+ "lat",
+ "lng"
+ ],
+ "example": {
+ "lat": 43.3,
+ "lng": 3.46
+ },
+ "properties": {
+ "lat": {
+ "type": "number",
+ "description": "Latitude in decimal degrees",
+ "example": 42.3
+ },
+ "lng": {
+ "type": "number",
+ "description": "Longitude in decimal degrees",
+ "example": 3.46
}
}
},
- "GeolocationStoresResponse": {
- "title": "GeolocationStoresResponse",
- "description": "JSON-formatted response defining a location, radius, and stores if accuracy of geocoded IP is 20km or less.",
+ "Bounds": {
+ "title": "Bounds",
"type": "object",
+ "description": "A rectangle in geographical coordinates from points at the southwest and northeast corners.",
"properties": {
- "stores": {
- "$ref": "#/components/schemas/AssetFeatureCollectionResponse"
+ "northeast": {
+ "$ref": "#/components/schemas/LatLngLiteral"
+ },
+ "southwest": {
+ "$ref": "#/components/schemas/LatLngLiteral"
+ }
+ },
+ "example": {
+ "northeast": {
+ "lat": 49.315678,
+ "lng": 4.15292
},
+ "southwest": {
+ "lat": 49.31073,
+ "lng": 4.145162
+ }
+ }
+ },
+ "Timezone": {
+ "title": "Timezone",
+ "description": "Timezone for the Opening Hours of an Asset. It is used to compute the `open_now` property of an asset. see ",
+ "type": "string",
+ "example": "Europe/London"
+ },
+ "GeolocationResponse": {
+ "title": "GeolocationResponse",
+ "type": "object",
+ "description": "A successful geolocation request will return a JSON-formatted response defining a location and radius.",
+ "properties": {
"viewport": {
"$ref": "#/components/schemas/Bounds"
},
@@ -6083,309 +3302,573 @@
"region_state": {
"description": "Region name when available",
"type": "string",
- "example": "Virginia"
+ "example": "Virginia"
+ },
+ "city": {
+ "description": "City name when available",
+ "type": "string",
+ "example": "Alexandria"
+ },
+ "postal_code": {
+ "description": "A postal code close to the user's location, when available",
+ "type": "string",
+ "example": "22309"
+ },
+ "timezone": {
+ "$ref": "#/components/schemas/Timezone"
+ },
+ "raw_offset": {
+ "description": "The offset from utc in seconds",
+ "type": "integer",
+ "example": -18000
+ },
+ "dst_offset": {
+ "description": "The daylight saving time offset in seconds",
+ "type": "integer",
+ "example": 3600
+ }
+ },
+ "example": {
+ "country_code": "US",
+ "country_name": "United States",
+ "continent": "North America",
+ "latitude": 38.719,
+ "longitude": -77.1067,
+ "viewport": {
+ "northeast": {
+ "lat": 38.763915764205976,
+ "lng": -77.0491321464058
+ },
+ "southwest": {
+ "lat": 38.674084235794034,
+ "lng": -77.16426785359421
+ }
+ },
+ "accuracy": 5,
+ "city": "Alexandria",
+ "region_state": "Virginia",
+ "postal_code": "22309",
+ "timezone": "America/New_York",
+ "raw_offset": -18000,
+ "dst_offset": 3600
+ }
+ },
+ "Error401": {
+ "title": "Error401",
+ "type": "object",
+ "description": "Authentication credentials are incorrect",
+ "properties": {
+ "detail": {
+ "description": "Details for the credentials error",
+ "example": "Incorrect authentication credentials. Please check or use a valid API Key",
+ "type": "string"
+ }
+ }
+ },
+ "Error403": {
+ "title": "Error403",
+ "type": "object",
+ "description": "API Request is authenticated but API Key don't have permission to access the resources",
+ "properties": {
+ "detail": {
+ "description": "Details for the forbidden error message",
+ "example": "This Woosmap API is not enabled for this project.",
+ "type": "string"
+ }
+ }
+ },
+ "Error429": {
+ "title": "Error429",
+ "type": "object",
+ "description": "Over Query Limit. Check the API Documentation for available QPS.",
+ "properties": {
+ "detail": {
+ "description": "Details for the Over Query Limit error message",
+ "example": "The rate limit for this endpoint has been exceeded",
+ "type": "string"
+ }
+ }
+ },
+ "AssetName": {
+ "title": "AssetName",
+ "description": "The asset's name.",
+ "type": "string",
+ "example": "My Cool Store"
+ },
+ "AssetId": {
+ "title": "AssetId",
+ "description": "A textual identifier that uniquely identifies an Asset. It must matches the following regexp `[A-Za-z0-9]+`\n",
+ "type": "string",
+ "example": "STORE_ID_12345"
+ },
+ "AssetAddressLines": {
+ "title": "AssetAddressLines",
+ "description": "An Array for lines of an Asset Address",
+ "type": "array",
+ "example": [
+ "Building Centre",
+ "26 Store Street"
+ ],
+ "items": {
+ "type": "string",
+ "example": "26 Store Street"
+ }
+ },
+ "AssetAddressResponse": {
+ "title": "AssetAddressResponse",
+ "type": "object",
+ "description": "An object containing the separate components applicable to this address.",
+ "properties": {
+ "lines": {
+ "$ref": "#/components/schemas/AssetAddressLines"
+ },
+ "country_code": {
+ "description": "An ISO_3166-1 Country Code where the Asset is located (see for full list)",
+ "type": [
+ "string",
+ "null"
+ ],
+ "example": "UK"
+ },
+ "city": {
+ "description": "A City where belongs an Asset",
+ "type": "string",
+ "example": "London"
+ },
+ "zipcode": {
+ "description": "An Zipcode / Postal code of an Asset Address",
+ "type": "string",
+ "example": "WC1E 7BT"
+ }
+ },
+ "example": {
+ "lines": [
+ "8 Southwark St"
+ ],
+ "country_code": "UK",
+ "city": "London",
+ "zipcode": "SE1 1TL"
+ }
+ },
+ "AssetContact": {
+ "title": "AssetContact",
+ "type": "object",
+ "description": "An object containing the asset's contact available information.",
+ "properties": {
+ "website": {
+ "description": "The website contact for this Asset, such as a business' homepage.",
+ "type": "string",
+ "example": "https://www.woosmap.com"
+ },
+ "phone": {
+ "description": "Contains the Asset's phone number in its [local format](https://en.wikipedia.org/wiki/Local_conventions_for_writing_telephone_numbers).",
+ "type": "string",
+ "example": "+44 20 7693 4000"
+ },
+ "email": {
+ "description": "Contains the Asset's email contact.",
+ "type": "string",
+ "example": "contact@woosmap.com"
+ }
+ },
+ "example": {
+ "website": "https://www.woosmap.com",
+ "phone": "+44 20 7693 4000",
+ "email": "contact@woosmap.com"
+ }
+ },
+ "AssetOpeningHoursPeriod": {
+ "title": "AssetOpeningHoursPeriod",
+ "type": "object",
+ "description": "The hours for an opening period. To define a slice of time where the asset is open you must define a `start` and `end` keys. `start` and `end` must belong to the same day (crossing midnight may result in open_now being always false.)",
+ "example": {
+ "start": "08:30",
+ "end": "19:30"
+ },
+ "required": [
+ "start",
+ "end"
+ ],
+ "properties": {
+ "start": {
+ "description": "Contains a time of day in 24-hour hh:mm format for the begin of opening period. Values are in the range 00:00–23:59",
+ "type": "string",
+ "example": "08:30"
},
- "city": {
- "description": "City name when available",
+ "end": {
+ "description": "Contains a time of day in 24-hour hh:mm format for the end of opening period. Values are in the range 00:00–23:59",
"type": "string",
- "example": "Alexandria"
+ "example": "19:30"
+ }
+ }
+ },
+ "AssetOpenResponse": {
+ "title": "AssetOpenResponse",
+ "type": "object",
+ "description": "The Current opening status for an Asset",
+ "properties": {
+ "current_slice": {
+ "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
},
- "postal_code": {
- "description": "A postal code close to the user's location, when available",
- "type": "string",
- "example": "22309"
+ "open_hours": {
+ "description": "the opening hours for the day",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
+ }
},
- "timezone": {
- "$ref": "#/components/schemas/Timezone"
+ "open_now": {
+ "description": "Boolean value indicating the status of the opening hours",
+ "type": "boolean"
},
- "raw_offset": {
- "description": "The offset from utc in seconds",
- "type": "integer",
- "example": -18000
+ "next_opening": {
+ "description": "the next opening hours period",
+ "type": "object",
+ "properties": {
+ "end": {
+ "description": "the hours of next opening",
+ "type": "string",
+ "example": "17:30"
+ },
+ "start": {
+ "description": "the hours of next closing",
+ "type": "string",
+ "example": "06:00"
+ },
+ "day": {
+ "type": "string",
+ "description": "the day of next opening",
+ "example": "2021-11-16"
+ }
+ }
},
- "dst_offset": {
- "description": "The daylight saving time offset in seconds",
+ "week_day": {
+ "description": "the day of the week starting from 1 to 7",
"type": "integer",
- "example": 3600
+ "minimum": 1,
+ "maximum": 7
}
},
"example": {
- "country_code": "US",
- "country_name": "United States",
- "continent": "North America",
- "latitude": 38.719,
- "longitude": -77.1067,
- "viewport": {
- "northeast": {
- "lat": 38.763915764205976,
- "lng": -77.0491321464058
- },
- "southwest": {
- "lat": 38.674084235794034,
- "lng": -77.16426785359421
+ "open_now": true,
+ "open_hours": [
+ {
+ "end": "20:00",
+ "start": "05:00"
}
- },
- "accuracy": 5,
- "city": "Alexandria",
- "region_state": "Virginia",
- "postal_code": "22309",
- "timezone": "America/New_York",
- "raw_offset": -18000,
- "dst_offset": 3600,
- "stores": {
- "type": "FeatureCollection",
- "features": [
- {
- "type": "Feature",
- "properties": {
- "store_id": "STORE_ID_123456",
- "name": "My Cool Store",
- "contact": {
- "email": "contact@woosmap.com",
- "phone": "+44 20 7693 4000",
- "website": "https://www.woosmap.com"
- },
- "address": {
- "lines": [
- "Building Centre",
- "26 Store Street"
- ],
- "country_code": "UK",
- "city": "London",
- "zipcode": "WC1E 7BT"
- },
- "user_properties": {
- "some_user_properties": "associated user value"
- },
- "tags": [
- "wifi",
- "covered_parking"
- ],
- "types": [
- "drive",
- "click_and_collect"
- ],
- "last_updated": "2025-09-16T08:49:42.523114+00:00",
- "distance": 0,
- "open": {
- "open_now": true,
- "open_hours": [
- {
- "end": "22:00",
- "start": "08:30"
- }
- ],
- "week_day": 2,
- "current_slice": {
- "end": "22:00",
- "start": "08:30"
- }
- },
- "weekly_opening": {
- "1": {
- "hours": [],
- "isSpecial": false
- },
- "2": {
- "hours": [
- {
- "end": "22:00",
- "start": "08:30"
- }
- ],
- "isSpecial": false
- },
- "3": {
- "hours": [
- {
- "end": "22:00",
- "start": "08:30"
- }
- ],
- "isSpecial": false
- },
- "4": {
- "hours": [
- {
- "end": "22:00",
- "start": "08:30"
- }
- ],
- "isSpecial": false
- },
- "5": {
- "hours": [
- {
- "end": "22:00",
- "start": "08:30"
- }
- ],
- "isSpecial": false
- },
- "6": {
- "hours": [
- {
- "end": "22:00",
- "start": "08:30"
- }
- ],
- "isSpecial": false
- },
- "7": {
- "hours": [
- {
- "end": "22:00",
- "start": "08:30"
- }
- ],
- "isSpecial": false
- },
- "timezone": "Europe/London"
- },
- "opening_hours": {
- "usual": {
- "1": [],
- "default": [
- {
- "end": "22:00",
- "start": "08:30"
- }
- ]
- },
- "special": {
- "2015-02-07": [
- {
- "end": "23:00",
- "start": "08:00"
- }
- ]
- },
- "timezone": "Europe/London"
- }
- },
- "geometry": {
- "type": "Point",
- "coordinates": [
- -77.1067,
- 38.719
- ]
- }
- }
- ],
- "pagination": {
- "page": 1,
- "pageCount": 2
+ ],
+ "week_day": 1,
+ "current_slice": {
+ "end": "20:00",
+ "start": "05:00"
+ }
+ }
+ },
+ "AssetWeeklyOpeningHoursPeriod": {
+ "title": "AssetWeeklyOpeningHoursPeriod",
+ "type": "object",
+ "description": "The opening Hours for Monday",
+ "properties": {
+ "hours": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
}
+ },
+ "isSpecial": {
+ "type": "boolean",
+ "description": "Define if the hours comes from a special opening hours day.",
+ "example": false
}
+ },
+ "example": {
+ "hours": [
+ {
+ "start": "06:30",
+ "end": "18:00"
+ }
+ ],
+ "isSpecial": false
}
},
- "TimezoneResponse": {
- "title": "TimezoneResponse",
+ "AssetWeeklyOpeningResponse": {
+ "title": "AssetWeeklyOpeningResponse",
"type": "object",
- "description": "Timezone information, name, raw offset to UTC and dst offset.",
+ "description": "The current Weekly Opening taking into account the special hours",
"properties": {
- "timezone": {
- "description": "The time zone identifier eg. 'Europe/Paris'. see ",
- "title": "Timezone id",
- "type": "string"
+ "1": {
+ "$ref": "#/components/schemas/AssetWeeklyOpeningHoursPeriod"
},
- "timezone_name": {
- "description": "The timezone name eg. `PDT`",
- "title": "Timezone name",
- "type": "string"
+ "2": {
+ "$ref": "#/components/schemas/AssetWeeklyOpeningHoursPeriod"
},
- "raw_offset": {
- "description": "offset from utc in seconds.",
- "title": "Raw offset",
- "type": "integer"
+ "3": {
+ "$ref": "#/components/schemas/AssetWeeklyOpeningHoursPeriod"
},
- "dst_offset": {
- "description": "The daylight saving time offset in seconds.",
- "title": "Dst offset",
- "type": "integer"
+ "4": {
+ "$ref": "#/components/schemas/AssetWeeklyOpeningHoursPeriod"
+ },
+ "5": {
+ "$ref": "#/components/schemas/AssetWeeklyOpeningHoursPeriod"
+ },
+ "6": {
+ "$ref": "#/components/schemas/AssetWeeklyOpeningHoursPeriod"
+ },
+ "7": {
+ "$ref": "#/components/schemas/AssetWeeklyOpeningHoursPeriod"
+ },
+ "timezone": {
+ "$ref": "#/components/schemas/Timezone"
}
},
- "required": [
- "timezone",
- "timezone_name",
- "raw_offset",
- "dst_offset"
- ],
"example": {
- "timezone": "Europe/Paris",
- "timezone_name": "CEST",
- "raw_offset": 3600,
- "dst_offset": 3600
+ "1": {
+ "hours": [],
+ "isSpecial": false
+ },
+ "2": {
+ "hours": [
+ {
+ "end": "22:00",
+ "start": "08:30"
+ }
+ ],
+ "isSpecial": false
+ },
+ "3": {
+ "hours": [
+ {
+ "end": "22:00",
+ "start": "08:30"
+ }
+ ],
+ "isSpecial": false
+ },
+ "4": {
+ "hours": [
+ {
+ "end": "22:00",
+ "start": "08:30"
+ }
+ ],
+ "isSpecial": false
+ },
+ "5": {
+ "hours": [
+ {
+ "end": "22:00",
+ "start": "08:30"
+ }
+ ],
+ "isSpecial": false
+ },
+ "6": {
+ "hours": [
+ {
+ "end": "22:00",
+ "start": "08:30"
+ }
+ ],
+ "isSpecial": false
+ },
+ "7": {
+ "hours": [
+ {
+ "end": "22:00",
+ "start": "08:30"
+ }
+ ],
+ "isSpecial": false
+ },
+ "timezone": "Europe/London"
}
},
- "AssetAddressRequest": {
- "title": "AssetAddressRequest",
+ "AssetTypes": {
+ "title": "AssetTypes",
+ "description": "Contains an array of types describing the Asset.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": "drive"
+ },
+ "example": [
+ "drive",
+ "click_and_collect"
+ ]
+ },
+ "AssetTags": {
+ "title": "AssetTags",
+ "description": "Contains an array of tags describing the Asset. For example a list of available amenities.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": "wifi"
+ },
+ "example": [
+ "wifi",
+ "covered_parking"
+ ]
+ },
+ "AssetOpeningHoursUsual": {
+ "title": "AssetOpeningHoursUsual",
+ "description": "An object describing the usual opening hours of an Asset.",
"type": "object",
- "description": "An object containing the separate components applicable to this address.",
"properties": {
- "lines": {
- "$ref": "#/components/schemas/AssetAddressLines"
+ "1": {
+ "description": "The opening Hours for Monday",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
+ }
},
- "countryCode": {
- "description": "An ISO_3166-1 Country Code where the Asset is located (see for full list)",
- "type": [
- "string",
- "null"
- ],
- "example": "UK"
+ "2": {
+ "description": "The opening Hours for Tuesday",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
+ }
},
- "city": {
- "description": "A City where belongs an Asset",
- "type": "string",
- "example": "London"
+ "3": {
+ "description": "The opening Hours for Wednesday",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
+ }
},
- "zipcode": {
- "description": "An Zipcode / Postal code of an Asset Address",
- "type": "string",
- "example": "WC1E 7BT"
+ "4": {
+ "description": "The opening Hours for Thursday",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
+ }
+ },
+ "5": {
+ "description": "The opening Hours for Friday",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
+ }
+ },
+ "6": {
+ "description": "The opening Hours for Saturday",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
+ }
+ },
+ "7": {
+ "description": "The opening Hours for Sunday",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
+ }
+ },
+ "default": {
+ "description": "Contains the default opening hours to apply to all week days",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
+ }
+ }
+ }
+ },
+ "AssetOpeningHoursSpecial": {
+ "title": "AssetOpeningHoursSpecial",
+ "description": "An object describing the special opening hours of an Asset.",
+ "type": "object",
+ "properties": {
+ "2015-02-07": {
+ "description": "The format for defining opening and closing hours for a particular day is the same as the usual. Instead of using numeric week day for keys you must use a date YYYY-MM-DD like \"2015-03-08\" (see ISO-8601).\n",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
+ }
+ },
+ "2015-02-08": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
+ }
+ }
+ }
+ },
+ "AssetOpeningHours": {
+ "title": "AssetOpeningHours",
+ "type": [
+ "object",
+ "null"
+ ],
+ "description": "An object describing the opening hours of an Asset.",
+ "properties": {
+ "timezone": {
+ "$ref": "#/components/schemas/Timezone"
+ },
+ "usual": {
+ "$ref": "#/components/schemas/AssetOpeningHoursUsual"
+ },
+ "special": {
+ "$ref": "#/components/schemas/AssetOpeningHoursSpecial"
}
},
"example": {
- "lines": [
- "8 Southwark St"
- ],
- "countryCode": "UK",
- "city": "London",
- "zipcode": "WC1E 7BT"
+ "timezone": "Europe/London",
+ "usual": {
+ "1": [],
+ "default": [
+ {
+ "start": "08:30",
+ "end": "22:00"
+ }
+ ]
+ },
+ "special": {
+ "2015-02-07": [
+ {
+ "start": "08:00",
+ "end": "23:00"
+ }
+ ]
+ }
}
},
- "AssetRequest": {
- "title": "AssetRequest",
+ "AssetResponse": {
+ "title": "AssetResponse",
"type": "object",
- "description": "Attributes describing an Asset Request.",
- "required": [
- "location",
- "name",
- "storeId"
- ],
+ "description": "Attributes describing an Asset.",
"properties": {
- "location": {
- "$ref": "#/components/schemas/LatLngLiteral"
- },
"name": {
"$ref": "#/components/schemas/AssetName"
},
- "storeId": {
+ "store_id": {
"$ref": "#/components/schemas/AssetId"
},
"address": {
- "$ref": "#/components/schemas/AssetAddressRequest"
+ "$ref": "#/components/schemas/AssetAddressResponse"
},
"contact": {
"$ref": "#/components/schemas/AssetContact"
},
+ "open": {
+ "$ref": "#/components/schemas/AssetOpenResponse"
+ },
+ "weekly_opening": {
+ "$ref": "#/components/schemas/AssetWeeklyOpeningResponse"
+ },
"types": {
"$ref": "#/components/schemas/AssetTypes"
},
"tags": {
"$ref": "#/components/schemas/AssetTags"
},
- "userProperties": {
+ "last_updated": {
+ "type": [
+ "string",
+ "null"
+ ],
+ "description": "the previous date timestamp when the asset has been updated",
+ "example": "2022-11-08T15:48:08.556803+00:00"
+ },
+ "user_properties": {
"description": "Contains all additional information relative to an Asset. If not set it returns null value.",
"type": [
"object",
@@ -6396,1757 +3879,1134 @@
"some_user_properties": "some_value"
}
},
- "localizedNames": {
- "description": "Alternate names for your assets. These localized names are useful for multi-language integrations. Combined with our Autocomplete API endpoint you can let your users find your store in their native language.",
- "type": "object",
- "example": {
- "ar": "مركز فيليتزي التجاري",
- "fr": "Centre Commercial Velizy",
- "it": "Centro Commerciale Velizy",
- "gb": "Velizy Shopping Center"
- }
- },
- "openingHours": {
+ "opening_hours": {
"$ref": "#/components/schemas/AssetOpeningHours"
+ },
+ "distance": {
+ "description": "The distance in meters from the geolocated position or searched position if exist",
+ "type": "number",
+ "example": 544.581
}
}
},
- "AssetsCollectionRequest": {
- "title": "AssetsCollectionRequest",
- "description": "A Collection of Woosmap Assets as expected for Data Management Data API.",
- "type": "object",
- "required": [
- "stores"
+ "LatLngArrayString": {
+ "title": "LatLngArrayString",
+ "description": "An array of comma separated {latitude,longitude} strings.",
+ "example": [
+ 43.4,
+ -2.1
],
- "properties": {
- "stores": {
- "description": "The Assets collection",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AssetRequest"
- }
- }
- },
- "example": {
- "stores": [
- {
- "types": [
- "drive",
- "click_and_collect"
- ],
- "tags": [
- "wifi",
- "covered_parking"
- ],
- "location": {
- "lat": 38.719,
- "lng": -77.1067
- },
- "storeId": "STORE_ID_123456",
- "name": "My Cool Store",
- "address": {
- "lines": [
- "Building Centre",
- "26 Store Street"
- ],
- "countryCode": "UK",
- "city": "London",
- "zipcode": "WC1E 7BT"
- },
- "contact": {
- "website": "https://www.woosmap.com",
- "phone": "+44 20 7693 4000",
- "email": "contact@woosmap.com"
- },
- "userProperties": {
- "some_user_properties": "associated user value"
- },
- "openingHours": {
- "timezone": "Europe/London",
- "usual": {
- "1": [],
- "default": [
- {
- "start": "08:30",
- "end": "22:00"
- }
- ]
- },
- "special": {
- "2015-02-07": [
- {
- "start": "08:00",
- "end": "23:00"
- }
- ]
- }
- }
- },
- {
- "types": [
- "drive"
- ],
- "tags": [
- "covered_parking"
- ],
- "location": {
- "lat": 38.5239,
- "lng": -77.0157
- },
- "storeId": "STORE_ID_45678",
- "name": "My Cool Store 2",
- "address": {
- "lines": [
- "1805-1899",
- "Orchard St"
- ],
- "countryCode": "US",
- "city": "Alexandria",
- "zipcode": "22309"
- },
- "contact": {
- "website": "https://www.woosmap.com",
- "phone": "+44 20 7693 4000",
- "email": "contact@woosmap.com"
- },
- "userProperties": {
- "some_user_properties": "associated user value"
- },
- "openingHours": {
- "timezone": "America/New_York",
- "usual": {
- "1": [],
- "default": [
- {
- "start": "08:30",
- "end": "22:00"
- }
- ]
- }
- }
- }
- ]
- }
- },
- "Success": {
- "title": "Success",
- "type": "object",
- "description": "Message returned to a success request",
- "properties": {
- "status": {
- "type": "string",
- "description": "the status of the 200 response",
- "example": "success"
- },
- "value": {
- "description": "The value of request for this 200 response",
- "example": "129 stores",
- "oneOf": [
- {
- "type": "string"
- },
- {
- "type": "integer"
- }
- ]
- }
+ "type": "array",
+ "minItems": 2,
+ "maxItems": 2,
+ "items": {
+ "type": "number"
}
},
- "Error400": {
- "title": "Error400",
+ "GeoJsonPoint": {
+ "title": "GeoJsonPoint",
"type": "object",
- "description": "The request is invalid",
+ "description": "GeoJSon Point Geometry",
"properties": {
- "status": {
+ "type": {
"type": "string",
- "description": "the status of the 400 response",
- "example": "error"
- },
- "value": {
- "description": "the value of request causing the Error",
- "example": "The request is invalid, the data is not a valid JSON.",
- "type": "string"
- }
- }
- },
- "MatchedSubstring": {
- "title": "MatchedSubstring",
- "type": "object",
- "properties": {
- "length": {
- "description": "Length of the matched substring in the prediction result text.",
- "type": "number"
+ "enum": [
+ "Point"
+ ],
+ "description": "the geometry type"
},
- "offset": {
- "description": "Start location of the matched substring in the prediction result text.",
- "type": "number"
+ "coordinates": {
+ "$ref": "#/components/schemas/LatLngArrayString"
}
},
"example": {
- "offset": 0,
- "length": 4
+ "type": "Point",
+ "coordinates": [
+ -0.14408,
+ 51.5088
+ ]
}
},
- "AssetAutocompleteResponse": {
- "title": "AssetAutocompleteResponse",
+ "AssetFeatureResponse": {
+ "title": "AssetFeatureResponse",
"type": "object",
- "description": "Asset Autocomplete Response with highlighted results on asset name.",
+ "description": "Asset Response as a GeoJSon Feature with Asset properties",
"properties": {
- "predictions": {
- "description": "A list of predictions based on similarity in all the `localizedNames` passed in query (or similarity to `store_name` if no `localizedNames` exist)",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "description": "The `name` property of each prediction will be filled with the localized name of your asset in the `language` you provided in your query if it exists, or else the default name property.\n",
- "type": "string",
- "example": "Centro Commerciale Deria"
- },
- "highlighted": {
- "type": "string",
- "description": "an HTML formatted string with, if it exists, the matched substring(s) in bold font.",
- "example": "Centro Commercial e Deria"
- },
- "store_id": {
- "$ref": "#/components/schemas/AssetId"
- },
- "types": {
- "$ref": "#/components/schemas/AssetTypes"
- },
- "matched_substrings": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/MatchedSubstring"
- }
- }
- }
- }
+ "type": {
+ "description": "the Geojson Type (only 'Feature')",
+ "type": "string",
+ "enum": [
+ "Feature"
+ ]
+ },
+ "properties": {
+ "$ref": "#/components/schemas/AssetResponse"
+ },
+ "geometry": {
+ "$ref": "#/components/schemas/GeoJsonPoint"
}
},
"example": {
- "predictions": [
- {
- "store_id": "2670",
- "name": "Sun Street",
- "types": [
- "Coffee shop"
- ],
- "matched_substrings": [
- {
- "offset": 4,
- "length": 6
- }
- ],
- "highlighted": "Sun Street "
+ "type": "Feature",
+ "properties": {
+ "store_id": "10031",
+ "name": "Santa Rosa & Yolanda",
+ "contact": {
+ "phone": "707-527-1006",
+ "website": "https://www.starbucks.com/store-locator/store/10031/santa-rosa-yolanda-2688-santa-rosa-ave-santa-rosa-ca-954077625-us"
},
- {
- "store_id": "16069",
- "name": "7th Street",
- "types": [
- "Coffee shop"
- ],
- "matched_substrings": [
- {
- "offset": 4,
- "length": 6
- }
+ "address": {
+ "lines": [
+ "2688 Santa Rosa Ave",
+ "Santa Rosa, CA 95407"
],
- "highlighted": "7th Street "
+ "country_code": "US",
+ "city": "Santa Rosa",
+ "zipcode": "954077625"
},
- {
- "store_id": "1013873",
- "name": "The Street",
- "types": [
- "Coffee shop"
- ],
- "matched_substrings": [
+ "user_properties": {
+ "take_away": "available"
+ },
+ "tags": [
+ "DT",
+ "WA",
+ "CD",
+ "DR",
+ "LB",
+ "GO",
+ "XO",
+ "MX",
+ "NB",
+ "BE",
+ "LU"
+ ],
+ "types": [
+ "Coffee shop"
+ ],
+ "last_updated": "2022-11-10T13:26:55.066524+00:00",
+ "open": {
+ "open_now": false,
+ "open_hours": [
{
- "offset": 4,
- "length": 6
+ "end": "20:00",
+ "start": "05:00"
}
],
- "highlighted": "The Street "
- }
- ]
- }
- },
- "BoundsResponse": {
- "title": "BoundsResponse",
- "type": "object",
- "description": "Message returned to a success Search Bounds request",
- "properties": {
- "bounds": {
- "description": "The bounds object",
- "type": "object",
- "properties": {
- "west": {
- "description": "The west longitude of bounds",
- "type": "number",
- "example": -0.14408
+ "week_day": 2,
+ "next_opening": {
+ "day": "2025-09-16",
+ "start": "05:00",
+ "end": "20:00"
+ }
+ },
+ "weekly_opening": {
+ "1": {
+ "hours": [
+ {
+ "end": "20:00",
+ "start": "05:00"
+ }
+ ],
+ "isSpecial": false
},
- "south": {
- "description": "The south latitude of bounds",
- "type": "number",
- "example": -51.5088
+ "2": {
+ "hours": [
+ {
+ "end": "20:00",
+ "start": "05:00"
+ }
+ ],
+ "isSpecial": false
},
- "east": {
- "description": "The east longitude of bounds",
- "type": "number",
- "example": -0.14408
+ "3": {
+ "hours": [
+ {
+ "end": "20:00",
+ "start": "05:00"
+ }
+ ],
+ "isSpecial": false
+ },
+ "4": {
+ "hours": [
+ {
+ "end": "20:00",
+ "start": "05:00"
+ }
+ ],
+ "isSpecial": false
+ },
+ "5": {
+ "hours": [
+ {
+ "end": "20:00",
+ "start": "05:00"
+ }
+ ],
+ "isSpecial": false
+ },
+ "6": {
+ "hours": [
+ {
+ "end": "20:00",
+ "start": "05:00"
+ }
+ ],
+ "isSpecial": false
+ },
+ "7": {
+ "hours": [
+ {
+ "end": "20:00",
+ "start": "05:00"
+ }
+ ],
+ "isSpecial": false
+ },
+ "timezone": "America/Los_Angeles"
+ },
+ "opening_hours": {
+ "usual": {
+ "1": [
+ {
+ "end": "20:00",
+ "start": "05:00"
+ }
+ ],
+ "2": [
+ {
+ "end": "20:00",
+ "start": "05:00"
+ }
+ ],
+ "3": [
+ {
+ "end": "20:00",
+ "start": "05:00"
+ }
+ ],
+ "4": [
+ {
+ "end": "20:00",
+ "start": "05:00"
+ }
+ ],
+ "5": [
+ {
+ "end": "20:00",
+ "start": "05:00"
+ }
+ ],
+ "6": [
+ {
+ "end": "20:00",
+ "start": "05:00"
+ }
+ ],
+ "7": [
+ {
+ "end": "20:00",
+ "start": "05:00"
+ }
+ ]
},
- "north": {
- "description": "The north latitude of bounds",
- "type": "number",
- "example": 51.5088
- }
+ "special": {},
+ "timezone": "America/Los_Angeles"
}
- }
- }
- },
- "LocalitiesTypes": {
- "title": "LocalitiesTypes",
- "type": "string",
- "description": "Common types unrelated to points of interest (POI). The `locality` type serves as an alias grouping various settlement types (see `enum` for details). This grouping enables flexible and efficient querying of related geographic data.\n",
- "enum": [
- "country",
- "admin_level",
- "admin_level_1",
- "admin_level_2",
- "admin_level_3",
- "postal_code",
- "address",
- "route",
- "locality",
- "city",
- "town",
- "village",
- "hamlet",
- "borough",
- "suburb",
- "quarter",
- "neighbourhood"
- ]
- },
- "LocalitiesTypesPoi": {
- "title": "LocalitiesTypesPoi",
- "description": "Categories of points of interest (POI) supported for detailed classification in geographic data queries.\n",
- "type": "string",
- "enum": [
- "point_of_interest",
- "transit.station",
- "transit.station.airport",
- "transit.station.rail",
- "transit.station.rail.funicular",
- "transit.station.rail.light_rail",
- "transit.station.rail.monorail",
- "transit.station.rail.subway",
- "transit.station.rail.train",
- "transit.station.rail.tram",
- "beach",
- "business",
- "business.car_repair",
- "business.car_rental",
- "business.cinema",
- "business.conference_centre",
- "business.exhibition_centre",
- "business.theatre",
- "business.nightclub",
- "business.finance",
- "business.finance.bank",
- "business.fuel",
- "business.parking",
- "business.mall",
- "business.food_and_drinks",
- "business.food_and_drinks.bar",
- "business.food_and_drinks.biergarten",
- "business.food_and_drinks.cafe",
- "business.food_and_drinks.fast_food",
- "business.food_and_drinks.pub",
- "business.food_and_drinks.restaurant",
- "business.food_and_drinks.food_court",
- "business.shop",
- "business.shop.mall",
- "business.shop.bakery",
- "business.shop.butcher",
- "business.shop.library",
- "business.shop.grocery",
- "business.shop.sports",
- "business.shop.toys",
- "business.shop.clothes",
- "business.shop.furniture",
- "business.shop.electronics",
- "business.shop.doityourself",
- "business.shop.craft",
- "education",
- "education.school",
- "education.kindergarten",
- "education.university",
- "education.college",
- "education.library",
- "hospitality",
- "hospitality.hotel",
- "hospitality.hostel",
- "hospitality.guest_house",
- "hospitality.bed_and_breakfast",
- "hospitality.motel",
- "medical",
- "medical.hospital",
- "medical.pharmacy",
- "medical.clinic",
- "tourism",
- "tourism.attraction",
- "tourism.attraction.amusement_park",
- "tourism.attraction.zoo",
- "tourism.attraction.aquarium",
- "tourism.monument",
- "tourism.monument.castle",
- "tourism.museum",
- "government",
- "park",
- "park.national",
- "place_of_worship",
- "police",
- "post_office",
- "sports",
- "sports.golf",
- "sports.winter"
- ]
- },
- "LocalitiesTypesPoiAlias": {
- "title": "LocalitiesTypesPoiAlias",
- "type": "string",
- "description": "Aliases for some point_of_interest types. These aliases are deprecated and should be replaced with the corresponding types in `LocalitiesTypesPoi`. For example:\n - `airport` → `transit.station.airport`\n - `train_station` → `transit.station.rail.train`\n\nThis ensures consistency and alignment with the updated schema.\n",
- "enum": [
- "airport",
- "train_station",
- "metro_station",
- "shopping",
- "museum",
- "zoo",
- "amusement_park",
- "art_gallery",
- "tourist_attraction"
- ]
- },
- "LocalitiesTypesAll": {
- "title": "LocalitiesTypesAll",
- "type": "string",
- "description": "A comprehensive string type that encompasses all supported locality classifications. This includes standard locality types (e.g., cities, regions), points of interest (POI) categories, and POI aliases for flexible geographic data representation and querying.\n",
- "anyOf": [
- {
- "$ref": "#/components/schemas/LocalitiesTypes"
},
- {
- "$ref": "#/components/schemas/LocalitiesTypesPoi"
- },
- {
- "$ref": "#/components/schemas/LocalitiesTypesPoiAlias"
- }
- ]
- },
- "LocalitiesAutocompleteMatchedFields": {
- "title": "LocalitiesAutocompleteMatchedFields",
- "type": "object",
- "description": "Contains a set of substrings in the `description` field that match elements in the `input`. It can be used to highlight those substrings. Each substring is identified by an `offset` and a `length`.",
- "properties": {
- "description": {
- "description": "match substrings for localities `description`",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/MatchedSubstring"
- }
+ "geometry": {
+ "type": "Point",
+ "coordinates": [
+ -122.712924,
+ 38.41244
+ ]
}
}
},
- "LocalitiesAutocompleteRelatedItem": {
- "title": "LocalitiesAutocompleteRelatedItem",
+ "Pagination": {
+ "title": "Pagination",
"type": "object",
- "description": "Contains a set of related elements to the locality suggestion.",
+ "description": "Pagination to reach all returned assets. max 300 assets par page.",
"properties": {
- "public_id": {
- "type": "string",
- "description": "Public ID of a related Postal Code."
+ "page": {
+ "type": "integer",
+ "description": "the request page",
+ "example": 1
},
- "description": {
- "type": "string",
- "description": "Formatted description for the related Postal Code."
+ "pageCount": {
+ "type": "integer",
+ "description": "the number of available pages",
+ "example": 10
}
}
},
- "LocalitiesAutocompleteRelated": {
- "title": "LocalitiesAutocompleteRelated",
+ "AssetFeatureCollectionResponse": {
+ "title": "AssetFeatureCollectionResponse",
"type": "object",
- "description": "Contains a set of related elements to the locality suggestion.",
+ "description": "Assets Collection Response as a GeoJSon FeatureCollection with Asset properties",
"properties": {
- "postal_codes": {
- "description": "Postal codes related to the locality suggestion.",
+ "type": {
+ "description": "the Geojson Type (only 'FeatureCollection')",
+ "type": "string",
+ "enum": [
+ "FeatureCollection"
+ ]
+ },
+ "features": {
+ "description": "the Assets Features",
"type": "array",
"items": {
- "$ref": "#/components/schemas/LocalitiesAutocompleteRelatedItem"
+ "$ref": "#/components/schemas/AssetFeatureResponse"
+ }
+ },
+ "pagination": {
+ "$ref": "#/components/schemas/Pagination"
+ }
+ },
+ "example": {
+ "type": "FeatureCollection",
+ "features": [
+ {
+ "type": "Feature",
+ "properties": {
+ "store_id": "2354",
+ "name": "Berkeley Street/Berkeley Square",
+ "contact": {
+ "phone": "02076295779",
+ "website": "https://www.starbucks.com/store-locator/store/2354/berkeley-street-berkeley-square-27-berkeley-st-berkeley-square-london-eng-w-1-x-5-"
+ },
+ "address": {
+ "lines": [
+ "27 Berkeley St",
+ "London, ENG W1X 5AD"
+ ],
+ "country_code": "GB",
+ "city": "London",
+ "zipcode": "W1X 5AD"
+ },
+ "user_properties": {
+ "take_away": "available"
+ },
+ "tags": [
+ "WA",
+ "WF",
+ "CD",
+ "DR",
+ "XO"
+ ],
+ "types": [
+ "Coffee shop"
+ ],
+ "last_updated": "2022-11-10T13:23:53.564829+00:00",
+ "distance": 135.28682936,
+ "open": {
+ "open_now": true,
+ "open_hours": [
+ {
+ "end": "18:00",
+ "start": "06:30"
+ }
+ ],
+ "week_day": 2,
+ "current_slice": {
+ "end": "18:00",
+ "start": "06:30"
+ }
+ },
+ "weekly_opening": {
+ "1": {
+ "hours": [
+ {
+ "end": "18:00",
+ "start": "06:30"
+ }
+ ],
+ "isSpecial": false
+ },
+ "2": {
+ "hours": [
+ {
+ "end": "18:00",
+ "start": "06:30"
+ }
+ ],
+ "isSpecial": false
+ },
+ "3": {
+ "hours": [
+ {
+ "end": "18:00",
+ "start": "06:30"
+ }
+ ],
+ "isSpecial": false
+ },
+ "4": {
+ "hours": [
+ {
+ "end": "18:00",
+ "start": "06:30"
+ }
+ ],
+ "isSpecial": false
+ },
+ "5": {
+ "hours": [
+ {
+ "end": "18:00",
+ "start": "06:30"
+ }
+ ],
+ "isSpecial": false
+ },
+ "6": {
+ "hours": [
+ {
+ "end": "17:00",
+ "start": "08:00"
+ }
+ ],
+ "isSpecial": false
+ },
+ "7": {
+ "hours": [
+ {
+ "end": "17:00",
+ "start": "08:00"
+ }
+ ],
+ "isSpecial": false
+ },
+ "timezone": "Europe/London"
+ },
+ "opening_hours": {
+ "usual": {
+ "1": [
+ {
+ "end": "18:00",
+ "start": "06:30"
+ }
+ ],
+ "2": [
+ {
+ "end": "18:00",
+ "start": "06:30"
+ }
+ ],
+ "3": [
+ {
+ "end": "18:00",
+ "start": "06:30"
+ }
+ ],
+ "4": [
+ {
+ "end": "18:00",
+ "start": "06:30"
+ }
+ ],
+ "5": [
+ {
+ "end": "18:00",
+ "start": "06:30"
+ }
+ ],
+ "6": [
+ {
+ "end": "17:00",
+ "start": "08:00"
+ }
+ ],
+ "7": [
+ {
+ "end": "17:00",
+ "start": "08:00"
+ }
+ ]
+ },
+ "special": {},
+ "timezone": "Europe/London"
+ }
+ },
+ "geometry": {
+ "type": "Point",
+ "coordinates": [
+ -0.14408,
+ 51.5088
+ ]
+ }
}
+ ],
+ "pagination": {
+ "page": 1,
+ "pageCount": 1
}
}
},
- "LocalitiesAutocompleteResponse": {
- "title": "LocalitiesAutocompleteResponse",
+ "GeolocationStoresResponse": {
+ "title": "GeolocationStoresResponse",
+ "description": "JSON-formatted response defining a location, radius, and stores if accuracy of geocoded IP is 20km or less.",
"type": "object",
- "description": "Attributes describing a locality. Not all attributes will be available for all locality types.",
"properties": {
- "public_id": {
- "description": "Contains a unique ID for each suggestion. Please use this ID if you need to give us feedback on results. This ID is also required to perform a Localities Details Request.",
- "type": "string",
- "example": "MkvnYy6K6oVGqeqfWJGO/6eCgqo="
+ "stores": {
+ "$ref": "#/components/schemas/AssetFeatureCollectionResponse"
},
- "types": {
- "description": "An array containing the types of the result",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/LocalitiesTypesAll"
- }
+ "viewport": {
+ "$ref": "#/components/schemas/Bounds"
},
- "type": {
- "deprecated": true,
- "description": "This field might be removed in the future, please use the `types` field which is more exhaustive.",
- "type": "string"
+ "accuracy": {
+ "description": "The accuracy of the estimated location, in kilometers. This represents the radius of a circle around the given `location` where the IP address is likely to be. If your Geolocation response shows a low value in the `accuracy` field (<=50), the IP has strong chance to be correctly located.",
+ "type": "number",
+ "example": 5
},
- "description": {
- "description": "Concatenation of `name`, `admin_1`, `admin_0` to be used as suggestion in drop-down list if needed. The description can vary depending on the type requested.",
- "type": "string",
- "example": "20121, Milano, Italy"
+ "latitude": {
+ "description": "Approximate latitude of the geographical area associated with the IP address",
+ "type": "number",
+ "example": 38.719
},
- "matched_substrings": {
- "$ref": "#/components/schemas/LocalitiesAutocompleteMatchedFields"
+ "longitude": {
+ "description": "Approximate longitude of the geographical area associated with the IP address",
+ "type": "number",
+ "example": -77.1067
},
- "related": {
- "$ref": "#/components/schemas/LocalitiesAutocompleteRelated"
+ "country_code": {
+ "description": "ISO 3166-1 Alpha-2 compatible country code",
+ "type": [
+ "string",
+ "null"
+ ],
+ "example": "US"
},
- "has_addresses": {
- "description": "On the specific territory of United Kingdom, Localities autocomplete request can return the additional attribute `has_addresses` for a postal code, which indicates if a postal code bears addresses. When `has_addresses` is `true`, it is possible to display a list of the available addresses by requesting `details` with the Localities `public_id`. To get the details of an address you will need to request again `/details` endpoint passing in the dedicated address `public_id`.\n",
- "type": "boolean",
- "example": true
- }
- },
- "example": {
- "public_id": "Ch6qA8cLmvyvEEoFy6nYeFcEdNU=",
- "description": "London, City of London, United Kingdom",
- "type": "locality",
- "matched_substrings": {
- "description": [
- {
- "offset": 0,
- "length": 6
- },
- {
- "offset": 16,
- "length": 6
- }
- ]
- }
- }
- },
- "LocalitiesAutocompleteCollectionResponse": {
- "title": "LocalitiesAutocompleteCollectionResponse",
- "type": "object",
- "description": "Localities Collection Response containing Localities",
- "properties": {
- "localities": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/LocalitiesAutocompleteResponse"
- }
- }
- },
- "example": {
- "localities": [
- {
- "public_id": "Ch6qA8cLmvyvEEoFy6nYeFcEdNU=",
- "type": "locality",
- "types": [
- "locality",
- "city"
- ],
- "description": "London, City of London, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 0,
- "length": 4
- }
- ]
- }
- },
- {
- "public_id": "m/T2C4YI2LgszkKXrELBC+9dfC8=",
- "type": "locality",
- "types": [
- "locality",
- "city"
- ],
- "description": "Derry/Londonderry, Derry City and Strabane, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 6,
- "length": 4
- }
- ]
- }
- },
- {
- "public_id": "J6eISGMjjvQwPkao8rsByB3aVwM=",
- "type": "locality",
- "types": [
- "locality",
- "village"
- ],
- "description": "London Colney, Hertfordshire, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 0,
- "length": 4
- }
- ]
- }
- },
- {
- "public_id": "52MnrbHVWH21CLWH8VY/YWKhqeM=",
- "type": "locality",
- "types": [
- "locality",
- "village"
- ],
- "description": "London Apprentice, Cornwall, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 0,
- "length": 4
- }
- ]
- }
- },
- {
- "public_id": "S/5AkUmMBhX35qVI2jR38+dALwk=",
- "type": "locality",
- "types": [
- "locality",
- "city"
- ],
- "description": "City of London, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 8,
- "length": 4
- }
- ]
- }
- }
- ]
- }
- },
- "FormattedAddress": {
- "title": "FormattedAddress",
- "description": "Contains the readable text description of the result.",
- "type": "string",
- "example": "London, England, United Kingdom"
- },
- "Position": {
- "title": "Position",
- "description": "an array containing longitude, latitude, in that order.",
- "type": "array",
- "items": {
- "type": "number"
- },
- "minItems": 2,
- "maxItems": 2,
- "example": [
- 2.06984,
- 48.77919
- ]
- },
- "GeoJsonCoords": {
- "title": "GeoJsonCoords",
- "description": "an array containing Positions.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Position"
- },
- "example": [
- [
- 2.06984,
- 48.77919
- ],
- [
- 2.07984,
- 48.77919
- ],
- [
- 2.07984,
- 48.78919
- ],
- [
- 2.06984,
- 48.78919
- ],
- [
- 2.06984,
- 48.77919
- ]
- ]
- },
- "GeoJsonGeometry": {
- "title": "GeoJsonGeometry",
- "type": "object",
- "description": "A GeoJSon Geometry representing the shape of the area, as specified in [RFC7946](https://datatracker.ietf.org/doc/html/rfc7946). \nTo display on the map, simply wrap this object in a feature:\n```json\n{\n \"type\": \"Feature\",\n \"geometry\": this_geojson_geometry\n}\n```\n",
- "properties": {
- "type": {
+ "country_name": {
+ "description": "Country name",
"type": "string",
- "enum": [
- "Polygon",
- "MultiPoligon"
- ],
- "description": "the geometry type"
+ "example": "United States"
},
- "coordinates": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/GeoJsonCoords"
- }
- }
- },
- "example": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 2.06984,
- 48.77919
- ],
- [
- 2.07984,
- 48.77919
- ],
- [
- 2.07984,
- 48.78919
- ],
- [
- 2.06984,
- 48.78919
- ],
- [
- 2.06984,
- 48.77919
- ]
- ]
- ]
- }
- },
- "AddressComponents": {
- "title": "AddressComponents",
- "type": "array",
- "description": "An array containing Address Components with additional information",
- "items": {
- "type": "object",
- "description": "The address component object",
- "properties": {
- "long_name": {
- "oneOf": [
- {
- "type": "string"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ],
- "description": "The full text description or name of the address component, or a list of names (ie. list of postal codes).",
- "example": "United Kingdom"
- },
- "short_name": {
- "oneOf": [
- {
- "type": "string"
- },
- {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- ],
- "description": "An abbreviated textual name for the address component, if available. For example, an address component for the state of United Kingdom may have a `long_name` of `United Kingdom` and a `short_name` of `UK` using the 2-letter postal abbreviation.",
- "example": "UK"
- },
- "types": {
- "description": "An array indicating the type of the address component.",
- "type": "array",
- "items": {
- "type": "string",
- "description": "address component type"
- },
- "example": [
- "country",
- "administrative_area_level_0"
- ]
- }
+ "continent": {
+ "description": "Continent name",
+ "type": "string",
+ "example": "North America"
},
- "example": {
- "types": [
- "country"
- ],
- "long_name": "United Kingdom",
- "short_name": "GBR"
- }
- },
- "example": [
- {
- "types": [
- "country"
- ],
- "long_name": "United Kingdom",
- "short_name": "GBR"
+ "region_state": {
+ "description": "Region name when available",
+ "type": "string",
+ "example": "Virginia"
},
- {
- "long_name": "London",
- "short_name": "London",
- "types": [
- "locality"
- ]
- }
- ]
- },
- "AdministrativeAreaLabel": {
- "title": "AdministrativeAreaLabel",
- "description": "Only available for `admin_level` suggestions, this contains the local english name of the administration level (\"department\" for France or \"federal_state\" for Germany).",
- "type": "string",
- "example": "district"
- },
- "LocalitiesStatus": {
- "title": "LocalitiesStatus",
- "type": "string",
- "description": "This optional field is only available for UK addresses referenced as not yet built by Royal Mail.",
- "enum": [
- "not_yet_built"
- ]
- },
- "LocalitiesAddressSummary": {
- "title": "LocalitiesAddressSummary",
- "type": "object",
- "description": "A short description of an address",
- "required": [
- "public_id",
- "description"
- ],
- "example": {
- "public_id": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9faitia1pNNURnOWYvQmRjMUdweXl5SjdLZUZnPQ==",
- "description": "Flat 1, Radway House, Alfred Road, London, W2 5ER"
- },
- "properties": {
- "public_id": {
+ "city": {
+ "description": "City name when available",
"type": "string",
- "description": "The public_id of the address can be used to gather details on that specific address",
- "example": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9faitia1pNNURnOWYvQmRjMUdweXl5SjdLZUZnPQ=="
+ "example": "Alexandria"
},
- "description": {
+ "postal_code": {
+ "description": "A postal code close to the user's location, when available",
"type": "string",
- "description": "A human readable description of the address",
- "example": "Flat 1, Radway House, Alfred Road, London, W2 5ER"
+ "example": "22309"
+ },
+ "timezone": {
+ "$ref": "#/components/schemas/Timezone"
+ },
+ "raw_offset": {
+ "description": "The offset from utc in seconds",
+ "type": "integer",
+ "example": -18000
+ },
+ "dst_offset": {
+ "description": "The daylight saving time offset in seconds",
+ "type": "integer",
+ "example": 3600
}
- }
- },
- "LocalitiesDetailsResponse": {
- "title": "LocalitiesDetailsResponse",
- "type": "object",
- "description": "Attributes describing a locality. Not all attributes are available for all locality types.",
- "properties": {
- "result": {
- "description": "The Root Node for Localities Details",
- "type": "object",
- "required": [
- "public_id",
- "formatted_address",
- "types",
- "geometry",
- "address_components"
- ],
- "properties": {
- "public_id": {
- "description": "Contains a unique ID for each suggestion. Please use this ID to give feedback on results.",
- "type": "string",
- "example": "MkvnYy6K6oVGqeqfWJGO/6eCgqo="
- },
- "formatted_address": {
- "$ref": "#/components/schemas/FormattedAddress"
- },
- "types": {
- "description": "Available localities types.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/LocalitiesTypesAll"
- }
- },
- "geometry": {
- "description": "The location of the PostalCode, in latitude and longitude, eventually associated with a Viewport and a shape.",
- "type": "object",
- "required": [
- "location"
- ],
+ },
+ "example": {
+ "country_code": "US",
+ "country_name": "United States",
+ "continent": "North America",
+ "latitude": 38.719,
+ "longitude": -77.1067,
+ "viewport": {
+ "northeast": {
+ "lat": 38.763915764205976,
+ "lng": -77.0491321464058
+ },
+ "southwest": {
+ "lat": 38.674084235794034,
+ "lng": -77.16426785359421
+ }
+ },
+ "accuracy": 5,
+ "city": "Alexandria",
+ "region_state": "Virginia",
+ "postal_code": "22309",
+ "timezone": "America/New_York",
+ "raw_offset": -18000,
+ "dst_offset": 3600,
+ "stores": {
+ "type": "FeatureCollection",
+ "features": [
+ {
+ "type": "Feature",
"properties": {
- "location": {
- "$ref": "#/components/schemas/LatLngLiteral"
+ "store_id": "STORE_ID_123456",
+ "name": "My Cool Store",
+ "contact": {
+ "email": "contact@woosmap.com",
+ "phone": "+44 20 7693 4000",
+ "website": "https://www.woosmap.com"
},
- "viewport": {
- "$ref": "#/components/schemas/Bounds"
+ "address": {
+ "lines": [
+ "Building Centre",
+ "26 Store Street"
+ ],
+ "country_code": "UK",
+ "city": "London",
+ "zipcode": "WC1E 7BT"
},
- "shape": {
- "$ref": "#/components/schemas/GeoJsonGeometry"
+ "user_properties": {
+ "some_user_properties": "associated user value"
},
- "accuracy": {
- "type": "string",
- "description": "This accuracy represents the type of address returned - `DISTRICT` and `POSTAL_CODE` are for UK only.",
- "enum": [
- "ROOFTOP",
- "ROUTE",
- "GEOMETRIC_CENTER",
- "DISTRICT",
- "POSTAL_CODE",
- "RANGE_INTERPOLATED",
- "APPROXIMATE"
- ]
- }
- },
- "example": {
- "location": {
- "lat": 51.49984,
- "lng": -0.124663
- }
- }
- },
- "address_components": {
- "$ref": "#/components/schemas/AddressComponents"
- },
- "name": {
- "description": "The postal code name if result is a postal code.",
- "type": "string",
- "example": "SW1A 0AA"
- },
- "administrative_area_label": {
- "$ref": "#/components/schemas/AdministrativeAreaLabel"
- },
- "status": {
- "$ref": "#/components/schemas/LocalitiesStatus"
- },
- "addresses": {
- "description": "For the UK only. When a postal code is returned, this field contains a list of addresses associated with this postal code.",
- "type": "object",
- "properties": {
- "pagination": {
- "type": "object",
- "deprecated": true,
- "description": "The pagination part of the response is deprecated as all the addresses are now automatically returned in the response. It will be turned off at some point. From now on, the pagination will systematically return `page=1`, `page_count=1`, `addresses_per_page=total addresses count` and `address_count=total addresses count`.",
- "properties": {
- "page": {
- "type": "integer",
- "description": "the request page",
- "deprecated": true
- },
- "page_count": {
- "type": "integer",
- "description": "the number of available pages",
- "deprecated": true
- },
- "addresses_per_page": {
- "type": "integer",
- "description": "the number of available addresses per page",
- "deprecated": true
- },
- "address_count": {
- "type": "integer",
- "description": "the number of available addresses",
- "deprecated": true
+ "tags": [
+ "wifi",
+ "covered_parking"
+ ],
+ "types": [
+ "drive",
+ "click_and_collect"
+ ],
+ "last_updated": "2025-09-16T08:49:42.523114+00:00",
+ "distance": 0,
+ "open": {
+ "open_now": true,
+ "open_hours": [
+ {
+ "end": "22:00",
+ "start": "08:30"
}
+ ],
+ "week_day": 2,
+ "current_slice": {
+ "end": "22:00",
+ "start": "08:30"
}
},
- "list": {
- "type": "array",
- "description": "List of addresses",
- "items": {
- "$ref": "#/components/schemas/LocalitiesAddressSummary"
- }
+ "weekly_opening": {
+ "1": {
+ "hours": [],
+ "isSpecial": false
+ },
+ "2": {
+ "hours": [
+ {
+ "end": "22:00",
+ "start": "08:30"
+ }
+ ],
+ "isSpecial": false
+ },
+ "3": {
+ "hours": [
+ {
+ "end": "22:00",
+ "start": "08:30"
+ }
+ ],
+ "isSpecial": false
+ },
+ "4": {
+ "hours": [
+ {
+ "end": "22:00",
+ "start": "08:30"
+ }
+ ],
+ "isSpecial": false
+ },
+ "5": {
+ "hours": [
+ {
+ "end": "22:00",
+ "start": "08:30"
+ }
+ ],
+ "isSpecial": false
+ },
+ "6": {
+ "hours": [
+ {
+ "end": "22:00",
+ "start": "08:30"
+ }
+ ],
+ "isSpecial": false
+ },
+ "7": {
+ "hours": [
+ {
+ "end": "22:00",
+ "start": "08:30"
+ }
+ ],
+ "isSpecial": false
+ },
+ "timezone": "Europe/London"
+ },
+ "opening_hours": {
+ "usual": {
+ "1": [],
+ "default": [
+ {
+ "end": "22:00",
+ "start": "08:30"
+ }
+ ]
+ },
+ "special": {
+ "2015-02-07": [
+ {
+ "end": "23:00",
+ "start": "08:00"
+ }
+ ]
+ },
+ "timezone": "Europe/London"
}
+ },
+ "geometry": {
+ "type": "Point",
+ "coordinates": [
+ -77.1067,
+ 38.719
+ ]
}
}
- }
- }
- },
- "example": {
- "result": {
- "public_id": "cG9zdGFsX2NvZGU6Z2I6OmNDN0N0ZUF2MW9YRi9KLzlnS2cremJndktFaz0=",
- "types": [
- "postal_code"
- ],
- "formatted_address": "SW1A 0AA, City of London",
- "name": "SW1A 0AA",
- "geometry": {
- "location": {
- "lat": 51.499842,
- "lng": -0.124638
- },
- "accuracy": "GEOMETRIC_CENTER"
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United Kingdom",
- "short_name": "GB"
- },
- {
- "types": [
- "state",
- "division_level_1"
- ],
- "long_name": "England",
- "short_name": "England"
- },
- {
- "types": [
- "administrative_area_level_1",
- "county",
- "division_level_2"
- ],
- "long_name": "City of London",
- "short_name": "City of London"
- },
- {
- "types": [
- "district",
- "division_level_3"
- ],
- "long_name": "Westminster",
- "short_name": "Westminster"
- },
- {
- "types": [
- "postal_codes"
- ],
- "long_name": "SW1A 0AA",
- "short_name": "SW1A 0AA"
- }
],
- "addresses": {
- "pagination": {
- "page": 1,
- "page_count": 1,
- "addresses_per_page": 1,
- "address_count": 1
- },
- "list": [
- {
- "public_id": "TVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPV9fTVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPQ==",
- "description": "House Of Commons, Houses Of Parliament London, SW1A 0AA"
- }
- ]
+ "pagination": {
+ "page": 1,
+ "pageCount": 2
}
}
}
},
- "LocalitiesAddressGeometry": {
- "title": "LocalitiesAddressGeometry",
+ "TimezoneResponse": {
+ "title": "TimezoneResponse",
"type": "object",
- "description": "The location of the result, in latitude and longitude. Accuracy is also provided.",
+ "description": "Timezone information, name, raw offset to UTC and dst offset.",
"properties": {
- "location_type": {
- "description": "Specifies additional data about the geocoded location. The following values are currently supported: \n - `ROOFTOP` result is a precise geocode for which we have location information accurate down to street address precision.\n - `RANGE_INTERPOLATED` result reflects an approximation (usually on a road) interpolated between two precise points (such as intersections). Interpolated results are generally returned when rooftop geocodes are unavailable for a street address.\n - `GEOMETRIC_CENTER` result is the geometric center of a result such as a polyline (for example, a street) or polygon (city, region, …).\n - `APPROXIMATE` result is approximate (usually when no other above value applies)\n - `POSTAL_CODE` Address has inherited from the location of the postal code it is part of (for NYB addresses)\n - `DISTRICT` Address has inherited from the location of the district it is part of (for NYB addresses)\n",
- "type": "string",
- "enum": [
- "ROOFTOP",
- "RANGE_INTERPOLATED",
- "GEOMETRIC_CENTER",
- "APPROXIMATE",
- "POSTAL_CODE",
- "DISTRICT"
- ]
+ "timezone": {
+ "description": "The time zone identifier eg. 'Europe/Paris'. see ",
+ "title": "Timezone id",
+ "type": "string"
},
- "location": {
- "$ref": "#/components/schemas/LatLngLiteral"
+ "timezone_name": {
+ "description": "The timezone name eg. `PDT`",
+ "title": "Timezone name",
+ "type": "string"
},
- "viewport": {
- "$ref": "#/components/schemas/Bounds"
+ "raw_offset": {
+ "description": "offset from utc in seconds.",
+ "title": "Raw offset",
+ "type": "integer"
},
- "shape": {
- "$ref": "#/components/schemas/GeoJsonGeometry"
+ "dst_offset": {
+ "description": "The daylight saving time offset in seconds.",
+ "title": "Dst offset",
+ "type": "integer"
}
},
+ "required": [
+ "timezone",
+ "timezone_name",
+ "raw_offset",
+ "dst_offset"
+ ],
"example": {
- "location": {
- "lat": 48.829405,
- "lng": 2.367944
- },
- "location_type": "GEOMETRIC_CENTER"
+ "timezone": "Europe/Paris",
+ "timezone_name": "CEST",
+ "raw_offset": 3600,
+ "dst_offset": 3600
}
},
- "LocalitiesScoresPerComponents": {
- "title": "LocalitiesScoresPerComponents",
+ "AssetAddressRequest": {
+ "title": "AssetAddressRequest",
"type": "object",
+ "description": "An object containing the separate components applicable to this address.",
"properties": {
- "street_name": {
- "description": "Street score",
- "type": "number"
+ "lines": {
+ "$ref": "#/components/schemas/AssetAddressLines"
},
- "postal_code": {
- "description": "Postal code score",
- "type": "number"
+ "countryCode": {
+ "description": "An ISO_3166-1 Country Code where the Asset is located (see for full list)",
+ "type": [
+ "string",
+ "null"
+ ],
+ "example": "UK"
+ },
+ "city": {
+ "description": "A City where belongs an Asset",
+ "type": "string",
+ "example": "London"
},
- "locality": {
- "description": "Postal code score",
- "type": "number"
+ "zipcode": {
+ "description": "An Zipcode / Postal code of an Asset Address",
+ "type": "string",
+ "example": "WC1E 7BT"
}
},
"example": {
- "scores_per_components": {
- "street_name": 0.6153846153846154,
- "postal_code": 0.8,
- "locality": 1
- }
+ "lines": [
+ "8 Southwark St"
+ ],
+ "countryCode": "UK",
+ "city": "London",
+ "zipcode": "WC1E 7BT"
}
},
- "LocalitiesGeocodeResponse": {
- "title": "LocalitiesGeocodeResponse",
+ "AssetRequest": {
+ "title": "AssetRequest",
"type": "object",
- "description": "Attributes describing a locality. Not all attributes will be available for all locality types.",
+ "description": "Attributes describing an Asset Request.",
+ "required": [
+ "location",
+ "name",
+ "storeId"
+ ],
"properties": {
- "formatted_address": {
- "$ref": "#/components/schemas/FormattedAddress"
+ "location": {
+ "$ref": "#/components/schemas/LatLngLiteral"
},
- "types": {
- "description": "An array containing the types of the result",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/LocalitiesTypesAll"
- }
+ "name": {
+ "$ref": "#/components/schemas/AssetName"
},
- "administrative_area_label": {
- "$ref": "#/components/schemas/AdministrativeAreaLabel"
+ "storeId": {
+ "$ref": "#/components/schemas/AssetId"
},
- "public_id": {
- "description": "Contains a unique ID for each suggestion. Please use this ID to give feedback on results.",
- "type": "string",
- "example": "MkvnYy6K6oVGqeqfWJGO/6eCgqo="
+ "address": {
+ "$ref": "#/components/schemas/AssetAddressRequest"
},
- "geometry": {
- "$ref": "#/components/schemas/LocalitiesAddressGeometry"
+ "contact": {
+ "$ref": "#/components/schemas/AssetContact"
},
- "status": {
- "$ref": "#/components/schemas/LocalitiesStatus"
+ "types": {
+ "$ref": "#/components/schemas/AssetTypes"
},
- "address_components": {
- "$ref": "#/components/schemas/AddressComponents"
+ "tags": {
+ "$ref": "#/components/schemas/AssetTags"
},
- "distance": {
- "description": "When reverse geocoding, this field represents the distance (in meter) to the requested latlng",
- "type": "number",
- "example": 5.234
+ "userProperties": {
+ "description": "Contains all additional information relative to an Asset. If not set it returns null value.",
+ "type": [
+ "object",
+ "null"
+ ],
+ "additionalProperties": true,
+ "example": {
+ "some_user_properties": "some_value"
+ }
},
- "sub_buildings": {
- "description": "When reverse geocoding with `list_sub_buildings=true`, this field will contain a list of precise addresses that can be found at that location, i.e. all flats within a building.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/LocalitiesAddressSummary"
+ "localizedNames": {
+ "description": "Alternate names for your assets. These localized names are useful for multi-language integrations. Combined with our Autocomplete API endpoint you can let your users find your store in their native language.",
+ "type": "object",
+ "example": {
+ "ar": "مركز فيليتزي التجاري",
+ "fr": "Centre Commercial Velizy",
+ "it": "Centro Commerciale Velizy",
+ "gb": "Velizy Shopping Center"
}
},
- "scores_per_components": {
- "description": "For each component (street_name, postal_code, and locality), it indicates the degree of correspondence with the original query. This value ranges from 0 to 1, with 0 indicating no match with the original query, and enables you to assess the quality of the Geocode's result.",
- "$ref": "#/components/schemas/LocalitiesScoresPerComponents"
+ "openingHours": {
+ "$ref": "#/components/schemas/AssetOpeningHours"
}
}
},
- "LocalitiesGeocodeCollectionResponse": {
- "title": "LocalitiesGeocodeCollectionResponse",
+ "AssetsCollectionRequest": {
+ "title": "AssetsCollectionRequest",
+ "description": "A Collection of Woosmap Assets as expected for Data Management Data API.",
"type": "object",
- "description": "Localities Geocode Collection Response. Contains one or more detailed Localities or Addresses in FR or in the UK, with coordinates (default to one result for reverse geocoding)",
+ "required": [
+ "stores"
+ ],
"properties": {
- "results": {
+ "stores": {
+ "description": "The Assets collection",
"type": "array",
"items": {
- "$ref": "#/components/schemas/LocalitiesGeocodeResponse"
+ "$ref": "#/components/schemas/AssetRequest"
}
}
},
"example": {
- "results": [
+ "stores": [
{
- "public_id": "0+FTYd/1MsiBSxLAKq+/Fiyy+uM=",
"types": [
- "address",
- "route"
+ "drive",
+ "click_and_collect"
],
- "formatted_address": "Place Jeanne D'Arc, 75013, Paris",
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "France",
- "short_name": "FR"
- },
- {
- "types": [
- "state",
- "division_level_1"
- ],
- "long_name": "Île-de-France",
- "short_name": "Île-de-France"
- },
- {
- "types": [
- "administrative_area_level_1",
- "county",
- "division_level_2"
- ],
- "long_name": "Paris",
- "short_name": "Paris"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "Paris",
- "short_name": "Paris"
- },
- {
- "types": [
- "postal_codes"
- ],
- "long_name": "75013",
- "short_name": "75013"
+ "tags": [
+ "wifi",
+ "covered_parking"
+ ],
+ "location": {
+ "lat": 38.719,
+ "lng": -77.1067
+ },
+ "storeId": "STORE_ID_123456",
+ "name": "My Cool Store",
+ "address": {
+ "lines": [
+ "Building Centre",
+ "26 Store Street"
+ ],
+ "countryCode": "UK",
+ "city": "London",
+ "zipcode": "WC1E 7BT"
+ },
+ "contact": {
+ "website": "https://www.woosmap.com",
+ "phone": "+44 20 7693 4000",
+ "email": "contact@woosmap.com"
+ },
+ "userProperties": {
+ "some_user_properties": "associated user value"
+ },
+ "openingHours": {
+ "timezone": "Europe/London",
+ "usual": {
+ "1": [],
+ "default": [
+ {
+ "start": "08:30",
+ "end": "22:00"
+ }
+ ]
},
- {
- "types": [
- "route"
- ],
- "long_name": "Place Jeanne D'Arc",
- "short_name": "Place Jeanne D'Arc"
+ "special": {
+ "2015-02-07": [
+ {
+ "start": "08:00",
+ "end": "23:00"
+ }
+ ]
}
+ }
+ },
+ {
+ "types": [
+ "drive"
],
- "geometry": {
- "location": {
- "lat": 48.829405,
- "lng": 2.367944
- },
- "location_type": "GEOMETRIC_CENTER"
+ "tags": [
+ "covered_parking"
+ ],
+ "location": {
+ "lat": 38.5239,
+ "lng": -77.0157
+ },
+ "storeId": "STORE_ID_45678",
+ "name": "My Cool Store 2",
+ "address": {
+ "lines": [
+ "1805-1899",
+ "Orchard St"
+ ],
+ "countryCode": "US",
+ "city": "Alexandria",
+ "zipcode": "22309"
+ },
+ "contact": {
+ "website": "https://www.woosmap.com",
+ "phone": "+44 20 7693 4000",
+ "email": "contact@woosmap.com"
},
- "scores_per_components": {
- "street_name": 1
+ "userProperties": {
+ "some_user_properties": "associated user value"
+ },
+ "openingHours": {
+ "timezone": "America/New_York",
+ "usual": {
+ "1": [],
+ "default": [
+ {
+ "start": "08:30",
+ "end": "22:00"
+ }
+ ]
+ }
}
}
]
}
},
- "LocalitiesNearbyResponse": {
- "title": "LocalitiesNearbyResponse",
+ "Success": {
+ "title": "Success",
"type": "object",
- "description": "Attributes describing a point of interest.",
+ "description": "Message returned to a success request",
"properties": {
- "types": {
- "description": "An array containing the types of the result.",
- "type": "array",
- "example": [
- "point_of_interest",
- "transit.station.rail.train",
- "train_station"
- ],
- "items": {
- "$ref": "#/components/schemas/LocalitiesTypesPoi"
- }
- },
- "name": {
- "description": "The name of the result.",
- "type": "string"
- },
- "public_id": {
- "description": "Contains a unique ID for each result. Please use this ID to give feedback on results.",
+ "status": {
"type": "string",
- "example": "NOAeiQADqqisOuN3NM7oXlhkROI="
+ "description": "the status of the 200 response",
+ "example": "success"
},
- "geometry": {
- "description": "The location of the result, in latitude and longitude, eventually associated with a Viewport.",
- "type": "object",
- "properties": {
- "location": {
- "$ref": "#/components/schemas/LatLngLiteral"
+ "value": {
+ "description": "The value of request for this 200 response",
+ "example": "129 stores",
+ "oneOf": [
+ {
+ "type": "string"
},
- "viewport": {
- "$ref": "#/components/schemas/Bounds"
- }
- },
- "example": {
- "location": {
- "lat": 51.4998415,
- "lng": -0.1246375
+ {
+ "type": "integer"
}
- }
- },
- "address_components": {
- "$ref": "#/components/schemas/AddressComponents"
- },
- "categories": {
- "description": "An array containing the categories of the result. This information is now available in the `types` field and will be removed.",
- "type": "array",
- "deprecated": true,
- "items": {
- "$ref": "#/components/schemas/LocalitiesTypesPoi"
- }
- },
- "formatted_address": {
- "$ref": "#/components/schemas/FormattedAddress"
+ ]
}
}
},
- "LocalitiesNearbyCollectionResponse": {
- "title": "LocalitiesNearbyCollectionResponse",
+ "Error400": {
+ "title": "Error400",
"type": "object",
- "description": "Collection of nearby points of interest.",
+ "description": "The request is invalid",
"properties": {
- "results": {
- "description": "The array of nearby points of interest.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/LocalitiesNearbyResponse"
- }
+ "status": {
+ "type": "string",
+ "description": "the status of the 400 response",
+ "example": "error"
},
- "pagination": {
- "description": "Helps to navigate through paginated results.",
- "type": "object",
- "properties": {
- "next_page": {
- "description": "If more results are available, this will contain the value to pass to the `page` parameter to get the next page",
- "type": [
- "integer",
- "null"
- ]
- },
- "previous_page": {
- "description": "If previous results are available, this will contain the value to pass to the `page` parameter to get the previous page",
- "type": [
- "integer",
- "null"
- ]
- }
- }
+ "value": {
+ "description": "the value of request causing the Error",
+ "example": "The request is invalid, the data is not a valid JSON.",
+ "type": "string"
+ }
+ }
+ },
+ "MatchedSubstring": {
+ "title": "MatchedSubstring",
+ "type": "object",
+ "properties": {
+ "length": {
+ "description": "Length of the matched substring in the prediction result text.",
+ "type": "number"
+ },
+ "offset": {
+ "description": "Start location of the matched substring in the prediction result text.",
+ "type": "number"
}
},
"example": {
- "results": [
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6ZTc2ZDA1YzBiM2M0M2NmNmVkNTJjNGQyZDFiZDE3Nzc0OTZkNjlmOA==",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.fast_food"
- ],
- "categories": [
- "business.food_and_drinks.fast_food"
- ],
- "name": "Pret A Manger",
- "formatted_address": "Broadway, New York",
- "geometry": {
- "location": {
- "lat": 40.715905992166256,
- "lng": -74.00508673226767
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
+ "offset": 0,
+ "length": 4
+ }
+ },
+ "AssetAutocompleteResponse": {
+ "title": "AssetAutocompleteResponse",
+ "type": "object",
+ "description": "Asset Autocomplete Response with highlighted results on asset name.",
+ "properties": {
+ "predictions": {
+ "description": "A list of predictions based on similarity in all the `localizedNames` passed in query (or similarity to `store_name` if no `localizedNames` exist)",
+ "items": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The `name` property of each prediction will be filled with the localized name of your asset in the `language` you provided in your query if it exists, or else the default name property.\n",
+ "type": "string",
+ "example": "Centro Commerciale Deria"
},
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
+ "highlighted": {
+ "type": "string",
+ "description": "an HTML formatted string with, if it exists, the matched substring(s) in bold font.",
+ "example": "Centro Commercial e Deria"
},
- {
- "types": [
- "route"
- ],
- "long_name": "Broadway",
- "short_name": "Broadway"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6MzBlMGYxMzVhNGUzZDQ4MzRiMmNlNDMzMWJiYjZkOTY0MWJhN2E0Zg==",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.fast_food"
- ],
- "categories": [
- "business.food_and_drinks.fast_food"
- ],
- "name": "Dunkin'",
- "formatted_address": "Broadway, New York",
- "geometry": {
- "location": {
- "lat": 40.71602115951586,
- "lng": -74.00494482664695
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
+ "store_id": {
+ "$ref": "#/components/schemas/AssetId"
},
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
+ "types": {
+ "$ref": "#/components/schemas/AssetTypes"
},
- {
- "types": [
- "route"
- ],
- "long_name": "Broadway",
- "short_name": "Broadway"
+ "matched_substrings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/MatchedSubstring"
+ }
}
- ]
- },
+ }
+ }
+ }
+ },
+ "example": {
+ "predictions": [
{
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmJlMWNkMTE2ZDQwM2E0Y2YwNGQ5NWQ2OTlmZWRmM2FhZTExNGU3ZWY=",
+ "store_id": "2670",
+ "name": "Sun Street",
"types": [
- "point_of_interest",
- "business.food_and_drinks.restaurant"
- ],
- "categories": [
- "business.food_and_drinks.restaurant"
+ "Coffee shop"
],
- "name": "Chambers",
- "formatted_address": "Chambers Street, New York",
- "geometry": {
- "location": {
- "lat": 40.71461844801976,
- "lng": -74.00754036678366
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
+ "matched_substrings": [
{
- "types": [
- "route"
- ],
- "long_name": "Chambers Street",
- "short_name": "Chambers Street"
+ "offset": 4,
+ "length": 6
}
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLnNob3AuZ3JvY2VyeTo1YTczMjYxOTQyYjVlZmUwOGEzZjQ1NGZmMTMwMmJjNjA4ODE3NmRk",
- "types": [
- "point_of_interest",
- "business.shop.grocery"
],
- "categories": [
- "business.shop.grocery"
- ],
- "name": "City Hall Oasis",
- "geometry": {
- "location": {
- "lat": 40.71283012706819,
- "lng": -74.00727837935057
- },
- "viewport": {
- "northeast": {
- "lat": 40.71286059528623,
- "lng": -74.00724213866874
- },
- "southwest": {
- "lat": 40.71279957503111,
- "lng": -74.00731464213119
- }
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- }
- ]
+ "highlighted": "Sun Street "
},
{
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZpbmFuY2UuYmFuazpiOGY5MDE4Nzc2ZDZjNmEwZTljOGM4YWM0OTAxZWZlNzNmODZkM2M3",
+ "store_id": "16069",
+ "name": "7th Street",
"types": [
- "point_of_interest",
- "business.finance.bank"
- ],
- "categories": [
- "business.finance.bank"
+ "Coffee shop"
],
- "name": "Citibank",
- "formatted_address": "Broadway, New York",
- "geometry": {
- "location": {
- "lat": 40.7130414767567,
- "lng": -74.0074818610995
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
+ "matched_substrings": [
{
- "types": [
- "route"
- ],
- "long_name": "Broadway",
- "short_name": "Broadway"
+ "offset": 4,
+ "length": 6
}
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQzMTMzZTJkODdiOGJjMGE3ZjI2YTdiMWVjYTZlZmI1MjQyYWE3MTE=",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.restaurant"
- ],
- "categories": [
- "business.food_and_drinks.restaurant"
],
- "name": "Saffron",
- "geometry": {
- "location": {
- "lat": 40.71467049963849,
- "lng": -74.00767187884445
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- }
- ]
+ "highlighted": "7th Street "
},
{
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQ1NjMyN2RiM2EyNWJlYmIwNjJjZjNlYWYwMDE3ZDIyYzEyNWNlMjY=",
+ "store_id": "1013873",
+ "name": "The Street",
"types": [
- "point_of_interest",
- "business.food_and_drinks.restaurant"
- ],
- "categories": [
- "business.food_and_drinks.restaurant"
+ "Coffee shop"
],
- "name": "Gran Morsi",
- "geometry": {
- "location": {
- "lat": 40.71432885326513,
- "lng": -74.00778746528921
- }
- },
- "address_components": [
+ "matched_substrings": [
{
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
+ "offset": 4,
+ "length": 6
}
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5iYXI6MDE5ZGUzNTdiZDkyNzAyZDM4ZDUyOWQ0YmJiZjBmODQ5YWEzZmY1NA==",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.bar"
- ],
- "categories": [
- "business.food_and_drinks.bar"
],
- "name": "Bon Courage",
- "formatted_address": "Reade Street, New York",
- "geometry": {
- "location": {
- "lat": 40.71541472882126,
- "lng": -74.00719193106873
- }
+ "highlighted": "The Street "
+ }
+ ]
+ }
+ },
+ "BoundsResponse": {
+ "title": "BoundsResponse",
+ "type": "object",
+ "description": "Message returned to a success Search Bounds request",
+ "properties": {
+ "bounds": {
+ "description": "The bounds object",
+ "type": "object",
+ "properties": {
+ "west": {
+ "description": "The west longitude of bounds",
+ "type": "number",
+ "example": -0.14408
},
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Reade Street",
- "short_name": "Reade Street"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6OGIyNDY5MDM4M2JhYzE1NmY4OGRiMGQzYmIyYzNjMTVmOTk0NDQwZQ==",
- "types": [
- "point_of_interest",
- "business.food_and_drinks.fast_food"
- ],
- "categories": [
- "business.food_and_drinks.fast_food"
- ],
- "name": "Burger King",
- "formatted_address": "Broadway, New York",
- "geometry": {
- "location": {
- "lat": 40.71619516782573,
- "lng": -74.00480635760651
- }
+ "south": {
+ "description": "The south latitude of bounds",
+ "type": "number",
+ "example": -51.5088
},
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Broadway",
- "short_name": "Broadway"
- }
- ]
- },
- {
- "public_id": "cG9pOnVzOmJ1c2luZXNzLnRoZWF0cmU6MTU1Yjk5YmEwY2FiYzIzZjYxYWYyYTViYzI0ZDViYTVlNmVmZTAwNA==",
- "types": [
- "point_of_interest",
- "business.theatre"
- ],
- "categories": [
- "business.theatre"
- ],
- "name": "The Flea",
- "formatted_address": "Thomas Street, New York",
- "geometry": {
- "location": {
- "lat": 40.71609349534023,
- "lng": -74.00589281989586
- }
+ "east": {
+ "description": "The east longitude of bounds",
+ "type": "number",
+ "example": -0.14408
},
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- },
- {
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
- },
- {
- "types": [
- "route"
- ],
- "long_name": "Thomas Street",
- "short_name": "Thomas Street"
- }
- ]
+ "north": {
+ "description": "The north latitude of bounds",
+ "type": "number",
+ "example": 51.5088
+ }
}
- ],
- "pagination": {
- "previous_page": 2,
- "next_page": 4
}
}
},
@@ -8316,13 +5176,13 @@
},
"securitySchemes": {
"PrivateApiKeyAuth": {
- "description": "A Private key generated specifically to authenticate API requests on server side. Required for Data management API. See how to [register a Private API Key](https://developers.woosmap.com/support/api-keys/#registering-a-woosmap-private-api-key).",
+ "description": "A Private key generated specifically to authenticate API requests on server side. Required for Data management API. See how to [register a Private API Key](https://developers.woosmap.com/api-reference/authentication/#registering-a-woosmap-private-api-key).",
"type": "apiKey",
"in": "query",
"name": "private_key"
},
"PublicApiKeyAuth": {
- "description": "A Public key generated specifically to authenticate API requests on the front side. See how to [register a Public API Key](https://developers.woosmap.com/support/api-keys/#registering-a-woosmap-public-api-key).",
+ "description": "A Public key generated specifically to authenticate API requests on the front side. See how to [register a Public API Key](https://developers.woosmap.com/api-reference/authentication/#registering-a-woosmap-public-api-key).",
"type": "apiKey",
"in": "query",
"name": "key"
@@ -8334,7 +5194,7 @@
"name": "Referer"
},
"PrivateApiKeyHeaderAuth": {
- "description": "A Private key to authenticate API requests through the Header instead of Query parameter. Use either PrivateApiKeyHeaderAuth or PrivateApiKeyAuth. See how to [register a Private API Key](https://developers.woosmap.com/support/api-keys/#registering-a-woosmap-private-api-key).",
+ "description": "A Private key to authenticate API requests through the Header instead of Query parameter. Use either PrivateApiKeyHeaderAuth or PrivateApiKeyAuth. See how to [register a Private API Key](https://developers.woosmap.com/api-reference/authentication/#registering-a-woosmap-private-api-key).",
"type": "apiKey",
"in": "header",
"name": "X-Api-Key"
diff --git a/dist/woosmap-openapi3.yml b/dist/woosmap-openapi3.yml
index bdd075ca..75ac69aa 100755
--- a/dist/woosmap-openapi3.yml
+++ b/dist/woosmap-openapi3.yml
@@ -26,7 +26,7 @@ security:
tags:
- name: Search
description: |
- Store Search lets you query the Assets which are returned as a [GeoJson](https://geojson.org/). Request is done over HTTPS using GET. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/support/api-keys/). If your request returns a high number of assets, the result will be paginated. If so, you can request assets by page using `page` and `stores_by_page` parameters (Default is **100**, max is **300**).
+ Store Search lets you query the Assets which are returned as a [GeoJson](https://geojson.org/). Request is done over HTTPS using GET. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/api-reference/authentication/). If your request returns a high number of assets, the result will be paginated. If so, you can request assets by page using `page` and `stores_by_page` parameters (Default is **100**, max is **300**).
externalDocs:
url: https://developers.woosmap.com/products/stores-api/overview/
- name: Data Management
@@ -49,14 +49,9 @@ tags:
url: https://developers.woosmap.com/products/stores-api/overview/
- name: Geolocation API
description: |
- Geolocation API returns a location (or nearby stores) and accuracy radius based on an IP address. Request is done over HTTPS using GET. Response is formatted as JSON. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/support/api-keys/).
+ Geolocation API returns a location (or nearby stores) and accuracy radius based on an IP address. Request is done over HTTPS using GET. Response is formatted as JSON. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/api-reference/authentication/).
externalDocs:
url: https://developers.woosmap.com/products/geolocation-api/location/
- - name: Localities API
- description: |
- Woosmap Localities API is a web service that returns a great amount of geographical places in response to an HTTP request. Among others are city names, postal codes, suburbs, addresses or airports. Request is done over HTTPS using GET. Response is formatted as JSON. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/support/api-keys/).
- externalDocs:
- url: https://developers.woosmap.com/products/localities/get-started/
paths:
/geolocation/position:
get:
@@ -2466,94 +2461,46 @@ paths:
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
- /localities/autocomplete:
+ /zones:
get:
- summary: Autocomplete for Localities
- operationId: localitiesAutocomplete
+ summary: List your Zones
+ operationId: listZones
servers:
- url: https://api.woosmap.com
tags:
- - Localities API
+ - Zones
description: |
- Autocomplete on worldwide suggestions for text-based geographic searches. It can match on full words as well as substrings. You can therefore send queries as the user types, to provide on-the-fly addresses, city names, postal codes or suburb name suggestions.
+ List all zones for the current project, sorted by `zone_id`.
security:
- - PublicApiKeyAuth: []
- RefererHeader: []
- PrivateApiKeyAuth: []
- - PrivateApiKeyHeaderAuth: []
parameters:
- - $ref: '#/components/parameters/input'
- - $ref: '#/components/parameters/types'
- - $ref: '#/components/parameters/excluded_types'
- - $ref: '#/components/parameters/localities_components'
- - $ref: '#/components/parameters/language-2'
- - $ref: '#/components/parameters/location'
- - $ref: '#/components/parameters/radius-2'
- - $ref: '#/components/parameters/data'
- - $ref: '#/components/parameters/extended'
- - $ref: '#/components/parameters/custom_description'
+ - $ref: '#/components/parameters/limit-3'
+ - $ref: '#/components/parameters/offset'
responses:
'200':
- description: Autocompletion Localities successfully retrieved
+ description: Zones successfully retrieved
content:
application/json:
schema:
- $ref: '#/components/schemas/LocalitiesAutocompleteCollectionResponse'
+ $ref: '#/components/schemas/ZonesCollectionResponse'
examples:
default:
- summary: Autocomplete localities results for input `Lond` and components `country:gb`
+ summary: Zones data
value:
- localities:
- - public_id: Ch6qA8cLmvyvEEoFy6nYeFcEdNU=
- type: locality
- types:
- - locality
- - city
- description: London, City of London, United Kingdom
- matched_substrings:
- description:
- - offset: 0
- length: 4
- - public_id: m/T2C4YI2LgszkKXrELBC+9dfC8=
- type: locality
- types:
- - locality
- - city
- description: Derry/Londonderry, Derry City and Strabane, United Kingdom
- matched_substrings:
- description:
- - offset: 6
- length: 4
- - public_id: J6eISGMjjvQwPkao8rsByB3aVwM=
- type: locality
- types:
- - locality
- - village
- description: London Colney, Hertfordshire, United Kingdom
- matched_substrings:
- description:
- - offset: 0
- length: 4
- - public_id: 52MnrbHVWH21CLWH8VY/YWKhqeM=
- type: locality
+ zones:
+ - store_id: STORE_ID_123456
+ zone_id: ZoneB
+ polygon: POLYGON ((-122.4546384 37.774656, -122.4515485 37.7595934, -122.4354306 37.7602172, -122.4333707 37.7512596, -122.423071 37.7511239, -122.4242726 37.7687665, -122.4259893 37.7691736, -122.4289075 37.7732444, -122.4306241 37.7850483, -122.4472753 37.7830133, -122.445902 37.7759581, -122.4546384 37.774656))
types:
- - locality
- - village
- description: London Apprentice, Cornwall, United Kingdom
- matched_substrings:
- description:
- - offset: 0
- length: 4
- - public_id: S/5AkUmMBhX35qVI2jR38+dALwk=
- type: locality
+ - delivery
+ description: Delivery Zone for Store B
+ - store_id: STORE_ID_45678
+ zone_id: ZoneC
+ polygon: POLYGON ((-122.4758889 37.7524995, -122.4751594 37.7321718, -122.4688079 37.7299995, -122.4648597 37.7261979, -122.4519851 37.7228035, -122.4483802 37.7215815, -122.4458053 37.726741, -122.4365356 37.7310857, -122.4315574 37.7324433, -122.4246909 37.7312214, -122.4219444 37.731493, -122.423071 37.7511239, -122.4333707 37.7512596, -122.4354306 37.7602172, -122.4515485 37.7595934, -122.4528628 37.7582744, -122.4540375 37.7566755, -122.4565266 37.7513144, -122.4601315 37.7521288, -122.4618481 37.7514501, -122.4635648 37.7530788, -122.4758889 37.7524995))
types:
- - locality
- - city
- description: City of London, United Kingdom
- matched_substrings:
- description:
- - offset: 8
- length: 4
+ - delivery
+ description: Delivery Zone for Store C
+ status: ok
'401':
description: Unauthorized. Incorrect authentication credentials.
content:
@@ -2590,9 +2537,7 @@ paths:
x-codeSamples:
- lang: curl
label: cURL
- source: |-
- curl -L 'https://api.woosmap.com/localities/autocomplete/?input=Lond&components=country%3Agb&no_deprecated_fields=true&key=YOUR_PUBLIC_API_KEY' \
- -H 'Referer: http://localhost'
+ source: curl -L 'https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY&limit=2&offset=1'
- lang: javascript
label: JavaScript
source: |-
@@ -2601,7 +2546,7 @@ paths:
redirect: "follow"
};
- fetch("https://api.woosmap.com/localities/autocomplete/?input=Lond&components=country%3Agb&no_deprecated_fields=true&key=YOUR_PUBLIC_API_KEY", requestOptions)
+ fetch("https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY&limit=2&offset=1", requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));
@@ -2610,148 +2555,80 @@ paths:
source: |
import requests
- url = "https://api.woosmap.com/localities/autocomplete/?input=Lond&components=country%3Agb&no_deprecated_fields=true&key=YOUR_PUBLIC_API_KEY"
+ url = "https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY&limit=2&offset=1"
payload = {}
- headers = {
- 'Referer': 'http://localhost'
- }
+ headers = {}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
- /localities/details:
- get:
- summary: Details of a Locality
- operationId: localitiesDetails
+ post:
+ summary: Create your Zones
+ operationId: createZones
servers:
- url: https://api.woosmap.com
tags:
- - Localities API
+ - Zones
description: |
- Provides details of an autocomplete suggestion (using the suggestion’s `public_id`).
+ Used to batch create Zones to a specific project identified with the `private_key` parameter.
security:
- - PublicApiKeyAuth: []
- RefererHeader: []
- PrivateApiKeyAuth: []
- - PrivateApiKeyHeaderAuth: []
- parameters:
- - $ref: '#/components/parameters/public_id'
- - $ref: '#/components/parameters/language-2'
- - $ref: '#/components/parameters/fields'
- - $ref: '#/components/parameters/cc_format'
- - $ref: '#/components/parameters/page-2'
- - $ref: '#/components/parameters/addresses_per_page'
+ requestBody:
+ description: The request body of Zones Creation must be formatted as JSON.
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ZonesCollectionRequest'
+ examples:
+ default:
+ summary: Zones data as JSON
+ value:
+ zones:
+ - zone_id: ZoneA
+ description: Delivery Zone for Store A
+ store_id: STORE_ID_123456
+ polygon: POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))
+ types:
+ - delivery
+ - zone_id: ZoneB
+ description: Delivery Zone for Store B
+ store_id: STORE_ID_123456
+ polygon: POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))
+ types:
+ - delivery
+ - zone_id: ZoneC
+ description: Delivery Zone for Store C
+ store_id: STORE_ID_45678
+ polygon: POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))
+ types:
+ - delivery
responses:
'200':
- description: Details Localities successfully retrieved
+ description: Zones successfully created
content:
application/json:
schema:
- $ref: '#/components/schemas/LocalitiesDetailsResponse'
+ $ref: '#/components/schemas/SuccessZones'
examples:
- Address:
- summary: Localities Address details from a `public_id` retrieved using Localities autocomplete
+ default:
+ summary: Success response for Zones Created
value:
- result:
- public_id: TVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPV9fTVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPQ==
- types:
- - address
- formatted_address: House Of Commons, Houses Of Parliament, London, SW1A 0AA
- geometry:
- location:
- lat: 51.4998415
- lng: -0.1246375
- accuracy: ROOFTOP
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United Kingdom
- short_name: GB
- - types:
- - state
- - division_level_1
- long_name: England
- short_name: England
- - types:
- - administrative_area_level_1
- - county
- - division_level_2
- long_name: City of London
- short_name: City of London
- - types:
- - district
- - division_level_3
- long_name: Westminster
- short_name: Westminster
- - types:
- - locality
- long_name: London
- short_name: London
- - types:
- - postal_codes
- long_name: SW1A 0AA
- short_name: SW1A 0AA
- - types:
- - premise
- long_name: Houses Of Parliament
- short_name: Houses Of Parliament
- - types:
- - organisation
- long_name: House Of Commons
- short_name: House Of Commons
- PostalCode:
- summary: Localities Postal Code details from a `public_id` retrieved using Localities autocomplete
+ status: ok
+ message: Zones successfully added.
+ '400':
+ description: Invalid. The data is not a valid JSON.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/Error400'
+ examples:
+ Invalid:
+ summary: Error 400
value:
- result:
- public_id: cG9zdGFsX2NvZGU6Z2I6OmNDN0N0ZUF2MW9YRi9KLzlnS2cremJndktFaz0=
- types:
- - postal_code
- formatted_address: SW1A 0AA, City of London
- name: SW1A 0AA
- geometry:
- location:
- lat: 51.499842
- lng: -0.124638
- accuracy: GEOMETRIC_CENTER
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United Kingdom
- short_name: GB
- - types:
- - state
- - division_level_1
- long_name: England
- short_name: England
- - types:
- - administrative_area_level_1
- - county
- - division_level_2
- long_name: City of London
- short_name: City of London
- - types:
- - district
- - division_level_3
- long_name: Westminster
- short_name: Westminster
- - types:
- - postal_codes
- long_name: SW1A 0AA
- short_name: SW1A 0AA
- addresses:
- pagination:
- page: 1
- page_count: 1
- addresses_per_page: 1
- address_count: 1
- list:
- - public_id: TVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPV9fTVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPQ==
- description: House Of Commons, Houses Of Parliament London, SW1A 0AA
+ status: error
+ value: The request is invalid, the data is not a valid JSON.
'401':
description: Unauthorized. Incorrect authentication credentials.
content:
@@ -2774,998 +2651,145 @@ paths:
summary: Error 403
value:
detail: This Woosmap API is not enabled for this project.
- '429':
- description: Too Many Requests. The rate limit for this endpoint has been exceeded.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error429'
- examples:
- Forbidden:
- summary: Error 429
- value:
- detail: The rate limit for this endpoint has been exceeded
x-codeSamples:
- lang: curl
label: cURL
source: |-
- curl -L 'https://api.woosmap.com/localities/details?public_id=TVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPV9fTVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPQ%3D%3D&key=YOUR_PUBLIC_API_KEY' \
- -H 'Referer: http://localhost'
- - lang: javascript
- label: JavaScript
- source: |-
- const requestOptions = {
- method: "GET",
- redirect: "follow"
- };
-
- fetch("https://api.woosmap.com/localities/details?public_id=TVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPV9fTVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPQ%3D%3D&key=YOUR_PUBLIC_API_KEY", requestOptions)
- .then((response) => response.text())
- .then((result) => console.log(result))
- .catch((error) => console.error(error));
+ curl -L 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY' \
+ -H 'content-type: application/json' \
+ -d '{
+ "zones": [
+ {
+ "zone_id": "ZoneA",
+ "description": "Delivery Zone for Store A",
+ "store_id": "STORE_ID_123456",
+ "polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))",
+ "types": [
+ "delivery"
+ ]
+ },
+ {
+ "zone_id": "ZoneB",
+ "description": "Delivery Zone for Store B",
+ "store_id": "STORE_ID_123456",
+ "polygon": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))",
+ "types": [
+ "delivery"
+ ]
+ },
+ {
+ "zone_id": "ZoneC",
+ "description": "Delivery Zone for Store C",
+ "store_id": "STORE_ID_45678",
+ "polygon": "POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))",
+ "types": [
+ "delivery"
+ ]
+ }
+ ]
+ }'
- lang: python
label: Python
source: |
import requests
+ import json
- url = "https://api.woosmap.com/localities/details?public_id=TVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPV9fTVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPQ%3D%3D&key=YOUR_PUBLIC_API_KEY"
+ url = "https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY"
- payload = {}
+ payload = json.dumps({
+ "zones": [
+ {
+ "zone_id": "ZoneA",
+ "description": "Delivery Zone for Store A",
+ "store_id": "STORE_ID_123456",
+ "polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))",
+ "types": [
+ "delivery"
+ ]
+ },
+ {
+ "zone_id": "ZoneB",
+ "description": "Delivery Zone for Store B",
+ "store_id": "STORE_ID_123456",
+ "polygon": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))",
+ "types": [
+ "delivery"
+ ]
+ },
+ {
+ "zone_id": "ZoneC",
+ "description": "Delivery Zone for Store C",
+ "store_id": "STORE_ID_45678",
+ "polygon": "POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))",
+ "types": [
+ "delivery"
+ ]
+ }
+ ]
+ })
headers = {
- 'Referer': 'http://localhost'
+ 'content-type': 'application/json'
}
- response = requests.request("GET", url, headers=headers, data=payload)
+ response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
- /localities/geocode:
- get:
- summary: Geocode a locality or Reverse Geocode a latlng
- operationId: localitiesGeocode
- servers:
- - url: https://api.woosmap.com
- tags:
- - Localities API
- description: |
- Provides details for an address or a geographic position. Either parameter `address` **or** `latlng` is required.
- security:
- - PublicApiKeyAuth: []
- RefererHeader: []
- - PrivateApiKeyAuth: []
- - PrivateApiKeyHeaderAuth: []
- parameters:
- - $ref: '#/components/parameters/address'
- - $ref: '#/components/parameters/latlng'
- - $ref: '#/components/parameters/geocode_types'
- - $ref: '#/components/parameters/excluded_types'
- - $ref: '#/components/parameters/list_sub_buildings'
- - $ref: '#/components/parameters/localities_components'
- - $ref: '#/components/parameters/language-2'
- - $ref: '#/components/parameters/fields'
- - $ref: '#/components/parameters/data'
- - $ref: '#/components/parameters/cc_format'
- responses:
- '200':
- description: Request Localities Geocode successful
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/LocalitiesGeocodeCollectionResponse'
- examples:
- geocode:
- summary: Geocode Results for address `Place Jeanne-d'Arc` with components `country:FR`
- value:
- results:
- - public_id: 0+FTYd/1MsiBSxLAKq+/Fiyy+uM=
- types:
- - address
- - route
- formatted_address: Place Jeanne D'Arc, 75013, Paris
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: France
- short_name: FR
- - types:
- - state
- - division_level_1
- long_name: Île-de-France
- short_name: Île-de-France
- - types:
- - administrative_area_level_1
- - county
- - division_level_2
- long_name: Paris
- short_name: Paris
- - types:
- - locality
- long_name: Paris
- short_name: Paris
- - types:
- - postal_codes
- long_name: '75013'
- short_name: '75013'
- - types:
- - route
- long_name: Place Jeanne D'Arc
- short_name: Place Jeanne D'Arc
- geometry:
- location:
- lat: 48.829405
- lng: 2.367944
- location_type: GEOMETRIC_CENTER
- scores_per_components:
- street_name: 1
- reverse:
- summary: Reverse Geocode Results for latlng `51.52089223979333, -0.195460973340401` with list_sub_buildings `true`
- value:
- results:
- - public_id: ''
- types:
- - address
- formatted_address: Radway House, Alfred Road, London, W2 5ER
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United Kingdom
- short_name: GB
- - types:
- - state
- - division_level_1
- long_name: England
- short_name: England
- - types:
- - administrative_area_level_1
- - county
- - division_level_2
- long_name: City of London
- short_name: City of London
- - types:
- - district
- - division_level_3
- long_name: Westminster
- short_name: Westminster
- - types:
- - locality
- long_name: London
- short_name: London
- - types:
- - postal_codes
- long_name: W2 5ER
- short_name: W2 5ER
- - types:
- - route
- long_name: Alfred Road
- short_name: Alfred Road
- - types:
- - premise
- long_name: Radway House
- short_name: Radway House
- geometry:
- location:
- lat: 51.5211258
- lng: -0.1956346
- location_type: ROOFTOP
- distance: 28.62347934634507
- sub_buildings:
- - public_id: Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9faitia1pNNURnOWYvQmRjMUdweXl5SjdLZUZnPQ==
- description: Flat 1, Radway House, Alfred Road, London, W2 5ER
- - public_id: Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fbTRoZVpxYkhBYVVXSytqek04UGtGQ1VLTVI0PQ==
- description: Flat 2, Radway House, Alfred Road, London, W2 5ER
- - public_id: Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fcmY1MHV6aE5kVytLWWZLV3JabzFzR2lnbThzPQ==
- description: Flat 3, Radway House, Alfred Road, London, W2 5ER
- - public_id: Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fajlaWXJJUDFKSmI1Y0dpNElDanBQejF2YUg4PQ==
- description: Flat 4, Radway House, Alfred Road, London, W2 5ER
- - public_id: Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fbkdEZTNOODZNL0VlWGtoR0pSa2tBS1NMYndVPQ==
- description: Flat 5, Radway House, Alfred Road, London, W2 5ER
- - public_id: Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fTGxlWUlKN2NhU1JXcTBuSEs1RExiamliNlpNPQ==
- description: Flat 6, Radway House, Alfred Road, London, W2 5ER
- - public_id: Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9feVZXa05ISjhzVGNHK2NQUHFpNlFIUWgvSnpJPQ==
- description: Flat 7, Radway House, Alfred Road, London, W2 5ER
- - public_id: Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fTVc5NldSeWpuOENUS2xST21vZzdnNGxGQldrPQ==
- description: Flat 8, Radway House, Alfred Road, London, W2 5ER
- - public_id: Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fN3RkdE9HeHBwT2M5R1hQMUFwNDJUc3NwRklZPQ==
- description: Flat 9, Radway House, Alfred Road, London, W2 5ER
- - public_id: Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fR2RVRHpoYll4a2RlTldjLzF3NVNFTXNZYzlFPQ==
- description: Flat 10, Radway House, Alfred Road, London, W2 5ER
- - public_id: Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fL3FXbnVZU2h4bjAwMDNKK3hJeU9OL3lnemFzPQ==
- description: Flat 11, Radway House, Alfred Road, London, W2 5ER
- - public_id: Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fVVVCUWhpNVJQWWk2eTl1WFBTVTRmK3Zma3VBPQ==
- description: Flat 12, Radway House, Alfred Road, London, W2 5ER
- - public_id: Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fV2hSUDNadnFMN3ZzaWJ6UFd2MWM3aW1qT3hBPQ==
- description: Flat 13, Radway House, Alfred Road, London, W2 5ER
- - public_id: Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fcWxGbFRlcE1TVStZVElodzFSdVhiTGxZTXl3PQ==
- description: Flat 14, Radway House, Alfred Road, London, W2 5ER
- - public_id: Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fYjR5VHRXMmZTQ0FOMGwwZHJNaFh5TFRnVHlnPQ==
- description: Flat 15, Radway House, Alfred Road, London, W2 5ER
- - public_id: Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9fNmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PQ==
- description: Flat 16, Radway House, Alfred Road, London, W2 5ER
- '401':
- description: Unauthorized. Incorrect authentication credentials.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error401'
- examples:
- Unauthorized:
- summary: Error 401
- value:
- detail: Incorrect authentication credentials. Please check or use a valid API Key
- '403':
- description: Forbidden. This Woosmap API is not enabled for this project.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error403'
- examples:
- Forbidden:
- summary: Error 403
- value:
- detail: This Woosmap API is not enabled for this project.
- '429':
- description: Too Many Requests. The rate limit for this endpoint has been exceeded.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error429'
- examples:
- Forbidden:
- summary: Error 429
- value:
- detail: The rate limit for this endpoint has been exceeded
- x-codeSamples:
- - lang: curl
- label: cURL
- source: |-
- curl -L 'https://api.woosmap.com/localities/geocode?address=Place%20Jeanne-d%27Arc&components=country%3AFR&key=YOUR_PUBLIC_API_KEY' \
- -H 'Referer: http://localhost'
- - lang: javascript
- label: JavaScript
- source: |-
- const requestOptions = {
- method: "GET",
- redirect: "follow"
- };
-
- fetch("https://api.woosmap.com/localities/geocode?address=Place%20Jeanne-d'Arc&components=country%3AFR&key=YOUR_PUBLIC_API_KEY", requestOptions)
- .then((response) => response.text())
- .then((result) => console.log(result))
- .catch((error) => console.error(error));
- - lang: python
- label: Python
- source: |
- import requests
-
- url = "https://api.woosmap.com/localities/geocode?address=Place%20Jeanne-d'Arc&components=country%3AFR&key=YOUR_PUBLIC_API_KEY"
-
- payload = {}
- headers = {
- 'Referer': 'http://localhost'
- }
-
- response = requests.request("GET", url, headers=headers, data=payload)
-
- print(response.text)
- /localities/nearby:
- get:
- summary: Nearby points of interest
- operationId: localitiesNearby
- servers:
- - url: https://api.woosmap.com
- tags:
- - Localities API
- description: |
- Retrieve worldwide points of interest surrounding a given location. They can be filtered by categories.
- security:
- - PublicApiKeyAuth: []
- RefererHeader: []
- - PrivateApiKeyAuth: []
- - PrivateApiKeyHeaderAuth: []
- parameters:
- - $ref: '#/components/parameters/nearby_types'
- - name: location
- description: |
- Center of the search circle.
- schema:
- type: string
- required: true
- example: 40.71399,-74.00499
- in: query
- - name: radius
- description: |
- Radius of the search circle, in meters.
- schema:
- type: integer
- default: 1000
- minimum: 10
- maximum: 50000
- in: query
- required: false
- example: 3000
- - name: page
- description: |
- Use `page` to navigate through paginated results.
- schema:
- type: integer
- default: 1
- minimum: 1
- in: query
- example: 7
- - name: limit
- description: |
- Defines how many results should be included in a page.
- schema:
- type: integer
- default: 10
- minimum: 1
- maximum: 30
- in: query
- example: 15
- - $ref: '#/components/parameters/nearby_excluded_types'
- responses:
- '200':
- description: Points of interest surrounding `location` and matching provided `types`, sorted by distance to `location`.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/LocalitiesNearbyCollectionResponse'
- examples:
- default:
- summary: Nearby points of interest with category `business.shop` around New York center.
- value:
- results:
- - public_id: cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6ZTc2ZDA1YzBiM2M0M2NmNmVkNTJjNGQyZDFiZDE3Nzc0OTZkNjlmOA==
- types:
- - point_of_interest
- - business.food_and_drinks.fast_food
- categories:
- - business.food_and_drinks.fast_food
- name: Pret A Manger
- formatted_address: Broadway, New York
- geometry:
- location:
- lat: 40.715905992166256
- lng: -74.00508673226767
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United States
- short_name: US
- - types:
- - locality
- long_name: New York
- short_name: New York
- - types:
- - route
- long_name: Broadway
- short_name: Broadway
- - public_id: cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6MzBlMGYxMzVhNGUzZDQ4MzRiMmNlNDMzMWJiYjZkOTY0MWJhN2E0Zg==
- types:
- - point_of_interest
- - business.food_and_drinks.fast_food
- categories:
- - business.food_and_drinks.fast_food
- name: Dunkin'
- formatted_address: Broadway, New York
- geometry:
- location:
- lat: 40.71602115951586
- lng: -74.00494482664695
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United States
- short_name: US
- - types:
- - locality
- long_name: New York
- short_name: New York
- - types:
- - route
- long_name: Broadway
- short_name: Broadway
- - public_id: cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmJlMWNkMTE2ZDQwM2E0Y2YwNGQ5NWQ2OTlmZWRmM2FhZTExNGU3ZWY=
- types:
- - point_of_interest
- - business.food_and_drinks.restaurant
- categories:
- - business.food_and_drinks.restaurant
- name: Chambers
- formatted_address: Chambers Street, New York
- geometry:
- location:
- lat: 40.71461844801976
- lng: -74.00754036678366
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United States
- short_name: US
- - types:
- - locality
- long_name: New York
- short_name: New York
- - types:
- - route
- long_name: Chambers Street
- short_name: Chambers Street
- - public_id: cG9pOnVzOmJ1c2luZXNzLnNob3AuZ3JvY2VyeTo1YTczMjYxOTQyYjVlZmUwOGEzZjQ1NGZmMTMwMmJjNjA4ODE3NmRk
- types:
- - point_of_interest
- - business.shop.grocery
- categories:
- - business.shop.grocery
- name: City Hall Oasis
- geometry:
- location:
- lat: 40.71283012706819
- lng: -74.00727837935057
- viewport:
- northeast:
- lat: 40.71286059528623
- lng: -74.00724213866874
- southwest:
- lat: 40.71279957503111
- lng: -74.00731464213119
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United States
- short_name: US
- - public_id: cG9pOnVzOmJ1c2luZXNzLmZpbmFuY2UuYmFuazpiOGY5MDE4Nzc2ZDZjNmEwZTljOGM4YWM0OTAxZWZlNzNmODZkM2M3
- types:
- - point_of_interest
- - business.finance.bank
- categories:
- - business.finance.bank
- name: Citibank
- formatted_address: Broadway, New York
- geometry:
- location:
- lat: 40.7130414767567
- lng: -74.0074818610995
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United States
- short_name: US
- - types:
- - locality
- long_name: New York
- short_name: New York
- - types:
- - route
- long_name: Broadway
- short_name: Broadway
- - public_id: cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQzMTMzZTJkODdiOGJjMGE3ZjI2YTdiMWVjYTZlZmI1MjQyYWE3MTE=
- types:
- - point_of_interest
- - business.food_and_drinks.restaurant
- categories:
- - business.food_and_drinks.restaurant
- name: Saffron
- geometry:
- location:
- lat: 40.71467049963849
- lng: -74.00767187884445
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United States
- short_name: US
- - public_id: cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQ1NjMyN2RiM2EyNWJlYmIwNjJjZjNlYWYwMDE3ZDIyYzEyNWNlMjY=
- types:
- - point_of_interest
- - business.food_and_drinks.restaurant
- categories:
- - business.food_and_drinks.restaurant
- name: Gran Morsi
- geometry:
- location:
- lat: 40.71432885326513
- lng: -74.00778746528921
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United States
- short_name: US
- - public_id: cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5iYXI6MDE5ZGUzNTdiZDkyNzAyZDM4ZDUyOWQ0YmJiZjBmODQ5YWEzZmY1NA==
- types:
- - point_of_interest
- - business.food_and_drinks.bar
- categories:
- - business.food_and_drinks.bar
- name: Bon Courage
- formatted_address: Reade Street, New York
- geometry:
- location:
- lat: 40.71541472882126
- lng: -74.00719193106873
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United States
- short_name: US
- - types:
- - locality
- long_name: New York
- short_name: New York
- - types:
- - route
- long_name: Reade Street
- short_name: Reade Street
- - public_id: cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6OGIyNDY5MDM4M2JhYzE1NmY4OGRiMGQzYmIyYzNjMTVmOTk0NDQwZQ==
- types:
- - point_of_interest
- - business.food_and_drinks.fast_food
- categories:
- - business.food_and_drinks.fast_food
- name: Burger King
- formatted_address: Broadway, New York
- geometry:
- location:
- lat: 40.71619516782573
- lng: -74.00480635760651
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United States
- short_name: US
- - types:
- - locality
- long_name: New York
- short_name: New York
- - types:
- - route
- long_name: Broadway
- short_name: Broadway
- - public_id: cG9pOnVzOmJ1c2luZXNzLnRoZWF0cmU6MTU1Yjk5YmEwY2FiYzIzZjYxYWYyYTViYzI0ZDViYTVlNmVmZTAwNA==
- types:
- - point_of_interest
- - business.theatre
- categories:
- - business.theatre
- name: The Flea
- formatted_address: Thomas Street, New York
- geometry:
- location:
- lat: 40.71609349534023
- lng: -74.00589281989586
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United States
- short_name: US
- - types:
- - locality
- long_name: New York
- short_name: New York
- - types:
- - route
- long_name: Thomas Street
- short_name: Thomas Street
- pagination:
- previous_page: 2
- next_page: 4
- '401':
- description: Unauthorized. Incorrect authentication credentials.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error401'
- examples:
- Unauthorized:
- summary: Error 401
- value:
- detail: Incorrect authentication credentials. Please check or use a valid API Key
- '403':
- description: Forbidden. This Woosmap API is not enabled for this project.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error403'
- examples:
- Forbidden:
- summary: Error 403
- value:
- detail: This Woosmap API is not enabled for this project.
- '429':
- description: Too Many Requests. The rate limit for this endpoint has been exceeded.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error429'
- examples:
- Forbidden:
- summary: Error 429
- value:
- detail: The rate limit for this endpoint has been exceeded
- x-codeSamples:
- - lang: curl
- label: cURL
- source: |-
- curl -L 'https://api.woosmap.com/localities/nearby?types=business&location=40.71399%2C-74.00499&page=3&key=YOUR_PUBLIC_API_KEY' \
- -H 'Referer: http://localhost'
- - lang: javascript
- label: JavaScript
- source: |-
- const requestOptions = {
- method: "GET",
- redirect: "follow"
- };
-
- fetch("https://api.woosmap.com/localities/nearby?types=business&location=40.71399%2C-74.00499&page=3&key=YOUR_PUBLIC_API_KEY", requestOptions)
- .then((response) => response.text())
- .then((result) => console.log(result))
- .catch((error) => console.error(error));
- - lang: python
- label: Python
- source: |
- import requests
-
- url = "https://api.woosmap.com/localities/nearby?types=business&location=40.71399%2C-74.00499&page=3&key=YOUR_PUBLIC_API_KEY"
-
- payload = {}
- headers = {
- 'Referer': 'http://localhost'
- }
-
- response = requests.request("GET", url, headers=headers, data=payload)
-
- print(response.text)
- /zones:
- get:
- summary: List your Zones
- operationId: listZones
- servers:
- - url: https://api.woosmap.com
- tags:
- - Zones
- description: |
- List all zones for the current project, sorted by `zone_id`.
- security:
- - PrivateApiKeyAuth: []
- parameters:
- - $ref: '#/components/parameters/limit-3'
- - $ref: '#/components/parameters/offset'
- responses:
- '200':
- description: Zones successfully retrieved
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ZonesCollectionResponse'
- examples:
- default:
- summary: Zones data
- value:
- zones:
- - store_id: STORE_ID_123456
- zone_id: ZoneB
- polygon: POLYGON ((-122.4546384 37.774656, -122.4515485 37.7595934, -122.4354306 37.7602172, -122.4333707 37.7512596, -122.423071 37.7511239, -122.4242726 37.7687665, -122.4259893 37.7691736, -122.4289075 37.7732444, -122.4306241 37.7850483, -122.4472753 37.7830133, -122.445902 37.7759581, -122.4546384 37.774656))
- types:
- - delivery
- description: Delivery Zone for Store B
- - store_id: STORE_ID_45678
- zone_id: ZoneC
- polygon: POLYGON ((-122.4758889 37.7524995, -122.4751594 37.7321718, -122.4688079 37.7299995, -122.4648597 37.7261979, -122.4519851 37.7228035, -122.4483802 37.7215815, -122.4458053 37.726741, -122.4365356 37.7310857, -122.4315574 37.7324433, -122.4246909 37.7312214, -122.4219444 37.731493, -122.423071 37.7511239, -122.4333707 37.7512596, -122.4354306 37.7602172, -122.4515485 37.7595934, -122.4528628 37.7582744, -122.4540375 37.7566755, -122.4565266 37.7513144, -122.4601315 37.7521288, -122.4618481 37.7514501, -122.4635648 37.7530788, -122.4758889 37.7524995))
- types:
- - delivery
- description: Delivery Zone for Store C
- status: ok
- '401':
- description: Unauthorized. Incorrect authentication credentials.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error401'
- examples:
- Unauthorized:
- summary: Error 401
- value:
- detail: Incorrect authentication credentials. Please check or use a valid API Key
- '403':
- description: Forbidden. This Woosmap API is not enabled for this project.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error403'
- examples:
- Forbidden:
- summary: Error 403
- value:
- detail: This Woosmap API is not enabled for this project.
- '429':
- description: Too Many Requests. The rate limit for this endpoint has been exceeded.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error429'
- examples:
- Forbidden:
- summary: Error 429
- value:
- detail: The rate limit for this endpoint has been exceeded
- x-codeSamples:
- - lang: curl
- label: cURL
- source: curl -L 'https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY&limit=2&offset=1'
- - lang: javascript
- label: JavaScript
- source: |-
- const requestOptions = {
- method: "GET",
- redirect: "follow"
- };
-
- fetch("https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY&limit=2&offset=1", requestOptions)
- .then((response) => response.text())
- .then((result) => console.log(result))
- .catch((error) => console.error(error));
- - lang: python
- label: Python
- source: |
- import requests
-
- url = "https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY&limit=2&offset=1"
-
- payload = {}
- headers = {}
-
- response = requests.request("GET", url, headers=headers, data=payload)
-
- print(response.text)
- post:
- summary: Create your Zones
- operationId: createZones
- servers:
- - url: https://api.woosmap.com
- tags:
- - Zones
- description: |
- Used to batch create Zones to a specific project identified with the `private_key` parameter.
- security:
- - PrivateApiKeyAuth: []
- requestBody:
- description: The request body of Zones Creation must be formatted as JSON.
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ZonesCollectionRequest'
- examples:
- default:
- summary: Zones data as JSON
- value:
- zones:
- - zone_id: ZoneA
- description: Delivery Zone for Store A
- store_id: STORE_ID_123456
- polygon: POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))
- types:
- - delivery
- - zone_id: ZoneB
- description: Delivery Zone for Store B
- store_id: STORE_ID_123456
- polygon: POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))
- types:
- - delivery
- - zone_id: ZoneC
- description: Delivery Zone for Store C
- store_id: STORE_ID_45678
- polygon: POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))
- types:
- - delivery
- responses:
- '200':
- description: Zones successfully created
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/SuccessZones'
- examples:
- default:
- summary: Success response for Zones Created
- value:
- status: ok
- message: Zones successfully added.
- '400':
- description: Invalid. The data is not a valid JSON.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error400'
- examples:
- Invalid:
- summary: Error 400
- value:
- status: error
- value: The request is invalid, the data is not a valid JSON.
- '401':
- description: Unauthorized. Incorrect authentication credentials.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error401'
- examples:
- Unauthorized:
- summary: Error 401
- value:
- detail: Incorrect authentication credentials. Please check or use a valid API Key
- '403':
- description: Forbidden. This Woosmap API is not enabled for this project.
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Error403'
- examples:
- Forbidden:
- summary: Error 403
- value:
- detail: This Woosmap API is not enabled for this project.
- x-codeSamples:
- - lang: curl
- label: cURL
- source: |-
- curl -L 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY' \
- -H 'content-type: application/json' \
- -d '{
- "zones": [
- {
- "zone_id": "ZoneA",
- "description": "Delivery Zone for Store A",
- "store_id": "STORE_ID_123456",
- "polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))",
- "types": [
- "delivery"
- ]
- },
- {
- "zone_id": "ZoneB",
- "description": "Delivery Zone for Store B",
- "store_id": "STORE_ID_123456",
- "polygon": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))",
- "types": [
- "delivery"
- ]
- },
- {
- "zone_id": "ZoneC",
- "description": "Delivery Zone for Store C",
- "store_id": "STORE_ID_45678",
- "polygon": "POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))",
- "types": [
- "delivery"
- ]
- }
- ]
- }'
- - lang: python
- label: Python
- source: |
- import requests
- import json
-
- url = "https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY"
-
- payload = json.dumps({
- "zones": [
- {
- "zone_id": "ZoneA",
- "description": "Delivery Zone for Store A",
- "store_id": "STORE_ID_123456",
- "polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))",
- "types": [
- "delivery"
- ]
- },
- {
- "zone_id": "ZoneB",
- "description": "Delivery Zone for Store B",
- "store_id": "STORE_ID_123456",
- "polygon": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))",
- "types": [
- "delivery"
- ]
- },
- {
- "zone_id": "ZoneC",
- "description": "Delivery Zone for Store C",
- "store_id": "STORE_ID_45678",
- "polygon": "POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))",
- "types": [
- "delivery"
- ]
- }
- ]
- })
- headers = {
- 'content-type': 'application/json'
- }
-
- response = requests.request("POST", url, headers=headers, data=payload)
-
- print(response.text)
- - lang: nodejs
- label: NodeJS
- source: |
- const axios = require('axios');
- let data = JSON.stringify({
- "zones": [
- {
- "zone_id": "ZoneA",
- "description": "Delivery Zone for Store A",
- "store_id": "STORE_ID_123456",
- "polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))",
- "types": [
- "delivery"
- ]
- },
- {
- "zone_id": "ZoneB",
- "description": "Delivery Zone for Store B",
- "store_id": "STORE_ID_123456",
- "polygon": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))",
- "types": [
- "delivery"
- ]
- },
- {
- "zone_id": "ZoneC",
- "description": "Delivery Zone for Store C",
- "store_id": "STORE_ID_45678",
- "polygon": "POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))",
- "types": [
- "delivery"
- ]
- }
- ]
- });
-
- let config = {
- method: 'post',
- maxBodyLength: Infinity,
- url: 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY',
- headers: {
- 'content-type': 'application/json'
- },
- data : data
- };
-
- axios.request(config)
- .then((response) => {
- console.log(JSON.stringify(response.data));
- })
- .catch((error) => {
- console.log(error);
- });
- put:
- summary: Update the Zones
- operationId: updateZones
+ - lang: nodejs
+ label: NodeJS
+ source: |
+ const axios = require('axios');
+ let data = JSON.stringify({
+ "zones": [
+ {
+ "zone_id": "ZoneA",
+ "description": "Delivery Zone for Store A",
+ "store_id": "STORE_ID_123456",
+ "polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))",
+ "types": [
+ "delivery"
+ ]
+ },
+ {
+ "zone_id": "ZoneB",
+ "description": "Delivery Zone for Store B",
+ "store_id": "STORE_ID_123456",
+ "polygon": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))",
+ "types": [
+ "delivery"
+ ]
+ },
+ {
+ "zone_id": "ZoneC",
+ "description": "Delivery Zone for Store C",
+ "store_id": "STORE_ID_45678",
+ "polygon": "POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))",
+ "types": [
+ "delivery"
+ ]
+ }
+ ]
+ });
+
+ let config = {
+ method: 'post',
+ maxBodyLength: Infinity,
+ url: 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY',
+ headers: {
+ 'content-type': 'application/json'
+ },
+ data : data
+ };
+
+ axios.request(config)
+ .then((response) => {
+ console.log(JSON.stringify(response.data));
+ })
+ .catch((error) => {
+ console.log(error);
+ });
+ put:
+ summary: Update the Zones
+ operationId: updateZones
servers:
- url: https://api.woosmap.com
tags:
@@ -4265,291 +3289,86 @@ components:
- `AND` : Return assets that match both clauses.
- `OR` : Return assets that match either clauses.
-
- - `NOT` : Negates a search clause.
-
- For compound clauses, you can use parentheses to group clauses together. For example: ```(type:"type1" OR type:"type2") AND tag:"hockey"```
- You can use `NOT` operator to negates a search clause. For example: ```not type:"type1"```
- lat:
- name: lat
- description: |
- Latitude bias for the results. Should be pass with `lng`.
- schema:
- type: number
- example: 5.2
- in: query
- lng:
- name: lng
- description: |
- Longitude bias for the results. Should be pass with `lat`.
- schema:
- type: number
- example: 3.5
- in: query
- radius:
- name: radius
- description: |
- Unit in meters. Used to combine with lat/lng or encoded polyline. To bias the results within a given circular area. 3000 means to search for Assets that are at the most far from 3kms to search area (latlng or polyline).
- schema:
- type: number
- example: 3000
- in: query
- encoded_polyline:
- name: encoded_polyline
- description: |
- Find assets nearby an [encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) and inside a defined radius.
- schema:
- type: string
- example: _p~iF~ps|U_ulLnnqC_mqNvxq`@
- in: query
- stores_by_page:
- name: stores_by_page
- description: |
- If your request returns a high number of assets, the result will be paginated. If so, you can request assets by page using `page` and `stores_by_page` parameters (Default is 100, max is 300).
- schema:
- type: integer
- minimum: 1
- maximum: 300
- example: 150
- in: query
- page:
- name: page
- description: |
- Page number when accessing paginated assets feature collection
- schema:
- type: integer
- example: 2
- in: query
- zone:
- name: zone
- in: query
- schema:
- type: boolean
- example: true
- description: |
- returns the stores that are linked to a zone intersecting the provided `lat`,`lng` query parameters.
- language:
- name: language
- description: |
- The language code, using ISO 639-2 Alpha-2 country codes, indicating in which language the `localized` name property should be searched , if present, or else the default `name` property.
- schema:
- type: string
- example: en
- in: query
- limit-2:
- name: limit
- description: |
- If your request returns a high number of assets you should use the `limit` parameters to return only the firsts matching elements (Default is 5, max is 50).
- schema:
- type: integer
- minimum: 1
- maximum: 50
- example: 15
- in: query
- input:
- name: input
- description: |
- The text string on which to search, for example: "london" or "123 Cross Road".
- The Woosmap Localities API will return predictions matches based on this string and order the results based on their perceived relevance.
- To protect against illegitimate requests, only the 20 first tokens found in the first 150 characters will be used.
- schema:
- type: string
- maxLength: 150
- example: London
- required: true
- in: query
- types:
- name: types
- description: |
- Specifies the types of suggestions to return in the query. Multiple types can be combined using the pipe character (`|`) as a separator. This parameter supports a wide range of locality classifications, including:
- - Standard locality types (e.g., cities, administrative areas, postal codes)
- - Points of Interest (POI) categories
- - POI aliases
-
- These classifications enable flexible geographic data representation and querying.
- schema:
- default: locality|postal_code
- example: locality|airport|admin_level
- $ref: '#/components/schemas/LocalitiesTypesAll'
- in: query
- excluded_types:
- name: excluded_types
- description: |
- The types of suggestion to exclude. Multiple types can be passed using the pipe character (`|`) as a separator.
- schema:
- type: string
- example: suburb|quarter|neighbourhood
- in: query
- localities_components:
- name: components
- description: |
- A grouping of places to which you would like to restrict your results. Components can and should be used when applicable to filter over countries and retrieve more accurate results. Countries must be passed as an ISO 3166-1 Alpha-2 or Alpha-3 compatible country code. For example: `components=country:fr` or `components=country:fra` would restrict your results to places within France and `components=country:fr-fr` returns locations only in Metropolitan France. Multiple countries must be passed as multiple `country:XX` filters, with the pipe character (`|`) as a separator. For example: `components=country:gb|country:fr|country:be|country:sp|country:it` would restrict your results to city names or postal codes within the United Kingdom, France, Belgium, Spain and Italy.
- schema:
- type: string
- example: country:fr|country:es
- in: query
- language-2:
- name: language
- description: |
- The language code, using ISO 639-2 Alpha-2 country codes, indicating in which language the results should be returned, if possible. If language is not supplied, first `Accept-Language` of the browser will be used. If neither the provided `language` or the `Accept-Language` are known, the Localities service uses the international default language (English). No `language` is necessary for a postal_code request. According to requested language, only parts of the address components might be translated.
- schema:
- type: string
- example: en
- in: query
- location:
- name: location
- description: |
- This parameter is used to add a geographical bias to the query. The location defines the point around which to retrieve results in priority. It must be specified in the `latitude,longitude` string format.
- schema:
- type: string
- example: 5.2,-2.3
- required: false
- in: query
- radius-2:
- name: radius
- description: |
- This parameter may be used in addition to the `location` parameter to define the distance in meters within which the API will return results in priority. Results outside of the defined area may still be displayed. Default radius if this parameter is not set is 100000.
- schema:
- type: integer
- example: 200000
- in: query
- required: false
- data:
- name: data
- description: |
- Two values for this parameter: `standard` or `advanced`. By default, if the parameter is not defined, value is set as `standard`. The `advanced` value opens suggestions to worldwide postal codes in addition to postal codes for Western Europe. ***A dedicated option subject to specific billing on your license is needed to use this parameter. Please contact us if you are interested in using this parameter and you do not have subscribed the proper option yet.***
- schema:
- type: string
- enum:
- - standard
- - advanced
- example: advanced
- in: query
- extended:
- name: extended
- description: |
- If set, this parameter allows a refined search over locality names that bears the same postal code. By triggering this parameter, integrators will benefit from a search spectrum on the `locality` type that ***includes postal codes***. To avoid confusion, it is recommended not to activate this parameter along with the `postal_code` type which could lead to duplicate locations. Also, the default description returned by the API changes to `name (postal code), admin_1, admin_0`. It is only available for France, Monaco, Italy, Spain, Belgium, Switzerland and Luxembourg.
- schema:
- type: string
- enum:
- - postal_code
- example: postal_code
- in: query
- custom_description:
- name: custom_description
+
+ - `NOT` : Negates a search clause.
+
+ For compound clauses, you can use parentheses to group clauses together. For example: ```(type:"type1" OR type:"type2") AND tag:"hockey"```
+ You can use `NOT` operator to negates a search clause. For example: ```not type:"type1"```
+ lat:
+ name: lat
description: |
- This parameter allows to choose the description format for all or some of the suggestion types selected. The custom formats are described as follows (available fields depend on the returned type): `custom_description=type_A:"{field_1}, {field_2}, [...]"|type_B:"{field_1}, {field_2}, [...]"`
+ Latitude bias for the results. Should be pass with `lng`.
schema:
- type: string
- example: locality:"{name} - {administrative_area_level_0}"|postal_code:"{name} ({administrative_area_level_1})"
- required: false
+ type: number
+ example: 5.2
in: query
- public_id:
- name: public_id
+ lng:
+ name: lng
description: |
- A textual identifier that uniquely identifies a locality, returned from a [Localities Autocomplete](https://developers.woosmap.com/products/localities/autocomplete/).
+ Longitude bias for the results. Should be pass with `lat`.
schema:
- type: string
- example: cG9zdGFsX2NvZGU6Z2I6OmNDN0N0ZUF2MW9YRi9KLzlnS2cremJndktFaz0=
- required: true
+ type: number
+ example: 3.5
in: query
- fields:
- name: fields
+ radius:
+ name: radius
description: |
- If set, it will limit the content of responses to the specified fields. This parameter can be any combination of `geometry`, `address_components` or `shape` (defaults to `geometry|address_components`).
+ Unit in meters. Used to combine with lat/lng or encoded polyline. To bias the results within a given circular area. 3000 means to search for Assets that are at the most far from 3kms to search area (latlng or polyline).
schema:
- type: string
- enum:
- - geometry
- example: geometry
+ type: number
+ example: 3000
in: query
- cc_format:
- name: cc_format
+ encoded_polyline:
+ name: encoded_polyline
description: |
- To specify the format for the short [country code](https://en.wikipedia.org/wiki/ISO_3166-1) expected to be returned in the address_components field. Default is the format used to specify `components` or `alpha2` if no components are specified.
+ Find assets nearby an [encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) and inside a defined radius.
schema:
type: string
- enum:
- - alpha2
- - alpha3
- example: alpha2
+ example: _p~iF~ps|U_ulLnnqC_mqNvxq`@
in: query
- page-2:
- name: page
+ stores_by_page:
+ name: stores_by_page
description: |
- In a few cases, a postal code details may contain addresses (UK postal codes). The address list is paginated. In that case, you can navigate in the address list thanks to the `addresses_per_page` and `page` parameters. Notice: as all the addresses are now automatically returned in the response, the `page` parameter is deprecated and has been turned off on December 31, 2021.
+ If your request returns a high number of assets, the result will be paginated. If so, you can request assets by page using `page` and `stores_by_page` parameters (Default is 100, max is 300).
schema:
type: integer
- example: 1
+ minimum: 1
+ maximum: 300
+ example: 150
in: query
- deprecated: true
- addresses_per_page:
- name: addresses_per_page
+ page:
+ name: page
description: |
- In a few cases, a postal code details may contain addresses (UK postal codes). The address list is paginated. In that case, you can navigate in the address list thanks to the `addresses_per_page` and `page` parameters. Notice: as all the addresses are now automatically returned in the response, the `addresses_per_page` parameter is deprecated and has been turned off on December 31, 2021.
+ Page number when accessing paginated assets feature collection
schema:
type: integer
- example: 10
- in: query
- deprecated: true
- address:
- name: address
- description: |
- The input string to geocode. Can represent an address, a street, a locality or a postal code. The `address` parameter must be URL encoded.
- To protect against illegitimate requests, only the 20 first tokens found in the first 150 characters will be used.
- schema:
- type: string
- maxLength: 150
- example: 224%20Rue%20de%20Rivoli%2C%20Paris
- required: false
- in: query
- latlng:
- name: latlng
- description: |
- The latlng parameter is used for reverse geocoding, it's required if the `address` parameter is missing.
- schema:
- type: string
- example: 5.2,-2.3
- required: false
+ example: 2
in: query
- geocode_types:
- name: types
- description: |
- When executing a geocode request with the `address` parameter, it specifies the types of suggestions to return in the query. Multiple types can be combined using the pipe character (`|`) as a separator. This parameter supports a wide range of locality classifications, including:
- - Standard locality types (e.g., cities, administrative areas, postal codes)
- - Points of Interest (POI) categories
- - POI aliases
-
- These classifications enable flexible geographic data representation and querying.
- This parameter is ignored when used with the `latlng` parameter.
- schema:
- default: locality|postal_code|address
- example: locality|admin_level
- $ref: '#/components/schemas/LocalitiesTypesAll'
+ zone:
+ name: zone
in: query
- list_sub_buildings:
- name: list_sub_buildings
- description: |
- When latlng parameter is used for reverse geocoding, setting `list_sub_building=true` allows to retrieve all addresses at the same location for a common street number or building. Results may contain an additional key "sub_buildings" with "public_id" and "description" values for every addresses at the same location sharing the same address components.
schema:
type: boolean
example: true
- required: false
- in: query
- nearby_types:
- name: types
description: |
- The types of points of interest to return. Multiple types can be passed using the pipe character (`|`) as a separator. For example: `types=business.shop|medical.pharmacy|business.finance.bank`.
+ returns the stores that are linked to a zone intersecting the provided `lat`,`lng` query parameters.
+ language:
+ name: language
+ description: |
+ The language code, using ISO 639-2 Alpha-2 country codes, indicating in which language the `localized` name property should be searched , if present, or else the default `name` property.
schema:
- $ref: '#/components/schemas/LocalitiesTypesPoi'
- required: true
+ type: string
+ example: en
in: query
- nearby_excluded_types:
- name: excluded_types
+ limit-2:
+ name: limit
description: |
- The types of points of interest to exclude from results. Results will match the specified `types`, if any, but will not match the specified `excluded_types`. Multiple types can be passed using the pipe character (`|`) as a separator. For example: `excluded_types=business.food_and_drinks.fast_food|business.food_and_drinks.pub`.
+ If your request returns a high number of assets you should use the `limit` parameters to return only the firsts matching elements (Default is 5, max is 50).
schema:
- $ref: '#/components/schemas/LocalitiesTypesPoi'
+ type: integer
+ minimum: 1
+ maximum: 50
+ example: 15
in: query
limit-3:
name: limit
@@ -5818,1023 +4637,6 @@ components:
description: The north latitude of bounds
type: number
example: 51.5088
- LocalitiesTypes:
- title: LocalitiesTypes
- type: string
- description: |
- Common types unrelated to points of interest (POI). The `locality` type serves as an alias grouping various settlement types (see `enum` for details). This grouping enables flexible and efficient querying of related geographic data.
- enum:
- - country
- - admin_level
- - admin_level_1
- - admin_level_2
- - admin_level_3
- - postal_code
- - address
- - route
- - locality
- - city
- - town
- - village
- - hamlet
- - borough
- - suburb
- - quarter
- - neighbourhood
- LocalitiesTypesPoi:
- title: LocalitiesTypesPoi
- description: |
- Categories of points of interest (POI) supported for detailed classification in geographic data queries.
- type: string
- enum:
- - point_of_interest
- - transit.station
- - transit.station.airport
- - transit.station.rail
- - transit.station.rail.funicular
- - transit.station.rail.light_rail
- - transit.station.rail.monorail
- - transit.station.rail.subway
- - transit.station.rail.train
- - transit.station.rail.tram
- - beach
- - business
- - business.car_repair
- - business.car_rental
- - business.cinema
- - business.conference_centre
- - business.exhibition_centre
- - business.theatre
- - business.nightclub
- - business.finance
- - business.finance.bank
- - business.fuel
- - business.parking
- - business.mall
- - business.food_and_drinks
- - business.food_and_drinks.bar
- - business.food_and_drinks.biergarten
- - business.food_and_drinks.cafe
- - business.food_and_drinks.fast_food
- - business.food_and_drinks.pub
- - business.food_and_drinks.restaurant
- - business.food_and_drinks.food_court
- - business.shop
- - business.shop.mall
- - business.shop.bakery
- - business.shop.butcher
- - business.shop.library
- - business.shop.grocery
- - business.shop.sports
- - business.shop.toys
- - business.shop.clothes
- - business.shop.furniture
- - business.shop.electronics
- - business.shop.doityourself
- - business.shop.craft
- - education
- - education.school
- - education.kindergarten
- - education.university
- - education.college
- - education.library
- - hospitality
- - hospitality.hotel
- - hospitality.hostel
- - hospitality.guest_house
- - hospitality.bed_and_breakfast
- - hospitality.motel
- - medical
- - medical.hospital
- - medical.pharmacy
- - medical.clinic
- - tourism
- - tourism.attraction
- - tourism.attraction.amusement_park
- - tourism.attraction.zoo
- - tourism.attraction.aquarium
- - tourism.monument
- - tourism.monument.castle
- - tourism.museum
- - government
- - park
- - park.national
- - place_of_worship
- - police
- - post_office
- - sports
- - sports.golf
- - sports.winter
- LocalitiesTypesPoiAlias:
- title: LocalitiesTypesPoiAlias
- type: string
- description: |
- Aliases for some point_of_interest types. These aliases are deprecated and should be replaced with the corresponding types in `LocalitiesTypesPoi`. For example:
- - `airport` → `transit.station.airport`
- - `train_station` → `transit.station.rail.train`
-
- This ensures consistency and alignment with the updated schema.
- enum:
- - airport
- - train_station
- - metro_station
- - shopping
- - museum
- - zoo
- - amusement_park
- - art_gallery
- - tourist_attraction
- LocalitiesTypesAll:
- title: LocalitiesTypesAll
- type: string
- description: |
- A comprehensive string type that encompasses all supported locality classifications. This includes standard locality types (e.g., cities, regions), points of interest (POI) categories, and POI aliases for flexible geographic data representation and querying.
- anyOf:
- - $ref: '#/components/schemas/LocalitiesTypes'
- - $ref: '#/components/schemas/LocalitiesTypesPoi'
- - $ref: '#/components/schemas/LocalitiesTypesPoiAlias'
- LocalitiesAutocompleteMatchedFields:
- title: LocalitiesAutocompleteMatchedFields
- type: object
- description: Contains a set of substrings in the `description` field that match elements in the `input`. It can be used to highlight those substrings. Each substring is identified by an `offset` and a `length`.
- properties:
- description:
- description: match substrings for localities `description`
- type: array
- items:
- $ref: '#/components/schemas/MatchedSubstring'
- LocalitiesAutocompleteRelatedItem:
- title: LocalitiesAutocompleteRelatedItem
- type: object
- description: Contains a set of related elements to the locality suggestion.
- properties:
- public_id:
- type: string
- description: Public ID of a related Postal Code.
- description:
- type: string
- description: Formatted description for the related Postal Code.
- LocalitiesAutocompleteRelated:
- title: LocalitiesAutocompleteRelated
- type: object
- description: Contains a set of related elements to the locality suggestion.
- properties:
- postal_codes:
- description: Postal codes related to the locality suggestion.
- type: array
- items:
- $ref: '#/components/schemas/LocalitiesAutocompleteRelatedItem'
- LocalitiesAutocompleteResponse:
- title: LocalitiesAutocompleteResponse
- type: object
- description: Attributes describing a locality. Not all attributes will be available for all locality types.
- properties:
- public_id:
- description: Contains a unique ID for each suggestion. Please use this ID if you need to give us feedback on results. This ID is also required to perform a Localities Details Request.
- type: string
- example: MkvnYy6K6oVGqeqfWJGO/6eCgqo=
- types:
- description: An array containing the types of the result
- type: array
- items:
- $ref: '#/components/schemas/LocalitiesTypesAll'
- type:
- deprecated: true
- description: This field might be removed in the future, please use the `types` field which is more exhaustive.
- type: string
- description:
- description: Concatenation of `name`, `admin_1`, `admin_0` to be used as suggestion in drop-down list if needed. The description can vary depending on the type requested.
- type: string
- example: 20121, Milano, Italy
- matched_substrings:
- $ref: '#/components/schemas/LocalitiesAutocompleteMatchedFields'
- related:
- $ref: '#/components/schemas/LocalitiesAutocompleteRelated'
- has_addresses:
- description: |
- On the specific territory of United Kingdom, Localities autocomplete request can return the additional attribute `has_addresses` for a postal code, which indicates if a postal code bears addresses. When `has_addresses` is `true`, it is possible to display a list of the available addresses by requesting `details` with the Localities `public_id`. To get the details of an address you will need to request again `/details` endpoint passing in the dedicated address `public_id`.
- type: boolean
- example: true
- example:
- public_id: Ch6qA8cLmvyvEEoFy6nYeFcEdNU=
- description: London, City of London, United Kingdom
- type: locality
- matched_substrings:
- description:
- - offset: 0
- length: 6
- - offset: 16
- length: 6
- LocalitiesAutocompleteCollectionResponse:
- title: LocalitiesAutocompleteCollectionResponse
- type: object
- description: Localities Collection Response containing Localities
- properties:
- localities:
- type: array
- items:
- $ref: '#/components/schemas/LocalitiesAutocompleteResponse'
- example:
- localities:
- - public_id: Ch6qA8cLmvyvEEoFy6nYeFcEdNU=
- type: locality
- types:
- - locality
- - city
- description: London, City of London, United Kingdom
- matched_substrings:
- description:
- - offset: 0
- length: 4
- - public_id: m/T2C4YI2LgszkKXrELBC+9dfC8=
- type: locality
- types:
- - locality
- - city
- description: Derry/Londonderry, Derry City and Strabane, United Kingdom
- matched_substrings:
- description:
- - offset: 6
- length: 4
- - public_id: J6eISGMjjvQwPkao8rsByB3aVwM=
- type: locality
- types:
- - locality
- - village
- description: London Colney, Hertfordshire, United Kingdom
- matched_substrings:
- description:
- - offset: 0
- length: 4
- - public_id: 52MnrbHVWH21CLWH8VY/YWKhqeM=
- type: locality
- types:
- - locality
- - village
- description: London Apprentice, Cornwall, United Kingdom
- matched_substrings:
- description:
- - offset: 0
- length: 4
- - public_id: S/5AkUmMBhX35qVI2jR38+dALwk=
- type: locality
- types:
- - locality
- - city
- description: City of London, United Kingdom
- matched_substrings:
- description:
- - offset: 8
- length: 4
- FormattedAddress:
- title: FormattedAddress
- description: Contains the readable text description of the result.
- type: string
- example: London, England, United Kingdom
- Position:
- title: Position
- description: an array containing longitude, latitude, in that order.
- type: array
- items:
- type: number
- minItems: 2
- maxItems: 2
- example:
- - 2.06984
- - 48.77919
- GeoJsonCoords:
- title: GeoJsonCoords
- description: an array containing Positions.
- type: array
- items:
- $ref: '#/components/schemas/Position'
- example:
- - - 2.06984
- - 48.77919
- - - 2.07984
- - 48.77919
- - - 2.07984
- - 48.78919
- - - 2.06984
- - 48.78919
- - - 2.06984
- - 48.77919
- GeoJsonGeometry:
- title: GeoJsonGeometry
- type: object
- description: |
- A GeoJSon Geometry representing the shape of the area, as specified in [RFC7946](https://datatracker.ietf.org/doc/html/rfc7946).
- To display on the map, simply wrap this object in a feature:
- ```json
- {
- "type": "Feature",
- "geometry": this_geojson_geometry
- }
- ```
- properties:
- type:
- type: string
- enum:
- - Polygon
- - MultiPoligon
- description: the geometry type
- coordinates:
- type: array
- items:
- $ref: '#/components/schemas/GeoJsonCoords'
- example:
- type: Polygon
- coordinates:
- - - - 2.06984
- - 48.77919
- - - 2.07984
- - 48.77919
- - - 2.07984
- - 48.78919
- - - 2.06984
- - 48.78919
- - - 2.06984
- - 48.77919
- AddressComponents:
- title: AddressComponents
- type: array
- description: An array containing Address Components with additional information
- items:
- type: object
- description: The address component object
- properties:
- long_name:
- oneOf:
- - type: string
- - type: array
- items:
- type: string
- description: The full text description or name of the address component, or a list of names (ie. list of postal codes).
- example: United Kingdom
- short_name:
- oneOf:
- - type: string
- - type: array
- items:
- type: string
- description: An abbreviated textual name for the address component, if available. For example, an address component for the state of United Kingdom may have a `long_name` of `United Kingdom` and a `short_name` of `UK` using the 2-letter postal abbreviation.
- example: UK
- types:
- description: An array indicating the type of the address component.
- type: array
- items:
- type: string
- description: address component type
- example:
- - country
- - administrative_area_level_0
- example:
- types:
- - country
- long_name: United Kingdom
- short_name: GBR
- example:
- - types:
- - country
- long_name: United Kingdom
- short_name: GBR
- - long_name: London
- short_name: London
- types:
- - locality
- AdministrativeAreaLabel:
- title: AdministrativeAreaLabel
- description: Only available for `admin_level` suggestions, this contains the local english name of the administration level ("department" for France or "federal_state" for Germany).
- type: string
- example: district
- LocalitiesStatus:
- title: LocalitiesStatus
- type: string
- description: This optional field is only available for UK addresses referenced as not yet built by Royal Mail.
- enum:
- - not_yet_built
- LocalitiesAddressSummary:
- title: LocalitiesAddressSummary
- type: object
- description: A short description of an address
- required:
- - public_id
- - description
- example:
- public_id: Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9faitia1pNNURnOWYvQmRjMUdweXl5SjdLZUZnPQ==
- description: Flat 1, Radway House, Alfred Road, London, W2 5ER
- properties:
- public_id:
- type: string
- description: The public_id of the address can be used to gather details on that specific address
- example: Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9faitia1pNNURnOWYvQmRjMUdweXl5SjdLZUZnPQ==
- description:
- type: string
- description: A human readable description of the address
- example: Flat 1, Radway House, Alfred Road, London, W2 5ER
- LocalitiesDetailsResponse:
- title: LocalitiesDetailsResponse
- type: object
- description: Attributes describing a locality. Not all attributes are available for all locality types.
- properties:
- result:
- description: The Root Node for Localities Details
- type: object
- required:
- - public_id
- - formatted_address
- - types
- - geometry
- - address_components
- properties:
- public_id:
- description: Contains a unique ID for each suggestion. Please use this ID to give feedback on results.
- type: string
- example: MkvnYy6K6oVGqeqfWJGO/6eCgqo=
- formatted_address:
- $ref: '#/components/schemas/FormattedAddress'
- types:
- description: Available localities types.
- type: array
- items:
- $ref: '#/components/schemas/LocalitiesTypesAll'
- geometry:
- description: The location of the PostalCode, in latitude and longitude, eventually associated with a Viewport and a shape.
- type: object
- required:
- - location
- properties:
- location:
- $ref: '#/components/schemas/LatLngLiteral'
- viewport:
- $ref: '#/components/schemas/Bounds'
- shape:
- $ref: '#/components/schemas/GeoJsonGeometry'
- accuracy:
- type: string
- description: This accuracy represents the type of address returned - `DISTRICT` and `POSTAL_CODE` are for UK only.
- enum:
- - ROOFTOP
- - ROUTE
- - GEOMETRIC_CENTER
- - DISTRICT
- - POSTAL_CODE
- - RANGE_INTERPOLATED
- - APPROXIMATE
- example:
- location:
- lat: 51.49984
- lng: -0.124663
- address_components:
- $ref: '#/components/schemas/AddressComponents'
- name:
- description: The postal code name if result is a postal code.
- type: string
- example: SW1A 0AA
- administrative_area_label:
- $ref: '#/components/schemas/AdministrativeAreaLabel'
- status:
- $ref: '#/components/schemas/LocalitiesStatus'
- addresses:
- description: For the UK only. When a postal code is returned, this field contains a list of addresses associated with this postal code.
- type: object
- properties:
- pagination:
- type: object
- deprecated: true
- description: The pagination part of the response is deprecated as all the addresses are now automatically returned in the response. It will be turned off at some point. From now on, the pagination will systematically return `page=1`, `page_count=1`, `addresses_per_page=total addresses count` and `address_count=total addresses count`.
- properties:
- page:
- type: integer
- description: the request page
- deprecated: true
- page_count:
- type: integer
- description: the number of available pages
- deprecated: true
- addresses_per_page:
- type: integer
- description: the number of available addresses per page
- deprecated: true
- address_count:
- type: integer
- description: the number of available addresses
- deprecated: true
- list:
- type: array
- description: List of addresses
- items:
- $ref: '#/components/schemas/LocalitiesAddressSummary'
- example:
- result:
- public_id: cG9zdGFsX2NvZGU6Z2I6OmNDN0N0ZUF2MW9YRi9KLzlnS2cremJndktFaz0=
- types:
- - postal_code
- formatted_address: SW1A 0AA, City of London
- name: SW1A 0AA
- geometry:
- location:
- lat: 51.499842
- lng: -0.124638
- accuracy: GEOMETRIC_CENTER
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United Kingdom
- short_name: GB
- - types:
- - state
- - division_level_1
- long_name: England
- short_name: England
- - types:
- - administrative_area_level_1
- - county
- - division_level_2
- long_name: City of London
- short_name: City of London
- - types:
- - district
- - division_level_3
- long_name: Westminster
- short_name: Westminster
- - types:
- - postal_codes
- long_name: SW1A 0AA
- short_name: SW1A 0AA
- addresses:
- pagination:
- page: 1
- page_count: 1
- addresses_per_page: 1
- address_count: 1
- list:
- - public_id: TVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPV9fTVZaV0JmR1pRbkFRbjlKdEU5Q0paamdlQjRRPQ==
- description: House Of Commons, Houses Of Parliament London, SW1A 0AA
- LocalitiesAddressGeometry:
- title: LocalitiesAddressGeometry
- type: object
- description: The location of the result, in latitude and longitude. Accuracy is also provided.
- properties:
- location_type:
- description: |
- Specifies additional data about the geocoded location. The following values are currently supported:
- - `ROOFTOP` result is a precise geocode for which we have location information accurate down to street address precision.
- - `RANGE_INTERPOLATED` result reflects an approximation (usually on a road) interpolated between two precise points (such as intersections). Interpolated results are generally returned when rooftop geocodes are unavailable for a street address.
- - `GEOMETRIC_CENTER` result is the geometric center of a result such as a polyline (for example, a street) or polygon (city, region, …).
- - `APPROXIMATE` result is approximate (usually when no other above value applies)
- - `POSTAL_CODE` Address has inherited from the location of the postal code it is part of (for NYB addresses)
- - `DISTRICT` Address has inherited from the location of the district it is part of (for NYB addresses)
- type: string
- enum:
- - ROOFTOP
- - RANGE_INTERPOLATED
- - GEOMETRIC_CENTER
- - APPROXIMATE
- - POSTAL_CODE
- - DISTRICT
- location:
- $ref: '#/components/schemas/LatLngLiteral'
- viewport:
- $ref: '#/components/schemas/Bounds'
- shape:
- $ref: '#/components/schemas/GeoJsonGeometry'
- example:
- location:
- lat: 48.829405
- lng: 2.367944
- location_type: GEOMETRIC_CENTER
- LocalitiesScoresPerComponents:
- title: LocalitiesScoresPerComponents
- type: object
- properties:
- street_name:
- description: Street score
- type: number
- postal_code:
- description: Postal code score
- type: number
- locality:
- description: Postal code score
- type: number
- example:
- scores_per_components:
- street_name: 0.6153846153846154
- postal_code: 0.8
- locality: 1
- LocalitiesGeocodeResponse:
- title: LocalitiesGeocodeResponse
- type: object
- description: Attributes describing a locality. Not all attributes will be available for all locality types.
- properties:
- formatted_address:
- $ref: '#/components/schemas/FormattedAddress'
- types:
- description: An array containing the types of the result
- type: array
- items:
- $ref: '#/components/schemas/LocalitiesTypesAll'
- administrative_area_label:
- $ref: '#/components/schemas/AdministrativeAreaLabel'
- public_id:
- description: Contains a unique ID for each suggestion. Please use this ID to give feedback on results.
- type: string
- example: MkvnYy6K6oVGqeqfWJGO/6eCgqo=
- geometry:
- $ref: '#/components/schemas/LocalitiesAddressGeometry'
- status:
- $ref: '#/components/schemas/LocalitiesStatus'
- address_components:
- $ref: '#/components/schemas/AddressComponents'
- distance:
- description: When reverse geocoding, this field represents the distance (in meter) to the requested latlng
- type: number
- example: 5.234
- sub_buildings:
- description: When reverse geocoding with `list_sub_buildings=true`, this field will contain a list of precise addresses that can be found at that location, i.e. all flats within a building.
- type: array
- items:
- $ref: '#/components/schemas/LocalitiesAddressSummary'
- scores_per_components:
- description: For each component (street_name, postal_code, and locality), it indicates the degree of correspondence with the original query. This value ranges from 0 to 1, with 0 indicating no match with the original query, and enables you to assess the quality of the Geocode's result.
- $ref: '#/components/schemas/LocalitiesScoresPerComponents'
- LocalitiesGeocodeCollectionResponse:
- title: LocalitiesGeocodeCollectionResponse
- type: object
- description: Localities Geocode Collection Response. Contains one or more detailed Localities or Addresses in FR or in the UK, with coordinates (default to one result for reverse geocoding)
- properties:
- results:
- type: array
- items:
- $ref: '#/components/schemas/LocalitiesGeocodeResponse'
- example:
- results:
- - public_id: 0+FTYd/1MsiBSxLAKq+/Fiyy+uM=
- types:
- - address
- - route
- formatted_address: Place Jeanne D'Arc, 75013, Paris
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: France
- short_name: FR
- - types:
- - state
- - division_level_1
- long_name: Île-de-France
- short_name: Île-de-France
- - types:
- - administrative_area_level_1
- - county
- - division_level_2
- long_name: Paris
- short_name: Paris
- - types:
- - locality
- long_name: Paris
- short_name: Paris
- - types:
- - postal_codes
- long_name: '75013'
- short_name: '75013'
- - types:
- - route
- long_name: Place Jeanne D'Arc
- short_name: Place Jeanne D'Arc
- geometry:
- location:
- lat: 48.829405
- lng: 2.367944
- location_type: GEOMETRIC_CENTER
- scores_per_components:
- street_name: 1
- LocalitiesNearbyResponse:
- title: LocalitiesNearbyResponse
- type: object
- description: Attributes describing a point of interest.
- properties:
- types:
- description: An array containing the types of the result.
- type: array
- example:
- - point_of_interest
- - transit.station.rail.train
- - train_station
- items:
- $ref: '#/components/schemas/LocalitiesTypesPoi'
- name:
- description: The name of the result.
- type: string
- public_id:
- description: Contains a unique ID for each result. Please use this ID to give feedback on results.
- type: string
- example: NOAeiQADqqisOuN3NM7oXlhkROI=
- geometry:
- description: The location of the result, in latitude and longitude, eventually associated with a Viewport.
- type: object
- properties:
- location:
- $ref: '#/components/schemas/LatLngLiteral'
- viewport:
- $ref: '#/components/schemas/Bounds'
- example:
- location:
- lat: 51.4998415
- lng: -0.1246375
- address_components:
- $ref: '#/components/schemas/AddressComponents'
- categories:
- description: An array containing the categories of the result. This information is now available in the `types` field and will be removed.
- type: array
- deprecated: true
- items:
- $ref: '#/components/schemas/LocalitiesTypesPoi'
- formatted_address:
- $ref: '#/components/schemas/FormattedAddress'
- LocalitiesNearbyCollectionResponse:
- title: LocalitiesNearbyCollectionResponse
- type: object
- description: Collection of nearby points of interest.
- properties:
- results:
- description: The array of nearby points of interest.
- type: array
- items:
- $ref: '#/components/schemas/LocalitiesNearbyResponse'
- pagination:
- description: Helps to navigate through paginated results.
- type: object
- properties:
- next_page:
- description: If more results are available, this will contain the value to pass to the `page` parameter to get the next page
- type:
- - integer
- - 'null'
- previous_page:
- description: If previous results are available, this will contain the value to pass to the `page` parameter to get the previous page
- type:
- - integer
- - 'null'
- example:
- results:
- - public_id: cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6ZTc2ZDA1YzBiM2M0M2NmNmVkNTJjNGQyZDFiZDE3Nzc0OTZkNjlmOA==
- types:
- - point_of_interest
- - business.food_and_drinks.fast_food
- categories:
- - business.food_and_drinks.fast_food
- name: Pret A Manger
- formatted_address: Broadway, New York
- geometry:
- location:
- lat: 40.715905992166256
- lng: -74.00508673226767
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United States
- short_name: US
- - types:
- - locality
- long_name: New York
- short_name: New York
- - types:
- - route
- long_name: Broadway
- short_name: Broadway
- - public_id: cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6MzBlMGYxMzVhNGUzZDQ4MzRiMmNlNDMzMWJiYjZkOTY0MWJhN2E0Zg==
- types:
- - point_of_interest
- - business.food_and_drinks.fast_food
- categories:
- - business.food_and_drinks.fast_food
- name: Dunkin'
- formatted_address: Broadway, New York
- geometry:
- location:
- lat: 40.71602115951586
- lng: -74.00494482664695
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United States
- short_name: US
- - types:
- - locality
- long_name: New York
- short_name: New York
- - types:
- - route
- long_name: Broadway
- short_name: Broadway
- - public_id: cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmJlMWNkMTE2ZDQwM2E0Y2YwNGQ5NWQ2OTlmZWRmM2FhZTExNGU3ZWY=
- types:
- - point_of_interest
- - business.food_and_drinks.restaurant
- categories:
- - business.food_and_drinks.restaurant
- name: Chambers
- formatted_address: Chambers Street, New York
- geometry:
- location:
- lat: 40.71461844801976
- lng: -74.00754036678366
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United States
- short_name: US
- - types:
- - locality
- long_name: New York
- short_name: New York
- - types:
- - route
- long_name: Chambers Street
- short_name: Chambers Street
- - public_id: cG9pOnVzOmJ1c2luZXNzLnNob3AuZ3JvY2VyeTo1YTczMjYxOTQyYjVlZmUwOGEzZjQ1NGZmMTMwMmJjNjA4ODE3NmRk
- types:
- - point_of_interest
- - business.shop.grocery
- categories:
- - business.shop.grocery
- name: City Hall Oasis
- geometry:
- location:
- lat: 40.71283012706819
- lng: -74.00727837935057
- viewport:
- northeast:
- lat: 40.71286059528623
- lng: -74.00724213866874
- southwest:
- lat: 40.71279957503111
- lng: -74.00731464213119
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United States
- short_name: US
- - public_id: cG9pOnVzOmJ1c2luZXNzLmZpbmFuY2UuYmFuazpiOGY5MDE4Nzc2ZDZjNmEwZTljOGM4YWM0OTAxZWZlNzNmODZkM2M3
- types:
- - point_of_interest
- - business.finance.bank
- categories:
- - business.finance.bank
- name: Citibank
- formatted_address: Broadway, New York
- geometry:
- location:
- lat: 40.7130414767567
- lng: -74.0074818610995
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United States
- short_name: US
- - types:
- - locality
- long_name: New York
- short_name: New York
- - types:
- - route
- long_name: Broadway
- short_name: Broadway
- - public_id: cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQzMTMzZTJkODdiOGJjMGE3ZjI2YTdiMWVjYTZlZmI1MjQyYWE3MTE=
- types:
- - point_of_interest
- - business.food_and_drinks.restaurant
- categories:
- - business.food_and_drinks.restaurant
- name: Saffron
- geometry:
- location:
- lat: 40.71467049963849
- lng: -74.00767187884445
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United States
- short_name: US
- - public_id: cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQ1NjMyN2RiM2EyNWJlYmIwNjJjZjNlYWYwMDE3ZDIyYzEyNWNlMjY=
- types:
- - point_of_interest
- - business.food_and_drinks.restaurant
- categories:
- - business.food_and_drinks.restaurant
- name: Gran Morsi
- geometry:
- location:
- lat: 40.71432885326513
- lng: -74.00778746528921
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United States
- short_name: US
- - public_id: cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5iYXI6MDE5ZGUzNTdiZDkyNzAyZDM4ZDUyOWQ0YmJiZjBmODQ5YWEzZmY1NA==
- types:
- - point_of_interest
- - business.food_and_drinks.bar
- categories:
- - business.food_and_drinks.bar
- name: Bon Courage
- formatted_address: Reade Street, New York
- geometry:
- location:
- lat: 40.71541472882126
- lng: -74.00719193106873
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United States
- short_name: US
- - types:
- - locality
- long_name: New York
- short_name: New York
- - types:
- - route
- long_name: Reade Street
- short_name: Reade Street
- - public_id: cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6OGIyNDY5MDM4M2JhYzE1NmY4OGRiMGQzYmIyYzNjMTVmOTk0NDQwZQ==
- types:
- - point_of_interest
- - business.food_and_drinks.fast_food
- categories:
- - business.food_and_drinks.fast_food
- name: Burger King
- formatted_address: Broadway, New York
- geometry:
- location:
- lat: 40.71619516782573
- lng: -74.00480635760651
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United States
- short_name: US
- - types:
- - locality
- long_name: New York
- short_name: New York
- - types:
- - route
- long_name: Broadway
- short_name: Broadway
- - public_id: cG9pOnVzOmJ1c2luZXNzLnRoZWF0cmU6MTU1Yjk5YmEwY2FiYzIzZjYxYWYyYTViYzI0ZDViYTVlNmVmZTAwNA==
- types:
- - point_of_interest
- - business.theatre
- categories:
- - business.theatre
- name: The Flea
- formatted_address: Thomas Street, New York
- geometry:
- location:
- lat: 40.71609349534023
- lng: -74.00589281989586
- address_components:
- - types:
- - country
- - administrative_area_level_0
- - division_level_0
- long_name: United States
- short_name: US
- - types:
- - locality
- long_name: New York
- short_name: New York
- - types:
- - route
- long_name: Thomas Street
- short_name: Thomas Street
- pagination:
- previous_page: 2
- next_page: 4
Zone:
title: Zone
type: object
@@ -6954,12 +4756,12 @@ components:
type: string
securitySchemes:
PrivateApiKeyAuth:
- description: A Private key generated specifically to authenticate API requests on server side. Required for Data management API. See how to [register a Private API Key](https://developers.woosmap.com/support/api-keys/#registering-a-woosmap-private-api-key).
+ description: A Private key generated specifically to authenticate API requests on server side. Required for Data management API. See how to [register a Private API Key](https://developers.woosmap.com/api-reference/authentication/#registering-a-woosmap-private-api-key).
type: apiKey
in: query
name: private_key
PublicApiKeyAuth:
- description: A Public key generated specifically to authenticate API requests on the front side. See how to [register a Public API Key](https://developers.woosmap.com/support/api-keys/#registering-a-woosmap-public-api-key).
+ description: A Public key generated specifically to authenticate API requests on the front side. See how to [register a Public API Key](https://developers.woosmap.com/api-reference/authentication/#registering-a-woosmap-public-api-key).
type: apiKey
in: query
name: key
@@ -6969,7 +4771,7 @@ components:
in: header
name: Referer
PrivateApiKeyHeaderAuth:
- description: A Private key to authenticate API requests through the Header instead of Query parameter. Use either PrivateApiKeyHeaderAuth or PrivateApiKeyAuth. See how to [register a Private API Key](https://developers.woosmap.com/support/api-keys/#registering-a-woosmap-private-api-key).
+ description: A Private key to authenticate API requests through the Header instead of Query parameter. Use either PrivateApiKeyHeaderAuth or PrivateApiKeyAuth. See how to [register a Private API Key](https://developers.woosmap.com/api-reference/authentication/#registering-a-woosmap-private-api-key).
type: apiKey
in: header
name: X-Api-Key
diff --git a/dist/woosmap-postman.json b/dist/woosmap-postman.json
index d61ada6e..29e6b5e4 100755
--- a/dist/woosmap-postman.json
+++ b/dist/woosmap-postman.json
@@ -2,7 +2,7 @@
"item": [
{
"name": "Search",
- "description": "Store Search lets you query the Assets which are returned as a [GeoJson](https://geojson.org/). Request is done over HTTPS using GET. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/support/api-keys/). If your request returns a high number of assets, the result will be paginated. If so, you can request assets by page using `page` and `stores_by_page` parameters (Default is **100**, max is **300**).\n",
+ "description": "Store Search lets you query the Assets which are returned as a [GeoJson](https://geojson.org/). Request is done over HTTPS using GET. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/api-reference/authentication/). If your request returns a high number of assets, the result will be paginated. If so, you can request assets by page using `page` and `stores_by_page` parameters (Default is **100**, max is **300**).\n",
"item": []
},
{
@@ -10,7 +10,7 @@
"description": "Manage the store and asset data within your Woosmap project. It provides full CRUD (Create, Read, Update, Delete) operations through standard HTTP methods, supporting batch imports up to 15MB, along with an atomic replace operation for swapping entire datasets without downtime.\nThis endpoint handles the complete lifecycle of your location data. You can add new assets in batch using POST, update existing assets with PUT, retrieve assets as GeoJSON with GET, remove individual or all assets with DELETE, and atomically replace your entire dataset using the replace operation. All write operations accept JSON payloads containing an array of store objects, each with a unique storeId, name, and geographic coordinates.\n\n``` POST|GET|PUT|DELETE https://api.woosmap.com/stores ```\n",
"item": [
{
- "id": "b9964e42-aec7-4fec-affa-2468cd5bd79e",
+ "id": "25e5bbb9-a875-444b-9ac4-b8e516508278",
"name": "Create your Assets",
"request": {
"name": "Create your Assets",
@@ -44,7 +44,7 @@
"method": "POST",
"body": {
"mode": "raw",
- "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": 9662.496641066637\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": null,\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n }\n ]\n}",
+ "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": null,\n \"localizedNames\": {},\n \"openingHours\": null\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": null,\n \"localizedNames\": {},\n \"openingHours\": null\n }\n ]\n}",
"options": {
"raw": {
"headerFamily": "json",
@@ -72,7 +72,7 @@
},
"response": [
{
- "id": "d991e08b-ae37-417a-8faa-e3c502033302",
+ "id": "033472a4-7786-4760-b7f9-b05f69f0c8a5",
"name": "Assets successfully created",
"originalRequest": {
"url": {
@@ -110,7 +110,7 @@
"method": "POST",
"body": {
"mode": "raw",
- "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": 9662.496641066637\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": null,\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"