diff --git a/BUILD.bazel b/BUILD.bazel
index 3cffa1a0..d9c2e351 100644
--- a/BUILD.bazel
+++ b/BUILD.bazel
@@ -180,6 +180,7 @@ bundle_external_specs(
"indoor",
"transit",
"datasets",
+ "distance",
],
)
diff --git a/WORKSPACE b/WORKSPACE
index 771d8468..c1e719d2 100644
--- a/WORKSPACE
+++ b/WORKSPACE
@@ -80,4 +80,5 @@ rules_pkg_dependencies()
"indoor",
"transit",
"datasets",
+ "distance",
]]
diff --git a/dist/documentation/parameters/woosmap_http_parameters_distancedistancematrix.html b/dist/documentation/parameters/woosmap_http_parameters_distancedistancematrix.html
deleted file mode 100644
index edce3f49..00000000
--- a/dist/documentation/parameters/woosmap_http_parameters_distancedistancematrix.html
+++ /dev/null
@@ -1,128 +0,0 @@
-
-
-
Required parameters
-
- -
-
destinations
-
- One or more locations to use as the finishing point for calculating travel
- distance. The options for the destinations parameter are the same as for
- the origins parameter, described above. In order to reduce URL size,
- encoded polylines
- are also supported using enc:encoded-polyline:
-
-
- -
-
origins
-
- The starting point for calculating travel distance. You can supply one or
- more locations separated by the pipe character (|), in the form of
- latitude/longitude coordinates. They are used unchanged to calculate
- distance. Ensure that no space exists between the latitude and longitude
- values. In order to reduce URL size,
- encoded polylines
- are also supported using enc:encoded-polyline:
-
-
-
-Optional parameters
-
- -
-
avoid
-
- The 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. To
- add multiple polygons, separate them with the | character.
-
-
- -
-
departure_time
-
- By using this parameter, Distance will calculate the duration with traffic
- Specifies the date/time at which to base the calculations on for traffic
- purposes. Valid values are a timestamp (e.g. 1600799173 for
- the date:22/09/2020 20:26:13) or now. Use either
- arrival_time or departure_time, not both.
-
-
- -
-
elements
-
- Specifies element values that will be part of the API response (distance
- and/or duration). if not specified default is distance
-
-
- -
-
language
-
- The language code, indicating in which language the results should be
- returned, if possible. If language is not supplied, the Distance API
- service will use the navigator language or “en”.
-
-
- -
-
method
-
- Specifies the method to compute the route between the start point and the
- end point:
-
-
- -
-
time: fastest route (default) - distance:
- shortest route
-
-
-
- -
-
mode
- Specifies the mode of transport to use when calculating distance
-
- -
-
units
-
- Specifies the unit system parameter to use when expressing distance as
- text. Two different units supported:
-
-
- -
-
metric (default) returns distances in kilometers and meters
-
- imperial returns distances in miles and feet
-
-
-
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/parameters/woosmap_http_parameters_distancedistancematrix.md b/dist/documentation/parameters/woosmap_http_parameters_distancedistancematrix.md
deleted file mode 100644
index 5be89121..00000000
--- a/dist/documentation/parameters/woosmap_http_parameters_distancedistancematrix.md
+++ /dev/null
@@ -1,55 +0,0 @@
-
-
-Required parameters
-
-- destinations
-
- One or more locations to use as the finishing point for calculating travel distance. The options for the destinations parameter are the same as for the origins parameter, described above. In order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc:encoded-polyline:`
-
-- origins
-
- The starting point for calculating travel distance. You can supply one or more locations separated by the pipe character (|), in the form of latitude/longitude coordinates. They are used unchanged to calculate distance. Ensure that no space exists between the latitude and longitude values. In order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc:encoded-polyline:`
-
-Optional parameters
-
-- avoid
-
- The 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. To add multiple polygons, separate them with the `|` character.
-
-- departure_time
-
- By using this parameter, Distance will calculate the duration with traffic Specifies the date/time at which to base the calculations on for traffic purposes. Valid values are a timestamp (e.g. `1600799173` for the date:`22/09/2020 20:26:13`) or `now`.
- Use either `arrival_time` or `departure_time`, not both.
-
-- elements
-
- Specifies element values that will be part of the API response (distance and/or duration). if not specified default is `distance`
-
-- language
-
- The language code, indicating in which language the results should be returned, if possible. If language is not supplied, the Distance API service will use the navigator language or “en”.
-
-- method
-
- Specifies the method to compute the route between the start point and the end point:
-
- - `time`: fastest route (default) - `distance`: shortest route
-
-- mode
-
- Specifies the mode of transport to use when calculating distance
-
-- units
-
- Specifies the unit system parameter to use when expressing distance as text. Two different units supported:
-
- - `metric` (default) returns distances in kilometers and meters
- - `imperial` returns distances in miles and feet
-
-
-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_distanceisochrone.html b/dist/documentation/parameters/woosmap_http_parameters_distanceisochrone.html
deleted file mode 100644
index 602fc090..00000000
--- a/dist/documentation/parameters/woosmap_http_parameters_distanceisochrone.html
+++ /dev/null
@@ -1,99 +0,0 @@
-
-
-Required parameters
-
- -
-
origin
-
- 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.
-
-
- -
-
value
-
- The value to use for isochrone contour. You can specify time in minutes or
- distance in kilometers (cf. method parameter). The maximum value that can
- be specified is 120 (120 minutes : 2 hours or 120 km).
-
-
-
-Optional parameters
-
- -
-
avoid
-
- The 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. To
- add multiple polygons, separate them with the | character.
-
-
- -
-
language
-
- The language code, indicating in which language the results should be
- returned, if possible. If language is not supplied, the Distance API
- service will use the navigator language or “en”.
-
-
- -
-
method
-
- Specifies the method to compute the route between the start point and the
- end point:
-
-
- -
-
time: fastest route (default) - distance:
- shortest route
-
-
-
- -
-
mode
- Specifies the mode of transport to use when calculating distance
-
- -
-
units
-
- Specifies the unit system parameter to use when expressing distance as
- text. Two different units supported:
-
-
- -
-
metric (default) returns distances in kilometers and meters
-
- imperial returns distances in miles and feet
-
-
-
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/parameters/woosmap_http_parameters_distanceisochrone.md b/dist/documentation/parameters/woosmap_http_parameters_distanceisochrone.md
deleted file mode 100644
index 76d5871c..00000000
--- a/dist/documentation/parameters/woosmap_http_parameters_distanceisochrone.md
+++ /dev/null
@@ -1,46 +0,0 @@
-
-
-Required parameters
-
-- origin
-
- 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.
-
-- value
-
- The value to use for isochrone contour. You can specify time in minutes or distance in kilometers (cf. method parameter). The maximum value that can be specified is 120 (120 minutes : 2 hours or 120 km).
-
-Optional parameters
-
-- avoid
-
- The 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. To add multiple polygons, separate them with the `|` character.
-
-- language
-
- The language code, indicating in which language the results should be returned, if possible. If language is not supplied, the Distance API service will use the navigator language or “en”.
-
-- method
-
- Specifies the method to compute the route between the start point and the end point:
-
- - `time`: fastest route (default) - `distance`: shortest route
-
-- mode
-
- Specifies the mode of transport to use when calculating distance
-
-- units
-
- Specifies the unit system parameter to use when expressing distance as text. Two different units supported:
-
- - `metric` (default) returns distances in kilometers and meters
- - `imperial` returns distances in miles and feet
-
-
-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_distanceroute.html b/dist/documentation/parameters/woosmap_http_parameters_distanceroute.html
deleted file mode 100644
index 61589954..00000000
--- a/dist/documentation/parameters/woosmap_http_parameters_distanceroute.html
+++ /dev/null
@@ -1,150 +0,0 @@
-
-
-Required parameters
-
- -
-
destination
-
- The ending point for the route. It should be supplied in the form of
- latitude/longitude coordinates. Ensure that no space exists between the
- latitude and longitude values.
-
-
- -
-
origin
-
- 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.
-
-
-
-Optional parameters
-
- -
-
alternatives
-
- Specifies if alternative routes should be returned. default is
- false. Depending on the calculated route, alternatives may
- not be provided. alternatives and waypoints can
- not be used at the same time.
-
-
- -
-
arrival_time
-
- By using this parameter, Distance will calculate the duration with traffic
- Specifies the arrival date/time as a timestamp to base the calculation on
- (e.g. 1600799173 for the date:22/09/2020 20:26:13). Use either arrival_time or departure_time,
- not both.
-
-
- -
-
avoid
-
- The 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. To
- add multiple polygons, separate them with the | character.
-
-
- -
-
departure_time
-
- By using this parameter, Distance will calculate the duration with traffic
- Specifies the date/time at which to base the calculations on for traffic
- purposes. Valid values are a timestamp (e.g. 1600799173 for
- the date:22/09/2020 20:26:13) or now. Use either
- arrival_time or departure_time, not both.
-
-
- -
-
details
-
- Specifies if maneuver instructions should be returned (roadbook). Valid
- values are none and full (default is
- none)
-
-
- -
-
language
-
- The language code, indicating in which language the results should be
- returned, if possible. If language is not supplied, the Distance API
- service will use the navigator language or “en”.
-
-
- -
-
method
-
- Specifies the method to compute the route between the start point and the
- end point:
-
-
- -
-
time: fastest route (default) - distance:
- shortest route
-
-
-
- -
-
mode
- Specifies the mode of transport to use when calculating distance
-
- -
-
units
-
- Specifies the unit system parameter to use when expressing distance as
- text. Two different units supported:
-
-
- -
-
metric (default) returns distances in kilometers and meters
-
- imperial returns distances in miles and feet
-
-
- -
-
waypoints
-
- A list of points by which the route should pass (route response is divided
- into legs, one leg corresponding to a route between two waypoints).
- Waypoints should be separated by | character. Optionally, you may pass
- optimize:true as the first argument within the waypoints
- parameter. This way the provided route is optimized by rearranging the
- waypoints in a more efficient order based on distance or time according to
- the method parameter. The route start point and end point order is not
- changed, their position is considered fixed. alternatives and
- waypoints can not be used at the same time.
-
-
-
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/parameters/woosmap_http_parameters_distanceroute.md b/dist/documentation/parameters/woosmap_http_parameters_distanceroute.md
deleted file mode 100644
index 547adb7e..00000000
--- a/dist/documentation/parameters/woosmap_http_parameters_distanceroute.md
+++ /dev/null
@@ -1,71 +0,0 @@
-
-
-Required parameters
-
-- destination
-
- The ending point for the route. It should be supplied in the form of latitude/longitude coordinates. Ensure that no space exists between the latitude and longitude values.
-
-- origin
-
- 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.
-
-Optional parameters
-
-- alternatives
-
- Specifies if alternative routes should be returned. default is `false`. Depending on the calculated route, alternatives may not be provided.
- `alternatives` and `waypoints` can not be used at the same time.
-
-- arrival_time
-
- By using this parameter, Distance will calculate the duration with traffic Specifies the arrival date/time as a timestamp to base the calculation on (e.g. `1600799173` for the date:`22/09/2020 20:26:13`).
- Use either `arrival_time` or `departure_time`, not both.
-
-- avoid
-
- The 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. To add multiple polygons, separate them with the `|` character.
-
-- departure_time
-
- By using this parameter, Distance will calculate the duration with traffic Specifies the date/time at which to base the calculations on for traffic purposes. Valid values are a timestamp (e.g. `1600799173` for the date:`22/09/2020 20:26:13`) or `now`.
- Use either `arrival_time` or `departure_time`, not both.
-
-- details
-
- Specifies if maneuver instructions should be returned (roadbook). Valid values are `none` and `full` (default is `none`)
-
-- language
-
- The language code, indicating in which language the results should be returned, if possible. If language is not supplied, the Distance API service will use the navigator language or “en”.
-
-- method
-
- Specifies the method to compute the route between the start point and the end point:
-
- - `time`: fastest route (default) - `distance`: shortest route
-
-- mode
-
- Specifies the mode of transport to use when calculating distance
-
-- units
-
- Specifies the unit system parameter to use when expressing distance as text. Two different units supported:
-
- - `metric` (default) returns distances in kilometers and meters
- - `imperial` returns distances in miles and feet
-
-- waypoints
-
- A list of points by which the route should pass (route response is divided into legs, one leg corresponding to a route between two waypoints). Waypoints should be separated by | character.
- Optionally, you may pass `optimize:true` as the first argument within the waypoints parameter. This way the provided route is optimized by rearranging the waypoints in a more efficient order based on distance or time according to the method parameter. The route start point and end point order is not changed, their position is considered fixed.
- `alternatives` and `waypoints` can not be used at the same time.
-
-
-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_distancetolls.html b/dist/documentation/parameters/woosmap_http_parameters_distancetolls.html
deleted file mode 100644
index ef66657b..00000000
--- a/dist/documentation/parameters/woosmap_http_parameters_distancetolls.html
+++ /dev/null
@@ -1,133 +0,0 @@
-
-
-Required parameters
-
- -
-
destination
-
- The ending point for the route. It should be supplied in the form of
- latitude/longitude coordinates. Ensure that no space exists between the
- latitude and longitude values.
-
-
- -
-
origin
-
- 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.
-
-
-
-Optional parameters
-
- -
-
alternatives
-
- Specifies if alternative routes should be returned. default is
- false. Depending on the calculated route, alternatives may
- not be provided. alternatives and waypoints can
- not be used at the same time.
-
-
- -
-
arrival_time
-
- By using this parameter, Distance will calculate the duration with traffic
- Specifies the arrival date/time as a timestamp to base the calculation on
- (e.g. 1600799173 for the date:22/09/2020 20:26:13). Use either arrival_time or departure_time,
- not both.
-
-
- -
-
departure_time
-
- By using this parameter, Distance will calculate the duration with traffic
- Specifies the date/time at which to base the calculations on for traffic
- purposes. Valid values are a timestamp (e.g. 1600799173 for
- the date:22/09/2020 20:26:13) or now. Use either
- arrival_time or departure_time, not both.
-
-
- -
-
language
-
- The language code, indicating in which language the results should be
- returned, if possible. If language is not supplied, the Distance API
- service will use the navigator language or “en”.
-
-
- -
-
method
-
- Specifies the method to compute the route between the start point and the
- end point:
-
-
- -
-
time: fastest route (default) - distance:
- shortest route
-
-
-
- -
-
mode
- Specifies the mode of transport to use when calculating distance
-
- -
-
units
-
- Specifies the unit system parameter to use when expressing distance as
- text. Two different units supported:
-
-
- -
-
metric (default) returns distances in kilometers and meters
-
- imperial returns distances in miles and feet
-
-
- -
-
waypoints
-
- A list of points by which the route should pass (route response is divided
- into legs, one leg corresponding to a route between two waypoints).
- Waypoints should be separated by | character. Optionally, you may pass
- optimize:true as the first argument within the waypoints
- parameter. This way the provided route is optimized by rearranging the
- waypoints in a more efficient order based on distance or time according to
- the method parameter. The route start point and end point order is not
- changed, their position is considered fixed. alternatives and
- waypoints can not be used at the same time.
-
-
-
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/parameters/woosmap_http_parameters_distancetolls.md b/dist/documentation/parameters/woosmap_http_parameters_distancetolls.md
deleted file mode 100644
index 54c3ab59..00000000
--- a/dist/documentation/parameters/woosmap_http_parameters_distancetolls.md
+++ /dev/null
@@ -1,63 +0,0 @@
-
-
-Required parameters
-
-- destination
-
- The ending point for the route. It should be supplied in the form of latitude/longitude coordinates. Ensure that no space exists between the latitude and longitude values.
-
-- origin
-
- 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.
-
-Optional parameters
-
-- alternatives
-
- Specifies if alternative routes should be returned. default is `false`. Depending on the calculated route, alternatives may not be provided.
- `alternatives` and `waypoints` can not be used at the same time.
-
-- arrival_time
-
- By using this parameter, Distance will calculate the duration with traffic Specifies the arrival date/time as a timestamp to base the calculation on (e.g. `1600799173` for the date:`22/09/2020 20:26:13`).
- Use either `arrival_time` or `departure_time`, not both.
-
-- departure_time
-
- By using this parameter, Distance will calculate the duration with traffic Specifies the date/time at which to base the calculations on for traffic purposes. Valid values are a timestamp (e.g. `1600799173` for the date:`22/09/2020 20:26:13`) or `now`.
- Use either `arrival_time` or `departure_time`, not both.
-
-- language
-
- The language code, indicating in which language the results should be returned, if possible. If language is not supplied, the Distance API service will use the navigator language or “en”.
-
-- method
-
- Specifies the method to compute the route between the start point and the end point:
-
- - `time`: fastest route (default) - `distance`: shortest route
-
-- mode
-
- Specifies the mode of transport to use when calculating distance
-
-- units
-
- Specifies the unit system parameter to use when expressing distance as text. Two different units supported:
-
- - `metric` (default) returns distances in kilometers and meters
- - `imperial` returns distances in miles and feet
-
-- waypoints
-
- A list of points by which the route should pass (route response is divided into legs, one leg corresponding to a route between two waypoints). Waypoints should be separated by | character.
- Optionally, you may pass `optimize:true` as the first argument within the waypoints parameter. This way the provided route is optimized by rearranging the waypoints in a more efficient order based on distance or time according to the method parameter. The route start point and end point order is not changed, their position is considered fixed.
- `alternatives` and `waypoints` can not be used at the same time.
-
-
-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
index 3d365611..a183f302 100644
--- a/dist/documentation/parameters/woosmap_http_parameters_localitiesnearby.html
+++ b/dist/documentation/parameters/woosmap_http_parameters_localitiesnearby.html
@@ -6,6 +6,14 @@ 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
@@ -33,14 +41,6 @@ page
radius
radius of the search circle, in meter.
- -
-
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.
-
-
Generated from the
diff --git a/dist/documentation/parameters/woosmap_http_parameters_localitiesnearby.md b/dist/documentation/parameters/woosmap_http_parameters_localitiesnearby.md
index b85960b9..786bbf37 100644
--- a/dist/documentation/parameters/woosmap_http_parameters_localitiesnearby.md
+++ b/dist/documentation/parameters/woosmap_http_parameters_localitiesnearby.md
@@ -6,6 +6,10 @@
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
@@ -24,10 +28,6 @@
radius of the search circle, in meter.
-- 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`.
-
Generated from the OpenAPI specification.
✎ Edit
diff --git a/dist/documentation/schemas/woosmap_http_schema_distanceinstructions.html b/dist/documentation/schemas/woosmap_http_schema_distanceinstructions.html
deleted file mode 100644
index f87a0186..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distanceinstructions.html
+++ /dev/null
@@ -1,173 +0,0 @@
-
-
-
DistanceInstructions
-Formatted instructions for this leg
-
-
-
- | Field |
- Required |
- Type |
- Description |
-
-
-
-
-
-
- action
-
- |
- optional |
- integer |
-
-
- |
-
-
-
-
- summary
-
- |
- optional |
- string |
-
-
- Written maneuver instruction.
-
- |
-
-
-
-
- verbal_after
-
- |
- optional |
- string |
-
-
-
- Text suitable for use as a verbal message immediately after the
- maneuver transition
-
-
- |
-
-
-
-
- verbal_alert
-
- |
- optional |
- string |
-
-
-
- The transition alert instruction will prepare the user for the
- forthcoming transition.
-
-
- |
-
-
-
-
- verbal_before
-
- |
- optional |
- string |
-
-
-
- Text suitable for use as a verbal message immediately prior to the
- maneuver transition
-
-
- |
-
-
-
-
- verbal_succint
-
- |
- optional |
- string |
-
-
-
- Text suitable for use as a verbal alert in a navigation application
-
-
- |
-
-
-
-Example
-
-{
- "action": 2,
- "summary": "Drive northeast on D 151.",
- "verbal_alert": "Enter the roundabout and take the 2nd exit onto D 30.",
- "verbal_before": "Drive northeast on D 151. Then Enter the roundabout and take the 2nd exit onto D 30."
-}
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distanceinstructions.md b/dist/documentation/schemas/woosmap_http_schema_distanceinstructions.md
deleted file mode 100644
index e99d911d..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distanceinstructions.md
+++ /dev/null
@@ -1,30 +0,0 @@
-
-
-DistanceInstructions
-
-Formatted instructions for this leg
-
-| Field | Required | Type | Description |
-| :------------------------------------------------------------------------------------------------------------------------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| action
| optional | integer | |
-| summary
| optional | string | Written maneuver instruction.
|
-| verbal_after
| optional | string | Text suitable for use as a verbal message immediately after the maneuver transition
|
-| verbal_alert
| optional | string | The transition alert instruction will prepare the user for the forthcoming transition.
|
-| verbal_before
| optional | string | Text suitable for use as a verbal message immediately prior to the maneuver transition
|
-| verbal_succint
| optional | string | Text suitable for use as a verbal alert in a navigation application
|
-
-Example
-
-{
- "action": 2,
- "summary": "Drive northeast on D 151.",
- "verbal_alert": "Enter the roundabout and take the 2nd exit onto D 30.",
- "verbal_before": "Drive northeast on D 151. Then Enter the roundabout and take the 2nd exit onto D 30."
-}
-
-Generated from the OpenAPI specification.
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distanceisochroneresponse.html b/dist/documentation/schemas/woosmap_http_schema_distanceisochroneresponse.html
deleted file mode 100644
index ffb14afe..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distanceisochroneresponse.html
+++ /dev/null
@@ -1,101 +0,0 @@
-
-
-
- DistanceIsochroneResponse
-
-Attributes describing a distance isochrone response.
-
-
-
- | Field |
- Required |
- Type |
- Description |
-
-
-
-
-
-
- isoline
-
- |
- optional |
- object |
-
-
- Contains the properties of isoline
-
- |
-
-
-
-
- status
-
- |
- optional |
-
- DistanceStatus
- |
-
- See
- DistanceStatus for
- more information.
- |
-
-
-
-
- Example
-
-
-{
- "status": "OK",
- "isoline": {
- "origin": {
- "lat": 48.709,
- "lng": 2.403
- },
- "distance": {
- "value": 1,
- "text": "1 km"
- },
- "geometry": "s|ihHouuMZ`GdClCsA~QhCnQmBhEpCfF|HxGpBtFfEnBnHqJpH}ADaEcCaB@sBnEiEYiGmVyFaG{G[eFoCw@gAiIkDYg@_DwA@"
- }
-}
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distanceisochroneresponse.md b/dist/documentation/schemas/woosmap_http_schema_distanceisochroneresponse.md
deleted file mode 100644
index eeeb39dd..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distanceisochroneresponse.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-
-DistanceIsochroneResponse
-
-Attributes describing a distance isochrone response.
-
-| Field | Required | Type | Description |
-| :--------------------------------------------------------------------------------------------------------------- | -------- | -------------------------------------------------- | ---------------------------------------------------------------------------------------- |
-| isoline
| optional | object | Contains the properties of isoline
|
-| status
| optional | [DistanceStatus](#DistanceStatus "DistanceStatus") | See [DistanceStatus](#DistanceStatus "DistanceStatus") for more information. |
-
-Example
-
-{
- "status": "OK",
- "isoline": {
- "origin": {
- "lat": 48.709,
- "lng": 2.403
- },
- "distance": {
- "value": 1,
- "text": "1 km"
- },
- "geometry": "s|ihHouuMZ`GdClCsA~QhCnQmBhEpCfF|HxGpBtFfEnBnHqJpH}ADaEcCaB@sBnEiEYiGmVyFaG{G[eFoCw@gAiIkDYg@_DwA@"
- }
-}
-
-Generated from the OpenAPI specification.
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distanceleg.html b/dist/documentation/schemas/woosmap_http_schema_distanceleg.html
deleted file mode 100644
index 7bd9eb92..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distanceleg.html
+++ /dev/null
@@ -1,228 +0,0 @@
-
-
-DistanceLeg
-Leg in a route
-
-
-
- | Field |
- Required |
- Type |
- Description |
-
-
-
-
-
-
- distance
-
- |
- optional |
- DistanceValue |
-
- See DistanceValue for
- more information.
- |
-
-
-
-
- duration
-
- |
- optional |
- DurationValue |
-
- See DurationValue for
- more information.
- |
-
-
-
-
- end_address
-
- |
- optional |
- string |
-
-
- the ending address of the leg
-
- |
-
-
-
-
- end_location
-
- |
- optional |
- LatLngLiteral |
-
- See LatLngLiteral for
- more information.
- |
-
-
-
-
- end_waypoint
-
- |
- optional |
- integer |
-
-
- The end waypoint order number
-
- |
-
-
-
-
- start_address
-
- |
- optional |
- string |
-
-
- the starting address of the leg
-
- |
-
-
-
-
- start_location
-
- |
- optional |
- LatLngLiteral |
-
- See LatLngLiteral for
- more information.
- |
-
-
-
-
- start_waypoint
-
- |
- optional |
- integer |
-
-
- The start waypoint order number
-
- |
-
-
-
-
- steps
-
- |
- optional |
-
- Array<DistanceStep>
- |
-
-
-
- List of steps constituting the leg. Steps are returned when
- details=full parameter is specified. 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.
-
-
- See DistanceStep for more information.
-
-
- |
-
-
-
-Example
-
-{
- "distance": {
- "text": "1 km",
- "value": 1038
- },
- "duration": {
- "text": "1 min",
- "value": 75
- },
- "start_location": {
- "lat": 49.31067,
- "lng": 4.14525
- },
- "end_location": {
- "lat": 49.31344,
- "lng": 4.15293
- },
- "start_waypoint": 0,
- "end_waypoint": 1,
- "end_address": "D 30",
- "start_address": "D 151"
-}
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distanceleg.md b/dist/documentation/schemas/woosmap_http_schema_distanceleg.md
deleted file mode 100644
index 9e509311..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distanceleg.md
+++ /dev/null
@@ -1,49 +0,0 @@
-
-
-DistanceLeg
-
-Leg in a route
-
-| Field | Required | Type | Description |
-| :--------------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| distance
| optional | [DistanceValue](#DistanceValue "DistanceValue") | See [DistanceValue](#DistanceValue "DistanceValue") for more information. |
-| duration
| optional | [DurationValue](#DurationValue "DurationValue") | See [DurationValue](#DurationValue "DurationValue") for more information. |
-| end_address
| optional | string | the ending address of the leg
|
-| end_location
| optional | [LatLngLiteral](#LatLngLiteral "LatLngLiteral") | See [LatLngLiteral](#LatLngLiteral "LatLngLiteral") for more information. |
-| end_waypoint
| optional | integer | The end waypoint order number
|
-| start_address
| optional | string | the starting address of the leg
|
-| start_location
| optional | [LatLngLiteral](#LatLngLiteral "LatLngLiteral") | See [LatLngLiteral](#LatLngLiteral "LatLngLiteral") for more information. |
-| start_waypoint
| optional | integer | The start waypoint order number
|
-| steps
| optional | Array<[DistanceStep](#DistanceStep "DistanceStep")> | List of steps constituting the leg. Steps are returned when details=full parameter is specified. 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.
See DistanceStep for more information.
|
-
-Example
-
-{
- "distance": {
- "text": "1 km",
- "value": 1038
- },
- "duration": {
- "text": "1 min",
- "value": 75
- },
- "start_location": {
- "lat": 49.31067,
- "lng": 4.14525
- },
- "end_location": {
- "lat": 49.31344,
- "lng": 4.15293
- },
- "start_waypoint": 0,
- "end_waypoint": 1,
- "end_address": "D 30",
- "start_address": "D 151"
-}
-
-Generated from the OpenAPI specification.
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancematrixelementresponse.html b/dist/documentation/schemas/woosmap_http_schema_distancematrixelementresponse.html
deleted file mode 100644
index d398977c..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancematrixelementresponse.html
+++ /dev/null
@@ -1,115 +0,0 @@
-
-
-
- DistanceMatrixElementResponse
-
-
- Attributes describing an element of origin and destination returned in
- distance Matrix response.
-
-
-
-
- | Field |
- Required |
- Type |
- Description |
-
-
-
-
-
-
- distance
-
- |
- optional |
- DistanceValue |
-
- See DistanceValue for
- more information.
- |
-
-
-
-
- duration
-
- |
- optional |
- DurationValue |
-
- See DurationValue for
- more information.
- |
-
-
-
-
- status
-
- |
- optional |
- string |
-
-
- Status returned for Distance Matrix Element Response.
-
- -
-
OK indicates the response contains a valid result.
-
- -
-
NOT_FOUND indicates that the origin and/or
- destination of this pairing could not be matched to the network.
-
- -
-
ZERO_RESULTS indicates no route could be found
- between the origin and destination.
-
-
-
- The allowed values include: OK, NOT_FOUND,
- and ZERO_RESULTS
-
-
- |
-
-
-
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancematrixelementresponse.md b/dist/documentation/schemas/woosmap_http_schema_distancematrixelementresponse.md
deleted file mode 100644
index 63568030..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancematrixelementresponse.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-
-DistanceMatrixElementResponse
-
-Attributes describing an element of origin and destination returned in distance Matrix response.
-
-| Field | Required | Type | Description |
-| :--------------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| distance
| optional | [DistanceValue](#DistanceValue "DistanceValue") | See [DistanceValue](#DistanceValue "DistanceValue") for more information. |
-| duration
| optional | [DurationValue](#DurationValue "DurationValue") | See [DurationValue](#DurationValue "DurationValue") for more information. |
-| status
| optional | string | Status returned for Distance Matrix Element Response.
OK indicates the response contains a valid result.NOT_FOUND indicates that the origin and/or destination of this pairing could not be matched to the network.ZERO_RESULTS indicates no route could be found between the origin and destination.
The allowed values include: `OK`, `NOT_FOUND`, and `ZERO_RESULTS`
|
-
-Generated from the OpenAPI specification.
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancematrixelementsresponse.html b/dist/documentation/schemas/woosmap_http_schema_distancematrixelementsresponse.html
deleted file mode 100644
index a86af907..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancematrixelementsresponse.html
+++ /dev/null
@@ -1,110 +0,0 @@
-
-
-
- DistanceMatrixElementsResponse
-
-
- Attributes describing elements of origin and destination returned in distance
- Matrix response.
-
-
-
- Example
-
-
-{
- "elements": [
- {
- "status": "OK",
- "duration": {
- "value": 866,
- "text": "14 mins"
- },
- "distance": {
- "value": 10613,
- "text": "10.6 km"
- }
- },
- {
- "status": "OK",
- "duration": {
- "value": 935,
- "text": "16 mins"
- },
- "distance": {
- "value": 10287,
- "text": "10.3 km"
- }
- }
- ]
-}
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancematrixelementsresponse.md b/dist/documentation/schemas/woosmap_http_schema_distancematrixelementsresponse.md
deleted file mode 100644
index 850bce96..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancematrixelementsresponse.md
+++ /dev/null
@@ -1,45 +0,0 @@
-
-
-DistanceMatrixElementsResponse
-
-Attributes describing elements of origin and destination returned in distance Matrix response.
-
-| Field | Required | Type | Description |
-| :---------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| elements
| optional | Array<[DistanceMatrixElementResponse](#DistanceMatrixElementResponse "DistanceMatrixElementResponse")> | |
-
-Example
-
-{
- "elements": [
- {
- "status": "OK",
- "duration": {
- "value": 866,
- "text": "14 mins"
- },
- "distance": {
- "value": 10613,
- "text": "10.6 km"
- }
- },
- {
- "status": "OK",
- "duration": {
- "value": 935,
- "text": "16 mins"
- },
- "distance": {
- "value": 10287,
- "text": "10.3 km"
- }
- }
- ]
-}
-
-Generated from the OpenAPI specification.
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancematrixrequest.html b/dist/documentation/schemas/woosmap_http_schema_distancematrixrequest.html
deleted file mode 100644
index e57e3929..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancematrixrequest.html
+++ /dev/null
@@ -1,222 +0,0 @@
-
-
-DistanceMatrixRequest
-Attributes describing a distance Matrix request
-
-
-
- | Field |
- Required |
- Type |
- Description |
-
-
-
-
-
-
- destinations
-
- |
- required |
- Destinations |
-
- See Destinations for
- more information.
- |
-
-
-
-
- origins
-
- |
- required |
- Origins |
-
- See Origins for more information.
- |
-
-
-
-
- departure_time
-
- |
- optional |
- string |
-
-
-
- Specifies the date/time at which to base the calculations on for
- traffic purposes. Valid values are a timestamp (e.g.
- 1600799173 for the date:22/09/2020 20:26:13) or now.
-
-
- |
-
-
-
-
- elements
-
- |
- optional |
- string |
-
-
-
- Specifies element values that will be part of the API response
- (distance and/or duration). if not specified default is
- distance
-
-
- The allowed values include: distance,
- duration, and duration_distance
-
-
- |
-
-
-
-
- language
-
- |
- optional |
- string |
-
-
-
- The language code, indicating in which language the results should
- be returned, if possible. If language is not supplied, the Distance
- API service will use the navigator language or “en”.
-
-
- |
-
-
-
-
- method
-
- |
- optional |
- string |
-
-
-
- Specifies the method to compute the route between the start point
- and the end point:
-
-
- time: fastest route (default)
- distance: shortest route
-
-
- The allowed values include: time, and
- distance
-
-
- |
-
-
-
-
- mode
-
- |
- optional |
- string |
-
-
-
- Specifies the mode of transport to use when calculating distance
-
-
- The allowed values include: driving,
- cycling, and walking
-
-
- |
-
-
-
-
- units
-
- |
- optional |
- Units |
-
- See Units for more information.
- |
-
-
-
-
- Example
-
-
-{
- "origins": "48.73534,2.368308|48.73534,2.368308",
- "destinations": "48.83534,2.368308",
- "units": "imperial",
- "elements": "duration_distance",
- "method": "distance",
- "departure_time": "now"
-}
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancematrixrequest.md b/dist/documentation/schemas/woosmap_http_schema_distancematrixrequest.md
deleted file mode 100644
index 778085ec..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancematrixrequest.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-
-DistanceMatrixRequest
-
-Attributes describing a distance Matrix request
-
-| Field | Required | Type | Description |
-| :------------------------------------------------------------------------------------------------------------------------- | ------------ | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| destinations
| **required** | [Destinations](#Destinations "Destinations") | See [Destinations](#Destinations "Destinations") for more information. |
-| origins
| **required** | [Origins](#Origins "Origins") | See [Origins](#Origins "Origins") for more information. |
-| departure_time
| optional | string | Specifies the date/time at which to base the calculations on for traffic purposes. Valid values are a timestamp (e.g. 1600799173 for the date:22/09/2020 20:26:13) or now.
|
-| elements
| optional | string | Specifies element values that will be part of the API response (distance and/or duration). if not specified default is distance
The allowed values include: `distance`, `duration`, and `duration_distance`
|
-| language
| optional | string | The language code, indicating in which language the results should be returned, if possible. If language is not supplied, the Distance API service will use the navigator language or “en”.
|
-| method
| optional | string | Specifies the method to compute the route between the start point and the end point:
time: fastest route (default)distance: shortest route
The allowed values include: `time`, and `distance`
|
-| mode
| optional | string | Specifies the mode of transport to use when calculating distance
The allowed values include: `driving`, `cycling`, and `walking`
|
-| units
| optional | [Units](#Units "Units") | See [Units](#Units "Units") for more information. |
-
-Example
-
-{
- "origins": "48.73534,2.368308|48.73534,2.368308",
- "destinations": "48.83534,2.368308",
- "units": "imperial",
- "elements": "duration_distance",
- "method": "distance",
- "departure_time": "now"
-}
-
-Generated from the OpenAPI specification.
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancematrixresponse.html b/dist/documentation/schemas/woosmap_http_schema_distancematrixresponse.html
deleted file mode 100644
index 3f316329..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancematrixresponse.html
+++ /dev/null
@@ -1,134 +0,0 @@
-
-
-
- DistanceMatrixResponse
-
-Attributes describing an distance Matrix response.
-
-
- Example
-
-
-{
- "status": "OK",
- "rows": [
- {
- "elements": [
- {
- "status": "OK",
- "duration": {
- "value": 978,
- "text": "16 mins"
- },
- "distance": {
- "value": 10796,
- "text": "10.8 km"
- }
- },
- {
- "status": "OK",
- "duration": {
- "value": 942,
- "text": "16 mins"
- },
- "distance": {
- "value": 10322,
- "text": "10.3 km"
- }
- }
- ]
- }
- ]
-}
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancematrixresponse.md b/dist/documentation/schemas/woosmap_http_schema_distancematrixresponse.md
deleted file mode 100644
index 74c0d481..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancematrixresponse.md
+++ /dev/null
@@ -1,51 +0,0 @@
-
-
-DistanceMatrixResponse
-
-Attributes describing an distance Matrix response.
-
-| Field | Required | Type | Description |
-| :---------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| rows
| optional | Array<[DistanceMatrixElementsResponse](#DistanceMatrixElementsResponse "DistanceMatrixElementsResponse")> | |
-| status
| optional | [DistanceStatus](#DistanceStatus "DistanceStatus") | See [DistanceStatus](#DistanceStatus "DistanceStatus") for more information. |
-
-Example
-
-{
- "status": "OK",
- "rows": [
- {
- "elements": [
- {
- "status": "OK",
- "duration": {
- "value": 978,
- "text": "16 mins"
- },
- "distance": {
- "value": 10796,
- "text": "10.8 km"
- }
- },
- {
- "status": "OK",
- "duration": {
- "value": 942,
- "text": "16 mins"
- },
- "distance": {
- "value": 10322,
- "text": "10.3 km"
- }
- }
- ]
- }
- ]
-}
-
-Generated from the OpenAPI specification.
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancerouteelementsresponse.html b/dist/documentation/schemas/woosmap_http_schema_distancerouteelementsresponse.html
deleted file mode 100644
index 0897e70f..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancerouteelementsresponse.html
+++ /dev/null
@@ -1,162 +0,0 @@
-
-
-
- DistanceRouteElementsResponse
-
-
- Attributes describing routes from an origin to a destination returned in
- distance route response.
-
-
-
-
- | Field |
- Required |
- Type |
- Description |
-
-
-
-
-
-
- bounds
-
- |
- required |
- Bounds |
-
- See Bounds for more information.
- |
-
-
-
-
- legs
-
- |
- required |
-
- Array<DistanceLeg>
- |
-
-
- Legs part of the route response
-
- See DistanceLeg for more information.
-
-
- |
-
-
-
-
- notice
-
- |
- required |
- string |
-
-
- Some noticeable information about the route
-
- |
-
-
-
-
- overview_polyline
-
- |
- required |
-
- EncodedPolyline
- |
-
- See
- EncodedPolyline
- for more information.
- |
-
-
-
-
- main_route_name
-
- |
- optional |
- string |
-
-
-
- The main route name based on the longest step length to
- differentiate routes when alternates are returned.
-
-
- |
-
-
-
-
- recommended
-
- |
- optional |
- boolean |
-
-
-
- Optional field. Only present and set to true when the route is the
- recommended route.
-
-
- |
-
-
-
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancerouteelementsresponse.md b/dist/documentation/schemas/woosmap_http_schema_distancerouteelementsresponse.md
deleted file mode 100644
index f7588ce9..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancerouteelementsresponse.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-
-DistanceRouteElementsResponse
-
-Attributes describing routes from an origin to a destination returned in distance route response.
-
-| Field | Required | Type | Description |
-| :--------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| bounds
| **required** | [Bounds](#Bounds "Bounds") | See [Bounds](#Bounds "Bounds") for more information. |
-| legs
| **required** | Array<[DistanceLeg](#DistanceLeg "DistanceLeg")> | Legs part of the route response
See DistanceLeg for more information.
|
-| notice
| **required** | string | Some noticeable information about the route
|
-| overview_polyline
| **required** | [EncodedPolyline](#EncodedPolyline "EncodedPolyline") | See [EncodedPolyline](#EncodedPolyline "EncodedPolyline") for more information. |
-| main_route_name
| optional | string | The main route name based on the longest step length to differentiate routes when alternates are returned.
|
-| recommended
| optional | boolean | Optional field. Only present and set to true when the route is the recommended route.
|
-
-Generated from the OpenAPI specification.
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancerouteresponse.html b/dist/documentation/schemas/woosmap_http_schema_distancerouteresponse.html
deleted file mode 100644
index d355462a..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancerouteresponse.html
+++ /dev/null
@@ -1,275 +0,0 @@
-
-
-DistanceRouteResponse
-Attributes describing a distance route response.
-
-
- Example
-
-
-{
- "status": "OK",
- "routes": [
- {
- "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@eAHO"
- },
- "bounds": {
- "northeast": {
- "lat": 49.315678,
- "lng": 4.152915
- },
- "southwest": {
- "lat": 49.31073,
- "lng": 4.145162
- }
- },
- "notice": "",
- "legs": [
- {
- "distance": {
- "text": "1 km",
- "value": 1038
- },
- "duration": {
- "text": "1 min",
- "value": 75
- },
- "start_location": {
- "lat": 49.31067,
- "lng": 4.14525
- },
- "end_location": {
- "lat": 49.31344,
- "lng": 4.15293
- },
- "start_waypoint": 0,
- "end_waypoint": 1,
- "end_address": "D 30",
- "start_address": "D 151",
- "steps": [
- {
- "distance": "676 m",
- "duration": "1 min",
- "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
- },
- "end_location": {
- "lat": 49.315679,
- "lng": 4.149621
- },
- "travel_mode": "DRIVING",
- "instructions": {
- "action": 2,
- "summary": "Drive northeast on D 151.",
- "verbal_succint": "Drive northeast. Then Enter the roundabout and take the 2nd exit onto D 30.",
- "verbal_before": "Drive northeast on D 151. Then Enter the roundabout and take the 2nd exit onto D 30.",
- "verbal_after": "Continue for 700 meters."
- }
- },
- {
- "distance": "22 m",
- "duration": "1 min",
- "polyline": "}}~kHcniXBIBU?W",
- "start_location": {
- "lat": 49.315679,
- "lng": 4.149621
- },
- "end_location": {
- "lat": 49.31563,
- "lng": 4.149905
- },
- "travel_mode": "DRIVING",
- "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_succint": "Enter the roundabout and take the 2nd exit.",
- "verbal_before": "Enter the roundabout and take the 2nd exit onto D 30."
- }
- },
- {
- "distance": "198 m",
- "duration": "1 min",
- "polyline": "u}~kH{oiXFWDOLUP[P]j@y@^g@`@i@NUNONMJKJIFELC",
- "start_location": {
- "lat": 49.31563,
- "lng": 4.149905
- },
- "end_location": {
- "lat": 49.314292,
- "lng": 4.151623
- },
- "travel_mode": "DRIVING",
- "instructions": {
- "action": 27,
- "summary": "Exit the roundabout onto D 30.",
- "verbal_succint": "Exit the roundabout.",
- "verbal_before": "Exit the roundabout onto D 30.",
- "verbal_after": "Continue for 200 meters."
- }
- },
- {
- "distance": "46 m",
- "duration": "1 min",
- "polyline": "iu~kHsziXJBJAHGFIDMBSAS",
- "start_location": {
- "lat": 49.314292,
- "lng": 4.151623
- },
- "end_location": {
- "lat": 49.314041,
- "lng": 4.151976
- },
- "travel_mode": "DRIVING",
- "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_succint": "Enter the roundabout and take the 2nd exit.",
- "verbal_before": "Enter the roundabout and take the 2nd exit onto D 30."
- }
- },
- {
- "distance": "96 m",
- "duration": "1 min",
- "polyline": "ws~kHy|iXBKDILURa@LWt@eAHO",
- "start_location": {
- "lat": 49.314041,
- "lng": 4.151976
- },
- "end_location": {
- "lat": 49.313431,
- "lng": 4.152916
- },
- "travel_mode": "DRIVING",
- "instructions": {
- "action": 27,
- "summary": "Exit the roundabout onto D 30.",
- "verbal_succint": "Exit the roundabout. Then, in 100 meters, You will arrive at your destination.",
- "verbal_before": "Exit the roundabout onto D 30. Then, in 100 meters, You will arrive at your destination.",
- "verbal_after": "Continue for 100 meters."
- }
- },
- {
- "distance": "1 m",
- "duration": "1 min",
- "polyline": "}o~kHubjX",
- "start_location": {
- "lat": 49.313431,
- "lng": 4.152916
- },
- "end_location": {
- "lat": 49.313431,
- "lng": 4.152916
- },
- "travel_mode": "DRIVING",
- "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."
- }
- }
- ]
- }
- ],
- "main_route_name": "D 151",
- "recommended": true
- }
- ]
-}
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancerouteresponse.md b/dist/documentation/schemas/woosmap_http_schema_distancerouteresponse.md
deleted file mode 100644
index 1a51a328..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancerouteresponse.md
+++ /dev/null
@@ -1,194 +0,0 @@
-
-
-DistanceRouteResponse
-
-Attributes describing a distance route response.
-
-| Field | Required | Type | Description |
-| :--------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| routes
| optional | Array<[DistanceRouteElementsResponse](#DistanceRouteElementsResponse "DistanceRouteElementsResponse")> | Contains an array of routes from origin to destination (only one if alternatives is not specified)
See DistanceRouteElementsResponse for more information.
|
-| status
| optional | [DistanceStatus](#DistanceStatus "DistanceStatus") | See [DistanceStatus](#DistanceStatus "DistanceStatus") for more information. |
-
-Example
-
-{
- "status": "OK",
- "routes": [
- {
- "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@eAHO"
- },
- "bounds": {
- "northeast": {
- "lat": 49.315678,
- "lng": 4.152915
- },
- "southwest": {
- "lat": 49.31073,
- "lng": 4.145162
- }
- },
- "notice": "",
- "legs": [
- {
- "distance": {
- "text": "1 km",
- "value": 1038
- },
- "duration": {
- "text": "1 min",
- "value": 75
- },
- "start_location": {
- "lat": 49.31067,
- "lng": 4.14525
- },
- "end_location": {
- "lat": 49.31344,
- "lng": 4.15293
- },
- "start_waypoint": 0,
- "end_waypoint": 1,
- "end_address": "D 30",
- "start_address": "D 151",
- "steps": [
- {
- "distance": "676 m",
- "duration": "1 min",
- "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
- },
- "end_location": {
- "lat": 49.315679,
- "lng": 4.149621
- },
- "travel_mode": "DRIVING",
- "instructions": {
- "action": 2,
- "summary": "Drive northeast on D 151.",
- "verbal_succint": "Drive northeast. Then Enter the roundabout and take the 2nd exit onto D 30.",
- "verbal_before": "Drive northeast on D 151. Then Enter the roundabout and take the 2nd exit onto D 30.",
- "verbal_after": "Continue for 700 meters."
- }
- },
- {
- "distance": "22 m",
- "duration": "1 min",
- "polyline": "}}~kHcniXBIBU?W",
- "start_location": {
- "lat": 49.315679,
- "lng": 4.149621
- },
- "end_location": {
- "lat": 49.31563,
- "lng": 4.149905
- },
- "travel_mode": "DRIVING",
- "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_succint": "Enter the roundabout and take the 2nd exit.",
- "verbal_before": "Enter the roundabout and take the 2nd exit onto D 30."
- }
- },
- {
- "distance": "198 m",
- "duration": "1 min",
- "polyline": "u}~kH{oiXFWDOLUP[P]j@y@^g@`@i@NUNONMJKJIFELC",
- "start_location": {
- "lat": 49.31563,
- "lng": 4.149905
- },
- "end_location": {
- "lat": 49.314292,
- "lng": 4.151623
- },
- "travel_mode": "DRIVING",
- "instructions": {
- "action": 27,
- "summary": "Exit the roundabout onto D 30.",
- "verbal_succint": "Exit the roundabout.",
- "verbal_before": "Exit the roundabout onto D 30.",
- "verbal_after": "Continue for 200 meters."
- }
- },
- {
- "distance": "46 m",
- "duration": "1 min",
- "polyline": "iu~kHsziXJBJAHGFIDMBSAS",
- "start_location": {
- "lat": 49.314292,
- "lng": 4.151623
- },
- "end_location": {
- "lat": 49.314041,
- "lng": 4.151976
- },
- "travel_mode": "DRIVING",
- "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_succint": "Enter the roundabout and take the 2nd exit.",
- "verbal_before": "Enter the roundabout and take the 2nd exit onto D 30."
- }
- },
- {
- "distance": "96 m",
- "duration": "1 min",
- "polyline": "ws~kHy|iXBKDILURa@LWt@eAHO",
- "start_location": {
- "lat": 49.314041,
- "lng": 4.151976
- },
- "end_location": {
- "lat": 49.313431,
- "lng": 4.152916
- },
- "travel_mode": "DRIVING",
- "instructions": {
- "action": 27,
- "summary": "Exit the roundabout onto D 30.",
- "verbal_succint": "Exit the roundabout. Then, in 100 meters, You will arrive at your destination.",
- "verbal_before": "Exit the roundabout onto D 30. Then, in 100 meters, You will arrive at your destination.",
- "verbal_after": "Continue for 100 meters."
- }
- },
- {
- "distance": "1 m",
- "duration": "1 min",
- "polyline": "}o~kHubjX",
- "start_location": {
- "lat": 49.313431,
- "lng": 4.152916
- },
- "end_location": {
- "lat": 49.313431,
- "lng": 4.152916
- },
- "travel_mode": "DRIVING",
- "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."
- }
- }
- ]
- }
- ],
- "main_route_name": "D 151",
- "recommended": true
- }
- ]
-}
-
-Generated from the OpenAPI specification.
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancestatus.html b/dist/documentation/schemas/woosmap_http_schema_distancestatus.html
deleted file mode 100644
index d229f542..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancestatus.html
+++ /dev/null
@@ -1,66 +0,0 @@
-
-
-DistanceStatus
-Returns more info on if the request was successful or not.
-
- OK indicates the response contains a valid result.
- -
-
INVALID_REQUEST indicates that the provided request was invalid
- (e.g. wrong URL syntax).
-
- -
-
MAX_ELEMENTS_EXCEEDED indicates that the product of origins and
- destinations exceeds the per-query limit (fixed at 200 elts/q).
-
- -
-
MAX_ROUTE_LENGTH_EXCEEDED indicates that at least one of
- requested route is too long and the matrix cannot be processed (>500km).
-
- -
-
REQUEST_DENIED indicates that the service denied use of the
- Distance API service (e.g. wrong API Key, wrong/no referer, …).
-
- -
-
BACKEND_ERROR indicates a Distance API request could not be
- processed due to a server error. This may indicate that the origin and/or
- destination of this pairing could not be matched to the network. The request
- may or may not succeed if you try again.
-
- -
-
OVER_QUERY_LIMIT (associated to a 429 status code) indicates
- that the number of queries per second (QPS) or the number of elements per
- second (EPS) exceed the
- usage limits
-
-
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancestatus.md b/dist/documentation/schemas/woosmap_http_schema_distancestatus.md
deleted file mode 100644
index 2f1ea845..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancestatus.md
+++ /dev/null
@@ -1,20 +0,0 @@
-
-
-DistanceStatus
-
-Returns more info on if the request was successful or not.
-
-- `OK` indicates the response contains a valid result.
-- `INVALID_REQUEST` indicates that the provided request was invalid (e.g. wrong URL syntax).
-- `MAX_ELEMENTS_EXCEEDED` indicates that the product of origins and destinations exceeds the per-query limit (fixed at 200 elts/q).
-- `MAX_ROUTE_LENGTH_EXCEEDED` indicates that at least one of requested route is too long and the matrix cannot be processed (>500km).
-- `REQUEST_DENIED` indicates that the service denied use of the Distance API service (e.g. wrong API Key, wrong/no referer, …).
-- `BACKEND_ERROR` indicates a Distance API request could not be processed due to a server error. This may indicate that the origin and/or destination of this pairing could not be matched to the network. The request may or may not succeed if you try again.
-- `OVER_QUERY_LIMIT` (associated to a 429 status code) indicates that the number of queries per second (QPS) or the number of elements per second (EPS) exceed the [usage limits](https://developers.woosmap.com/products/distance-api/distance-matrix-endpoint/#usage-limits)
-
-Generated from the OpenAPI specification.
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancestep.html b/dist/documentation/schemas/woosmap_http_schema_distancestep.html
deleted file mode 100644
index 0bc3181f..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancestep.html
+++ /dev/null
@@ -1,193 +0,0 @@
-
-
-DistanceStep
-step in a leg
-
-
-
- | Field |
- Required |
- Type |
- Description |
-
-
-
-
-
-
- distance
-
- |
- optional |
- string |
-
-
- the distance as text covered by this step until the next step.
-
- |
-
-
-
-
- duration
-
- |
- optional |
- string |
-
-
-
- the typical time as text required to perform the step, until the
- next step
-
-
- |
-
-
-
-
- end_location
-
- |
- optional |
- LatLngLiteral |
-
- See LatLngLiteral for
- more information.
- |
-
-
-
-
- instructions
-
- |
- optional |
-
- DistanceInstructions
- |
-
- See
- DistanceInstructions
- for more information.
- |
-
-
-
-
- polyline
-
- |
- optional |
- string |
-
-
-
- the polyline representation of the step (encoded with the
- poyline algorithm
-
-
- |
-
-
-
-
- start_location
-
- |
- optional |
- LatLngLiteral |
-
- See LatLngLiteral for
- more information.
- |
-
-
-
-
- travel_mode
-
- |
- optional |
- string |
-
-
- the type of travel mode used
-
- |
-
-
-
-Example
-
-{
- "distance": "46 m",
- "duration": "1 min",
- "polyline": "iu~kHsziXJBJAHGFIDMBSAS",
- "start_location": {
- "lat": 49.314292,
- "lng": 4.151623
- },
- "end_location": {
- "lat": 49.314041,
- "lng": 4.151976
- },
- "travel_mode": "DRIVING"
-}
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancestep.md b/dist/documentation/schemas/woosmap_http_schema_distancestep.md
deleted file mode 100644
index a0113435..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancestep.md
+++ /dev/null
@@ -1,39 +0,0 @@
-
-
-DistanceStep
-
-step in a leg
-
-| Field | Required | Type | Description |
-| :---------------------------------------------------------------------------------------------------------------- | -------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| distance
| optional | string | the distance as text covered by this step until the next step.
|
-| duration
| optional | string | the typical time as text required to perform the step, until the next step
|
-| end_location
| optional | [LatLngLiteral](#LatLngLiteral "LatLngLiteral") | See [LatLngLiteral](#LatLngLiteral "LatLngLiteral") for more information. |
-| instructions
| optional | [DistanceInstructions](#DistanceInstructions "DistanceInstructions") | See [DistanceInstructions](#DistanceInstructions "DistanceInstructions") for more information. |
-| polyline
| optional | string | |
-| start_location
| optional | [LatLngLiteral](#LatLngLiteral "LatLngLiteral") | See [LatLngLiteral](#LatLngLiteral "LatLngLiteral") for more information. |
-| travel_mode
| optional | string | the type of travel mode used
|
-
-Example
-
-{
- "distance": "46 m",
- "duration": "1 min",
- "polyline": "iu~kHsziXJBJAHGFIDMBSAS",
- "start_location": {
- "lat": 49.314292,
- "lng": 4.151623
- },
- "end_location": {
- "lat": 49.314041,
- "lng": 4.151976
- },
- "travel_mode": "DRIVING"
-}
-
-Generated from the OpenAPI specification.
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancetollselementsresponse.html b/dist/documentation/schemas/woosmap_http_schema_distancetollselementsresponse.html
deleted file mode 100644
index d2c604dd..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancetollselementsresponse.html
+++ /dev/null
@@ -1,108 +0,0 @@
-
-
-
- DistanceTollsElementsResponse
-
-
- Attributes describing routes from an origin to a destination returned in
- distance tolls response.
-
-
-
-
- | Field |
- Required |
- Type |
- Description |
-
-
-
-
-
-
- bounds
-
- |
- required |
- Bounds |
-
- See Bounds for more information.
- |
-
-
-
-
- legs
-
- |
- required |
-
- Array<DistanceTollsLeg>
- |
-
-
- Legs part of the route response
-
- See DistanceTollsLeg for more
- information.
-
-
- |
-
-
-
-
- overview_polyline
-
- |
- required |
-
- EncodedPolyline
- |
-
- See
- EncodedPolyline
- for more information.
- |
-
-
-
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancetollselementsresponse.md b/dist/documentation/schemas/woosmap_http_schema_distancetollselementsresponse.md
deleted file mode 100644
index 2111f269..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancetollselementsresponse.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-
-DistanceTollsElementsResponse
-
-Attributes describing routes from an origin to a destination returned in distance tolls response.
-
-| Field | Required | Type | Description |
-| :--------------------------------------------------------------------------------------------------------------------------------------- | ------------ | --------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| bounds
| **required** | [Bounds](#Bounds "Bounds") | See [Bounds](#Bounds "Bounds") for more information. |
-| legs
| **required** | Array<[DistanceTollsLeg](#DistanceTollsLeg "DistanceTollsLeg")> | |
-| overview_polyline
| **required** | [EncodedPolyline](#EncodedPolyline "EncodedPolyline") | See [EncodedPolyline](#EncodedPolyline "EncodedPolyline") for more information. |
-
-Generated from the OpenAPI specification.
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancetollsleg.html b/dist/documentation/schemas/woosmap_http_schema_distancetollsleg.html
deleted file mode 100644
index b1def301..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancetollsleg.html
+++ /dev/null
@@ -1,177 +0,0 @@
-
-
-DistanceTollsLeg
-Leg in a route
-
-Example
-
-{
- "distance": {
- "text": "1 km",
- "value": 1038
- },
- "duration": {
- "text": "1 min",
- "value": 75
- },
- "start_location": {
- "lat": 49.31067,
- "lng": 4.14525
- },
- "end_location": {
- "lat": 49.31344,
- "lng": 4.15293
- }
-}
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancetollsleg.md b/dist/documentation/schemas/woosmap_http_schema_distancetollsleg.md
deleted file mode 100644
index 86941c54..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancetollsleg.md
+++ /dev/null
@@ -1,42 +0,0 @@
-
-
-DistanceTollsLeg
-
-Leg in a route
-
-| Field | Required | Type | Description |
-| :-------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------- |
-| distance
| optional | [DistanceValue](#DistanceValue "DistanceValue") | See [DistanceValue](#DistanceValue "DistanceValue") for more information. |
-| duration
| optional | [DurationValue](#DurationValue "DurationValue") | See [DurationValue](#DurationValue "DurationValue") for more information. |
-| end_location
| optional | [LatLngLiteral](#LatLngLiteral "LatLngLiteral") | See [LatLngLiteral](#LatLngLiteral "LatLngLiteral") for more information. |
-| start_location
| optional | [LatLngLiteral](#LatLngLiteral "LatLngLiteral") | See [LatLngLiteral](#LatLngLiteral "LatLngLiteral") for more information. |
-| tollSystems
| optional | Array<[DistanceTollsSystemStep](#DistanceTollsSystemStep "DistanceTollsSystemStep")> | See [DistanceTollsSystemStep](#DistanceTollsSystemStep "DistanceTollsSystemStep") for more information. |
-| tolls
| optional | Array<[DistanceTollsStep](#DistanceTollsStep "DistanceTollsStep")> | See [DistanceTollsStep](#DistanceTollsStep "DistanceTollsStep") for more information. |
-
-Example
-
-{
- "distance": {
- "text": "1 km",
- "value": 1038
- },
- "duration": {
- "text": "1 min",
- "value": 75
- },
- "start_location": {
- "lat": 49.31067,
- "lng": 4.14525
- },
- "end_location": {
- "lat": 49.31344,
- "lng": 4.15293
- }
-}
-
-Generated from the OpenAPI specification.
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancetollsresponse.html b/dist/documentation/schemas/woosmap_http_schema_distancetollsresponse.html
deleted file mode 100644
index 09a23ce2..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancetollsresponse.html
+++ /dev/null
@@ -1,242 +0,0 @@
-
-
-DistanceTollsResponse
-Attributes describing a distance tolls response.
-
-
- Example
-
-
-{
- "status": "OK",
- "routes": [
- {
- "legs": [
- {
- "distance": {
- "value": 272304,
- "text": "272 km"
- },
- "duration": {
- "value": 8834,
- "text": "2 hours 27 mins"
- },
- "start_location": {
- "lat": 43.7037562,
- "lng": 4.1217688
- },
- "end_location": {
- "lat": 45.7196995,
- "lng": 4.848819
- },
- "tolls": [
- {
- "countryCode": "FRA",
- "tollSystemRef": 0,
- "tollSystem": "ASF",
- "tollSystems": [
- 0
- ],
- "fares": [
- {
- "id": "e4626716-1e29-4f9a-905a-19f0376cfb38",
- "name": "ASF",
- "price": {
- "type": "value",
- "currency": "EUR",
- "value": 28.9
- },
- "reason": "toll",
- "paymentMethods": [
- "cash",
- "bankCard",
- "creditCard",
- "transponder",
- "travelCard"
- ],
- "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": [
- {
- "name": "MONTPELLIER (M.EST)",
- "location": {
- "lat": 43.70291,
- "lng": 4.11982
- }
- },
- {
- "name": "VIENNE",
- "location": {
- "lat": 45.4761,
- "lng": 4.83378
- }
- }
- ]
- }
- ],
- "tollSystems": [
- {
- "id": 7607,
- "name": "ASF"
- }
- ]
- }
- ],
- "bounds": {
- "northeast": {
- "lat": 45.7197,
- "lng": 4.89669
- },
- "southwest": {
- "lat": 43.7022,
- "lng": 4.11696
- }
- },
- "overview_polyline": {
- "points": "m{viG_`dXDGLUDU@a@C]GUGMOOOEQCQDMFMPGPGf@@\\H\\HPJHNF\\@N?RFTNNTVh@Rh@Nl@^zBXlAb@|A\\~@\\t@Rx@RhADl@?VCd@EZGTKRUZUL]FM?MCQISOcAaA]WwF{HcDoEgA}AkBoCeCyDuE_IqEkIoEiI_@s@gBiDmCkFkC_FmRw^sB_Ea@w@c@y@sDcHuH{NyDwH}AeD{AoDy@uBmBuFiAuDeA{DiAcFOq@w@eEk@cDs@iFo@}Fo@iI[oGSaHGmFCyEGaXGmHG}DKkEKmDWqG_@qHa@wGi@aHMsAMsAk@mGK}@i@yEKu@_@uCAKWgBU}ASoAUwAWaBgAkGm@iDWoAy@cDaAkDiAeDcAgCeAaCoAcCmAuBaCqDsAcB}@eA_BaBq@m@aCoBgBoAgBeAaAg@iBy@w@[}Bu@sM}D_Cy@gEiBmCuAaBaAwDcCs@i@sBcByAsAiBeBwB_CiBwBqCwDoAiBoCsEgAqBoBgEqAyCmA_DiAcDgAeDc@{Aq@aCu@}CQw@_AwEc@gCy@oFi@{EUgCUyCWsEOkDO{GAkHBsEB_BFoBLiDNsCf@{Hx@qLTsCdI{iAj@}INeEFcGAkDGyCUiFSqCk@cFQqA]uBw@}Dq@mCoAoEa@mAi@wAyAkDm@qAWe@}AmCw@iAgBcCoA{A_C_CwKyJaEkDiL_KsHwGwC_CsE_D_DkBmBcAmEcCeBkAwBcByAqAq@o@}AgB}AoBuAsBk@_AyAmCaAqBuAiDq@sB{@{CeDmL{@sCmB{FuBwF{BaFuAqC{@_BuBmDaBeCqBqCw@cAwAeBgAmA{CyCgD_D_BsAoC_CyG{FyByBuB_CmCaDcByBgCuDoBcDcIsNk@_A_BgCu@eAcByBmB{BaEmE_GiG_DcDwD}DmBmBsAuAcB}AoCcCcA}@s@k@}CcCgDeC{FcEuAeAmAiAmAiAuAyAiAsAe@o@sAoB}@{Au@uAw@_Bq@}AoAgDa@oAiAeEm@sCa@wB]yBUiBi@wEYuCg@{EEe@K_AGk@y@uHYeCGe@}AcMi@qDOaAeBoK{AcIwDiQwC}LqD}NkAaF}@_EuAmGo@sC_ByIWaBq@oD]oB[yBw@cFo@oDi@uDcBiKkB_LSqAw@yEc@_CcAyFo@iDiA{Fm@aDmA_GsDuPGYoCeL_CcJqAwEw@sC_DuKoC}ImCmIgAcDmAiDyDmKaDqIeDiI_@{@Ui@eAkCeEwJuSoe@iFyLmCsGkDwI}FsOSk@kE_MoHoTgDsJSi@]}@gBgEyA_Ds@uA_BsCq@gAaCkD{BqCe@k@cDeDaB{AgA_AyBcBoAy@mBgAsBiAiEyBm@YsB{@aD}As@[eFaC_Bw@gCuA{B{AqCuBwBgByLsKmC_C_EoDgB_B_Ay@qO_NyFkFoAiAyE_E{I_IOMkSsQyDoDi@g@s@s@qCuCyBgCaDcEcCkDuBeDqBmDeC{EsAuCkBsEWq@{@}BgA{CmAqDcLg^wDuLiBaGe@wAuAmEwAsEwAwEgAyDgBgHw@uDq@wDqA{JW_CUaC_@iFc@}JQiH_@}RMeEWuGI}AWuD}@mK[_DeA{Im@qEeAmH}@sFs@cEeAsFkCaM_@cB{B_J_AmDiC_JcAcDuCuIwCcImAcDmCmG}BgFcCiFyCcGwCmFiB_DcDiFsEcHuHgLwC}EwAkCiBwDuBeF{AmEe@yAoAmE_BwG_AsEy@wEc@qCIk@w@iG{@_Ji@kHa@gG}@uOm@qJ_@cH]eGGoAi@qJGaAg@kIqAyUIuAEs@e@wHiAuO_@sEUyBi@_Fk@iEgAcHy@uEs@sDEQwAiGkAsEiA_Eu@cCwDaL{AaEuCmHeEwIkCkFiCuEcBuCkAmBsFoIgNyRiCqDeD_F_A}AkGaLuAcCy@{AcEsH}AsC[k@_Tc`@{@yAyFiKkDiGmCqE}A_CcDsEuBkCuBcC{BcCaAeA}BcCa@c@c@e@s@w@yAaBsD}EgBkC}AgC}C_GgA{BqBiE}AoD}BcF}BaFiA}B{Pg[aD}Fu@oAmIcOmB{CoAcByAeBuCwC_Aw@uAcAeBeAqDsBgFmCoCyAeC{AkCgBy@o@q@g@}AqA_EuDsCuC}CeDmEcF_D{D}CaEuEsGsCkEwDiGwD{G_@o@u@yAmA}BuAgCgBoDcAmBuAqCqBuDy@}A_BuC{CaFoBcDuFqIgK}NuB_DeA_BwBkDaAeBmCeF{AaDaCqF{ByFwBwFyBgGoAcD_C{FyAcD_AqByA_DcDyGaDaHwCaH{BaGsB{FiBuFmA_E}GmUqC{IaD_JoBcFqCuGaAyBmEiJoCmF_ByCcEmHyC_FcEqGkBuC_AsAsAoBm@y@eEwFeBcCqC_EiAeBkCiEm@eAm@gAuBgEkAyB_BiDmAuCyGuPeBiEm@yA]w@aCaFg@eA}AqCgB}CgCaEwCgEeEoFkByBqFcGwHkIsCkDmBgCcCiDeBoCw@mAcDmFyCqFsB}D}AcD_AuBy@wB}@mCq@_C_AcEe@gC[oB_@kCeAiIy@kFkAyFi@qBc@sAkBaFe@eAsAmCmAuBoBwCu@cAwCyDoFmHiBgCgAaBgDmFqBeDgB_DmCeFoB}D}B}E}AoDaA_CeEyKkAcDqBeGoBsGkBsG_E_OiBsGiBuFoAiDk@sAuAyC}AsCeBiCmCqDoAwAqBqBaA{@kCoBkBmAcCqAcAe@cAa@cA[gA[gAWkCe@kAOkCOmAEeA?oCHmAHkCViCZgFh@qBLaBFkBD}@CaAEeAK{@KiASmAYy@Y{Bw@aAc@c@QiCqAmE{BeEiBo@SqCm@cAO{AMw@Iu@C{A?yBD_AF}BVaCh@gAZeCx@cAb@uDzAgC`AeA\\eCp@cARyC`@w@FmADmC@}@CmCQqAQ{@OcAUiCs@oDsA{@]cBq@o@WsAm@iGgC_IcDi@S{@a@kQsH_FcCuBeA_CsAqD_CeCeB}BgB_CmB{BuBMMoBiBe@c@mAyAaBiB_AgAyEgG}KgO{BwCaCwC_@e@qCcDwBaCwA{A_DoCiCqBiBoAyA_A}BoAiAi@aBw@wCiAgCy@QGy@SwCs@}Cm@sB[iH}@cAIkBQ{D[}He@sCMo@?uE?aCDkF^u@HqBXkDn@iAViCn@mAb@y@PqBd@cDr@gC^cBR}ADmBB}BAeBKo@E}@MyAUuA[oBk@yAi@qCkA}DmBgG{CmB_AoBy@q@WgE}AqBm@sCs@{Be@mASiDa@oAIwAE_A?eBFuARiBd@k@RiB~@]Pu@j@]Tk@f@e@f@gAvAgA~Aa@p@wCxFcEbJkCnFq@rAcAjBs@hA{CzE}@fAgAnAyAxAYXo@j@_BrA}BbB}@l@cBbAsHjEkEbCoKjGoBbA}BbAq@XwChAoCjAm@VgHnCgBp@a@NcBf@c@TiGfCqDpAsLtEuJpDuDxAmAh@aBv@q@^yFlDmAz@eAt@qBnAmBpAmBlAmBpAkD|B{HdF{E~CaLpHeDtBmMxI{DhC[TmGdEuc@xYiAv@{FtDeGlEyBdBwD`DgE|DsDpDiBnBqElFqE|FmBlCiCxDqEjHcBvCaCnEIN{ChGaDhHuElLqBjFk@zAgCxGkBrEqArC}BtEq@nAiCbEkBdCmAvAeAfAkAdAgCpBqBjAmAn@gAf@{Bz@kBh@oB`@gAPiCVyCL_B@kC?yIMkCFyADwBNkAL_ANuB`@q@N{@RmA\\aAZoAf@kBx@{BlAsAx@wCrBwAhAmAfAeC`CmAnAaAbAiBrB}AfBcJzKuCfDsD|DuDnD{@r@uAhAwDrCiBnAiBhAoAr@}Ax@}HrDmJdEiDvA}Ap@kDrAyC`AgAXsCj@sATeBNsCPyDFqBEkCMqBOiSuBiBSiHu@mDg@uAYeBa@wBm@sBs@{CsAkBcAmAu@gMgIkTwN_SoMwDgC_C}Aa_@mVez@mj@yIgGsFcEcG_F{FiFyBuBsIqIwNeOm@m@}@_AkHqH{GaHqFqFwBoB{BeBw@k@aC}AeCuA_CgAaDoAaA[gAYkEaAeAOuBYgBOaFUiAEaGOgACw@Ac@Ac@?iEM_Sa@iCCmC@eBFoBHqALwAPeBZwAVwA^iA\\wAf@eBp@aBt@sDfBwJhF{FtCoFjCmD|AmBt@iBp@mDfAsA^cEdAiB\\mEt@{C`@kBR}@JoDZaDPmQnAaEV_OdAyG^oI`@_FRoDJgGRwGLoDDeJHiC@wX?iGCkMBoAByBFuCDiCFsBFa@BiADiHb@mBLsBN{Iz@iD`@mDd@iGbAcF|@qLbC{M|CgKxBoEv@uDl@uEn@gIz@sE`@gk@vEcCPmDXmD\\i`@`DcCT{Jv@oFd@gIl@gHf@_CNqJf@qELgB@yDD_HEaBCwDKwBKsBGsAKcEYkBQmBQgCYaH_AiEs@kAUk@Ki@Ke@I]ImCi@mEiAaHmBaEoAyHsC_DqAuDaBkAk@{F{CcHeEm@[oBoAyAeAsB{AyHoG}AuA_CuBeIcIiHeIkC{CcBuBk@q@yBiCmBuBqBsBsBsBgD}CgDoCyAiAaBkAgAw@mD{BoBiAeEwB}As@cCcAeE{AiCy@yC{@mCo@mE{@y@UcF_A_F_AkN{CuD{@oGgBcAY_AYUGqDiAwE_BeA]aBk@eEcBeBs@sEoBsDaBkFmCk@[gIkE{SuLqDmByCyAqCoAyEgBuFiB}Bk@mBe@{E_AuB[iEi@aCSaDSqEQwAEwCC}CCoIIeHIsJMoDGaLI{FIuDGaCEkX[mACuHW_Fa@iBSaEk@kASiDq@kAW_EkAiCy@aC{@w@YyAm@yCsAqBcAeFsCwDeC{AeAiFgE}AsAyAuAqCqC}@_Ao@u@oAwAsD{Ek@s@_@k@_AsAyBgDwC_Fs@kAwFiKaIsOgBeDmD_HwB{D}CqFaBmCiCaEyAyBcGeIaCyC{AgBeCqC_DgDeCeC{GiGwFsEqDkCmCkB_DqB_JiFo@]gFeCcCeA_CaAq@YqAg@_C_AsB{@cRyGkPqFu@UoImCQGoBm@uHyBkA]cMiDgHeBqEw@iCc@aEe@cDW{AIgEM_DGeD?wEFmCDgGTeFVwE\\sALwLlAuG|@_BVcKhByE`AsFrAyCt@eGdB{IpCe[rKgQhGWHq@VcLzDuE`B]Jg@PuAh@kAb@mHtC_Ab@aEbBiKvEsAp@sCtAeItDcEfB{DzAiDnAuBr@yDjA{Bl@{EhAeCn@aCd@qIxAsBZqBVsDb@aGj@oDXqDVmGZeFPwDHcEDmIBcHAoNCa@?uMCgQLaNRkJTsJZ_Md@yOx@mIXiCH_@?c@@oGBaCAkEIcFQsE[kHs@_@CwB[iC]{E{@oFiASESC{Bi@iEgAcJsBmGsAkFeAkDm@kEq@yGy@uCYsFc@uCWaJg@s@AsG[iE]q@EYA{@?wC?mCM_S{@s@CcGO}BMcBIkDMgEKmBC}B?yCDgAD_EVeBPkBVqB\\uDv@iCr@_Cv@mBr@gBt@mAj@yAt@cAj@{CfBsSdN}D~BiGfDsEtBwB|@}Aj@wFjBu@VeCr@}Bh@gCj@yDv@oEv@aJxAqHpA_MtBy@LkC\\uGx@kFh@cAHwF\\oDPqHLuDB{GGeEIgGWw@GwCOoSwA{Jw@yDa@gDi@y@MkCm@{Aa@qA[aCu@cEoAeF}AuAc@qFsAmEy@{B]aAKeCUyAKcEOoDC}B?aCFy@D_Kl@gBNmIf@sCJcEFcA?mFIoDQsAKcCWeC]sB[kBa@_B_@{Cw@sBo@qBq@}B_AsF_C_Bo@aGoCw@]qFeCkAg@yBaAeAc@u@[cNkGqAm@eCiAy@[kGqC_DuAm@[gJmEkDgB{CaBq@_@kBeAUMwBsAgFiDoA}@wDuCqF{EoBoBgAiA{@aAmCaD{CeEeBiCgEkH_B_Dy@gBwCeHuAyDQg@cAaDgBiGkB_IyAuHmAgH_Fc\\sA}HcAiF}@{DgA_E]kAaBiFa@kA_AcCu@iBs@_BaAwBkA_CeB_DoAwBoAmBmBmC_CwCY]]a@yB_C_B}AmFwEsD{CiUwQoQ{NuMmKcNsKaGiEoFmDcF{CuDqBqCuAkAi@o@[_EeBsAi@iE}A_IiC}MgE{FcBsEoAwBi@cBc@eDs@gEy@cCe@uQuCoFw@_m@iJs]gFkC]oWqDwFw@qC_@gd@gGgGw@yGw@uEc@iCSeDQeBGaCG{CEkA?{FFkDJwDRYBkE\\eBPg@FcH|@_QfCuDd@cEb@g@BsCRcDL}BB}E?yDKaCK}@G_CScCWuCa@qF_AsCm@YKUGiF{Ae@OsFiBgIuCg@Q{h@aRoE}AmG{ByCcA_A[s@Ww@Y_Cw@cA]mC_AiDaAyAc@oKoCsDo@mB]{AUkDe@qB[aBWmC[oB[wAU{B]oIoAeC]gBUwAQcAK}@KyCWuEUgCKgEEmBBcGHwDL{G^}CLoCHsA?aCCgAE}C[oASwB_@iAWkA[gC{@uAi@u@[yBkAcBeAeCaByBcBiCsBiByAi@_@iG}E]YcIkGcBoAo@i@mDgDs@y@wE_Gm@o@cB}Aw@o@w@k@yEiCeBq@iA]cAWaAQuC[cI]gFUaFYuBWgASwFoAsBa@}@MaAIgACy@?aBHsAL}@Lc@LeBf@aA`@]RcDjBsAn@cBl@wBj@q@LuAP{O~AcAH_BRmBPaBViB\\}LrCkBd@mBh@s@RyAh@aA`@oB|@eBz@wBlAi@TmAd@gAZuAXgAL{AHqB@oCQ_AIiAUkDu@sEaAuA[oAU_B[s@MkB]y@KeAImACu@Ci@?g@@yADeBNaC^qBd@YHoAf@q@Tu@\\yB|@qIlD_DlAsBr@QD[H}@XeB^uB`@aBT_CX_BN_AFuAFaCDeIFqGLaBL_CZoAPyBd@k@LiAZcBf@uBx@mB|@{PlJwDjBuD`Bs@VcA`@}Ah@yEvAyDz@iB\\w@LkDh@eAPsCV{CTqBJo@BaGJyDAmR]iJQoEIsIMgC?uA@kELcBJg@BaY~AyAFmFXmCL}BFsCFmEBuC?o@A{CCiAEoHWkIo@{Eg@yEk@mGeAuN}CuGyAwDs@wB]iAOyEg@uF[mEKuCAiA@mFL{CLoBJeDTkY|AsWzAa@BiBL{BR_D`@uDp@wCn@sDbA{DrAqDzA_ErB}@d@iAn@aCzAyAbAsAbAcDrC}ApAsDhD{@z@{@t@[RiAx@mAr@o@Z]Pq@^y@X{@XiDr@cCV_DLuEM_Dc@iBc@qA_@_A_@]O{Aw@m@]w@g@wB_ByAuAuA{AcBuBqGwI}@oAgD{Dk@m@gDyCoAeAkBsAkAs@{@i@kAo@mAm@{B_AqBq@cBk@yAa@wA[{AWgBUeEa@cCOeCIcCBeBJkD^oARcK`C_BPmANyALyABsBAgBG}AKsDg@qDcAoDuAiDkBwEgDqB{AeL}IgHuFwJsHsJuHyAsAiBgBiAmAqCcDiC_DuCuDiDgEgBuBiAmAsAoAgCyBoCkBeC}AQKSKiDwA{B{@{Cw@wB]_Ca@yE[kBE_DBsEZeFr@sq@rOaOhDyDdA}Af@yAh@_C`AaBv@wEdC_HzDkB|@{B|@kBl@_AVmAXyB`@aCZkAJcBHiCDsB?sCCo@C_BAcDIgLYiHMk@AiGO{BGmBCk@CoFMO?Y?a^s@iJWaEG}BAeE@}AD{BLiBPgCZwAToAVyCv@}Br@yBx@oBx@mB~@{@f@yAz@uDfCiBzA[XUR}ArA}ApAmAbA_BhAsBpAu@^cBv@uAd@mAZsCd@wAPwCd@qAV_AViA^}An@}Av@cAl@sBxAuAjAyEjEgF|EuBdBeAv@y@h@w@d@}Ar@eA^]Lo@Rm@PwAZ{@LsBPoBHwA@yBK_AGu@MgB[mBe@wBs@y@[}Ae@uBi@}AYkBUeCKgBBu@@aBJqBVkAT_Bb@y@Xm@RyBbAiAn@aAn@sAbA{BtBy@~@q@z@qAhBe@r@W`@qAdCm@tAaAbCs@xBaAjDi@dCiA~Es@lC]tAg@xA_BzDe@`As@tAo@dA}AxBk@r@iBnBw@r@w@p@mBrA}BpAgAd@aA^w@VkBh@_Cp@yN~D}CdA_C|@uBz@aDxAgCrAqDtBoAv@eBjAa@VqCrBeCtBmAlA_BfBqA`BwBtCsDbFwAhBgAjAcAdAyArA_Av@kBvAo@b@yCdB}BhAsCnA}VjKeBv@uAr@g@ZQH}AbA_Ar@u@l@u@r@aBjBmA|A_AtAw@pAmA~B_AnBsCnFsAxBcAzA{@fAmCtCkBbBkA`ASLyAdAe@XuCzAoBx@eCx@sCp@}@RiCZeBLkCDwCEqBKcBMcZiCcIs@cCQkCMuAEiCCiA@oDL}DXyDj@qCj@qBh@sC|@wChAk@ViB~@gBbAaB`AgAr@eBrAk@^oB|AwE`EuBjBqAhA{BnBqC~BoNzLwEdEkGjF{F`FiA~@eAr@_@VeAn@q@\\mBx@qBn@iBb@s@LiBRy@FsBF{BEgCSmBYaCi@oBc@kPiEoE_A}@MwAK}@Cs@Cg@?cCFmBNgBVwBd@gBh@iBt@i@VmAp@{AbAmA~@{AxAyA|Aq@x@iA|AsB`D_FlHoBxCmCxD{AjBiApAmDfDy@r@qCpBmAv@sAt@ULsB`AqAd@}Ah@eAZ{A^aBZ_CZ_DXsAFc@?oB?eCE_IYeACoLe@oO]oACyB@qD?aFFcJH}@B_IZS@iCNkEVwJx@{Db@wKtAuHlA_[tFyB^iJdBmJbBk`@bHmB`@]Hk@JgFbA{J|AcCZkAJeAJcEN{C@kBCkCKqAIcCSoBWmRwBqDe@_Eo@qFkAaB]oMsCcGkAaBQkACgBDg@FsARuA\\aBl@}Az@kA|@g@f@oErEsAjAc@ZgAp@cBv@{@V_APaALmAHaA?aAGyAKy@McC]oBW_Fs@sAOwG{@qBQiBIgBIqAAsAAmA@aBDsFXqABgCAcDMoBO_AKyB[aBYyA[aBe@_EkA}@[yB_A}@a@qCwAwBsAqA{@cBmA{AmAo@i@yBuBwZgYuDiDyBqBiG{F_EwDwCoCkEaEaA{@gAgA_A}@sCmCg@e@_FsEaQ_PSQmAcA{CsBk@c@qAo@kAi@cAc@{@[s@UyBm@wBa@{AS_CSiAGoC?kA@u@BuBLiBToB\\aCj@mA`@kBt@mAh@_A`@c@Tk@V_@PmAh@oLfFq@VaDdAkCn@wB`@{C`@wBL}@BiBDgA?iAGqDY_BQoASqEy@eEaAeIcBwIkBgLeCqQsDgCm@_B[oGsA{D}@aCe@aDs@mLcCgDs@kNyCcHwA{GyAiE_AcEy@qCe@qFw@_Ee@}AOuKu@w@EiGU{BIoDA{BAq@@iCB{@BmCH{BF_@@_@@qDKeCMcAKo@KkBa@aAMs@Ko@Ai@Ck@BmALwCf@_AL}APc@@W?oFE_BIaAIs@MyA]iA[qFeBi@QsA]uAYmAMk@Ck@?iADe@DgAPc@JkA`@oAl@mGbDeBx@wAj@g@Pg@He@FkAHkA@qAIgAQeAYe@QcAe@iAs@a@[iAcAiAoAkAyAeFiHq@_AqC{Du@cAy@}@u@s@s@i@k@[eAa@cA[]Im@K[EmAMeAC}ABkBFgERwDHq@BoBDu@AoBKiB]_CeASKm@a@m@e@k@k@oA}Ae@q@]m@c@}@q@}ASi@[_AcAuCg@qAs@}Ak@eAw@oAg@o@}@cAkAkAgAaA_D_DqDcDwAwAu@cA]i@g@_Ac@}@{@wBqAaEoB}G]uA_EaN}@cCy@kBg@_Ai@{@kA{Ak@m@o@q@e@a@_BgA{@c@s@]s@Uy@W}AYuAKgHYoBQeAO_@KyAa@q@UaNkFyBu@eBc@m@M}AY}AOm@EeCCyA@_AF}ANaC`@}A`@qAd@aCdAeBbA{B~AuBbBoBdBuC|BoBnAeB`AaC`AuG|BoC`A{HhCaEvAc@TUJi@Xk@^a@Zu@r@w@`Ak@|@mAbCi@|Aa@~AQx@WfBIz@K|AIbC@tBPpFRjFBrA?fBE|AGdAMrAc@bDc@`Cg@~BqAfFs@hC{@lCu@rBy@zBoA~CKXKR}AtDa@x@qB`E}@bBGHeAjBiBzCiDdF{FzHcEfFoEdFyB`CkClCkDjDsElEuEfEyKtJa@Z{AlA{AlAoDrCyFhEyEfDqCfBqBjAuBdAkE`BkCfAeDdBgBhAm@b@wBbBo@j@yCxCuA|Ao@v@_@d@yAtBm@`Am@bAkAxBaApB{ApDi@tAiA`DeAtCu@fBiAxB_A|Ak@z@}BzCuBrBiA~@kAz@iAr@cAh@qAn@sDjBeHjDsHbDoDxAsEhBa@Rq@Tw@Ze@RwFnBgA`@sDnA}EzAwCr@cFpAqE`AoB^g@JgBVkEp@iEj@{AP_Ed@mAJoCPmCPkCLeC@cBIyBS{@Qy@Q}@WaBo@e@UoAs@_@WkByAwAsA_CcCmC_D{AoB{AuBiHmKyEgGqDiEwCaDcCcCeE{D{DcDeCiBsDeCkBiA_FuCsGmDwGcDeEqBuCoAyFyB}JuD_UmIiEeB_Aa@kIuDgB{@mHuDiBcAs@_@qAw@cEcCkAs@kFqD}CyB{DaDi@c@s@m@WUaCqB}AuAq@o@iBgBmDmDyPaR_EeEw@w@qCwCoJcJiC}BkJgIyGsFiF{DgDaCoCgBaBaAaFgCgEkBeCeAgGuBwHuBsF}AiIiCyK{DeHsCgVmKkBs@mA_@eAWyBi@{Bc@gDi@_AKo@CWEkESi@AmBC{ABu@@}AFcEVs@FwKt@kHf@{BPuE\\c@FmAJy@Js@HqBV_Fr@o@J{PfCcBXu@LQBwAHo@J_AZ_A^g@RoAd@oAZoB`@eANcAHmADkAAsAMq@Mm@Qa@MqE{AcA]q@MuB[eAIqBIyA?_CJuBVmAT[DcAVcAZkG|BeCp@}AVcAH_@DsAFeK`@aHXiCHu@DwDToAHi@DaGRsCDiABoA?WAqAAe@?]KQGQKQOQUUk@I_@MiAKeBIsBKmEOmDE_AKwBUsFEs@MuCMoCSuD@W@sA?cAB]PaAKuBS]OYSQ[MOUc@c@]@_@Fa@V}@L}@HkBLS?gAFFxFLnL@rAB`C@n@BhA?RAl@yA`@QD"
- }
- }
- ]
-}
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancetollsresponse.md b/dist/documentation/schemas/woosmap_http_schema_distancetollsresponse.md
deleted file mode 100644
index ee3cf74e..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancetollsresponse.md
+++ /dev/null
@@ -1,161 +0,0 @@
-
-
-DistanceTollsResponse
-
-Attributes describing a distance tolls response.
-
-| Field | Required | Type | Description |
-| :--------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| routes
| optional | Array<[DistanceTollsElementsResponse](#DistanceTollsElementsResponse "DistanceTollsElementsResponse")> | |
-| status
| optional | [DistanceStatus](#DistanceStatus "DistanceStatus") | See [DistanceStatus](#DistanceStatus "DistanceStatus") for more information. |
-
-Example
-
-{
- "status": "OK",
- "routes": [
- {
- "legs": [
- {
- "distance": {
- "value": 272304,
- "text": "272 km"
- },
- "duration": {
- "value": 8834,
- "text": "2 hours 27 mins"
- },
- "start_location": {
- "lat": 43.7037562,
- "lng": 4.1217688
- },
- "end_location": {
- "lat": 45.7196995,
- "lng": 4.848819
- },
- "tolls": [
- {
- "countryCode": "FRA",
- "tollSystemRef": 0,
- "tollSystem": "ASF",
- "tollSystems": [
- 0
- ],
- "fares": [
- {
- "id": "e4626716-1e29-4f9a-905a-19f0376cfb38",
- "name": "ASF",
- "price": {
- "type": "value",
- "currency": "EUR",
- "value": 28.9
- },
- "reason": "toll",
- "paymentMethods": [
- "cash",
- "bankCard",
- "creditCard",
- "transponder",
- "travelCard"
- ],
- "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": [
- {
- "name": "MONTPELLIER (M.EST)",
- "location": {
- "lat": 43.70291,
- "lng": 4.11982
- }
- },
- {
- "name": "VIENNE",
- "location": {
- "lat": 45.4761,
- "lng": 4.83378
- }
- }
- ]
- }
- ],
- "tollSystems": [
- {
- "id": 7607,
- "name": "ASF"
- }
- ]
- }
- ],
- "bounds": {
- "northeast": {
- "lat": 45.7197,
- "lng": 4.89669
- },
- "southwest": {
- "lat": 43.7022,
- "lng": 4.11696
- }
- },
- "overview_polyline": {
- "points": "m{viG_`dXDGLUDU@a@C]GUGMOOOEQCQDMFMPGPGf@@\\H\\HPJHNF\\@N?RFTNNTVh@Rh@Nl@^zBXlAb@|A\\~@\\t@Rx@RhADl@?VCd@EZGTKRUZUL]FM?MCQISOcAaA]WwF{HcDoEgA}AkBoCeCyDuE_IqEkIoEiI_@s@gBiDmCkFkC_FmRw^sB_Ea@w@c@y@sDcHuH{NyDwH}AeD{AoDy@uBmBuFiAuDeA{DiAcFOq@w@eEk@cDs@iFo@}Fo@iI[oGSaHGmFCyEGaXGmHG}DKkEKmDWqG_@qHa@wGi@aHMsAMsAk@mGK}@i@yEKu@_@uCAKWgBU}ASoAUwAWaBgAkGm@iDWoAy@cDaAkDiAeDcAgCeAaCoAcCmAuBaCqDsAcB}@eA_BaBq@m@aCoBgBoAgBeAaAg@iBy@w@[}Bu@sM}D_Cy@gEiBmCuAaBaAwDcCs@i@sBcByAsAiBeBwB_CiBwBqCwDoAiBoCsEgAqBoBgEqAyCmA_DiAcDgAeDc@{Aq@aCu@}CQw@_AwEc@gCy@oFi@{EUgCUyCWsEOkDO{GAkHBsEB_BFoBLiDNsCf@{Hx@qLTsCdI{iAj@}INeEFcGAkDGyCUiFSqCk@cFQqA]uBw@}Dq@mCoAoEa@mAi@wAyAkDm@qAWe@}AmCw@iAgBcCoA{A_C_CwKyJaEkDiL_KsHwGwC_CsE_D_DkBmBcAmEcCeBkAwBcByAqAq@o@}AgB}AoBuAsBk@_AyAmCaAqBuAiDq@sB{@{CeDmL{@sCmB{FuBwF{BaFuAqC{@_BuBmDaBeCqBqCw@cAwAeBgAmA{CyCgD_D_BsAoC_CyG{FyByBuB_CmCaDcByBgCuDoBcDcIsNk@_A_BgCu@eAcByBmB{BaEmE_GiG_DcDwD}DmBmBsAuAcB}AoCcCcA}@s@k@}CcCgDeC{FcEuAeAmAiAmAiAuAyAiAsAe@o@sAoB}@{Au@uAw@_Bq@}AoAgDa@oAiAeEm@sCa@wB]yBUiBi@wEYuCg@{EEe@K_AGk@y@uHYeCGe@}AcMi@qDOaAeBoK{AcIwDiQwC}LqD}NkAaF}@_EuAmGo@sC_ByIWaBq@oD]oB[yBw@cFo@oDi@uDcBiKkB_LSqAw@yEc@_CcAyFo@iDiA{Fm@aDmA_GsDuPGYoCeL_CcJqAwEw@sC_DuKoC}ImCmIgAcDmAiDyDmKaDqIeDiI_@{@Ui@eAkCeEwJuSoe@iFyLmCsGkDwI}FsOSk@kE_MoHoTgDsJSi@]}@gBgEyA_Ds@uA_BsCq@gAaCkD{BqCe@k@cDeDaB{AgA_AyBcBoAy@mBgAsBiAiEyBm@YsB{@aD}As@[eFaC_Bw@gCuA{B{AqCuBwBgByLsKmC_C_EoDgB_B_Ay@qO_NyFkFoAiAyE_E{I_IOMkSsQyDoDi@g@s@s@qCuCyBgCaDcEcCkDuBeDqBmDeC{EsAuCkBsEWq@{@}BgA{CmAqDcLg^wDuLiBaGe@wAuAmEwAsEwAwEgAyDgBgHw@uDq@wDqA{JW_CUaC_@iFc@}JQiH_@}RMeEWuGI}AWuD}@mK[_DeA{Im@qEeAmH}@sFs@cEeAsFkCaM_@cB{B_J_AmDiC_JcAcDuCuIwCcImAcDmCmG}BgFcCiFyCcGwCmFiB_DcDiFsEcHuHgLwC}EwAkCiBwDuBeF{AmEe@yAoAmE_BwG_AsEy@wEc@qCIk@w@iG{@_Ji@kHa@gG}@uOm@qJ_@cH]eGGoAi@qJGaAg@kIqAyUIuAEs@e@wHiAuO_@sEUyBi@_Fk@iEgAcHy@uEs@sDEQwAiGkAsEiA_Eu@cCwDaL{AaEuCmHeEwIkCkFiCuEcBuCkAmBsFoIgNyRiCqDeD_F_A}AkGaLuAcCy@{AcEsH}AsC[k@_Tc`@{@yAyFiKkDiGmCqE}A_CcDsEuBkCuBcC{BcCaAeA}BcCa@c@c@e@s@w@yAaBsD}EgBkC}AgC}C_GgA{BqBiE}AoD}BcF}BaFiA}B{Pg[aD}Fu@oAmIcOmB{CoAcByAeBuCwC_Aw@uAcAeBeAqDsBgFmCoCyAeC{AkCgBy@o@q@g@}AqA_EuDsCuC}CeDmEcF_D{D}CaEuEsGsCkEwDiGwD{G_@o@u@yAmA}BuAgCgBoDcAmBuAqCqBuDy@}A_BuC{CaFoBcDuFqIgK}NuB_DeA_BwBkDaAeBmCeF{AaDaCqF{ByFwBwFyBgGoAcD_C{FyAcD_AqByA_DcDyGaDaHwCaH{BaGsB{FiBuFmA_E}GmUqC{IaD_JoBcFqCuGaAyBmEiJoCmF_ByCcEmHyC_FcEqGkBuC_AsAsAoBm@y@eEwFeBcCqC_EiAeBkCiEm@eAm@gAuBgEkAyB_BiDmAuCyGuPeBiEm@yA]w@aCaFg@eA}AqCgB}CgCaEwCgEeEoFkByBqFcGwHkIsCkDmBgCcCiDeBoCw@mAcDmFyCqFsB}D}AcD_AuBy@wB}@mCq@_C_AcEe@gC[oB_@kCeAiIy@kFkAyFi@qBc@sAkBaFe@eAsAmCmAuBoBwCu@cAwCyDoFmHiBgCgAaBgDmFqBeDgB_DmCeFoB}D}B}E}AoDaA_CeEyKkAcDqBeGoBsGkBsG_E_OiBsGiBuFoAiDk@sAuAyC}AsCeBiCmCqDoAwAqBqBaA{@kCoBkBmAcCqAcAe@cAa@cA[gA[gAWkCe@kAOkCOmAEeA?oCHmAHkCViCZgFh@qBLaBFkBD}@CaAEeAK{@KiASmAYy@Y{Bw@aAc@c@QiCqAmE{BeEiBo@SqCm@cAO{AMw@Iu@C{A?yBD_AF}BVaCh@gAZeCx@cAb@uDzAgC`AeA\\eCp@cARyC`@w@FmADmC@}@CmCQqAQ{@OcAUiCs@oDsA{@]cBq@o@WsAm@iGgC_IcDi@S{@a@kQsH_FcCuBeA_CsAqD_CeCeB}BgB_CmB{BuBMMoBiBe@c@mAyAaBiB_AgAyEgG}KgO{BwCaCwC_@e@qCcDwBaCwA{A_DoCiCqBiBoAyA_A}BoAiAi@aBw@wCiAgCy@QGy@SwCs@}Cm@sB[iH}@cAIkBQ{D[}He@sCMo@?uE?aCDkF^u@HqBXkDn@iAViCn@mAb@y@PqBd@cDr@gC^cBR}ADmBB}BAeBKo@E}@MyAUuA[oBk@yAi@qCkA}DmBgG{CmB_AoBy@q@WgE}AqBm@sCs@{Be@mASiDa@oAIwAE_A?eBFuARiBd@k@RiB~@]Pu@j@]Tk@f@e@f@gAvAgA~Aa@p@wCxFcEbJkCnFq@rAcAjBs@hA{CzE}@fAgAnAyAxAYXo@j@_BrA}BbB}@l@cBbAsHjEkEbCoKjGoBbA}BbAq@XwChAoCjAm@VgHnCgBp@a@NcBf@c@TiGfCqDpAsLtEuJpDuDxAmAh@aBv@q@^yFlDmAz@eAt@qBnAmBpAmBlAmBpAkD|B{HdF{E~CaLpHeDtBmMxI{DhC[TmGdEuc@xYiAv@{FtDeGlEyBdBwD`DgE|DsDpDiBnBqElFqE|FmBlCiCxDqEjHcBvCaCnEIN{ChGaDhHuElLqBjFk@zAgCxGkBrEqArC}BtEq@nAiCbEkBdCmAvAeAfAkAdAgCpBqBjAmAn@gAf@{Bz@kBh@oB`@gAPiCVyCL_B@kC?yIMkCFyADwBNkAL_ANuB`@q@N{@RmA\\aAZoAf@kBx@{BlAsAx@wCrBwAhAmAfAeC`CmAnAaAbAiBrB}AfBcJzKuCfDsD|DuDnD{@r@uAhAwDrCiBnAiBhAoAr@}Ax@}HrDmJdEiDvA}Ap@kDrAyC`AgAXsCj@sATeBNsCPyDFqBEkCMqBOiSuBiBSiHu@mDg@uAYeBa@wBm@sBs@{CsAkBcAmAu@gMgIkTwN_SoMwDgC_C}Aa_@mVez@mj@yIgGsFcEcG_F{FiFyBuBsIqIwNeOm@m@}@_AkHqH{GaHqFqFwBoB{BeBw@k@aC}AeCuA_CgAaDoAaA[gAYkEaAeAOuBYgBOaFUiAEaGOgACw@Ac@Ac@?iEM_Sa@iCCmC@eBFoBHqALwAPeBZwAVwA^iA\\wAf@eBp@aBt@sDfBwJhF{FtCoFjCmD|AmBt@iBp@mDfAsA^cEdAiB\\mEt@{C`@kBR}@JoDZaDPmQnAaEV_OdAyG^oI`@_FRoDJgGRwGLoDDeJHiC@wX?iGCkMBoAByBFuCDiCFsBFa@BiADiHb@mBLsBN{Iz@iD`@mDd@iGbAcF|@qLbC{M|CgKxBoEv@uDl@uEn@gIz@sE`@gk@vEcCPmDXmD\\i`@`DcCT{Jv@oFd@gIl@gHf@_CNqJf@qELgB@yDD_HEaBCwDKwBKsBGsAKcEYkBQmBQgCYaH_AiEs@kAUk@Ki@Ke@I]ImCi@mEiAaHmBaEoAyHsC_DqAuDaBkAk@{F{CcHeEm@[oBoAyAeAsB{AyHoG}AuA_CuBeIcIiHeIkC{CcBuBk@q@yBiCmBuBqBsBsBsBgD}CgDoCyAiAaBkAgAw@mD{BoBiAeEwB}As@cCcAeE{AiCy@yC{@mCo@mE{@y@UcF_A_F_AkN{CuD{@oGgBcAY_AYUGqDiAwE_BeA]aBk@eEcBeBs@sEoBsDaBkFmCk@[gIkE{SuLqDmByCyAqCoAyEgBuFiB}Bk@mBe@{E_AuB[iEi@aCSaDSqEQwAEwCC}CCoIIeHIsJMoDGaLI{FIuDGaCEkX[mACuHW_Fa@iBSaEk@kASiDq@kAW_EkAiCy@aC{@w@YyAm@yCsAqBcAeFsCwDeC{AeAiFgE}AsAyAuAqCqC}@_Ao@u@oAwAsD{Ek@s@_@k@_AsAyBgDwC_Fs@kAwFiKaIsOgBeDmD_HwB{D}CqFaBmCiCaEyAyBcGeIaCyC{AgBeCqC_DgDeCeC{GiGwFsEqDkCmCkB_DqB_JiFo@]gFeCcCeA_CaAq@YqAg@_C_AsB{@cRyGkPqFu@UoImCQGoBm@uHyBkA]cMiDgHeBqEw@iCc@aEe@cDW{AIgEM_DGeD?wEFmCDgGTeFVwE\\sALwLlAuG|@_BVcKhByE`AsFrAyCt@eGdB{IpCe[rKgQhGWHq@VcLzDuE`B]Jg@PuAh@kAb@mHtC_Ab@aEbBiKvEsAp@sCtAeItDcEfB{DzAiDnAuBr@yDjA{Bl@{EhAeCn@aCd@qIxAsBZqBVsDb@aGj@oDXqDVmGZeFPwDHcEDmIBcHAoNCa@?uMCgQLaNRkJTsJZ_Md@yOx@mIXiCH_@?c@@oGBaCAkEIcFQsE[kHs@_@CwB[iC]{E{@oFiASESC{Bi@iEgAcJsBmGsAkFeAkDm@kEq@yGy@uCYsFc@uCWaJg@s@AsG[iE]q@EYA{@?wC?mCM_S{@s@CcGO}BMcBIkDMgEKmBC}B?yCDgAD_EVeBPkBVqB\\uDv@iCr@_Cv@mBr@gBt@mAj@yAt@cAj@{CfBsSdN}D~BiGfDsEtBwB|@}Aj@wFjBu@VeCr@}Bh@gCj@yDv@oEv@aJxAqHpA_MtBy@LkC\\uGx@kFh@cAHwF\\oDPqHLuDB{GGeEIgGWw@GwCOoSwA{Jw@yDa@gDi@y@MkCm@{Aa@qA[aCu@cEoAeF}AuAc@qFsAmEy@{B]aAKeCUyAKcEOoDC}B?aCFy@D_Kl@gBNmIf@sCJcEFcA?mFIoDQsAKcCWeC]sB[kBa@_B_@{Cw@sBo@qBq@}B_AsF_C_Bo@aGoCw@]qFeCkAg@yBaAeAc@u@[cNkGqAm@eCiAy@[kGqC_DuAm@[gJmEkDgB{CaBq@_@kBeAUMwBsAgFiDoA}@wDuCqF{EoBoBgAiA{@aAmCaD{CeEeBiCgEkH_B_Dy@gBwCeHuAyDQg@cAaDgBiGkB_IyAuHmAgH_Fc\\sA}HcAiF}@{DgA_E]kAaBiFa@kA_AcCu@iBs@_BaAwBkA_CeB_DoAwBoAmBmBmC_CwCY]]a@yB_C_B}AmFwEsD{CiUwQoQ{NuMmKcNsKaGiEoFmDcF{CuDqBqCuAkAi@o@[_EeBsAi@iE}A_IiC}MgE{FcBsEoAwBi@cBc@eDs@gEy@cCe@uQuCoFw@_m@iJs]gFkC]oWqDwFw@qC_@gd@gGgGw@yGw@uEc@iCSeDQeBGaCG{CEkA?{FFkDJwDRYBkE\\eBPg@FcH|@_QfCuDd@cEb@g@BsCRcDL}BB}E?yDKaCK}@G_CScCWuCa@qF_AsCm@YKUGiF{Ae@OsFiBgIuCg@Q{h@aRoE}AmG{ByCcA_A[s@Ww@Y_Cw@cA]mC_AiDaAyAc@oKoCsDo@mB]{AUkDe@qB[aBWmC[oB[wAU{B]oIoAeC]gBUwAQcAK}@KyCWuEUgCKgEEmBBcGHwDL{G^}CLoCHsA?aCCgAE}C[oASwB_@iAWkA[gC{@uAi@u@[yBkAcBeAeCaByBcBiCsBiByAi@_@iG}E]YcIkGcBoAo@i@mDgDs@y@wE_Gm@o@cB}Aw@o@w@k@yEiCeBq@iA]cAWaAQuC[cI]gFUaFYuBWgASwFoAsBa@}@MaAIgACy@?aBHsAL}@Lc@LeBf@aA`@]RcDjBsAn@cBl@wBj@q@LuAP{O~AcAH_BRmBPaBViB\\}LrCkBd@mBh@s@RyAh@aA`@oB|@eBz@wBlAi@TmAd@gAZuAXgAL{AHqB@oCQ_AIiAUkDu@sEaAuA[oAU_B[s@MkB]y@KeAImACu@Ci@?g@@yADeBNaC^qBd@YHoAf@q@Tu@\\yB|@qIlD_DlAsBr@QD[H}@XeB^uB`@aBT_CX_BN_AFuAFaCDeIFqGLaBL_CZoAPyBd@k@LiAZcBf@uBx@mB|@{PlJwDjBuD`Bs@VcA`@}Ah@yEvAyDz@iB\\w@LkDh@eAPsCV{CTqBJo@BaGJyDAmR]iJQoEIsIMgC?uA@kELcBJg@BaY~AyAFmFXmCL}BFsCFmEBuC?o@A{CCiAEoHWkIo@{Eg@yEk@mGeAuN}CuGyAwDs@wB]iAOyEg@uF[mEKuCAiA@mFL{CLoBJeDTkY|AsWzAa@BiBL{BR_D`@uDp@wCn@sDbA{DrAqDzA_ErB}@d@iAn@aCzAyAbAsAbAcDrC}ApAsDhD{@z@{@t@[RiAx@mAr@o@Z]Pq@^y@X{@XiDr@cCV_DLuEM_Dc@iBc@qA_@_A_@]O{Aw@m@]w@g@wB_ByAuAuA{AcBuBqGwI}@oAgD{Dk@m@gDyCoAeAkBsAkAs@{@i@kAo@mAm@{B_AqBq@cBk@yAa@wA[{AWgBUeEa@cCOeCIcCBeBJkD^oARcK`C_BPmANyALyABsBAgBG}AKsDg@qDcAoDuAiDkBwEgDqB{AeL}IgHuFwJsHsJuHyAsAiBgBiAmAqCcDiC_DuCuDiDgEgBuBiAmAsAoAgCyBoCkBeC}AQKSKiDwA{B{@{Cw@wB]_Ca@yE[kBE_DBsEZeFr@sq@rOaOhDyDdA}Af@yAh@_C`AaBv@wEdC_HzDkB|@{B|@kBl@_AVmAXyB`@aCZkAJcBHiCDsB?sCCo@C_BAcDIgLYiHMk@AiGO{BGmBCk@CoFMO?Y?a^s@iJWaEG}BAeE@}AD{BLiBPgCZwAToAVyCv@}Br@yBx@oBx@mB~@{@f@yAz@uDfCiBzA[XUR}ArA}ApAmAbA_BhAsBpAu@^cBv@uAd@mAZsCd@wAPwCd@qAV_AViA^}An@}Av@cAl@sBxAuAjAyEjEgF|EuBdBeAv@y@h@w@d@}Ar@eA^]Lo@Rm@PwAZ{@LsBPoBHwA@yBK_AGu@MgB[mBe@wBs@y@[}Ae@uBi@}AYkBUeCKgBBu@@aBJqBVkAT_Bb@y@Xm@RyBbAiAn@aAn@sAbA{BtBy@~@q@z@qAhBe@r@W`@qAdCm@tAaAbCs@xBaAjDi@dCiA~Es@lC]tAg@xA_BzDe@`As@tAo@dA}AxBk@r@iBnBw@r@w@p@mBrA}BpAgAd@aA^w@VkBh@_Cp@yN~D}CdA_C|@uBz@aDxAgCrAqDtBoAv@eBjAa@VqCrBeCtBmAlA_BfBqA`BwBtCsDbFwAhBgAjAcAdAyArA_Av@kBvAo@b@yCdB}BhAsCnA}VjKeBv@uAr@g@ZQH}AbA_Ar@u@l@u@r@aBjBmA|A_AtAw@pAmA~B_AnBsCnFsAxBcAzA{@fAmCtCkBbBkA`ASLyAdAe@XuCzAoBx@eCx@sCp@}@RiCZeBLkCDwCEqBKcBMcZiCcIs@cCQkCMuAEiCCiA@oDL}DXyDj@qCj@qBh@sC|@wChAk@ViB~@gBbAaB`AgAr@eBrAk@^oB|AwE`EuBjBqAhA{BnBqC~BoNzLwEdEkGjF{F`FiA~@eAr@_@VeAn@q@\\mBx@qBn@iBb@s@LiBRy@FsBF{BEgCSmBYaCi@oBc@kPiEoE_A}@MwAK}@Cs@Cg@?cCFmBNgBVwBd@gBh@iBt@i@VmAp@{AbAmA~@{AxAyA|Aq@x@iA|AsB`D_FlHoBxCmCxD{AjBiApAmDfDy@r@qCpBmAv@sAt@ULsB`AqAd@}Ah@eAZ{A^aBZ_CZ_DXsAFc@?oB?eCE_IYeACoLe@oO]oACyB@qD?aFFcJH}@B_IZS@iCNkEVwJx@{Db@wKtAuHlA_[tFyB^iJdBmJbBk`@bHmB`@]Hk@JgFbA{J|AcCZkAJeAJcEN{C@kBCkCKqAIcCSoBWmRwBqDe@_Eo@qFkAaB]oMsCcGkAaBQkACgBDg@FsARuA\\aBl@}Az@kA|@g@f@oErEsAjAc@ZgAp@cBv@{@V_APaALmAHaA?aAGyAKy@McC]oBW_Fs@sAOwG{@qBQiBIgBIqAAsAAmA@aBDsFXqABgCAcDMoBO_AKyB[aBYyA[aBe@_EkA}@[yB_A}@a@qCwAwBsAqA{@cBmA{AmAo@i@yBuBwZgYuDiDyBqBiG{F_EwDwCoCkEaEaA{@gAgA_A}@sCmCg@e@_FsEaQ_PSQmAcA{CsBk@c@qAo@kAi@cAc@{@[s@UyBm@wBa@{AS_CSiAGoC?kA@u@BuBLiBToB\\aCj@mA`@kBt@mAh@_A`@c@Tk@V_@PmAh@oLfFq@VaDdAkCn@wB`@{C`@wBL}@BiBDgA?iAGqDY_BQoASqEy@eEaAeIcBwIkBgLeCqQsDgCm@_B[oGsA{D}@aCe@aDs@mLcCgDs@kNyCcHwA{GyAiE_AcEy@qCe@qFw@_Ee@}AOuKu@w@EiGU{BIoDA{BAq@@iCB{@BmCH{BF_@@_@@qDKeCMcAKo@KkBa@aAMs@Ko@Ai@Ck@BmALwCf@_AL}APc@@W?oFE_BIaAIs@MyA]iA[qFeBi@QsA]uAYmAMk@Ck@?iADe@DgAPc@JkA`@oAl@mGbDeBx@wAj@g@Pg@He@FkAHkA@qAIgAQeAYe@QcAe@iAs@a@[iAcAiAoAkAyAeFiHq@_AqC{Du@cAy@}@u@s@s@i@k@[eAa@cA[]Im@K[EmAMeAC}ABkBFgERwDHq@BoBDu@AoBKiB]_CeASKm@a@m@e@k@k@oA}Ae@q@]m@c@}@q@}ASi@[_AcAuCg@qAs@}Ak@eAw@oAg@o@}@cAkAkAgAaA_D_DqDcDwAwAu@cA]i@g@_Ac@}@{@wBqAaEoB}G]uA_EaN}@cCy@kBg@_Ai@{@kA{Ak@m@o@q@e@a@_BgA{@c@s@]s@Uy@W}AYuAKgHYoBQeAO_@KyAa@q@UaNkFyBu@eBc@m@M}AY}AOm@EeCCyA@_AF}ANaC`@}A`@qAd@aCdAeBbA{B~AuBbBoBdBuC|BoBnAeB`AaC`AuG|BoC`A{HhCaEvAc@TUJi@Xk@^a@Zu@r@w@`Ak@|@mAbCi@|Aa@~AQx@WfBIz@K|AIbC@tBPpFRjFBrA?fBE|AGdAMrAc@bDc@`Cg@~BqAfFs@hC{@lCu@rBy@zBoA~CKXKR}AtDa@x@qB`E}@bBGHeAjBiBzCiDdF{FzHcEfFoEdFyB`CkClCkDjDsElEuEfEyKtJa@Z{AlA{AlAoDrCyFhEyEfDqCfBqBjAuBdAkE`BkCfAeDdBgBhAm@b@wBbBo@j@yCxCuA|Ao@v@_@d@yAtBm@`Am@bAkAxBaApB{ApDi@tAiA`DeAtCu@fBiAxB_A|Ak@z@}BzCuBrBiA~@kAz@iAr@cAh@qAn@sDjBeHjDsHbDoDxAsEhBa@Rq@Tw@Ze@RwFnBgA`@sDnA}EzAwCr@cFpAqE`AoB^g@JgBVkEp@iEj@{AP_Ed@mAJoCPmCPkCLeC@cBIyBS{@Qy@Q}@WaBo@e@UoAs@_@WkByAwAsA_CcCmC_D{AoB{AuBiHmKyEgGqDiEwCaDcCcCeE{D{DcDeCiBsDeCkBiA_FuCsGmDwGcDeEqBuCoAyFyB}JuD_UmIiEeB_Aa@kIuDgB{@mHuDiBcAs@_@qAw@cEcCkAs@kFqD}CyB{DaDi@c@s@m@WUaCqB}AuAq@o@iBgBmDmDyPaR_EeEw@w@qCwCoJcJiC}BkJgIyGsFiF{DgDaCoCgBaBaAaFgCgEkBeCeAgGuBwHuBsF}AiIiCyK{DeHsCgVmKkBs@mA_@eAWyBi@{Bc@gDi@_AKo@CWEkESi@AmBC{ABu@@}AFcEVs@FwKt@kHf@{BPuE\\c@FmAJy@Js@HqBV_Fr@o@J{PfCcBXu@LQBwAHo@J_AZ_A^g@RoAd@oAZoB`@eANcAHmADkAAsAMq@Mm@Qa@MqE{AcA]q@MuB[eAIqBIyA?_CJuBVmAT[DcAVcAZkG|BeCp@}AVcAH_@DsAFeK`@aHXiCHu@DwDToAHi@DaGRsCDiABoA?WAqAAe@?]KQGQKQOQUUk@I_@MiAKeBIsBKmEOmDE_AKwBUsFEs@MuCMoCSuD@W@sA?cAB]PaAKuBS]OYSQ[MOUc@c@]@_@Fa@V}@L}@HkBLS?gAFFxFLnL@rAB`C@n@BhA?RAl@yA`@QD"
- }
- }
- ]
-}
-
-Generated from the OpenAPI specification.
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancetollsstep.html b/dist/documentation/schemas/woosmap_http_schema_distancetollsstep.html
deleted file mode 100644
index f69e3b03..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancetollsstep.html
+++ /dev/null
@@ -1,68 +0,0 @@
-
-
-DistanceTollsStep
-
- Detail of tolls to be paid for traversing the specified section. Directly come
- from Here API
-
-
-
-
- | Field |
- Required |
- Type |
- Description |
-
-
-
-
-
-
- countryCode
-
- |
- optional |
- string |
-
-
- |
-
-
-
-Example
-
-{
- "tolls": "some_value"
-}
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancetollsstep.md b/dist/documentation/schemas/woosmap_http_schema_distancetollsstep.md
deleted file mode 100644
index 9a16d923..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancetollsstep.md
+++ /dev/null
@@ -1,22 +0,0 @@
-
-
-DistanceTollsStep
-
-Detail of tolls to be paid for traversing the specified section. Directly come from Here API
-
-| Field | Required | Type | Description |
-| :--------------------------------------------------------------------------------------------------------------- | -------- | ------ | ------------------------------------------------------------------ |
-| countryCode
| optional | string | |
-
-Example
-
-{
- "tolls": "some_value"
-}
-
-Generated from the OpenAPI specification.
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancetollssystemstep.html b/dist/documentation/schemas/woosmap_http_schema_distancetollssystemstep.html
deleted file mode 100644
index b2c2749d..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancetollssystemstep.html
+++ /dev/null
@@ -1,88 +0,0 @@
-
-
-
- DistanceTollsSystemStep
-
-
- An array of toll authorities that collect payments for the use of (part of)
- the specified section of the route. Directly come from Here API
-
-
-
-
- | Field |
- Required |
- Type |
- Description |
-
-
-
-
-
-
- id
-
- |
- optional |
- integer |
-
-
- |
-
-
-
-
- name
-
- |
- optional |
- string |
-
-
- |
-
-
-
-
- Example
-
-
-{
- "id": 12,
- "name": "ASF"
-}
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancetollssystemstep.md b/dist/documentation/schemas/woosmap_http_schema_distancetollssystemstep.md
deleted file mode 100644
index d4656980..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancetollssystemstep.md
+++ /dev/null
@@ -1,24 +0,0 @@
-
-
-DistanceTollsSystemStep
-
-An array of toll authorities that collect payments for the use of (part of) the specified section of the route. Directly come from Here API
-
-| Field | Required | Type | Description |
-| :------------------------------------------------------------------------------------------------------- | -------- | ------- | ----------------------------------------------------------------------- |
-| id
| optional | integer | |
-| name
| optional | string | |
-
-Example
-
-{
- "id": 12,
- "name": "ASF"
-}
-
-Generated from the OpenAPI specification.
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancevalue.html b/dist/documentation/schemas/woosmap_http_schema_distancevalue.html
deleted file mode 100644
index 235b8b3d..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancevalue.html
+++ /dev/null
@@ -1,86 +0,0 @@
-
-
-DistanceValue
-
- The total distance expressed in meters (value) and as text. The textual value
- uses the unit system specified with the units parameter of the original
- request.
-
-
-
-
- | Field |
- Required |
- Type |
- Description |
-
-
-
-
-
-
- text
-
- |
- optional |
- string |
-
-
- The readable distance using the unit system specified.
-
- |
-
-
-
-
- value
-
- |
- optional |
- number |
-
-
- The distance in meters.
-
- |
-
-
-
-Example
-
-{
- "value": 2775.1,
- "text": "2.8 km"
-}
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_distancevalue.md b/dist/documentation/schemas/woosmap_http_schema_distancevalue.md
deleted file mode 100644
index 90059886..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_distancevalue.md
+++ /dev/null
@@ -1,24 +0,0 @@
-
-
-DistanceValue
-
-The total distance expressed in meters (value) and as text. The textual value uses the unit system specified with the units parameter of the original request.
-
-| Field | Required | Type | Description |
-| :----------------------------------------------------------------------------------------------- | -------- | ------ | ------------------------------------------------------------------------------------------------------------ |
-| text
| optional | string | The readable distance using the unit system specified.
|
-| value
| optional | number | |
-
-Example
-
-{
- "value": 2775.1,
- "text": "2.8 km"
-}
-
-Generated from the OpenAPI specification.
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_durationvalue.html b/dist/documentation/schemas/woosmap_http_schema_durationvalue.html
deleted file mode 100644
index 404eaa7b..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_durationvalue.html
+++ /dev/null
@@ -1,86 +0,0 @@
-
-
-DurationValue
-
- The total duration to travel this route/leg, expressed in seconds (value) and
- as text. The textual value gives a structured string for duration in the
- specified language (if available).
-
-
-
-
- | Field |
- Required |
- Type |
- Description |
-
-
-
-
-
-
- text
-
- |
- optional |
- string |
-
-
- The readable duration value
-
- |
-
-
-
-
- value
-
- |
- optional |
- number |
-
-
- The duration in seconds
-
- |
-
-
-
-Example
-
-{
- "value": 272.5,
- "text": "5 mins"
-}
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_durationvalue.md b/dist/documentation/schemas/woosmap_http_schema_durationvalue.md
deleted file mode 100644
index 8822a36b..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_durationvalue.md
+++ /dev/null
@@ -1,24 +0,0 @@
-
-
-DurationValue
-
-The total duration to travel this route/leg, expressed in seconds (value) and as text. The textual value gives a structured string for duration in the specified language (if available).
-
-| Field | Required | Type | Description |
-| :----------------------------------------------------------------------------------------------- | -------- | ------ | --------------------------------------------------------------------------------- |
-| text
| optional | string | The readable duration value
|
-| value
| optional | number | |
-
-Example
-
-{
- "value": 272.5,
- "text": "5 mins"
-}
-
-Generated from the OpenAPI specification.
-✎ Edit
-bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_encodedpolyline.html b/dist/documentation/schemas/woosmap_http_schema_encodedpolyline.html
deleted file mode 100644
index d8551d2e..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_encodedpolyline.html
+++ /dev/null
@@ -1,73 +0,0 @@
-
-
-EncodedPolyline
-
- The polyline of the route (encoded with the
- poyline algorithm).
-
-
-
-
- | Field |
- Required |
- Type |
- Description |
-
-
-
-
-
-
- points
-
- |
- optional |
- string |
-
-
- The encoded string value for points of the polyline
-
- |
-
-
-
-Example
-
-{
- "points": "a_jyHfol@aAfEzGlIfER~JqV_KqLu@pDiHv@bAfEeCfE"
-}
-
- Generated from the
- OpenAPI specification.
- ✎ Edit
- bug_report Report bug
-
-
-
diff --git a/dist/documentation/schemas/woosmap_http_schema_encodedpolyline.md b/dist/documentation/schemas/woosmap_http_schema_encodedpolyline.md
deleted file mode 100644
index abd623dd..00000000
--- a/dist/documentation/schemas/woosmap_http_schema_encodedpolyline.md
+++ /dev/null
@@ -1,22 +0,0 @@
-
-
-EncodedPolyline
-
-The polyline of the route (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm)).
-
-| Field | Required | Type | Description |
-| :--------------------------------------------------------------------------------------------------- | -------- | ------ | --------------------------------------------------------------------------------------------------------- |
-| points
| optional | string | The encoded string value for points of the polyline
|
-
-Example
-
-{
- "points": "a_jyHfol@aAfEzGlIfER~JqV_KqLu@pDiHv@bAfEeCfE"
-}
-
-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 bd5786f4..fffc0baa 100755
--- a/dist/merged-woosmap-openapi3.json
+++ b/dist/merged-woosmap-openapi3.json
@@ -53,13 +53,6 @@
"url": "https://developers.woosmap.com/products/address-api/get-started/"
}
},
- {
- "name": "Distance API",
- "description": "Woosmap Distance API is a service providing road travel distance and duration calculations, on a Worldwide scale. Request is done over HTTPS using GET or POST. 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/distance-api/get-started/"
- }
- },
{
"name": "Zones API",
"description": "Woosmap Zones API is a web service that uses an HTTP request to manage, create or edit your Zones (polygons) attached to your assets.\nThe general principle is that sometimes searching assets using crowfly distance is not good enough. For example to search the restaurant that will do the delivery for a specified address, each restaurant has a delivery zone and for topological or business reasons it’s not always the nearest restaurant in charge of your delivery. Woosmap Zones API allows you to associate a delivery zone to each of the restaurants.\n",
@@ -94,23 +87,37 @@
},
{
"name": "Datasets API",
- "description": "The Datasets API enables you to store, manage, and analyze geospatial data collections. Work with custom datasets containing points, lines, or polygons - with each feature defined by its geometry and properties.\n\n* Create and manage datasets from uploaded Shapefile data\n* Import data from external sources via URL or scheduled updates\n* Monitor dataset status and processing through detailed status reports\n* Schedule dataset deletion for proper data lifecycle management\n* Leverage high accuracy storage for location-dependent business processes\n\nIdeal for applications that require precise location analysis, spatial queries and geographic data management.\n",
+ "description": "Manage the full lifecycle of your geospatial data alongside powerful analysis and retrieval.\n\n* **Management:** Programmatically create datasets, import features in bulk (CSV/GeoJSON), and handle updates or deletions.\n* **Search:** Execute **Nearby**, **Contains**, **Intersects**, and **Within** queries using SQL-like `WHERE` filters.\n* **Features:** Direct access to individual geographic features by unique ID with field masking. \n\nIdeal for applications that require precise location analysis, spatial queries and geographic data management.\n",
"externalDocs": {
"url": "https://developers.woosmap.com/products/datasets-api/get-started/"
}
},
{
- "name": "Datasets API - Search",
- "description": "Perform powerful spatial analysis on your geospatial data with four key search capabilities:\n\n* Nearby search: Find features within a specified distance from a location\n* Contains search: Discover which features completely contain a point or geometry\n* Intersects search: Identify features that intersect with a given geometry\n* Within search: Locate features that fall entirely inside a specified boundary\n\nAll operations support attribute filtering with WHERE clauses, pagination for large results, and multiple geometry formats (GeoJSON, WKB, encoded polylines).\n",
+ "name": "Isochrone API",
+ "description": "Woosmap Isochrone API is a service providing all destinations that can be reached in a specific amount of time or a maximum travel distance. Request is done over HTTPS using GET or POST. 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/datasets-api/first-queries/"
+ "url": "https://developers.woosmap.com/products/distance-api/features/isochrone/"
}
},
{
- "name": "Datasets API - Features",
- "description": "Access and retrieve individual geographic features from your datasets by their unique ID. This endpoint provides direct access to the complete geometry and properties of specific features within your datasets.\n\nThe API supports field masking to optimize response size by retrieving only needed attributes. Output formats include both GeoJSON and WKB, allowing flexible integration with various mapping and analysis systems.\n",
+ "name": "Tolls API",
+ "description": "Woosmap Tolls API is a service providing toll costs and informations for an origin and destination pair. Request is done over HTTPS using GET or POST. 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/datasets-api/get-started/"
+ "url": "https://developers.woosmap.com/products/distance-api/features/tolls/"
+ }
+ },
+ {
+ "name": "Route API",
+ "description": "Woosmap Route API is a service providing road travel distance and duration calculations, on a Worldwide scale. Request is done over HTTPS using GET or POST. 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/distance-api/features/route/"
+ }
+ },
+ {
+ "name": "Matrix API",
+ "description": "Woosmap Matrix API is a service providing travel distance and time for a matrix of origins and destinations. Request is done over HTTPS using GET or POST. 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/distance-api/features/distancematrix/"
}
}
],
@@ -5186,344 +5193,389 @@
]
}
},
- "/distance/distancematrix/json": {
+ "/maps/static": {
"get": {
- "summary": "Distance Matrix",
- "operationId": "getDistanceMatrix",
- "servers": [
- {
- "url": "https://api.woosmap.com"
- }
- ],
"tags": [
- "Distance API"
+ "Static Map API"
],
- "description": "Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode.\n",
+ "summary": "Get Static Map",
+ "description": "Retrieve a static map\n\n**Rate limit**: `20/1s`",
+ "operationId": "get_static_map_maps_static_get",
"security": [
{
- "Woosmap_Platform_API_Reference_PublicApiKeyAuth": [],
- "Woosmap_Platform_API_Reference_RefererHeader": []
+ "Maps_PublicAPIKey": []
},
{
- "Woosmap_Platform_API_Reference_PrivateApiKeyAuth": []
+ "Maps_PrivateApiKey": []
},
{
- "Woosmap_Platform_API_Reference_PrivateApiKeyHeaderAuth": []
+ "Maps_PrivateApiKeyHeader": []
}
],
"parameters": [
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_origins"
+ "name": "language",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Language"
+ }
+ },
+ {
+ "name": "lat",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "number",
+ "maximum": 90,
+ "minimum": -90,
+ "title": "Lat"
+ },
+ "example": "43.6"
+ },
+ {
+ "name": "lng",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "number",
+ "maximum": 180,
+ "minimum": -180,
+ "title": "Lng"
+ },
+ "example": "3.883"
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_destinations"
+ "name": "zoom",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "number",
+ "maximum": 24,
+ "minimum": 0,
+ "description": "The zoom",
+ "title": "Zoom"
+ },
+ "description": "The zoom",
+ "example": 11
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_mode"
+ "name": "width",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "maximum": 640,
+ "minimum": 40,
+ "title": "Width"
+ },
+ "example": 400
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_language-4"
+ "name": "height",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "maximum": 640,
+ "minimum": 40,
+ "title": "Height"
+ },
+ "example": 400
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_units"
+ "name": "markers",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "contentMediaType": "application/json",
+ "contentSchema": {
+ "$ref": "#/components/schemas/Maps_MarkerWithUrlOptions"
+ }
+ },
+ "description": "Adds a marker.\n \nThe images are by default are considered to be non retina images (pixel resolution=1)\n\nIf the image name contains @2x or the query parameter retina=yes are found in the marker url the image will be considered to be retina (pixel resolution=2).\n\n> Note: the image size in bytes cannot exceed 65535 bytes.\n \n ",
+ "title": "Markers"
+ },
+ "description": "Adds a marker.\n \nThe images are by default are considered to be non retina images (pixel resolution=1)\n\nIf the image name contains @2x or the query parameter retina=yes are found in the marker url the image will be considered to be retina (pixel resolution=2).\n\n> Note: the image size in bytes cannot exceed 65535 bytes.\n \n ",
+ "example": "{\"lat\": 43.6, \"lng\": 3.883, \"url\": \"https://webapp.woosmap.com/img/geolocated_marker.png?retina=yes\"}"
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_elements"
+ "name": "polylines",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "contentMediaType": "application/json",
+ "contentSchema": {
+ "$ref": "#/components/schemas/Maps_PolylineOptions"
+ }
+ },
+ "description": "Add a polyline.\n \n> Note: enc should be a google encoded polyline see [Google-encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) for more information\n\n ",
+ "title": "Polylines"
+ },
+ "description": "Add a polyline.\n \n> Note: enc should be a google encoded polyline see [Google-encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) for more information\n\n ",
+ "example": "{\"enc\": \"ydjiG_}jVjn@cjAf`AycBnc@mqCp\\\\ewBrQmlBzrAeuCreBw_C\", \"color\": \"magenta\", \"weight\": 4}"
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_method"
+ "name": "polygons",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "contentMediaType": "application/json",
+ "contentSchema": {
+ "$ref": "#/components/schemas/Maps_PolygonOptions"
+ }
+ },
+ "description": "Adds a polygon.\n \n> Note: shape should be a google encoded polyline see [Google-encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) for more information\n ",
+ "title": "Polygons"
+ },
+ "description": "Adds a polygon.\n \n> Note: shape should be a google encoded polyline see [Google-encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) for more information\n ",
+ "example": "{\"shape\": \"ymgiGm|rV~uAtaB|dAefCqeBwuFu~@njC??\", \"fill_color\": \"rgba(255, 20, 147, 0.5)\", \"color\": \"rgba(199, 21, 133, 0.7)\"}"
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_avoid"
+ "name": "stylers",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string",
+ "contentMediaType": "application/json",
+ "contentSchema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Maps_MapStyle"
+ }
+ }
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Stylers"
+ },
+ "example": "[{\"featureType\": \"points_of_interest.business\", \"stylers\":[{\"visibility\": \"off\"}]}]"
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_departure_time"
+ "name": "retina",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false,
+ "title": "Retina"
+ }
}
],
"responses": {
"200": {
- "description": "Distance Matrix successfully retrieved",
+ "description": "Successful Response",
"content": {
- "application/json": {
+ "image/webp": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceMatrixResponse"
- },
- "examples": {
- "default": {
- "summary": "Distance Matrix Result for driving from origins `48.709,2.403` to destinations `48.709,2.303|48.768,2.338`,",
- "value": {
- "status": "OK",
- "rows": [
- {
- "elements": [
- {
- "status": "OK",
- "duration": {
- "value": 978,
- "text": "16 mins"
- },
- "distance": {
- "value": 10796,
- "text": "10.8 km"
- }
- },
- {
- "status": "OK",
- "duration": {
- "value": 942,
- "text": "16 mins"
- },
- "distance": {
- "value": 10322,
- "text": "10.3 km"
- }
- }
- ]
- }
- ]
- }
- }
+ "type": "string",
+ "format": "binary"
}
}
}
},
"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/Maps_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "402": {
+ "description": "Out of free quota.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Maps_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/Maps_AuthenticationErrorResponse"
}
}
}
},
- "429": {
- "description": "Too Many Requests. The rate limit for this endpoint has been exceeded.",
+ "422": {
+ "description": "Validation Error",
"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/Maps_HTTPValidationError"
}
}
}
- }
- },
- "x-codeSamples": [
- {
- "lang": "curl",
- "label": "cURL",
- "source": "curl -L 'https://api.woosmap.com/distance/distancematrix/json?origins=48.709%2C2.403&destinations=48.709%2C2.303%7C48.768%2C2.338&mode=driving&language=en&elements=duration_distance&method=distance&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/distance/distancematrix/json?origins=48.709%2C2.403&destinations=48.709%2C2.303%7C48.768%2C2.338&mode=driving&language=en&elements=duration_distance&method=distance&key=YOUR_PUBLIC_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/distance/distancematrix/json?origins=48.709%2C2.403&destinations=48.709%2C2.303%7C48.768%2C2.338&mode=driving&language=en&elements=duration_distance&method=distance&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"
- }
- ]
- },
- "post": {
- "summary": "Distance Matrix using POST",
- "operationId": "postDistanceMatrix",
- "servers": [
- {
- "url": "https://api.woosmap.com"
+ "429": {
+ "description": "Rate limit reached",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Maps_HTTPErrorModel"
+ }
+ }
+ }
}
- ],
+ }
+ }
+ },
+ "/what3words/convert-to-3wa": {
+ "get": {
"tags": [
- "Distance API"
+ "Woosmap for what3words API"
],
- "description": "Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode. If the URL size is too short for your origins and destinations, you should request the server using this POST method and passing arguments as json.\n",
+ "summary": "Convert To What 3 Words",
+ "description": "This function will convert a latitude and longitude to a 3 word address, in the language of your choice.\nIt also returns country, the bounds of the grid square,\na nearby place (such as a local town) and a link to the what3words map site.\n\n**Rate limit**: `20/1s`",
+ "operationId": "convert_to_what_3_words_what3words_convert_to_3wa_get",
"security": [
{
- "Woosmap_Platform_API_Reference_PublicApiKeyAuth": [],
- "Woosmap_Platform_API_Reference_RefererHeader": []
+ "External-api-wrapper_what3words_PublicAPIKey": []
},
{
- "Woosmap_Platform_API_Reference_PrivateApiKeyAuth": []
+ "External-api-wrapper_what3words_PrivateApiKey": []
},
{
- "Woosmap_Platform_API_Reference_PrivateApiKeyHeaderAuth": []
+ "External-api-wrapper_what3words_PrivateApiKeyHeader": []
}
],
- "requestBody": {
- "description": "The request body of Distance Matrix must be formatted as JSON.",
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceMatrixRequest"
- },
- "examples": {
- "default": {
- "summary": "Request as a JSON for a distance matrix call",
- "value": {
- "origins": "48.73534,2.368308|48.73534,2.368308",
- "destinations": "48.83534,2.368308",
- "units": "imperial",
- "elements": "duration_distance",
- "method": "distance",
- "departure_time": "now"
- }
- }
- }
- }
+ "parameters": [
+ {
+ "name": "coordinates",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "description": "Coordinates as a comma separated string of latitude and longitude",
+ "examples": [
+ "48.858304,2.294514"
+ ],
+ "title": "Coordinates"
+ },
+ "description": "Coordinates as a comma separated string of latitude and longitude"
+ },
+ {
+ "name": "format",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "enum": [
+ "json",
+ "geojson"
+ ],
+ "type": "string",
+ "description": "Return data format type; can be either json or geojson",
+ "default": "json",
+ "title": "Format"
+ },
+ "description": "Return data format type; can be either json or geojson"
+ },
+ {
+ "name": "language",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "description": "A supported address language as an ISO 639-1 2 letter code.",
+ "default": "en",
+ "title": "Language"
+ },
+ "description": "A supported address language as an ISO 639-1 2 letter code."
}
- },
+ ],
"responses": {
"200": {
- "description": "Distance Matrix with POST successfully retrieved",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceMatrixResponse"
- },
- "examples": {
- "default": {
- "summary": "Distance Matrix Result for driving from origins `48.73534,2.368308|48.73534,2.368308` to destinations `48.83534,2.368308`,",
- "value": {
- "status": "OK",
- "rows": [
- {
- "elements": [
- {
- "status": "OK",
- "duration": {
- "value": 978,
- "text": "16 mins"
- },
- "distance": {
- "value": 10796,
- "text": "10.8 km"
- }
- },
- {
- "status": "OK",
- "duration": {
- "value": 942,
- "text": "16 mins"
- },
- "distance": {
- "value": 10322,
- "text": "10.3 km"
- }
- }
- ]
- }
- ]
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_JsonCoordinatesResponse"
+ },
+ {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_GeoJsonCoordinatesResponse"
}
- }
+ ],
+ "title": "Response Convert To What 3 Words What3Words Convert To 3Wa Get"
}
}
}
},
- "400": {
- "description": "Invalid. The data is not a valid JSON.",
+ "401": {
+ "description": "Unable to locate credentials.",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Error400"
- },
- "examples": {
- "Invalid": {
- "summary": "Error 400",
- "value": {
- "status": "error",
- "value": "The request is invalid, the data is not a valid JSON."
- }
- }
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_AuthenticationErrorResponse"
}
}
}
},
- "401": {
- "description": "Unauthorized. Incorrect authentication credentials.",
+ "402": {
+ "description": "Out of free quota.",
"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/External-api-wrapper_what3words_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/External-api-wrapper_what3words_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_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/External-api-wrapper_what3words_HTTPErrorModel"
}
}
}
@@ -5533,324 +5585,125 @@
{
"lang": "curl",
"label": "cURL",
- "source": "curl -L 'https://api.woosmap.com/distance/distancematrix/json?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"origins\": \"48.73534,2.368308|48.73534,2.368308\",\n \"destinations\": \"48.83534,2.368308\",\n \"units\": \"imperial\",\n \"elements\": \"duration_distance\",\n \"method\": \"distance\",\n \"departure_time\": \"now\"\n}'"
+ "source": "curl -L -X GET 'https://api.woosmap.com/what3words/convert-to-3wa?coordinates=48.858304,2.294514&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
},
{
"lang": "python",
"label": "Python",
- "source": "import requests\nimport json\n\nurl = \"https://api.woosmap.com/distance/distancematrix/json?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"origins\": \"48.73534,2.368308|48.73534,2.368308\",\n \"destinations\": \"48.83534,2.368308\",\n \"units\": \"imperial\",\n \"elements\": \"duration_distance\",\n \"method\": \"distance\",\n \"departure_time\": \"now\"\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
+ "source": "import requests\n\nurl = \"https://api.woosmap.com/what3words/convert-to-3wa?coordinates=48.858304,2.294514&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"
},
{
- "lang": "nodejs",
- "label": "NodeJS",
- "source": "const axios = require('axios');\nlet data = JSON.stringify({\n \"origins\": \"48.73534,2.368308|48.73534,2.368308\",\n \"destinations\": \"48.83534,2.368308\",\n \"units\": \"imperial\",\n \"elements\": \"duration_distance\",\n \"method\": \"distance\",\n \"departure_time\": \"now\"\n});\n\nlet config = {\n method: 'post',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/distance/distancematrix/json?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"
+ "lang": "javascript",
+ "label": "JavaScript",
+ "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/what3words/convert-to-3wa?coordinates=48.858304,2.294514&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
}
]
}
},
- "/distance/route/json": {
+ "/what3words/convert-to-address": {
"get": {
- "summary": "Route",
- "operationId": "getRoute",
- "servers": [
- {
- "url": "https://api.woosmap.com"
- }
- ],
"tags": [
- "Distance API"
+ "Woosmap for what3words API"
],
- "description": "Get distance, duration and path (as a polyline) for a pair of origin and destination, based on the recommended route between those two points for a specified travel mode.\n",
+ "summary": "Convert To Address",
+ "description": "This function converts a 3 word address to a list of address.\nIt will return at most the 5 closest addresses to the what3words provided.\n\n**Rate limit**: `20/1s`",
+ "operationId": "convert_to_address_what3words_convert_to_address_get",
"security": [
{
- "Woosmap_Platform_API_Reference_PublicApiKeyAuth": [],
- "Woosmap_Platform_API_Reference_RefererHeader": []
+ "External-api-wrapper_what3words_PublicAPIKey": []
},
{
- "Woosmap_Platform_API_Reference_PrivateApiKeyAuth": []
+ "External-api-wrapper_what3words_PrivateApiKey": []
},
{
- "Woosmap_Platform_API_Reference_PrivateApiKeyHeaderAuth": []
+ "External-api-wrapper_what3words_PrivateApiKeyHeader": []
}
],
"parameters": [
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_origin"
- },
- {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_destination"
- },
- {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_mode"
- },
- {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_language-4"
- },
- {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_units"
- },
- {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_alternatives"
- },
- {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_waypoints"
- },
- {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_method"
- },
- {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_details"
- },
- {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_avoid"
- },
- {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_departure_time"
+ "name": "words",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "description": "A 3 word address as a string. It must be three words separated with dots or a japanese middle dot character (・). Words separated by spaces will be rejected. Optionally, the 3 word address can be prefixed with /// (which would be encoded as %2F%2F%2F)",
+ "examples": [
+ "couch.spotted.amended"
+ ],
+ "title": "Words"
+ },
+ "description": "A 3 word address as a string. It must be three words separated with dots or a japanese middle dot character (・). Words separated by spaces will be rejected. Optionally, the 3 word address can be prefixed with /// (which would be encoded as %2F%2F%2F)"
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_arrival_time"
+ "name": "language",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "description": "A supported address language as an ISO 639-1 2 letter code.",
+ "default": "en",
+ "title": "Language"
+ },
+ "description": "A supported address language as an ISO 639-1 2 letter code."
}
],
"responses": {
"200": {
- "description": "Route successfully retrieved",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceRouteResponse"
- },
- "examples": {
- "default": {
- "summary": "Distance Route Result for driving from origin `49.31067,4.14525` to destination `49.31344,4.15293` and retrieving alternatives routes.",
- "value": {
- "status": "OK",
- "routes": [
- {
- "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@eAHO"
- },
- "bounds": {
- "northeast": {
- "lat": 49.315678,
- "lng": 4.152915
- },
- "southwest": {
- "lat": 49.31073,
- "lng": 4.145162
- }
- },
- "notice": "",
- "legs": [
- {
- "distance": {
- "text": "1 km",
- "value": 1038
- },
- "duration": {
- "text": "1 min",
- "value": 75
- },
- "start_location": {
- "lat": 49.31067,
- "lng": 4.14525
- },
- "end_location": {
- "lat": 49.31344,
- "lng": 4.15293
- },
- "start_waypoint": 0,
- "end_waypoint": 1,
- "end_address": "D 30",
- "start_address": "D 151",
- "steps": [
- {
- "distance": "676 m",
- "duration": "1 min",
- "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
- },
- "end_location": {
- "lat": 49.315679,
- "lng": 4.149621
- },
- "travel_mode": "DRIVING",
- "instructions": {
- "action": 2,
- "summary": "Drive northeast on D 151.",
- "verbal_succint": "Drive northeast. Then Enter the roundabout and take the 2nd exit onto D 30.",
- "verbal_before": "Drive northeast on D 151. Then Enter the roundabout and take the 2nd exit onto D 30.",
- "verbal_after": "Continue for 700 meters."
- }
- },
- {
- "distance": "22 m",
- "duration": "1 min",
- "polyline": "}}~kHcniXBIBU?W",
- "start_location": {
- "lat": 49.315679,
- "lng": 4.149621
- },
- "end_location": {
- "lat": 49.31563,
- "lng": 4.149905
- },
- "travel_mode": "DRIVING",
- "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_succint": "Enter the roundabout and take the 2nd exit.",
- "verbal_before": "Enter the roundabout and take the 2nd exit onto D 30."
- }
- },
- {
- "distance": "198 m",
- "duration": "1 min",
- "polyline": "u}~kH{oiXFWDOLUP[P]j@y@^g@`@i@NUNONMJKJIFELC",
- "start_location": {
- "lat": 49.31563,
- "lng": 4.149905
- },
- "end_location": {
- "lat": 49.314292,
- "lng": 4.151623
- },
- "travel_mode": "DRIVING",
- "instructions": {
- "action": 27,
- "summary": "Exit the roundabout onto D 30.",
- "verbal_succint": "Exit the roundabout.",
- "verbal_before": "Exit the roundabout onto D 30.",
- "verbal_after": "Continue for 200 meters."
- }
- },
- {
- "distance": "46 m",
- "duration": "1 min",
- "polyline": "iu~kHsziXJBJAHGFIDMBSAS",
- "start_location": {
- "lat": 49.314292,
- "lng": 4.151623
- },
- "end_location": {
- "lat": 49.314041,
- "lng": 4.151976
- },
- "travel_mode": "DRIVING",
- "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_succint": "Enter the roundabout and take the 2nd exit.",
- "verbal_before": "Enter the roundabout and take the 2nd exit onto D 30."
- }
- },
- {
- "distance": "96 m",
- "duration": "1 min",
- "polyline": "ws~kHy|iXBKDILURa@LWt@eAHO",
- "start_location": {
- "lat": 49.314041,
- "lng": 4.151976
- },
- "end_location": {
- "lat": 49.313431,
- "lng": 4.152916
- },
- "travel_mode": "DRIVING",
- "instructions": {
- "action": 27,
- "summary": "Exit the roundabout onto D 30.",
- "verbal_succint": "Exit the roundabout. Then, in 100 meters, You will arrive at your destination.",
- "verbal_before": "Exit the roundabout onto D 30. Then, in 100 meters, You will arrive at your destination.",
- "verbal_after": "Continue for 100 meters."
- }
- },
- {
- "distance": "1 m",
- "duration": "1 min",
- "polyline": "}o~kHubjX",
- "start_location": {
- "lat": 49.313431,
- "lng": 4.152916
- },
- "end_location": {
- "lat": 49.313431,
- "lng": 4.152916
- },
- "travel_mode": "DRIVING",
- "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."
- }
- }
- ]
- }
- ],
- "main_route_name": "D 151",
- "recommended": true
- }
- ]
- }
- }
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_LiteAddressResponse"
}
}
}
},
"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/External-api-wrapper_what3words_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "402": {
+ "description": "Out of free quota.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_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/External-api-wrapper_what3words_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_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/External-api-wrapper_what3words_HTTPErrorModel"
}
}
}
@@ -5860,285 +5713,269 @@
{
"lang": "curl",
"label": "cURL",
- "source": "curl -L 'https://api.woosmap.com/distance/route/json?origin=49.31067%2C4.14525&destination=49.31344%2C4.15293&mode=driving&language=en&alternatives=true&method=distance&details=full&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/distance/route/json?origin=49.31067%2C4.14525&destination=49.31344%2C4.15293&mode=driving&language=en&alternatives=true&method=distance&details=full&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 GET 'https://api.woosmap.com/what3words/convert-to-address?words=couch.spotted.amended&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
},
{
"lang": "python",
"label": "Python",
- "source": "import requests\n\nurl = \"https://api.woosmap.com/distance/route/json?origin=49.31067%2C4.14525&destination=49.31344%2C4.15293&mode=driving&language=en&alternatives=true&method=distance&details=full&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/what3words/convert-to-address?words=couch.spotted.amended&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"
+ },
+ {
+ "lang": "javascript",
+ "label": "JavaScript",
+ "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/what3words/convert-to-address?words=couch.spotted.amended&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
}
]
}
},
- "/distance/tolls/json": {
+ "/what3words/autosuggest": {
"get": {
- "summary": "Tolls",
- "operationId": "getTolls",
- "servers": [
- {
- "url": "https://api.woosmap.com"
- }
- ],
"tags": [
- "Distance API"
+ "Woosmap for what3words API"
],
- "description": "Get Tolls\n",
+ "summary": "Autosuggest",
+ "description": "AutoSuggest can take a slightly incorrect 3 word address and suggest a list of valid 3 word addresses.\nIt has powerful features that can, for example, optionally limit results to a country or area,\nand prioritise results that are near the user.\n\n**Rate limit**: `20/1s`",
+ "operationId": "autosuggest_what3words_autosuggest_get",
"security": [
{
- "Woosmap_Platform_API_Reference_PublicApiKeyAuth": [],
- "Woosmap_Platform_API_Reference_RefererHeader": []
+ "External-api-wrapper_what3words_PublicAPIKey": []
},
{
- "Woosmap_Platform_API_Reference_PrivateApiKeyAuth": []
+ "External-api-wrapper_what3words_PrivateApiKey": []
},
{
- "Woosmap_Platform_API_Reference_PrivateApiKeyHeaderAuth": []
+ "External-api-wrapper_what3words_PrivateApiKeyHeader": []
}
],
"parameters": [
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_origin"
+ "name": "input",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "description": "The full or partial 3 word address to obtain suggestions for. At minimum this must be the first two complete words plus at least one character from the third word.",
+ "examples": [
+ "couch.spotted.a"
+ ],
+ "title": "Input"
+ },
+ "description": "The full or partial 3 word address to obtain suggestions for. At minimum this must be the first two complete words plus at least one character from the third word."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_destination"
+ "name": "focus",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "This is a location, specified as latitude,longitude (often where the user making the query is). If specified, the results will be weighted to give preference to those near the focus.",
+ "examples": [
+ "48.861026,2.335853"
+ ],
+ "title": "Focus"
+ },
+ "description": "This is a location, specified as latitude,longitude (often where the user making the query is). If specified, the results will be weighted to give preference to those near the focus."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_mode"
+ "name": "clip-to-country",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Restricts AutoSuggest to only return results inside the countries specified by comma-separated list of ISO 3166-1 alpha-2 country codes.",
+ "examples": [
+ "FR"
+ ],
+ "title": "Clip-To-Country"
+ },
+ "description": "Restricts AutoSuggest to only return results inside the countries specified by comma-separated list of ISO 3166-1 alpha-2 country codes."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_language-4"
+ "name": "clip-to-bounding-box",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Restrict AutoSuggest results to a bounding box, specified by coordinates.south_lat,west_lng,north_lat,east_lng, where: south_lat less than or equal to north_lat, west_lng less than or equal to east_lng.",
+ "examples": [
+ "48.624314,1.804429,49.058148,2.908555"
+ ],
+ "title": "Clip-To-Bounding-Box"
+ },
+ "description": "Restrict AutoSuggest results to a bounding box, specified by coordinates.south_lat,west_lng,north_lat,east_lng, where: south_lat less than or equal to north_lat, west_lng less than or equal to east_lng."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_units"
+ "name": "clip-to-circle",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Restrict AutoSuggest results to a circle, specified by lat, lng, kilometres, where kilometres is the radius of the circle.",
+ "examples": [
+ "48.839701,2.291878,20"
+ ],
+ "title": "Clip-To-Circle"
+ },
+ "description": "Restrict AutoSuggest results to a circle, specified by lat, lng, kilometres, where kilometres is the radius of the circle."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_alternatives"
+ "name": "clip-to-polygon",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Restrict AutoSuggest results to a polygon, specified by a comma-separated list of lat, lng pairs. The polygon should be closed, i.e. the first element should be repeated as the last element; also the list should contain at least 4 pairs. The API is currently limited to accepting up to 25 pairs.",
+ "examples": [
+ "48.823547,2.199174,48.823547,2.199174,48.922216,2.328709,48.888626,2.473673,48.819279,2.445513,48.784865,2.330668,48.823547,2.199174"
+ ],
+ "title": "Clip-To-Polygon"
+ },
+ "description": "Restrict AutoSuggest results to a polygon, specified by a comma-separated list of lat, lng pairs. The polygon should be closed, i.e. the first element should be repeated as the last element; also the list should contain at least 4 pairs. The API is currently limited to accepting up to 25 pairs."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_waypoints"
+ "name": "input-type",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "enum": [
+ "text",
+ "vocon-hybrid",
+ "nmdp-asr",
+ "generic-voice"
+ ],
+ "type": "string",
+ "description": "For power users, used to specify voice input mode.",
+ "default": "text",
+ "title": "Input-Type"
+ },
+ "description": "For power users, used to specify voice input mode."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_method"
+ "name": "prefer-land",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "description": "Makes AutoSuggest prefer results on land to those in the sea.",
+ "default": true,
+ "title": "Prefer-Land"
+ },
+ "description": "Makes AutoSuggest prefer results on land to those in the sea."
},
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_departure_time"
- },
- {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_arrival_time"
+ "name": "language",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "For normal text input, specifies a fallback language, which will help guide AutoSuggest if the input is particularly messy. A supported address language as an ISO 639-1 2 letter code.",
+ "examples": [
+ "fr"
+ ],
+ "title": "Language"
+ },
+ "description": "For normal text input, specifies a fallback language, which will help guide AutoSuggest if the input is particularly messy. A supported address language as an ISO 639-1 2 letter code."
}
],
"responses": {
"200": {
- "description": "Tolls successfully retrieved",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceTollsResponse"
- },
- "examples": {
- "default": {
- "summary": "Distance Tolls Result for driving by car from origin `Lunel, France` to `Lyon, France`",
- "value": {
- "status": "OK",
- "routes": [
- {
- "legs": [
- {
- "distance": {
- "value": 272304,
- "text": "272 km"
- },
- "duration": {
- "value": 8834,
- "text": "2 hours 27 mins"
- },
- "start_location": {
- "lat": 43.7037562,
- "lng": 4.1217688
- },
- "end_location": {
- "lat": 45.7196995,
- "lng": 4.848819
- },
- "tolls": [
- {
- "countryCode": "FRA",
- "tollSystemRef": 0,
- "tollSystem": "ASF",
- "tollSystems": [
- 0
- ],
- "fares": [
- {
- "id": "e4626716-1e29-4f9a-905a-19f0376cfb38",
- "name": "ASF",
- "price": {
- "type": "value",
- "currency": "EUR",
- "value": 28.9
- },
- "reason": "toll",
- "paymentMethods": [
- "cash",
- "bankCard",
- "creditCard",
- "transponder",
- "travelCard"
- ],
- "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": [
- {
- "name": "MONTPELLIER (M.EST)",
- "location": {
- "lat": 43.70291,
- "lng": 4.11982
- }
- },
- {
- "name": "VIENNE",
- "location": {
- "lat": 45.4761,
- "lng": 4.83378
- }
- }
- ]
- }
- ],
- "tollSystems": [
- {
- "id": 7607,
- "name": "ASF"
- }
- ]
- }
- ],
- "bounds": {
- "northeast": {
- "lat": 45.7197,
- "lng": 4.89669
- },
- "southwest": {
- "lat": 43.7022,
- "lng": 4.11696
- }
- },
- "overview_polyline": {
- "points": "m{viG_`dXDGLUDU@a@C]GUGMOOOEQCQDMFMPGPGf@@\\H\\HPJHNF\\@N?RFTNNTVh@Rh@Nl@^zBXlAb@|A\\~@\\t@Rx@RhADl@?VCd@EZGTKRUZUL]FM?MCQISOcAaA]WwF{HcDoEgA}AkBoCeCyDuE_IqEkIoEiI_@s@gBiDmCkFkC_FmRw^sB_Ea@w@c@y@sDcHuH{NyDwH}AeD{AoDy@uBmBuFiAuDeA{DiAcFOq@w@eEk@cDs@iFo@}Fo@iI[oGSaHGmFCyEGaXGmHG}DKkEKmDWqG_@qHa@wGi@aHMsAMsAk@mGK}@i@yEKu@_@uCAKWgBU}ASoAUwAWaBgAkGm@iDWoAy@cDaAkDiAeDcAgCeAaCoAcCmAuBaCqDsAcB}@eA_BaBq@m@aCoBgBoAgBeAaAg@iBy@w@[}Bu@sM}D_Cy@gEiBmCuAaBaAwDcCs@i@sBcByAsAiBeBwB_CiBwBqCwDoAiBoCsEgAqBoBgEqAyCmA_DiAcDgAeDc@{Aq@aCu@}CQw@_AwEc@gCy@oFi@{EUgCUyCWsEOkDO{GAkHBsEB_BFoBLiDNsCf@{Hx@qLTsCdI{iAj@}INeEFcGAkDGyCUiFSqCk@cFQqA]uBw@}Dq@mCoAoEa@mAi@wAyAkDm@qAWe@}AmCw@iAgBcCoA{A_C_CwKyJaEkDiL_KsHwGwC_CsE_D_DkBmBcAmEcCeBkAwBcByAqAq@o@}AgB}AoBuAsBk@_AyAmCaAqBuAiDq@sB{@{CeDmL{@sCmB{FuBwF{BaFuAqC{@_BuBmDaBeCqBqCw@cAwAeBgAmA{CyCgD_D_BsAoC_CyG{FyByBuB_CmCaDcByBgCuDoBcDcIsNk@_A_BgCu@eAcByBmB{BaEmE_GiG_DcDwD}DmBmBsAuAcB}AoCcCcA}@s@k@}CcCgDeC{FcEuAeAmAiAmAiAuAyAiAsAe@o@sAoB}@{Au@uAw@_Bq@}AoAgDa@oAiAeEm@sCa@wB]yBUiBi@wEYuCg@{EEe@K_AGk@y@uHYeCGe@}AcMi@qDOaAeBoK{AcIwDiQwC}LqD}NkAaF}@_EuAmGo@sC_ByIWaBq@oD]oB[yBw@cFo@oDi@uDcBiKkB_LSqAw@yEc@_CcAyFo@iDiA{Fm@aDmA_GsDuPGYoCeL_CcJqAwEw@sC_DuKoC}ImCmIgAcDmAiDyDmKaDqIeDiI_@{@Ui@eAkCeEwJuSoe@iFyLmCsGkDwI}FsOSk@kE_MoHoTgDsJSi@]}@gBgEyA_Ds@uA_BsCq@gAaCkD{BqCe@k@cDeDaB{AgA_AyBcBoAy@mBgAsBiAiEyBm@YsB{@aD}As@[eFaC_Bw@gCuA{B{AqCuBwBgByLsKmC_C_EoDgB_B_Ay@qO_NyFkFoAiAyE_E{I_IOMkSsQyDoDi@g@s@s@qCuCyBgCaDcEcCkDuBeDqBmDeC{EsAuCkBsEWq@{@}BgA{CmAqDcLg^wDuLiBaGe@wAuAmEwAsEwAwEgAyDgBgHw@uDq@wDqA{JW_CUaC_@iFc@}JQiH_@}RMeEWuGI}AWuD}@mK[_DeA{Im@qEeAmH}@sFs@cEeAsFkCaM_@cB{B_J_AmDiC_JcAcDuCuIwCcImAcDmCmG}BgFcCiFyCcGwCmFiB_DcDiFsEcHuHgLwC}EwAkCiBwDuBeF{AmEe@yAoAmE_BwG_AsEy@wEc@qCIk@w@iG{@_Ji@kHa@gG}@uOm@qJ_@cH]eGGoAi@qJGaAg@kIqAyUIuAEs@e@wHiAuO_@sEUyBi@_Fk@iEgAcHy@uEs@sDEQwAiGkAsEiA_Eu@cCwDaL{AaEuCmHeEwIkCkFiCuEcBuCkAmBsFoIgNyRiCqDeD_F_A}AkGaLuAcCy@{AcEsH}AsC[k@_Tc`@{@yAyFiKkDiGmCqE}A_CcDsEuBkCuBcC{BcCaAeA}BcCa@c@c@e@s@w@yAaBsD}EgBkC}AgC}C_GgA{BqBiE}AoD}BcF}BaFiA}B{Pg[aD}Fu@oAmIcOmB{CoAcByAeBuCwC_Aw@uAcAeBeAqDsBgFmCoCyAeC{AkCgBy@o@q@g@}AqA_EuDsCuC}CeDmEcF_D{D}CaEuEsGsCkEwDiGwD{G_@o@u@yAmA}BuAgCgBoDcAmBuAqCqBuDy@}A_BuC{CaFoBcDuFqIgK}NuB_DeA_BwBkDaAeBmCeF{AaDaCqF{ByFwBwFyBgGoAcD_C{FyAcD_AqByA_DcDyGaDaHwCaH{BaGsB{FiBuFmA_E}GmUqC{IaD_JoBcFqCuGaAyBmEiJoCmF_ByCcEmHyC_FcEqGkBuC_AsAsAoBm@y@eEwFeBcCqC_EiAeBkCiEm@eAm@gAuBgEkAyB_BiDmAuCyGuPeBiEm@yA]w@aCaFg@eA}AqCgB}CgCaEwCgEeEoFkByBqFcGwHkIsCkDmBgCcCiDeBoCw@mAcDmFyCqFsB}D}AcD_AuBy@wB}@mCq@_C_AcEe@gC[oB_@kCeAiIy@kFkAyFi@qBc@sAkBaFe@eAsAmCmAuBoBwCu@cAwCyDoFmHiBgCgAaBgDmFqBeDgB_DmCeFoB}D}B}E}AoDaA_CeEyKkAcDqBeGoBsGkBsG_E_OiBsGiBuFoAiDk@sAuAyC}AsCeBiCmCqDoAwAqBqBaA{@kCoBkBmAcCqAcAe@cAa@cA[gA[gAWkCe@kAOkCOmAEeA?oCHmAHkCViCZgFh@qBLaBFkBD}@CaAEeAK{@KiASmAYy@Y{Bw@aAc@c@QiCqAmE{BeEiBo@SqCm@cAO{AMw@Iu@C{A?yBD_AF}BVaCh@gAZeCx@cAb@uDzAgC`AeA\\eCp@cARyC`@w@FmADmC@}@CmCQqAQ{@OcAUiCs@oDsA{@]cBq@o@WsAm@iGgC_IcDi@S{@a@kQsH_FcCuBeA_CsAqD_CeCeB}BgB_CmB{BuBMMoBiBe@c@mAyAaBiB_AgAyEgG}KgO{BwCaCwC_@e@qCcDwBaCwA{A_DoCiCqBiBoAyA_A}BoAiAi@aBw@wCiAgCy@QGy@SwCs@}Cm@sB[iH}@cAIkBQ{D[}He@sCMo@?uE?aCDkF^u@HqBXkDn@iAViCn@mAb@y@PqBd@cDr@gC^cBR}ADmBB}BAeBKo@E}@MyAUuA[oBk@yAi@qCkA}DmBgG{CmB_AoBy@q@WgE}AqBm@sCs@{Be@mASiDa@oAIwAE_A?eBFuARiBd@k@RiB~@]Pu@j@]Tk@f@e@f@gAvAgA~Aa@p@wCxFcEbJkCnFq@rAcAjBs@hA{CzE}@fAgAnAyAxAYXo@j@_BrA}BbB}@l@cBbAsHjEkEbCoKjGoBbA}BbAq@XwChAoCjAm@VgHnCgBp@a@NcBf@c@TiGfCqDpAsLtEuJpDuDxAmAh@aBv@q@^yFlDmAz@eAt@qBnAmBpAmBlAmBpAkD|B{HdF{E~CaLpHeDtBmMxI{DhC[TmGdEuc@xYiAv@{FtDeGlEyBdBwD`DgE|DsDpDiBnBqElFqE|FmBlCiCxDqEjHcBvCaCnEIN{ChGaDhHuElLqBjFk@zAgCxGkBrEqArC}BtEq@nAiCbEkBdCmAvAeAfAkAdAgCpBqBjAmAn@gAf@{Bz@kBh@oB`@gAPiCVyCL_B@kC?yIMkCFyADwBNkAL_ANuB`@q@N{@RmA\\aAZoAf@kBx@{BlAsAx@wCrBwAhAmAfAeC`CmAnAaAbAiBrB}AfBcJzKuCfDsD|DuDnD{@r@uAhAwDrCiBnAiBhAoAr@}Ax@}HrDmJdEiDvA}Ap@kDrAyC`AgAXsCj@sATeBNsCPyDFqBEkCMqBOiSuBiBSiHu@mDg@uAYeBa@wBm@sBs@{CsAkBcAmAu@gMgIkTwN_SoMwDgC_C}Aa_@mVez@mj@yIgGsFcEcG_F{FiFyBuBsIqIwNeOm@m@}@_AkHqH{GaHqFqFwBoB{BeBw@k@aC}AeCuA_CgAaDoAaA[gAYkEaAeAOuBYgBOaFUiAEaGOgACw@Ac@Ac@?iEM_Sa@iCCmC@eBFoBHqALwAPeBZwAVwA^iA\\wAf@eBp@aBt@sDfBwJhF{FtCoFjCmD|AmBt@iBp@mDfAsA^cEdAiB\\mEt@{C`@kBR}@JoDZaDPmQnAaEV_OdAyG^oI`@_FRoDJgGRwGLoDDeJHiC@wX?iGCkMBoAByBFuCDiCFsBFa@BiADiHb@mBLsBN{Iz@iD`@mDd@iGbAcF|@qLbC{M|CgKxBoEv@uDl@uEn@gIz@sE`@gk@vEcCPmDXmD\\i`@`DcCT{Jv@oFd@gIl@gHf@_CNqJf@qELgB@yDD_HEaBCwDKwBKsBGsAKcEYkBQmBQgCYaH_AiEs@kAUk@Ki@Ke@I]ImCi@mEiAaHmBaEoAyHsC_DqAuDaBkAk@{F{CcHeEm@[oBoAyAeAsB{AyHoG}AuA_CuBeIcIiHeIkC{CcBuBk@q@yBiCmBuBqBsBsBsBgD}CgDoCyAiAaBkAgAw@mD{BoBiAeEwB}As@cCcAeE{AiCy@yC{@mCo@mE{@y@UcF_A_F_AkN{CuD{@oGgBcAY_AYUGqDiAwE_BeA]aBk@eEcBeBs@sEoBsDaBkFmCk@[gIkE{SuLqDmByCyAqCoAyEgBuFiB}Bk@mBe@{E_AuB[iEi@aCSaDSqEQwAEwCC}CCoIIeHIsJMoDGaLI{FIuDGaCEkX[mACuHW_Fa@iBSaEk@kASiDq@kAW_EkAiCy@aC{@w@YyAm@yCsAqBcAeFsCwDeC{AeAiFgE}AsAyAuAqCqC}@_Ao@u@oAwAsD{Ek@s@_@k@_AsAyBgDwC_Fs@kAwFiKaIsOgBeDmD_HwB{D}CqFaBmCiCaEyAyBcGeIaCyC{AgBeCqC_DgDeCeC{GiGwFsEqDkCmCkB_DqB_JiFo@]gFeCcCeA_CaAq@YqAg@_C_AsB{@cRyGkPqFu@UoImCQGoBm@uHyBkA]cMiDgHeBqEw@iCc@aEe@cDW{AIgEM_DGeD?wEFmCDgGTeFVwE\\sALwLlAuG|@_BVcKhByE`AsFrAyCt@eGdB{IpCe[rKgQhGWHq@VcLzDuE`B]Jg@PuAh@kAb@mHtC_Ab@aEbBiKvEsAp@sCtAeItDcEfB{DzAiDnAuBr@yDjA{Bl@{EhAeCn@aCd@qIxAsBZqBVsDb@aGj@oDXqDVmGZeFPwDHcEDmIBcHAoNCa@?uMCgQLaNRkJTsJZ_Md@yOx@mIXiCH_@?c@@oGBaCAkEIcFQsE[kHs@_@CwB[iC]{E{@oFiASESC{Bi@iEgAcJsBmGsAkFeAkDm@kEq@yGy@uCYsFc@uCWaJg@s@AsG[iE]q@EYA{@?wC?mCM_S{@s@CcGO}BMcBIkDMgEKmBC}B?yCDgAD_EVeBPkBVqB\\uDv@iCr@_Cv@mBr@gBt@mAj@yAt@cAj@{CfBsSdN}D~BiGfDsEtBwB|@}Aj@wFjBu@VeCr@}Bh@gCj@yDv@oEv@aJxAqHpA_MtBy@LkC\\uGx@kFh@cAHwF\\oDPqHLuDB{GGeEIgGWw@GwCOoSwA{Jw@yDa@gDi@y@MkCm@{Aa@qA[aCu@cEoAeF}AuAc@qFsAmEy@{B]aAKeCUyAKcEOoDC}B?aCFy@D_Kl@gBNmIf@sCJcEFcA?mFIoDQsAKcCWeC]sB[kBa@_B_@{Cw@sBo@qBq@}B_AsF_C_Bo@aGoCw@]qFeCkAg@yBaAeAc@u@[cNkGqAm@eCiAy@[kGqC_DuAm@[gJmEkDgB{CaBq@_@kBeAUMwBsAgFiDoA}@wDuCqF{EoBoBgAiA{@aAmCaD{CeEeBiCgEkH_B_Dy@gBwCeHuAyDQg@cAaDgBiGkB_IyAuHmAgH_Fc\\sA}HcAiF}@{DgA_E]kAaBiFa@kA_AcCu@iBs@_BaAwBkA_CeB_DoAwBoAmBmBmC_CwCY]]a@yB_C_B}AmFwEsD{CiUwQoQ{NuMmKcNsKaGiEoFmDcF{CuDqBqCuAkAi@o@[_EeBsAi@iE}A_IiC}MgE{FcBsEoAwBi@cBc@eDs@gEy@cCe@uQuCoFw@_m@iJs]gFkC]oWqDwFw@qC_@gd@gGgGw@yGw@uEc@iCSeDQeBGaCG{CEkA?{FFkDJwDRYBkE\\eBPg@FcH|@_QfCuDd@cEb@g@BsCRcDL}BB}E?yDKaCK}@G_CScCWuCa@qF_AsCm@YKUGiF{Ae@OsFiBgIuCg@Q{h@aRoE}AmG{ByCcA_A[s@Ww@Y_Cw@cA]mC_AiDaAyAc@oKoCsDo@mB]{AUkDe@qB[aBWmC[oB[wAU{B]oIoAeC]gBUwAQcAK}@KyCWuEUgCKgEEmBBcGHwDL{G^}CLoCHsA?aCCgAE}C[oASwB_@iAWkA[gC{@uAi@u@[yBkAcBeAeCaByBcBiCsBiByAi@_@iG}E]YcIkGcBoAo@i@mDgDs@y@wE_Gm@o@cB}Aw@o@w@k@yEiCeBq@iA]cAWaAQuC[cI]gFUaFYuBWgASwFoAsBa@}@MaAIgACy@?aBHsAL}@Lc@LeBf@aA`@]RcDjBsAn@cBl@wBj@q@LuAP{O~AcAH_BRmBPaBViB\\}LrCkBd@mBh@s@RyAh@aA`@oB|@eBz@wBlAi@TmAd@gAZuAXgAL{AHqB@oCQ_AIiAUkDu@sEaAuA[oAU_B[s@MkB]y@KeAImACu@Ci@?g@@yADeBNaC^qBd@YHoAf@q@Tu@\\yB|@qIlD_DlAsBr@QD[H}@XeB^uB`@aBT_CX_BN_AFuAFaCDeIFqGLaBL_CZoAPyBd@k@LiAZcBf@uBx@mB|@{PlJwDjBuD`Bs@VcA`@}Ah@yEvAyDz@iB\\w@LkDh@eAPsCV{CTqBJo@BaGJyDAmR]iJQoEIsIMgC?uA@kELcBJg@BaY~AyAFmFXmCL}BFsCFmEBuC?o@A{CCiAEoHWkIo@{Eg@yEk@mGeAuN}CuGyAwDs@wB]iAOyEg@uF[mEKuCAiA@mFL{CLoBJeDTkY|AsWzAa@BiBL{BR_D`@uDp@wCn@sDbA{DrAqDzA_ErB}@d@iAn@aCzAyAbAsAbAcDrC}ApAsDhD{@z@{@t@[RiAx@mAr@o@Z]Pq@^y@X{@XiDr@cCV_DLuEM_Dc@iBc@qA_@_A_@]O{Aw@m@]w@g@wB_ByAuAuA{AcBuBqGwI}@oAgD{Dk@m@gDyCoAeAkBsAkAs@{@i@kAo@mAm@{B_AqBq@cBk@yAa@wA[{AWgBUeEa@cCOeCIcCBeBJkD^oARcK`C_BPmANyALyABsBAgBG}AKsDg@qDcAoDuAiDkBwEgDqB{AeL}IgHuFwJsHsJuHyAsAiBgBiAmAqCcDiC_DuCuDiDgEgBuBiAmAsAoAgCyBoCkBeC}AQKSKiDwA{B{@{Cw@wB]_Ca@yE[kBE_DBsEZeFr@sq@rOaOhDyDdA}Af@yAh@_C`AaBv@wEdC_HzDkB|@{B|@kBl@_AVmAXyB`@aCZkAJcBHiCDsB?sCCo@C_BAcDIgLYiHMk@AiGO{BGmBCk@CoFMO?Y?a^s@iJWaEG}BAeE@}AD{BLiBPgCZwAToAVyCv@}Br@yBx@oBx@mB~@{@f@yAz@uDfCiBzA[XUR}ArA}ApAmAbA_BhAsBpAu@^cBv@uAd@mAZsCd@wAPwCd@qAV_AViA^}An@}Av@cAl@sBxAuAjAyEjEgF|EuBdBeAv@y@h@w@d@}Ar@eA^]Lo@Rm@PwAZ{@LsBPoBHwA@yBK_AGu@MgB[mBe@wBs@y@[}Ae@uBi@}AYkBUeCKgBBu@@aBJqBVkAT_Bb@y@Xm@RyBbAiAn@aAn@sAbA{BtBy@~@q@z@qAhBe@r@W`@qAdCm@tAaAbCs@xBaAjDi@dCiA~Es@lC]tAg@xA_BzDe@`As@tAo@dA}AxBk@r@iBnBw@r@w@p@mBrA}BpAgAd@aA^w@VkBh@_Cp@yN~D}CdA_C|@uBz@aDxAgCrAqDtBoAv@eBjAa@VqCrBeCtBmAlA_BfBqA`BwBtCsDbFwAhBgAjAcAdAyArA_Av@kBvAo@b@yCdB}BhAsCnA}VjKeBv@uAr@g@ZQH}AbA_Ar@u@l@u@r@aBjBmA|A_AtAw@pAmA~B_AnBsCnFsAxBcAzA{@fAmCtCkBbBkA`ASLyAdAe@XuCzAoBx@eCx@sCp@}@RiCZeBLkCDwCEqBKcBMcZiCcIs@cCQkCMuAEiCCiA@oDL}DXyDj@qCj@qBh@sC|@wChAk@ViB~@gBbAaB`AgAr@eBrAk@^oB|AwE`EuBjBqAhA{BnBqC~BoNzLwEdEkGjF{F`FiA~@eAr@_@VeAn@q@\\mBx@qBn@iBb@s@LiBRy@FsBF{BEgCSmBYaCi@oBc@kPiEoE_A}@MwAK}@Cs@Cg@?cCFmBNgBVwBd@gBh@iBt@i@VmAp@{AbAmA~@{AxAyA|Aq@x@iA|AsB`D_FlHoBxCmCxD{AjBiApAmDfDy@r@qCpBmAv@sAt@ULsB`AqAd@}Ah@eAZ{A^aBZ_CZ_DXsAFc@?oB?eCE_IYeACoLe@oO]oACyB@qD?aFFcJH}@B_IZS@iCNkEVwJx@{Db@wKtAuHlA_[tFyB^iJdBmJbBk`@bHmB`@]Hk@JgFbA{J|AcCZkAJeAJcEN{C@kBCkCKqAIcCSoBWmRwBqDe@_Eo@qFkAaB]oMsCcGkAaBQkACgBDg@FsARuA\\aBl@}Az@kA|@g@f@oErEsAjAc@ZgAp@cBv@{@V_APaALmAHaA?aAGyAKy@McC]oBW_Fs@sAOwG{@qBQiBIgBIqAAsAAmA@aBDsFXqABgCAcDMoBO_AKyB[aBYyA[aBe@_EkA}@[yB_A}@a@qCwAwBsAqA{@cBmA{AmAo@i@yBuBwZgYuDiDyBqBiG{F_EwDwCoCkEaEaA{@gAgA_A}@sCmCg@e@_FsEaQ_PSQmAcA{CsBk@c@qAo@kAi@cAc@{@[s@UyBm@wBa@{AS_CSiAGoC?kA@u@BuBLiBToB\\aCj@mA`@kBt@mAh@_A`@c@Tk@V_@PmAh@oLfFq@VaDdAkCn@wB`@{C`@wBL}@BiBDgA?iAGqDY_BQoASqEy@eEaAeIcBwIkBgLeCqQsDgCm@_B[oGsA{D}@aCe@aDs@mLcCgDs@kNyCcHwA{GyAiE_AcEy@qCe@qFw@_Ee@}AOuKu@w@EiGU{BIoDA{BAq@@iCB{@BmCH{BF_@@_@@qDKeCMcAKo@KkBa@aAMs@Ko@Ai@Ck@BmALwCf@_AL}APc@@W?oFE_BIaAIs@MyA]iA[qFeBi@QsA]uAYmAMk@Ck@?iADe@DgAPc@JkA`@oAl@mGbDeBx@wAj@g@Pg@He@FkAHkA@qAIgAQeAYe@QcAe@iAs@a@[iAcAiAoAkAyAeFiHq@_AqC{Du@cAy@}@u@s@s@i@k@[eAa@cA[]Im@K[EmAMeAC}ABkBFgERwDHq@BoBDu@AoBKiB]_CeASKm@a@m@e@k@k@oA}Ae@q@]m@c@}@q@}ASi@[_AcAuCg@qAs@}Ak@eAw@oAg@o@}@cAkAkAgAaA_D_DqDcDwAwAu@cA]i@g@_Ac@}@{@wBqAaEoB}G]uA_EaN}@cCy@kBg@_Ai@{@kA{Ak@m@o@q@e@a@_BgA{@c@s@]s@Uy@W}AYuAKgHYoBQeAO_@KyAa@q@UaNkFyBu@eBc@m@M}AY}AOm@EeCCyA@_AF}ANaC`@}A`@qAd@aCdAeBbA{B~AuBbBoBdBuC|BoBnAeB`AaC`AuG|BoC`A{HhCaEvAc@TUJi@Xk@^a@Zu@r@w@`Ak@|@mAbCi@|Aa@~AQx@WfBIz@K|AIbC@tBPpFRjFBrA?fBE|AGdAMrAc@bDc@`Cg@~BqAfFs@hC{@lCu@rBy@zBoA~CKXKR}AtDa@x@qB`E}@bBGHeAjBiBzCiDdF{FzHcEfFoEdFyB`CkClCkDjDsElEuEfEyKtJa@Z{AlA{AlAoDrCyFhEyEfDqCfBqBjAuBdAkE`BkCfAeDdBgBhAm@b@wBbBo@j@yCxCuA|Ao@v@_@d@yAtBm@`Am@bAkAxBaApB{ApDi@tAiA`DeAtCu@fBiAxB_A|Ak@z@}BzCuBrBiA~@kAz@iAr@cAh@qAn@sDjBeHjDsHbDoDxAsEhBa@Rq@Tw@Ze@RwFnBgA`@sDnA}EzAwCr@cFpAqE`AoB^g@JgBVkEp@iEj@{AP_Ed@mAJoCPmCPkCLeC@cBIyBS{@Qy@Q}@WaBo@e@UoAs@_@WkByAwAsA_CcCmC_D{AoB{AuBiHmKyEgGqDiEwCaDcCcCeE{D{DcDeCiBsDeCkBiA_FuCsGmDwGcDeEqBuCoAyFyB}JuD_UmIiEeB_Aa@kIuDgB{@mHuDiBcAs@_@qAw@cEcCkAs@kFqD}CyB{DaDi@c@s@m@WUaCqB}AuAq@o@iBgBmDmDyPaR_EeEw@w@qCwCoJcJiC}BkJgIyGsFiF{DgDaCoCgBaBaAaFgCgEkBeCeAgGuBwHuBsF}AiIiCyK{DeHsCgVmKkBs@mA_@eAWyBi@{Bc@gDi@_AKo@CWEkESi@AmBC{ABu@@}AFcEVs@FwKt@kHf@{BPuE\\c@FmAJy@Js@HqBV_Fr@o@J{PfCcBXu@LQBwAHo@J_AZ_A^g@RoAd@oAZoB`@eANcAHmADkAAsAMq@Mm@Qa@MqE{AcA]q@MuB[eAIqBIyA?_CJuBVmAT[DcAVcAZkG|BeCp@}AVcAH_@DsAFeK`@aHXiCHu@DwDToAHi@DaGRsCDiABoA?WAqAAe@?]KQGQKQOQUUk@I_@MiAKeBIsBKmEOmDE_AKwBUsFEs@MuCMoCSuD@W@sA?cAB]PaAKuBS]OYSQ[MOUc@c@]@_@Fa@V}@L}@HkBLS?gAFFxFLnL@rAB`C@n@BhA?RAl@yA`@QD"
- }
- }
- ]
- }
- }
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_AutoSuggestResponse"
}
}
}
},
"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/External-api-wrapper_what3words_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "402": {
+ "description": "Out of free quota.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_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/External-api-wrapper_what3words_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_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/External-api-wrapper_what3words_HTTPErrorModel"
}
}
}
@@ -6148,1000 +5985,771 @@
{
"lang": "curl",
"label": "cURL",
- "source": "curl -L 'https://api.woosmap.com/distance/tolls/json?origin=43.70386%2C%204.12200&destination=45.71971%2C%204.84891&mode=driving&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/distance/tolls/json?origin=43.70386%2C%204.12200&destination=45.71971%2C%204.84891&mode=driving&private_key=YOUR_PRIVATE_API_KEY\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));"
+ "source": "curl -L -X GET 'https://api.woosmap.com/what3words/autosuggest?input=couch.spotted.am&clip-to-country=fr&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
},
{
"lang": "python",
"label": "Python",
- "source": "import requests\n\nurl = \"https://api.woosmap.com/distance/tolls/json?origin=43.70386%2C%204.12200&destination=45.71971%2C%204.84891&mode=driving&private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
+ "source": "import requests\n\nurl = \"https://api.woosmap.com/what3words/autosuggest?input=couch.spotted.am&clip-to-country=fr&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"
+ },
+ {
+ "lang": "javascript",
+ "label": "JavaScript",
+ "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/what3words/autosuggest?input=couch.spotted.am&clip-to-country=fr&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
}
]
}
},
- "/distance/isochrone/json": {
+ "/indoor/venues/{venue_id}": {
"get": {
- "summary": "Isochrone (Early Access)",
- "operationId": "getIsochrone",
- "servers": [
- {
- "url": "https://api.woosmap.com"
- }
- ],
- "tags": [
- "Distance API"
- ],
- "description": "Find all destinations that can be reached in a specific amount of time or a maximum travel distance\n",
- "security": [
- {
- "Woosmap_Platform_API_Reference_PublicApiKeyAuth": [],
- "Woosmap_Platform_API_Reference_RefererHeader": []
- },
- {
- "Woosmap_Platform_API_Reference_PrivateApiKeyAuth": []
- },
- {
- "Woosmap_Platform_API_Reference_PrivateApiKeyHeaderAuth": []
- }
- ],
+ "operationId": "api_routers_indoor_get_venue_by_key",
+ "summary": "Get Venue By Key",
"parameters": [
{
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_origin"
- },
- {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_value"
- },
- {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_mode"
- },
- {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_language-4"
- },
- {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_units"
- },
- {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_method"
- },
- {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_avoid"
+ "in": "path",
+ "name": "venue_id",
+ "schema": {
+ "description": "ID of the Venue to retrieve.",
+ "title": "Venue Id",
+ "type": "string"
+ },
+ "required": true,
+ "description": "ID of the Venue to retrieve."
}
],
"responses": {
"200": {
- "description": "Isochrone successfully retrieved",
+ "description": "OK",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceIsochroneResponse"
- },
- "examples": {
- "default": {
- "summary": "Distance Isochrone Result for driving 1km by car from origin `48.709,2.403`",
- "value": {
- "status": "OK",
- "isoline": {
- "origin": {
- "lat": 48.709,
- "lng": 2.403
- },
- "distance": {
- "value": 1,
- "text": "1 km"
- },
- "geometry": "s|ihHouuMZ`GdClCsA~QhCnQmBhEpCfF|HxGpBtFfEnBnHqJpH}ADaEcCaB@sBnEiEYiGmVyFaG{G[eFoCw@gAiIkDYg@_DwA@"
- }
- }
- }
+ "$ref": "#/components/schemas/Indoor_API_VenueSchema"
}
}
}
},
"401": {
- "description": "Unauthorized. Incorrect authentication credentials.",
+ "description": "Unauthorized",
"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/Indoor_API_ErrorResponseSchema"
+ }
+ }
+ }
+ },
+ "402": {
+ "description": "Payment Required",
+ "content": {
+ "application/json": {
+ "schema": {
+ "description": "A more detailed explanation on what went wrong.",
+ "title": "Detail",
+ "type": "string"
}
}
}
},
"403": {
- "description": "Forbidden. This Woosmap API is not enabled for this project.",
+ "description": "Forbidden",
"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."
- }
- }
+ "description": "A more detailed explanation on what went wrong.",
+ "title": "Detail",
+ "type": "string"
}
}
}
},
- "429": {
- "description": "Too Many Requests. The rate limit for this endpoint has been exceeded.",
+ "422": {
+ "description": "Unprocessable Entity",
"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"
+ "properties": {
+ "detail": {
+ "description": "The validation errors.",
+ "items": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "title": "Detail",
+ "type": "array"
+ },
+ "context": {
+ "additionalProperties": true,
+ "description": "Context",
+ "title": "Context",
+ "type": "object"
}
- }
+ },
+ "required": [
+ "detail",
+ "context"
+ ],
+ "title": "ValidationErrorSchema",
+ "type": "object"
}
}
}
}
},
- "x-codeSamples": [
- {
- "lang": "curl",
- "label": "cURL",
- "source": "curl -L 'https://api.woosmap.com/distance/isochrone/json?origin=48.709%2C2.403&value=1&mode=driving&language=en&method=distance&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/distance/isochrone/json?origin=48.709%2C2.403&value=1&mode=driving&language=en&method=distance&key=YOUR_PUBLIC_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/distance/isochrone/json?origin=48.709%2C2.403&value=1&mode=driving&language=en&method=distance&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"
- }
- ]
- }
- },
- "/maps/static": {
- "get": {
+ "description": "Returns a Venue based on the ID given.\n\n**Rate limit**: `20/1s`",
"tags": [
- "Static Map API"
+ "Indoor API"
],
- "summary": "Get Static Map",
- "description": "Retrieve a static map\n\n**Rate limit**: `20/1s`",
- "operationId": "get_static_map_maps_static_get",
"security": [
{
- "Maps_PublicAPIKey": []
+ "Indoor_API_PrivateKeyAuth": []
},
{
- "Maps_PrivateApiKey": []
+ "Indoor_API_PrivateKeyHeaderAuth": []
},
{
- "Maps_PrivateApiKeyHeader": []
+ "Indoor_API_PublicKeyAuth": []
}
],
- "parameters": [
- {
- "name": "language",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Language"
- }
- },
- {
- "name": "lat",
- "in": "query",
- "required": true,
- "schema": {
- "type": "number",
- "title": "Lat"
- },
- "example": "43.6"
- },
- {
- "name": "lng",
- "in": "query",
- "required": true,
- "schema": {
- "type": "number",
- "title": "Lng"
- },
- "example": "3.883"
- },
- {
- "name": "zoom",
- "in": "query",
- "required": true,
- "schema": {
- "type": "number",
- "maximum": 24,
- "minimum": 0,
- "description": "The zoom",
- "title": "Zoom"
- },
- "description": "The zoom",
- "example": 11
- },
- {
- "name": "width",
- "in": "query",
- "required": true,
- "schema": {
- "type": "integer",
- "maximum": 640,
- "minimum": 40,
- "title": "Width"
- },
- "example": 400
- },
- {
- "name": "height",
- "in": "query",
- "required": true,
- "schema": {
- "type": "integer",
- "maximum": 640,
- "minimum": 40,
- "title": "Height"
- },
- "example": 400
- },
+ "x-codeSamples": [
{
- "name": "markers",
- "in": "query",
- "required": false,
- "schema": {
- "type": "array",
- "items": {
- "type": "string",
- "contentMediaType": "application/json",
- "contentSchema": {
- "$ref": "#/components/schemas/Maps_MarkerWithUrlOptions"
- }
- },
- "description": "Adds a marker.\n \nThe images are by default are considered to be non retina images (pixel resolution=1)\n\nIf the image name contains @2x or the query parameter retina=yes are found in the marker url the image will be considered to be retina (pixel resolution=2).\n\n> Note: the image size in bytes cannot exceed 65535 bytes.\n \n ",
- "title": "Markers"
- },
- "description": "Adds a marker.\n \nThe images are by default are considered to be non retina images (pixel resolution=1)\n\nIf the image name contains @2x or the query parameter retina=yes are found in the marker url the image will be considered to be retina (pixel resolution=2).\n\n> Note: the image size in bytes cannot exceed 65535 bytes.\n \n ",
- "example": "{\"lat\": 43.6, \"lng\": 3.883, \"url\": \"https://webapp.woosmap.com/img/geolocated_marker.png?retina=yes\"}"
+ "lang": "curl",
+ "label": "cURL",
+ "source": "curl -L -X GET 'https://api.woosmap.com/indoor/venues/west_pal?key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
},
{
- "name": "polylines",
- "in": "query",
- "required": false,
- "schema": {
- "type": "array",
- "items": {
- "type": "string",
- "contentMediaType": "application/json",
- "contentSchema": {
- "$ref": "#/components/schemas/Maps_PolylineOptions"
- }
- },
- "description": "Add a polyline.\n \n> Note: enc should be a google encoded polyline see [Google-encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) for more information\n\n ",
- "title": "Polylines"
- },
- "description": "Add a polyline.\n \n> Note: enc should be a google encoded polyline see [Google-encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) for more information\n\n ",
- "example": "{\"enc\": \"ydjiG_}jVjn@cjAf`AycBnc@mqCp\\\\ewBrQmlBzrAeuCreBw_C\", \"color\": \"magenta\", \"weight\": 4}"
+ "lang": "python",
+ "label": "Python",
+ "source": "import requests\n\nurl = \"https://api.woosmap.com/indoor/venues/west_pal?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"
},
{
- "name": "polygons",
- "in": "query",
- "required": false,
- "schema": {
- "type": "array",
- "items": {
- "type": "string",
- "contentMediaType": "application/json",
- "contentSchema": {
- "$ref": "#/components/schemas/Maps_PolygonOptions"
- }
- },
- "description": "Adds a polygon.\n \n> Note: shape should be a google encoded polyline see [Google-encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) for more information\n ",
- "title": "Polygons"
- },
- "description": "Adds a polygon.\n \n> Note: shape should be a google encoded polyline see [Google-encoded polyline](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) for more information\n ",
- "example": "{\"shape\": \"ymgiGm|rV~uAtaB|dAefCqeBwuFu~@njC??\", \"fill_color\": \"rgba(255, 20, 147, 0.5)\", \"color\": \"rgba(199, 21, 133, 0.7)\"}"
- },
+ "lang": "javascript",
+ "label": "JavaScript",
+ "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/indoor/venues/west_pal?key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
+ }
+ ]
+ }
+ },
+ "/indoor/venues": {
+ "get": {
+ "operationId": "api_routers_indoor_get_venues_by_key",
+ "summary": "Get Venues By Key",
+ "parameters": [
{
- "name": "stylers",
"in": "query",
- "required": false,
+ "name": "sort_by",
"schema": {
- "anyOf": [
- {
- "type": "string",
- "contentMediaType": "application/json",
- "contentSchema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Maps_MapStyle"
- }
- }
- },
+ "allOf": [
{
- "type": "null"
+ "enum": [
+ "created_at",
+ "updated_at",
+ "name"
+ ],
+ "title": "SortingInputSchema",
+ "type": "string"
}
],
- "title": "Stylers"
+ "description": "The order in which the venues should be retrieved"
},
- "example": "[{\"featureType\": \"points_of_interest.business\", \"stylers\":[{\"visibility\": \"off\"}]}]"
- },
- {
- "name": "retina",
- "in": "query",
"required": false,
- "schema": {
- "type": "boolean",
- "default": false,
- "title": "Retina"
- }
+ "description": "The order in which the venues should be retrieved"
}
],
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "OK",
"content": {
- "image/webp": {
+ "application/json": {
"schema": {
- "type": "string",
- "format": "binary"
+ "items": {
+ "$ref": "#/components/schemas/Indoor_API_VenueListSchema"
+ },
+ "title": "Response",
+ "type": "array"
}
}
}
},
"401": {
- "description": "Unable to locate credentials.",
+ "description": "Unauthorized",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Maps_AuthenticationErrorResponse"
+ "$ref": "#/components/schemas/Indoor_API_ErrorResponseSchema"
}
}
}
},
"402": {
- "description": "Out of free quota.",
+ "description": "Payment Required",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Maps_AuthenticationErrorResponse"
+ "description": "A more detailed explanation on what went wrong.",
+ "title": "Detail",
+ "type": "string"
}
}
}
},
"403": {
- "description": "Credentials found, but not matching.",
+ "description": "Forbidden",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Maps_AuthenticationErrorResponse"
+ "description": "A more detailed explanation on what went wrong.",
+ "title": "Detail",
+ "type": "string"
}
}
}
},
"422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Maps_HTTPValidationError"
- }
- }
- }
- },
- "429": {
- "description": "Rate limit reached",
+ "description": "Unprocessable Entity",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Maps_HTTPErrorModel"
- }
- }
- }
- }
- }
- }
- },
- "/what3words/convert-to-3wa": {
- "get": {
+ "properties": {
+ "detail": {
+ "description": "The validation errors.",
+ "items": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "title": "Detail",
+ "type": "array"
+ },
+ "context": {
+ "additionalProperties": true,
+ "description": "Context",
+ "title": "Context",
+ "type": "object"
+ }
+ },
+ "required": [
+ "detail",
+ "context"
+ ],
+ "title": "ValidationErrorSchema",
+ "type": "object"
+ }
+ }
+ }
+ }
+ },
+ "description": "Returns a list of Venues associated with the project of the key used to authenticate the request.\n\n**Rate limit**: `20/1s`",
"tags": [
- "Woosmap for what3words API"
+ "Indoor API"
],
- "summary": "Convert To What 3 Words",
- "description": "This function will convert a latitude and longitude to a 3 word address, in the language of your choice.\nIt also returns country, the bounds of the grid square,\na nearby place (such as a local town) and a link to the what3words map site.\n\n**Rate limit**: `20/1s`",
- "operationId": "convert_to_what_3_words_what3words_convert_to_3wa_get",
"security": [
{
- "External-api-wrapper_what3words_PublicAPIKey": []
+ "Indoor_API_PrivateKeyAuth": []
},
{
- "External-api-wrapper_what3words_PrivateApiKey": []
+ "Indoor_API_PrivateKeyHeaderAuth": []
},
{
- "External-api-wrapper_what3words_PrivateApiKeyHeader": []
+ "Indoor_API_PublicKeyAuth": []
}
],
- "parameters": [
+ "x-codeSamples": [
{
- "name": "coordinates",
- "in": "query",
- "required": true,
- "schema": {
- "type": "string",
- "description": "Coordinates as a comma separated string of latitude and longitude",
- "examples": [
- "48.858304,2.294514"
- ],
- "title": "Coordinates"
- },
- "description": "Coordinates as a comma separated string of latitude and longitude"
+ "lang": "curl",
+ "label": "cURL",
+ "source": "curl -L -X GET 'https://api.woosmap.com/indoor/venues?key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
},
{
- "name": "format",
+ "lang": "python",
+ "label": "Python",
+ "source": "import requests\n\nurl = \"https://api.woosmap.com/indoor/venues?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"
+ },
+ {
+ "lang": "javascript",
+ "label": "JavaScript",
+ "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/indoor/venues?key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
+ }
+ ]
+ }
+ },
+ "/indoor/style": {
+ "get": {
+ "operationId": "api_routers_indoor_get_indoor_style",
+ "summary": "Get Indoor Style",
+ "parameters": [
+ {
"in": "query",
- "required": false,
+ "name": "theme",
"schema": {
- "enum": [
- "json",
- "geojson"
- ],
- "type": "string",
- "description": "Return data format type; can be either json or geojson",
- "default": "json",
- "title": "Format"
+ "description": "The theme to apply to customize the style",
+ "example": "woosmap_default",
+ "title": "Theme",
+ "type": "string"
},
- "description": "Return data format type; can be either json or geojson"
+ "required": false,
+ "description": "The theme to apply to customize the style",
+ "example": "woosmap_default"
},
{
- "name": "language",
"in": "query",
- "required": false,
+ "name": "language",
"schema": {
- "type": "string",
- "description": "A supported address language as an ISO 639-1 2 letter code.",
"default": "en",
- "title": "Language"
+ "description": "A supported language as an ISO 639-1 2 letter code.",
+ "title": "Language",
+ "type": "string"
},
- "description": "A supported address language as an ISO 639-1 2 letter code."
+ "required": false,
+ "description": "A supported language as an ISO 639-1 2 letter code."
}
],
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "OK",
"content": {
"application/json": {
"schema": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_JsonCoordinatesResponse"
- },
- {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_GeoJsonCoordinatesResponse"
- }
- ],
- "title": "Response Convert To What 3 Words What3Words Convert To 3Wa Get"
+ "additionalProperties": true,
+ "title": "Response",
+ "type": "object"
}
}
}
},
"401": {
- "description": "Unable to locate credentials.",
+ "description": "Unauthorized",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_AuthenticationErrorResponse"
+ "$ref": "#/components/schemas/Indoor_API_ErrorResponseSchema"
}
}
}
},
"402": {
- "description": "Out of free quota.",
+ "description": "Payment Required",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_AuthenticationErrorResponse"
+ "description": "A more detailed explanation on what went wrong.",
+ "title": "Detail",
+ "type": "string"
}
}
}
},
"403": {
- "description": "Credentials found, but not matching.",
+ "description": "Forbidden",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_AuthenticationErrorResponse"
+ "description": "A more detailed explanation on what went wrong.",
+ "title": "Detail",
+ "type": "string"
}
}
}
},
"422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_HTTPValidationError"
- }
- }
- }
- },
- "429": {
- "description": "Rate limit reached",
+ "description": "Unprocessable Entity",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_HTTPErrorModel"
+ "properties": {
+ "detail": {
+ "description": "The validation errors.",
+ "items": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "title": "Detail",
+ "type": "array"
+ },
+ "context": {
+ "additionalProperties": true,
+ "description": "Context",
+ "title": "Context",
+ "type": "object"
+ }
+ },
+ "required": [
+ "detail",
+ "context"
+ ],
+ "title": "ValidationErrorSchema",
+ "type": "object"
}
}
}
}
},
+ "description": "Returns the style layers.\n\n**Rate limit**: `20/1s`",
+ "tags": [
+ "Indoor API"
+ ],
+ "security": [
+ {
+ "Indoor_API_PrivateKeyAuth": []
+ },
+ {
+ "Indoor_API_PrivateKeyHeaderAuth": []
+ },
+ {
+ "Indoor_API_PublicKeyAuth": []
+ }
+ ],
"x-codeSamples": [
{
"lang": "curl",
"label": "cURL",
- "source": "curl -L -X GET 'https://api.woosmap.com/what3words/convert-to-3wa?coordinates=48.858304,2.294514&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
+ "source": "curl -L -X GET 'https://api.woosmap.com/indoor/style?language=en&theme=woosmap_default&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
},
{
"lang": "python",
"label": "Python",
- "source": "import requests\n\nurl = \"https://api.woosmap.com/what3words/convert-to-3wa?coordinates=48.858304,2.294514&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/indoor/style?language=en&theme=woosmap_default&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"
},
{
"lang": "javascript",
"label": "JavaScript",
- "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/what3words/convert-to-3wa?coordinates=48.858304,2.294514&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
+ "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/indoor/style?language=en&theme=woosmap_default&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
}
]
}
},
- "/what3words/convert-to-address": {
+ "/indoor/distancematrix/{venue_id}": {
"get": {
- "tags": [
- "Woosmap for what3words API"
- ],
- "summary": "Convert To Address",
- "description": "This function converts a 3 word address to a list of address.\nIt will return at most the 5 closest addresses to the what3words provided.\n\n**Rate limit**: `20/1s`",
- "operationId": "convert_to_address_what3words_convert_to_address_get",
- "security": [
+ "operationId": "api_routers_indoor_distance_matrix",
+ "summary": "Distance Matrix",
+ "parameters": [
{
- "External-api-wrapper_what3words_PublicAPIKey": []
+ "in": "path",
+ "name": "venue_id",
+ "schema": {
+ "description": "ID of the venue",
+ "title": "Venue Id",
+ "type": "string"
+ },
+ "required": true,
+ "description": "ID of the venue"
},
{
- "External-api-wrapper_what3words_PrivateApiKey": []
+ "in": "query",
+ "name": "origins",
+ "schema": {
+ "description": "A string with a list of origins seperated by `|`. Origins can be of the format: `lat,lng,level`, `poi_id`, `ref:poi_ref`",
+ "example": "1.2,2.1,1|exit_1|1.3,3.1,2|ref:main_exit",
+ "title": "Origins",
+ "type": "string"
+ },
+ "required": true,
+ "description": "A string with a list of origins seperated by `|`. Origins can be of the format: `lat,lng,level`, `poi_id`, `ref:poi_ref`",
+ "example": "1.2,2.1,1|exit_1|1.3,3.1,2|ref:main_exit"
},
{
- "External-api-wrapper_what3words_PrivateApiKeyHeader": []
- }
- ],
- "parameters": [
- {
- "name": "words",
"in": "query",
- "required": true,
+ "name": "destinations",
"schema": {
- "type": "string",
- "description": "A 3 word address as a string. It must be three words separated with dots or a japanese middle dot character (・). Words separated by spaces will be rejected. Optionally, the 3 word address can be prefixed with /// (which would be encoded as %2F%2F%2F)",
- "examples": [
- "couch.spotted.amended"
- ],
- "title": "Words"
+ "description": "A string with a list of destinations seperated by `|`. Destinations can be of the format: `lat,lng,level`, `poi_id`, `ref:poi_ref`",
+ "example": "1.2,2.1,1|exit_1|1.3,3.1,2|ref:main_exit",
+ "title": "Destinations",
+ "type": "string"
},
- "description": "A 3 word address as a string. It must be three words separated with dots or a japanese middle dot character (・). Words separated by spaces will be rejected. Optionally, the 3 word address can be prefixed with /// (which would be encoded as %2F%2F%2F)"
+ "required": true,
+ "description": "A string with a list of destinations seperated by `|`. Destinations can be of the format: `lat,lng,level`, `poi_id`, `ref:poi_ref`",
+ "example": "1.2,2.1,1|exit_1|1.3,3.1,2|ref:main_exit"
},
{
- "name": "language",
"in": "query",
- "required": false,
+ "name": "language",
"schema": {
- "type": "string",
- "description": "A supported address language as an ISO 639-1 2 letter code.",
"default": "en",
- "title": "Language"
- },
- "description": "A supported address language as an ISO 639-1 2 letter code."
+ "description": "A supported language as an ISO 639-1, 2 letter code.",
+ "title": "Language",
+ "type": "string"
+ },
+ "required": false,
+ "description": "A supported language as an ISO 639-1, 2 letter code."
+ },
+ {
+ "in": "query",
+ "name": "routing_profile",
+ "schema": {
+ "default": "",
+ "description": "The routing profile to use to calculate the path (depends on the modes which were used to digitize the venue)",
+ "title": "Routing Profile",
+ "type": "string"
+ },
+ "required": false,
+ "description": "The routing profile to use to calculate the path (depends on the modes which were used to digitize the venue)"
+ },
+ {
+ "in": "query",
+ "name": "units",
+ "schema": {
+ "allOf": [
+ {
+ "enum": [
+ "metric",
+ "imperial"
+ ],
+ "title": "UnitSystem",
+ "type": "string"
+ }
+ ],
+ "default": "metric",
+ "description": "Unit System to use for response"
+ },
+ "required": false,
+ "description": "Unit System to use for response"
}
],
"responses": {
"200": {
- "description": "Successful Response",
+ "description": "OK",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_LiteAddressResponse"
+ "$ref": "#/components/schemas/Indoor_API_DistanceMatrixCollection"
}
}
}
},
- "401": {
- "description": "Unable to locate credentials.",
+ "400": {
+ "description": "Bad Request",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_AuthenticationErrorResponse"
+ "$ref": "#/components/schemas/Indoor_API_ErrorResponseSchema"
}
}
}
},
- "402": {
- "description": "Out of free quota.",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_AuthenticationErrorResponse"
+ "$ref": "#/components/schemas/Indoor_API_ErrorResponseSchema"
}
}
}
},
- "403": {
- "description": "Credentials found, but not matching.",
+ "402": {
+ "description": "Payment Required",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_AuthenticationErrorResponse"
+ "description": "A more detailed explanation on what went wrong.",
+ "title": "Detail",
+ "type": "string"
}
}
}
},
- "422": {
- "description": "Validation Error",
+ "403": {
+ "description": "Forbidden",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_HTTPValidationError"
+ "description": "A more detailed explanation on what went wrong.",
+ "title": "Detail",
+ "type": "string"
}
}
}
},
- "429": {
- "description": "Rate limit reached",
+ "422": {
+ "description": "Unprocessable Entity",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_HTTPErrorModel"
+ "properties": {
+ "detail": {
+ "description": "The validation errors.",
+ "items": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "title": "Detail",
+ "type": "array"
+ },
+ "context": {
+ "additionalProperties": true,
+ "description": "Context",
+ "title": "Context",
+ "type": "object"
+ }
+ },
+ "required": [
+ "detail",
+ "context"
+ ],
+ "title": "ValidationErrorSchema",
+ "type": "object"
}
}
}
}
},
- "x-codeSamples": [
+ "description": "Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode.\nThe API returns information consisting of rows containing distance and duration values for each pair of start and end point.\nThe returned distances are designed to be used to find and sort multiple assets by road distance.\nDuration values are provided as complementary info.\n\n**Rate limit**: `20/1s`",
+ "tags": [
+ "Indoor API"
+ ],
+ "security": [
{
- "lang": "curl",
- "label": "cURL",
- "source": "curl -L -X GET 'https://api.woosmap.com/what3words/convert-to-address?words=couch.spotted.amended&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
+ "Indoor_API_PrivateKeyAuth": []
},
{
- "lang": "python",
- "label": "Python",
- "source": "import requests\n\nurl = \"https://api.woosmap.com/what3words/convert-to-address?words=couch.spotted.amended&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"
+ "Indoor_API_PrivateKeyHeaderAuth": []
},
{
- "lang": "javascript",
- "label": "JavaScript",
- "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/what3words/convert-to-address?words=couch.spotted.amended&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
+ "Indoor_API_PublicKeyAuth": []
}
]
}
},
- "/what3words/autosuggest": {
+ "/indoor/directions/{venue_id}": {
"get": {
- "tags": [
- "Woosmap for what3words API"
- ],
- "summary": "Autosuggest",
- "description": "AutoSuggest can take a slightly incorrect 3 word address and suggest a list of valid 3 word addresses.\nIt has powerful features that can, for example, optionally limit results to a country or area,\nand prioritise results that are near the user.\n\n**Rate limit**: `20/1s`",
- "operationId": "autosuggest_what3words_autosuggest_get",
- "security": [
- {
- "External-api-wrapper_what3words_PublicAPIKey": []
- },
- {
- "External-api-wrapper_what3words_PrivateApiKey": []
- },
- {
- "External-api-wrapper_what3words_PrivateApiKeyHeader": []
- }
- ],
+ "operationId": "api_routers_indoor_directions",
+ "summary": "Directions",
"parameters": [
{
- "name": "input",
- "in": "query",
- "required": true,
+ "in": "path",
+ "name": "venue_id",
"schema": {
- "type": "string",
- "description": "The full or partial 3 word address to obtain suggestions for. At minimum this must be the first two complete words plus at least one character from the third word.",
- "examples": [
- "couch.spotted.a"
- ],
- "title": "Input"
+ "description": "ID of the Venue",
+ "title": "Venue Id",
+ "type": "string"
},
- "description": "The full or partial 3 word address to obtain suggestions for. At minimum this must be the first two complete words plus at least one character from the third word."
+ "required": true,
+ "description": "ID of the Venue"
},
{
- "name": "focus",
"in": "query",
- "required": false,
+ "name": "origin",
"schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "This is a location, specified as latitude,longitude (often where the user making the query is). If specified, the results will be weighted to give preference to those near the focus.",
- "examples": [
- "48.861026,2.335853"
- ],
- "title": "Focus"
+ "description": "A string defining the origin of the route, in the format of `lat,lng,level`, `poi_id` (identifier of a POI), or `ref:poi_ref` (ref of a POI starting with 'ref:').\n\nExamples:\n- `lat,lng,level`: `48.8818546,2.3572283,0`\n- `poi`: `123456`\n- `ref`: `ref:entrance`",
+ "example": "48.8818546,2.3572283,0",
+ "title": "Origin",
+ "type": "string"
},
- "description": "This is a location, specified as latitude,longitude (often where the user making the query is). If specified, the results will be weighted to give preference to those near the focus."
+ "required": true,
+ "description": "A string defining the origin of the route, in the format of `lat,lng,level`, `poi_id` (identifier of a POI), or `ref:poi_ref` (ref of a POI starting with 'ref:').\n\nExamples:\n- `lat,lng,level`: `48.8818546,2.3572283,0`\n- `poi`: `123456`\n- `ref`: `ref:entrance`",
+ "example": "48.8818546,2.3572283,0"
},
{
- "name": "clip-to-country",
"in": "query",
- "required": false,
+ "name": "destination",
"schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Restricts AutoSuggest to only return results inside the countries specified by comma-separated list of ISO 3166-1 alpha-2 country codes.",
- "examples": [
- "FR"
- ],
- "title": "Clip-To-Country"
+ "description": "A string defining the destination of the route, in the format of `lat,lng,level`, `poi_id` (identifier of a POI), or `ref:poi_ref` (ref of a POI starting with 'ref:').\n\nExamples:\n- `lat,lng,level`: `48.8818546,2.3572283,0`\n- `poi`: `123456`\n- `ref`: `ref:entrance`",
+ "example": "123456",
+ "title": "Destination",
+ "type": "string"
},
- "description": "Restricts AutoSuggest to only return results inside the countries specified by comma-separated list of ISO 3166-1 alpha-2 country codes."
+ "required": true,
+ "description": "A string defining the destination of the route, in the format of `lat,lng,level`, `poi_id` (identifier of a POI), or `ref:poi_ref` (ref of a POI starting with 'ref:').\n\nExamples:\n- `lat,lng,level`: `48.8818546,2.3572283,0`\n- `poi`: `123456`\n- `ref`: `ref:entrance`",
+ "example": "123456"
},
{
- "name": "clip-to-bounding-box",
"in": "query",
- "required": false,
+ "name": "language",
"schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Restrict AutoSuggest results to a bounding box, specified by coordinates.south_lat,west_lng,north_lat,east_lng, where: south_lat less than or equal to north_lat, west_lng less than or equal to east_lng.",
- "examples": [
- "48.624314,1.804429,49.058148,2.908555"
- ],
- "title": "Clip-To-Bounding-Box"
+ "default": "en",
+ "description": "A supported language as an ISO 639-1 2 letter code.",
+ "title": "Language",
+ "type": "string"
},
- "description": "Restrict AutoSuggest results to a bounding box, specified by coordinates.south_lat,west_lng,north_lat,east_lng, where: south_lat less than or equal to north_lat, west_lng less than or equal to east_lng."
+ "required": false,
+ "description": "A supported language as an ISO 639-1 2 letter code."
},
{
- "name": "clip-to-circle",
"in": "query",
- "required": false,
+ "name": "units",
"schema": {
- "anyOf": [
+ "allOf": [
{
+ "enum": [
+ "metric",
+ "imperial"
+ ],
+ "title": "UnitSystem",
"type": "string"
- },
- {
- "type": "null"
}
],
- "description": "Restrict AutoSuggest results to a circle, specified by lat, lng, kilometres, where kilometres is the radius of the circle.",
- "examples": [
- "48.839701,2.291878,20"
- ],
- "title": "Clip-To-Circle"
+ "default": "metric",
+ "description": "Unit System to use for response"
},
- "description": "Restrict AutoSuggest results to a circle, specified by lat, lng, kilometres, where kilometres is the radius of the circle."
+ "required": false,
+ "description": "Unit System to use for response"
},
{
- "name": "clip-to-polygon",
"in": "query",
- "required": false,
+ "name": "waypoints",
"schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Restrict AutoSuggest results to a polygon, specified by a comma-separated list of lat, lng pairs. The polygon should be closed, i.e. the first element should be repeated as the last element; also the list should contain at least 4 pairs. The API is currently limited to accepting up to 25 pairs.",
- "examples": [
- "48.823547,2.199174,48.823547,2.199174,48.922216,2.328709,48.888626,2.473673,48.819279,2.445513,48.784865,2.330668,48.823547,2.199174"
- ],
- "title": "Clip-To-Polygon"
+ "default": "",
+ "description": "A list of points by which the route should pass seperated by `|`. Waypoints can be of the format: `lat,lng,level`, `poi_id`, `ref:poi_ref`",
+ "example": "48.8818546,2.3572283,0|123456|48.8818546,2.3572283,0|ref:main_exit",
+ "title": "Waypoints",
+ "type": "string"
},
- "description": "Restrict AutoSuggest results to a polygon, specified by a comma-separated list of lat, lng pairs. The polygon should be closed, i.e. the first element should be repeated as the last element; also the list should contain at least 4 pairs. The API is currently limited to accepting up to 25 pairs."
+ "required": false,
+ "description": "A list of points by which the route should pass seperated by `|`. Waypoints can be of the format: `lat,lng,level`, `poi_id`, `ref:poi_ref`",
+ "example": "48.8818546,2.3572283,0|123456|48.8818546,2.3572283,0|ref:main_exit"
},
{
- "name": "input-type",
"in": "query",
- "required": false,
+ "name": "optimize",
"schema": {
- "enum": [
- "text",
- "vocon-hybrid",
- "nmdp-asr",
- "generic-voice"
- ],
- "type": "string",
- "description": "For power users, used to specify voice input mode.",
- "default": "text",
- "title": "Input-Type"
+ "default": false,
+ "description": "If true and set with the waypoints parameter. The provided route is optimized by rearranging the waypoints in a more efficient order",
+ "title": "Optimize",
+ "type": "boolean"
},
- "description": "For power users, used to specify voice input mode."
+ "required": false,
+ "description": "If true and set with the waypoints parameter. The provided route is optimized by rearranging the waypoints in a more efficient order"
},
{
- "name": "prefer-land",
"in": "query",
- "required": false,
+ "name": "mode",
"schema": {
- "type": "boolean",
- "description": "Makes AutoSuggest prefer results on land to those in the sea.",
- "default": true,
- "title": "Prefer-Land"
+ "description": "The mode to use to calculate the path (depends on the modes which were used to digitize the venue)",
+ "title": "Mode",
+ "type": "string"
},
- "description": "Makes AutoSuggest prefer results on land to those in the sea."
+ "required": false,
+ "description": "The mode to use to calculate the path (depends on the modes which were used to digitize the venue)"
},
{
- "name": "language",
"in": "query",
- "required": false,
+ "name": "avoid_in",
"schema": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "For normal text input, specifies a fallback language, which will help guide AutoSuggest if the input is particularly messy. A supported address language as an ISO 639-1 2 letter code.",
- "examples": [
- "fr"
- ],
- "title": "Language"
+ "description": "A list of Bounding Boxes which the routing should avoid seperated by `|`. A Bounding Box has a format of `level;lat,lng;lat,lng;lat,lng;lat,lng;`",
+ "example": "1;48.8818546,2.3572283;48.8818547,2.3572282;48.8818548,2.3572281;48.8818549,2.3572280",
+ "title": "Avoid In",
+ "type": "string"
},
- "description": "For normal text input, specifies a fallback language, which will help guide AutoSuggest if the input is particularly messy. A supported address language as an ISO 639-1 2 letter code."
+ "required": false,
+ "description": "A list of Bounding Boxes which the routing should avoid seperated by `|`. A Bounding Box has a format of `level;lat,lng;lat,lng;lat,lng;lat,lng;`",
+ "example": "1;48.8818546,2.3572283;48.8818547,2.3572282;48.8818548,2.3572281;48.8818549,2.3572280"
}
],
"responses": {
"200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_AutoSuggestResponse"
- }
- }
- }
- },
- "401": {
- "description": "Unable to locate credentials.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_AuthenticationErrorResponse"
- }
- }
- }
- },
- "402": {
- "description": "Out of free quota.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_AuthenticationErrorResponse"
- }
- }
- }
- },
- "403": {
- "description": "Credentials found, but not matching.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_AuthenticationErrorResponse"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_HTTPValidationError"
- }
- }
- }
- },
- "429": {
- "description": "Rate limit reached",
+ "description": "OK",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_HTTPErrorModel"
+ "$ref": "#/components/schemas/Indoor_API_RouteCollection"
}
}
}
- }
- },
- "x-codeSamples": [
- {
- "lang": "curl",
- "label": "cURL",
- "source": "curl -L -X GET 'https://api.woosmap.com/what3words/autosuggest?input=couch.spotted.am&clip-to-country=fr&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
},
- {
- "lang": "python",
- "label": "Python",
- "source": "import requests\n\nurl = \"https://api.woosmap.com/what3words/autosuggest?input=couch.spotted.am&clip-to-country=fr&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"
- },
- {
- "lang": "javascript",
- "label": "JavaScript",
- "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/what3words/autosuggest?input=couch.spotted.am&clip-to-country=fr&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
- }
- ]
- }
- },
- "/indoor/venues/{venue_id}": {
- "get": {
- "operationId": "api_routers_indoor_get_venue_by_key",
- "summary": "Get Venue By Key",
- "parameters": [
- {
- "in": "path",
- "name": "venue_id",
- "schema": {
- "description": "ID of the Venue to retrieve.",
- "title": "Venue Id",
- "type": "string"
- },
- "required": true,
- "description": "ID of the Venue to retrieve."
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
+ "400": {
+ "description": "Bad Request",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Indoor_API_VenueSchema"
+ "$ref": "#/components/schemas/Indoor_API_ErrorResponseSchema"
}
}
}
@@ -7213,7 +6821,7 @@
}
}
},
- "description": "Returns a Venue based on the ID given.\n\n**Rate limit**: `20/1s`",
+ "description": "Returns the directions to go from an Origin to a Destination.\nRouting Configuration must be done before this endpoint will work.\n\n**Rate limit**: `20/1s`",
"tags": [
"Indoor API"
],
@@ -7232,180 +6840,143 @@
{
"lang": "curl",
"label": "cURL",
- "source": "curl -L -X GET 'https://api.woosmap.com/indoor/venues/west_pal?key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
+ "source": "curl -L -X GET 'https://api.woosmap.com/indoor/directions/west_pal?language=en&units=metric&origin=3623024&destination=3625106&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
},
{
"lang": "python",
"label": "Python",
- "source": "import requests\n\nurl = \"https://api.woosmap.com/indoor/venues/west_pal?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/indoor/directions/west_pal?language=en&units=metric&origin=3623024&destination=3625106&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"
},
{
"lang": "javascript",
"label": "JavaScript",
- "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/indoor/venues/west_pal?key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
+ "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/indoor/directions/west_pal?language=en&units=metric&origin=3623024&destination=3625106&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
}
]
}
},
- "/indoor/venues": {
+ "/indoor/venues/{venue_id}/pois/search": {
"get": {
- "operationId": "api_routers_indoor_get_venues_by_key",
- "summary": "Get Venues By Key",
+ "operationId": "api_routers_indoor_search_venue_pois_by_key",
+ "summary": "Search Venue Pois By Key",
"parameters": [
+ {
+ "in": "path",
+ "name": "venue_id",
+ "schema": {
+ "description": "ID of the Venue",
+ "title": "Venue Id",
+ "type": "string"
+ },
+ "required": true,
+ "description": "ID of the Venue"
+ },
{
"in": "query",
- "name": "sort_by",
+ "name": "items_by_page",
"schema": {
- "allOf": [
- {
- "enum": [
- "created_at",
- "updated_at",
- "name"
- ],
- "title": "SortingInputSchema",
- "type": "string"
- }
- ],
- "description": "The order in which the venues should be retrieved"
+ "default": 0,
+ "description": "Number of items per page. A value of 0 means no pagination.",
+ "title": "Items By Page",
+ "type": "integer"
},
"required": false,
- "description": "The order in which the venues should be retrieved"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/Indoor_API_VenueListSchema"
- },
- "title": "Response",
- "type": "array"
- }
- }
- }
+ "description": "Number of items per page. A value of 0 means no pagination."
},
- "401": {
- "description": "Unauthorized",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Indoor_API_ErrorResponseSchema"
- }
- }
- }
+ {
+ "in": "query",
+ "name": "page",
+ "schema": {
+ "default": 0,
+ "description": "Page number. 0 being the first page.",
+ "title": "Page",
+ "type": "integer"
+ },
+ "required": false,
+ "description": "Page number. 0 being the first page."
},
- "402": {
- "description": "Payment Required",
- "content": {
- "application/json": {
- "schema": {
- "description": "A more detailed explanation on what went wrong.",
- "title": "Detail",
- "type": "string"
- }
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "description": "A more detailed explanation on what went wrong.",
- "title": "Detail",
- "type": "string"
- }
- }
- }
- },
- "422": {
- "description": "Unprocessable Entity",
- "content": {
- "application/json": {
- "schema": {
- "properties": {
- "detail": {
- "description": "The validation errors.",
- "items": {
- "additionalProperties": true,
- "type": "object"
- },
- "title": "Detail",
- "type": "array"
- },
- "context": {
- "additionalProperties": true,
- "description": "Context",
- "title": "Context",
- "type": "object"
- }
- },
- "required": [
- "detail",
- "context"
- ],
- "title": "ValidationErrorSchema",
- "type": "object"
- }
- }
- }
- }
- },
- "description": "Returns a list of Venues associated with the project of the key used to authenticate the request.\n\n**Rate limit**: `20/1s`",
- "tags": [
- "Indoor API"
- ],
- "security": [
{
- "Indoor_API_PrivateKeyAuth": []
+ "in": "query",
+ "name": "from_location",
+ "schema": {
+ "description": "A string with the format lat,lng,level",
+ "example": "48.8818546,2.3572283,0",
+ "title": "From Location",
+ "type": "string"
+ },
+ "required": false,
+ "description": "A string with the format lat,lng,level",
+ "example": "48.8818546,2.3572283,0"
},
{
- "Indoor_API_PrivateKeyHeaderAuth": []
+ "in": "query",
+ "name": "q",
+ "schema": {
+ "description": "Search string. If not passed then all features will be listed alphabetically",
+ "title": "Q",
+ "type": "string"
+ },
+ "required": false,
+ "description": "Search string. If not passed then all features will be listed alphabetically"
},
{
- "Indoor_API_PublicKeyAuth": []
- }
- ],
- "x-codeSamples": [
+ "in": "query",
+ "name": "extended",
+ "schema": {
+ "description": "Option to search even not searchable pois (extended=full)",
+ "example": "full",
+ "title": "Extended",
+ "type": "string"
+ },
+ "required": false,
+ "description": "Option to search even not searchable pois (extended=full)",
+ "example": "full"
+ },
{
- "lang": "curl",
- "label": "cURL",
- "source": "curl -L -X GET 'https://api.woosmap.com/indoor/venues?key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
+ "in": "query",
+ "name": "level",
+ "schema": {
+ "description": "Filter by level.",
+ "title": "Level",
+ "type": "integer"
+ },
+ "required": false,
+ "description": "Filter by level."
},
{
- "lang": "python",
- "label": "Python",
- "source": "import requests\n\nurl = \"https://api.woosmap.com/indoor/venues?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"
+ "in": "query",
+ "name": "building",
+ "schema": {
+ "description": "Filter by building (use `undefined` to find POIs not associated with a building.).",
+ "title": "Building",
+ "type": "string"
+ },
+ "required": false,
+ "description": "Filter by building (use `undefined` to find POIs not associated with a building.)."
},
{
- "lang": "javascript",
- "label": "JavaScript",
- "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/indoor/venues?key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
- }
- ]
- }
- },
- "/indoor/style": {
- "get": {
- "operationId": "api_routers_indoor_get_indoor_style",
- "summary": "Get Indoor Style",
- "parameters": [
+ "in": "query",
+ "name": "category",
+ "schema": {
+ "description": "Filter by category.",
+ "title": "Category",
+ "type": "string"
+ },
+ "required": false,
+ "description": "Filter by category."
+ },
{
"in": "query",
- "name": "theme",
+ "name": "ref",
"schema": {
- "description": "The theme to apply to customize the style",
- "example": "woosmap_default",
- "title": "Theme",
+ "description": "Filter by a comma seperated list of POI Refs.",
+ "example": "ref:main_entrance,ref:side_entrance",
+ "title": "Ref",
"type": "string"
},
"required": false,
- "description": "The theme to apply to customize the style",
- "example": "woosmap_default"
+ "description": "Filter by a comma seperated list of POI Refs.",
+ "example": "ref:main_entrance,ref:side_entrance"
},
{
"in": "query",
@@ -7418,6 +6989,30 @@
},
"required": false,
"description": "A supported language as an ISO 639-1 2 letter code."
+ },
+ {
+ "in": "query",
+ "name": "advanced_filter",
+ "schema": {
+ "description": "Filter by complex queries on properties (ex: indoor:=\"room\" OR door:=\"yes\").",
+ "title": "Advanced Filter",
+ "type": "string"
+ },
+ "required": false,
+ "description": "Filter by complex queries on properties (ex: indoor:=\"room\" OR door:=\"yes\")."
+ },
+ {
+ "in": "query",
+ "name": "id",
+ "schema": {
+ "description": "Filter by a comma seperated list of POI IDs.",
+ "example": "1234,4321,9876",
+ "title": "Id",
+ "type": "string"
+ },
+ "required": false,
+ "description": "Filter by a comma seperated list of POI IDs.",
+ "example": "1234,4321,9876"
}
],
"responses": {
@@ -7426,9 +7021,7 @@
"content": {
"application/json": {
"schema": {
- "additionalProperties": true,
- "title": "Response",
- "type": "object"
+ "$ref": "#/components/schemas/Indoor_API_SearchPagination"
}
}
}
@@ -7500,7 +7093,7 @@
}
}
},
- "description": "Returns the style layers.\n\n**Rate limit**: `20/1s`",
+ "description": "Full text search of the features of a venue using name or description\n\n**Rate limit**: `30/1s`",
"tags": [
"Indoor API"
],
@@ -7519,25 +7112,25 @@
{
"lang": "curl",
"label": "cURL",
- "source": "curl -L -X GET 'https://api.woosmap.com/indoor/style?language=en&theme=woosmap_default&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
+ "source": "curl -L -X GET 'https://api.woosmap.com/indoor/venues/west_pal/pois/search?id=3623459&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
},
{
"lang": "python",
"label": "Python",
- "source": "import requests\n\nurl = \"https://api.woosmap.com/indoor/style?language=en&theme=woosmap_default&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/indoor/venues/west_pal/pois/search?id=3623459&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"
},
{
"lang": "javascript",
"label": "JavaScript",
- "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/indoor/style?language=en&theme=woosmap_default&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
+ "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/indoor/venues/west_pal/pois/search?id=3623459&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
}
]
}
},
- "/indoor/distancematrix/{venue_id}": {
+ "/indoor/venues/{venue_id}/pois/autocomplete": {
"get": {
- "operationId": "api_routers_indoor_distance_matrix",
- "summary": "Distance Matrix",
+ "operationId": "api_routers_indoor_autocomplete_venue_pois_by_key",
+ "summary": "Autocomplete Venue Pois By Key",
"parameters": [
{
"in": "path",
@@ -7552,73 +7145,133 @@
},
{
"in": "query",
- "name": "origins",
+ "name": "items_by_page",
"schema": {
- "description": "A string with a list of origins seperated by `|`. Origins can be of the format: `lat,lng,level`, `poi_id`, `ref:poi_ref`",
- "example": "1.2,2.1,1|exit_1|1.3,3.1,2|ref:main_exit",
- "title": "Origins",
- "type": "string"
+ "default": 0,
+ "description": "Number of items per page. A value of 0 means no pagination.",
+ "title": "Items By Page",
+ "type": "integer"
},
- "required": true,
- "description": "A string with a list of origins seperated by `|`. Origins can be of the format: `lat,lng,level`, `poi_id`, `ref:poi_ref`",
- "example": "1.2,2.1,1|exit_1|1.3,3.1,2|ref:main_exit"
+ "required": false,
+ "description": "Number of items per page. A value of 0 means no pagination."
},
{
"in": "query",
- "name": "destinations",
+ "name": "page",
"schema": {
- "description": "A string with a list of destinations seperated by `|`. Destinations can be of the format: `lat,lng,level`, `poi_id`, `ref:poi_ref`",
- "example": "1.2,2.1,1|exit_1|1.3,3.1,2|ref:main_exit",
- "title": "Destinations",
- "type": "string"
+ "default": 0,
+ "description": "Page number. 0 being the first page.",
+ "title": "Page",
+ "type": "integer"
},
- "required": true,
- "description": "A string with a list of destinations seperated by `|`. Destinations can be of the format: `lat,lng,level`, `poi_id`, `ref:poi_ref`",
- "example": "1.2,2.1,1|exit_1|1.3,3.1,2|ref:main_exit"
+ "required": false,
+ "description": "Page number. 0 being the first page."
},
{
"in": "query",
- "name": "language",
+ "name": "from_location",
"schema": {
- "default": "en",
- "description": "A supported language as an ISO 639-1, 2 letter code.",
- "title": "Language",
+ "description": "A string with the format lat,lng,level",
+ "example": "48.8818546,2.3572283,0",
+ "title": "From Location",
"type": "string"
},
"required": false,
- "description": "A supported language as an ISO 639-1, 2 letter code."
+ "description": "A string with the format lat,lng,level",
+ "example": "48.8818546,2.3572283,0"
},
{
"in": "query",
- "name": "routing_profile",
+ "name": "q",
"schema": {
- "default": "",
- "description": "The routing profile to use to calculate the path (depends on the modes which were used to digitize the venue)",
- "title": "Routing Profile",
+ "description": "Search string. If not passed then all features will be listed alphabetically",
+ "title": "Q",
"type": "string"
},
"required": false,
- "description": "The routing profile to use to calculate the path (depends on the modes which were used to digitize the venue)"
+ "description": "Search string. If not passed then all features will be listed alphabetically"
},
{
"in": "query",
- "name": "units",
+ "name": "extended",
"schema": {
- "allOf": [
- {
- "enum": [
- "metric",
- "imperial"
- ],
- "title": "UnitSystem",
- "type": "string"
- }
- ],
- "default": "metric",
- "description": "Unit System to use for response"
+ "description": "Option to search even not searchable pois (extended=full)",
+ "example": "full",
+ "title": "Extended",
+ "type": "string"
},
"required": false,
- "description": "Unit System to use for response"
+ "description": "Option to search even not searchable pois (extended=full)",
+ "example": "full"
+ },
+ {
+ "in": "query",
+ "name": "level",
+ "schema": {
+ "description": "Filter by level.",
+ "title": "Level",
+ "type": "integer"
+ },
+ "required": false,
+ "description": "Filter by level."
+ },
+ {
+ "in": "query",
+ "name": "building",
+ "schema": {
+ "description": "Filter by building (use `undefined` to find POIs not associated with a building.).",
+ "title": "Building",
+ "type": "string"
+ },
+ "required": false,
+ "description": "Filter by building (use `undefined` to find POIs not associated with a building.)."
+ },
+ {
+ "in": "query",
+ "name": "category",
+ "schema": {
+ "description": "Filter by category.",
+ "title": "Category",
+ "type": "string"
+ },
+ "required": false,
+ "description": "Filter by category."
+ },
+ {
+ "in": "query",
+ "name": "ref",
+ "schema": {
+ "description": "Filter by a comma seperated list of POI Refs.",
+ "example": "ref:main_entrance,ref:side_entrance",
+ "title": "Ref",
+ "type": "string"
+ },
+ "required": false,
+ "description": "Filter by a comma seperated list of POI Refs.",
+ "example": "ref:main_entrance,ref:side_entrance"
+ },
+ {
+ "in": "query",
+ "name": "language",
+ "schema": {
+ "default": "en",
+ "description": "A supported language as an ISO 639-1 2 letter code.",
+ "title": "Language",
+ "type": "string"
+ },
+ "required": false,
+ "description": "A supported language as an ISO 639-1 2 letter code."
+ },
+ {
+ "in": "query",
+ "name": "advanced_filter",
+ "schema": {
+ "description": "Filter by complex queries on properties (ex: indoor:=\"room\" OR door:=\"yes\").",
+ "title": "Advanced Filter",
+ "type": "string"
+ },
+ "required": false,
+ "description": "Filter by complex queries on properties (ex: indoor:=\"room\" OR door:=\"yes\")."
}
],
"responses": {
@@ -7627,17 +7280,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Indoor_API_DistanceMatrixCollection"
- }
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Indoor_API_ErrorResponseSchema"
+ "$ref": "#/components/schemas/Indoor_API_AutocompletePagination"
}
}
}
@@ -7709,7 +7352,7 @@
}
}
},
- "description": "Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode.\nThe API returns information consisting of rows containing distance and duration values for each pair of start and end point.\nThe returned distances are designed to be used to find and sort multiple assets by road distance.\nDuration values are provided as complementary info.\n\n**Rate limit**: `20/1s`",
+ "description": "Autocomplete text search of the features of a venue using a name or description\n\n**Rate limit**: `20/1s`",
"tags": [
"Indoor API"
],
@@ -7723,132 +7366,52 @@
{
"Indoor_API_PublicKeyAuth": []
}
+ ],
+ "x-codeSamples": [
+ {
+ "lang": "curl",
+ "label": "cURL",
+ "source": "curl -L -X GET 'https://api.woosmap.com/indoor/venues/west_pal/pois/autocomplete?q=cham&language=en&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
+ },
+ {
+ "lang": "python",
+ "label": "Python",
+ "source": "import requests\n\nurl = \"https://api.woosmap.com/indoor/venues/west_pal/pois/autocomplete?q=cham&language=en&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"
+ },
+ {
+ "lang": "javascript",
+ "label": "JavaScript",
+ "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/indoor/venues/west_pal/pois/autocomplete?q=cham&language=en&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
+ }
]
}
},
- "/indoor/directions/{venue_id}": {
+ "/indoor/venues/{venue_id}/features/{feature_id}": {
"get": {
- "operationId": "api_routers_indoor_directions",
- "summary": "Directions",
+ "operationId": "api_routers_indoor_get_feature_by_key",
+ "summary": "Get Feature By Key",
"parameters": [
{
"in": "path",
"name": "venue_id",
"schema": {
- "description": "ID of the Venue",
+ "description": "ID of the venue",
"title": "Venue Id",
"type": "string"
},
"required": true,
- "description": "ID of the Venue"
- },
- {
- "in": "query",
- "name": "origin",
- "schema": {
- "description": "A string defining the origin of the route, in the format of `lat,lng,level`, `poi_id` (identifier of a POI), or `ref:poi_ref` (ref of a POI starting with 'ref:').\n\nExamples:\n- `lat,lng,level`: `48.8818546,2.3572283,0`\n- `poi`: `123456`\n- `ref`: `ref:entrance`",
- "example": "48.8818546,2.3572283,0",
- "title": "Origin",
- "type": "string"
- },
- "required": true,
- "description": "A string defining the origin of the route, in the format of `lat,lng,level`, `poi_id` (identifier of a POI), or `ref:poi_ref` (ref of a POI starting with 'ref:').\n\nExamples:\n- `lat,lng,level`: `48.8818546,2.3572283,0`\n- `poi`: `123456`\n- `ref`: `ref:entrance`",
- "example": "48.8818546,2.3572283,0"
+ "description": "ID of the venue"
},
{
- "in": "query",
- "name": "destination",
+ "in": "path",
+ "name": "feature_id",
"schema": {
- "description": "A string defining the destination of the route, in the format of `lat,lng,level`, `poi_id` (identifier of a POI), or `ref:poi_ref` (ref of a POI starting with 'ref:').\n\nExamples:\n- `lat,lng,level`: `48.8818546,2.3572283,0`\n- `poi`: `123456`\n- `ref`: `ref:entrance`",
- "example": "123456",
- "title": "Destination",
- "type": "string"
+ "description": "ID of the feature",
+ "title": "Feature Id",
+ "type": "integer"
},
"required": true,
- "description": "A string defining the destination of the route, in the format of `lat,lng,level`, `poi_id` (identifier of a POI), or `ref:poi_ref` (ref of a POI starting with 'ref:').\n\nExamples:\n- `lat,lng,level`: `48.8818546,2.3572283,0`\n- `poi`: `123456`\n- `ref`: `ref:entrance`",
- "example": "123456"
- },
- {
- "in": "query",
- "name": "language",
- "schema": {
- "default": "en",
- "description": "A supported language as an ISO 639-1 2 letter code.",
- "title": "Language",
- "type": "string"
- },
- "required": false,
- "description": "A supported language as an ISO 639-1 2 letter code."
- },
- {
- "in": "query",
- "name": "units",
- "schema": {
- "allOf": [
- {
- "enum": [
- "metric",
- "imperial"
- ],
- "title": "UnitSystem",
- "type": "string"
- }
- ],
- "default": "metric",
- "description": "Unit System to use for response"
- },
- "required": false,
- "description": "Unit System to use for response"
- },
- {
- "in": "query",
- "name": "waypoints",
- "schema": {
- "default": "",
- "description": "A list of points by which the route should pass seperated by `|`. Waypoints can be of the format: `lat,lng,level`, `poi_id`, `ref:poi_ref`",
- "example": "48.8818546,2.3572283,0|123456|48.8818546,2.3572283,0|ref:main_exit",
- "title": "Waypoints",
- "type": "string"
- },
- "required": false,
- "description": "A list of points by which the route should pass seperated by `|`. Waypoints can be of the format: `lat,lng,level`, `poi_id`, `ref:poi_ref`",
- "example": "48.8818546,2.3572283,0|123456|48.8818546,2.3572283,0|ref:main_exit"
- },
- {
- "in": "query",
- "name": "optimize",
- "schema": {
- "default": false,
- "description": "If true and set with the waypoints parameter. The provided route is optimized by rearranging the waypoints in a more efficient order",
- "title": "Optimize",
- "type": "boolean"
- },
- "required": false,
- "description": "If true and set with the waypoints parameter. The provided route is optimized by rearranging the waypoints in a more efficient order"
- },
- {
- "in": "query",
- "name": "mode",
- "schema": {
- "description": "The mode to use to calculate the path (depends on the modes which were used to digitize the venue)",
- "title": "Mode",
- "type": "string"
- },
- "required": false,
- "description": "The mode to use to calculate the path (depends on the modes which were used to digitize the venue)"
- },
- {
- "in": "query",
- "name": "avoid_in",
- "schema": {
- "description": "A list of Bounding Boxes which the routing should avoid seperated by `|`. A Bounding Box has a format of `level;lat,lng;lat,lng;lat,lng;lat,lng;`",
- "example": "1;48.8818546,2.3572283;48.8818547,2.3572282;48.8818548,2.3572281;48.8818549,2.3572280",
- "title": "Avoid In",
- "type": "string"
- },
- "required": false,
- "description": "A list of Bounding Boxes which the routing should avoid seperated by `|`. A Bounding Box has a format of `level;lat,lng;lat,lng;lat,lng;lat,lng;`",
- "example": "1;48.8818546,2.3572283;48.8818547,2.3572282;48.8818548,2.3572281;48.8818549,2.3572280"
+ "description": "ID of the feature"
}
],
"responses": {
@@ -7857,17 +7420,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Indoor_API_RouteCollection"
- }
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Indoor_API_ErrorResponseSchema"
+ "$ref": "#/components/schemas/Indoor_API_SingleIndoorFeatureSchema"
}
}
}
@@ -7939,7 +7492,7 @@
}
}
},
- "description": "Returns the directions to go from an Origin to a Destination.\nRouting Configuration must be done before this endpoint will work.\n\n**Rate limit**: `20/1s`",
+ "description": "Returns a single feature using its ID.\n\n**Rate limit**: `20/1s`",
"tags": [
"Indoor API"
],
@@ -7958,179 +7511,92 @@
{
"lang": "curl",
"label": "cURL",
- "source": "curl -L -X GET 'https://api.woosmap.com/indoor/directions/west_pal?language=en&units=metric&origin=3623024&destination=3625106&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
+ "source": "curl -L -X GET 'https://api.woosmap.com/indoor/venues/west_pal/features/3623459?key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
},
{
"lang": "python",
"label": "Python",
- "source": "import requests\n\nurl = \"https://api.woosmap.com/indoor/directions/west_pal?language=en&units=metric&origin=3623024&destination=3625106&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/indoor/venues/west_pal/features/3623459?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"
},
{
"lang": "javascript",
"label": "JavaScript",
- "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/indoor/directions/west_pal?language=en&units=metric&origin=3623024&destination=3625106&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
+ "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/indoor/venues/west_pal/features/3623459?key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
}
]
}
},
- "/indoor/venues/{venue_id}/pois/search": {
+ "/indoor/venues/{venue_id}/tiles/{z}/{x}/{y}.pbf": {
"get": {
- "operationId": "api_routers_indoor_search_venue_pois_by_key",
- "summary": "Search Venue Pois By Key",
+ "operationId": "api_routers_indoor_tiles_by_key",
+ "summary": "Tiles By Key",
"parameters": [
{
"in": "path",
"name": "venue_id",
"schema": {
- "description": "ID of the Venue",
+ "description": "ID of the venue",
"title": "Venue Id",
"type": "string"
},
"required": true,
- "description": "ID of the Venue"
+ "description": "ID of the venue"
},
{
- "in": "query",
- "name": "items_by_page",
+ "in": "path",
+ "name": "x",
"schema": {
- "default": 0,
- "description": "Number of items per page. A value of 0 means no pagination.",
- "title": "Items By Page",
+ "description": "X coordinate of the tile",
+ "title": "X",
"type": "integer"
},
- "required": false,
- "description": "Number of items per page. A value of 0 means no pagination."
+ "required": true,
+ "description": "X coordinate of the tile"
},
{
- "in": "query",
- "name": "page",
+ "in": "path",
+ "name": "y",
"schema": {
- "default": 0,
- "description": "Page number. 0 being the first page.",
- "title": "Page",
+ "description": "Y coordinate of the tile",
+ "title": "Y",
"type": "integer"
},
- "required": false,
- "description": "Page number. 0 being the first page."
- },
- {
- "in": "query",
- "name": "from_location",
- "schema": {
- "description": "A string with the format lat,lng,level",
- "example": "48.8818546,2.3572283,0",
- "title": "From Location",
- "type": "string"
- },
- "required": false,
- "description": "A string with the format lat,lng,level",
- "example": "48.8818546,2.3572283,0"
- },
- {
- "in": "query",
- "name": "q",
- "schema": {
- "description": "Search string. If not passed then all features will be listed alphabetically",
- "title": "Q",
- "type": "string"
- },
- "required": false,
- "description": "Search string. If not passed then all features will be listed alphabetically"
- },
- {
- "in": "query",
- "name": "extended",
- "schema": {
- "description": "Option to search even not searchable pois (extended=full)",
- "example": "full",
- "title": "Extended",
- "type": "string"
- },
- "required": false,
- "description": "Option to search even not searchable pois (extended=full)",
- "example": "full"
+ "required": true,
+ "description": "Y coordinate of the tile"
},
{
- "in": "query",
- "name": "level",
+ "in": "path",
+ "name": "z",
"schema": {
- "description": "Filter by level.",
- "title": "Level",
+ "description": "Zoom level",
+ "title": "Z",
"type": "integer"
},
- "required": false,
- "description": "Filter by level."
- },
- {
- "in": "query",
- "name": "building",
- "schema": {
- "description": "Filter by building (use `undefined` to find POIs not associated with a building.).",
- "title": "Building",
- "type": "string"
- },
- "required": false,
- "description": "Filter by building (use `undefined` to find POIs not associated with a building.)."
- },
- {
- "in": "query",
- "name": "category",
- "schema": {
- "description": "Filter by category.",
- "title": "Category",
- "type": "string"
- },
- "required": false,
- "description": "Filter by category."
- },
- {
- "in": "query",
- "name": "ref",
- "schema": {
- "description": "Filter by a comma seperated list of POI Refs.",
- "example": "ref:main_entrance,ref:side_entrance",
- "title": "Ref",
- "type": "string"
- },
- "required": false,
- "description": "Filter by a comma seperated list of POI Refs.",
- "example": "ref:main_entrance,ref:side_entrance"
- },
- {
- "in": "query",
- "name": "language",
- "schema": {
- "default": "en",
- "description": "A supported language as an ISO 639-1 2 letter code.",
- "title": "Language",
- "type": "string"
- },
- "required": false,
- "description": "A supported language as an ISO 639-1 2 letter code."
+ "required": true,
+ "description": "Zoom level"
},
{
"in": "query",
"name": "advanced_filter",
"schema": {
- "description": "Filter by complex queries on properties (ex: indoor:=\"room\" OR door:=\"yes\").",
+ "description": "Filter POI labels by advanced filter.",
"title": "Advanced Filter",
"type": "string"
},
"required": false,
- "description": "Filter by complex queries on properties (ex: indoor:=\"room\" OR door:=\"yes\")."
+ "description": "Filter POI labels by advanced filter."
},
{
"in": "query",
- "name": "id",
+ "name": "disable_zoom_min",
"schema": {
- "description": "Filter by a comma seperated list of POI IDs.",
- "example": "1234,4321,9876",
- "title": "Id",
- "type": "string"
+ "default": false,
+ "description": "Disable the zoom_min for POIs.",
+ "title": "Disable Zoom Min",
+ "type": "boolean"
},
"required": false,
- "description": "Filter by a comma seperated list of POI IDs.",
- "example": "1234,4321,9876"
+ "description": "Disable the zoom_min for POIs."
}
],
"responses": {
@@ -8139,7 +7605,9 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Indoor_API_SearchPagination"
+ "format": "binary",
+ "title": "Response",
+ "type": "string"
}
}
}
@@ -8149,7 +7617,9 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Indoor_API_ErrorResponseSchema"
+ "description": "A more detailed explanation on what went wrong.",
+ "title": "Detail",
+ "type": "string"
}
}
}
@@ -8211,7 +7681,7 @@
}
}
},
- "description": "Full text search of the features of a venue using name or description\n\n**Rate limit**: `30/1s`",
+ "description": "Returns a tile for the venue.\n\n**Rate limit**: `50/1s`",
"tags": [
"Indoor API"
],
@@ -8225,712 +7695,455 @@
{
"Indoor_API_PublicKeyAuth": []
}
+ ]
+ }
+ },
+ "/transit/route": {
+ "get": {
+ "tags": [
+ "Transit API"
],
- "x-codeSamples": [
+ "summary": "Transit Route",
+ "description": "**Rate limit**: `10/1s`",
+ "operationId": "transit_route_transit_route_get",
+ "security": [
{
- "lang": "curl",
- "label": "cURL",
- "source": "curl -L -X GET 'https://api.woosmap.com/indoor/venues/west_pal/pois/search?id=3623459&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
+ "External-api-wrapper_PublicAPIKey": []
},
{
- "lang": "python",
- "label": "Python",
- "source": "import requests\n\nurl = \"https://api.woosmap.com/indoor/venues/west_pal/pois/search?id=3623459&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"
+ "External-api-wrapper_PrivateApiKey": []
},
{
- "lang": "javascript",
- "label": "JavaScript",
- "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/indoor/venues/west_pal/pois/search?id=3623459&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
+ "External-api-wrapper_PrivateApiKeyHeader": []
}
- ]
- }
- },
- "/indoor/venues/{venue_id}/pois/autocomplete": {
- "get": {
- "operationId": "api_routers_indoor_autocomplete_venue_pois_by_key",
- "summary": "Autocomplete Venue Pois By Key",
+ ],
"parameters": [
{
- "in": "path",
- "name": "venue_id",
+ "name": "departure_time",
+ "in": "query",
+ "required": false,
"schema": {
- "description": "ID of the venue",
- "title": "Venue Id",
- "type": "string"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Departure Time",
+ "description": "DateTime with or without timezone, if not set the default datetime is the current one",
+ "examples": [
+ "2024-01-01T12:00:00%2B01:00"
+ ]
},
- "required": true,
- "description": "ID of the venue"
+ "description": "DateTime with or without timezone, if not set the default datetime is the current one"
},
{
+ "name": "arrival_time",
"in": "query",
- "name": "items_by_page",
+ "required": false,
"schema": {
- "default": 0,
- "description": "Number of items per page. A value of 0 means no pagination.",
- "title": "Items By Page",
- "type": "integer"
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Arrival Time",
+ "description": "DateTime with or without timezone, if departure_time is defined this parameter is ignored",
+ "examples": [
+ "2024-01-01T14:00:00%2B01:00"
+ ]
},
- "required": false,
- "description": "Number of items per page. A value of 0 means no pagination."
+ "description": "DateTime with or without timezone, if departure_time is defined this parameter is ignored"
},
{
+ "name": "origin",
"in": "query",
- "name": "page",
+ "required": true,
"schema": {
- "default": 0,
- "description": "Page number. 0 being the first page.",
- "title": "Page",
- "type": "integer"
+ "type": "string",
+ "title": "Position",
+ "description": "WGS84 coordinates as format lat,lng",
+ "examples": [
+ "lat,lng"
+ ]
},
- "required": false,
- "description": "Page number. 0 being the first page."
+ "description": "WGS84 coordinates as format lat,lng"
},
{
+ "name": "destination",
"in": "query",
- "name": "from_location",
+ "required": true,
"schema": {
- "description": "A string with the format lat,lng,level",
- "example": "48.8818546,2.3572283,0",
- "title": "From Location",
- "type": "string"
- },
- "required": false,
- "description": "A string with the format lat,lng,level",
- "example": "48.8818546,2.3572283,0"
- },
- {
- "in": "query",
- "name": "q",
- "schema": {
- "description": "Search string. If not passed then all features will be listed alphabetically",
- "title": "Q",
- "type": "string"
- },
- "required": false,
- "description": "Search string. If not passed then all features will be listed alphabetically"
- },
- {
- "in": "query",
- "name": "extended",
- "schema": {
- "description": "Option to search even not searchable pois (extended=full)",
- "example": "full",
- "title": "Extended",
- "type": "string"
- },
- "required": false,
- "description": "Option to search even not searchable pois (extended=full)",
- "example": "full"
- },
- {
- "in": "query",
- "name": "level",
- "schema": {
- "description": "Filter by level.",
- "title": "Level",
- "type": "integer"
- },
- "required": false,
- "description": "Filter by level."
- },
- {
- "in": "query",
- "name": "building",
- "schema": {
- "description": "Filter by building (use `undefined` to find POIs not associated with a building.).",
- "title": "Building",
- "type": "string"
- },
- "required": false,
- "description": "Filter by building (use `undefined` to find POIs not associated with a building.)."
- },
- {
- "in": "query",
- "name": "category",
- "schema": {
- "description": "Filter by category.",
- "title": "Category",
- "type": "string"
- },
- "required": false,
- "description": "Filter by category."
- },
- {
- "in": "query",
- "name": "ref",
- "schema": {
- "description": "Filter by a comma seperated list of POI Refs.",
- "example": "ref:main_entrance,ref:side_entrance",
- "title": "Ref",
- "type": "string"
+ "type": "string",
+ "title": "Position",
+ "description": "WGS84 coordinates as format lat,lng",
+ "examples": [
+ "lat,lng"
+ ]
},
- "required": false,
- "description": "Filter by a comma seperated list of POI Refs.",
- "example": "ref:main_entrance,ref:side_entrance"
+ "description": "WGS84 coordinates as format lat,lng"
},
{
+ "name": "modes",
"in": "query",
- "name": "language",
- "schema": {
- "default": "en",
- "description": "A supported language as an ISO 639-1 2 letter code.",
- "title": "Language",
- "type": "string"
- },
"required": false,
- "description": "A supported language as an ISO 639-1 2 letter code."
- },
- {
- "in": "query",
- "name": "advanced_filter",
"schema": {
- "description": "Filter by complex queries on properties (ex: indoor:=\"room\" OR door:=\"yes\").",
- "title": "Advanced Filter",
- "type": "string"
+ "type": "string",
+ "title": "Array of Modes (string) or Excluded modes (string) (TransitModesFilter)",
+ "description": "Transit mode filter used to determine which modes of transit to include in the response. \n By default, all supported transit modes are permitted. Supported modes: `highSpeedTrain` `intercityTrain` `interRegionalTrain` `regionalTrain` `cityTrain` `bus` `ferry` `subway` `lightRail` `privateBus` `inclined` `aerial` `busRapid` `monorail` `flight` `spaceship` This parameter also support an exclusion list: It's sufficient to specify each mode to exclude by prefixing it with `-`. \n Mixing of inclusive and exclusive transit modes is not allowed.",
+ "examples": [
+ "subway,bus",
+ "-subway,-bus"
+ ]
},
- "required": false,
- "description": "Filter by complex queries on properties (ex: indoor:=\"room\" OR door:=\"yes\")."
+ "description": "Transit mode filter used to determine which modes of transit to include in the response. \n By default, all supported transit modes are permitted. Supported modes: `highSpeedTrain` `intercityTrain` `interRegionalTrain` `regionalTrain` `cityTrain` `bus` `ferry` `subway` `lightRail` `privateBus` `inclined` `aerial` `busRapid` `monorail` `flight` `spaceship` This parameter also support an exclusion list: It's sufficient to specify each mode to exclude by prefixing it with `-`. \n Mixing of inclusive and exclusive transit modes is not allowed."
}
],
"responses": {
"200": {
- "description": "OK",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Indoor_API_AutocompletePagination"
+ "$ref": "#/components/schemas/External-api-wrapper_Transit"
}
}
}
},
"401": {
- "description": "Unauthorized",
+ "description": "Unable to locate credentials.",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Indoor_API_ErrorResponseSchema"
+ "$ref": "#/components/schemas/External-api-wrapper_AuthenticationErrorResponse"
}
}
}
},
"402": {
- "description": "Payment Required",
+ "description": "Out of free quota.",
"content": {
"application/json": {
"schema": {
- "description": "A more detailed explanation on what went wrong.",
- "title": "Detail",
- "type": "string"
+ "$ref": "#/components/schemas/External-api-wrapper_AuthenticationErrorResponse"
}
}
}
},
"403": {
- "description": "Forbidden",
+ "description": "Credentials found, but not matching.",
"content": {
"application/json": {
"schema": {
- "description": "A more detailed explanation on what went wrong.",
- "title": "Detail",
- "type": "string"
+ "$ref": "#/components/schemas/External-api-wrapper_AuthenticationErrorResponse"
}
}
}
},
"422": {
- "description": "Unprocessable Entity",
+ "description": "Validation Error",
"content": {
"application/json": {
"schema": {
- "properties": {
- "detail": {
- "description": "The validation errors.",
- "items": {
- "additionalProperties": true,
- "type": "object"
- },
- "title": "Detail",
- "type": "array"
- },
- "context": {
- "additionalProperties": true,
- "description": "Context",
- "title": "Context",
- "type": "object"
- }
- },
- "required": [
- "detail",
- "context"
- ],
- "title": "ValidationErrorSchema",
- "type": "object"
+ "$ref": "#/components/schemas/External-api-wrapper_HTTPValidationError"
}
}
}
- }
- },
- "description": "Autocomplete text search of the features of a venue using a name or description\n\n**Rate limit**: `20/1s`",
- "tags": [
- "Indoor API"
- ],
- "security": [
- {
- "Indoor_API_PrivateKeyAuth": []
},
- {
- "Indoor_API_PrivateKeyHeaderAuth": []
- },
- {
- "Indoor_API_PublicKeyAuth": []
+ "429": {
+ "description": "Rate limit reached",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/External-api-wrapper_HTTPErrorModel"
+ }
+ }
+ }
}
- ],
+ },
"x-codeSamples": [
{
"lang": "curl",
"label": "cURL",
- "source": "curl -L -X GET 'https://api.woosmap.com/indoor/venues/west_pal/pois/autocomplete?q=cham&language=en&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
+ "source": "curl -L -X GET 'https://api.woosmap.com/transit/route?origin=48.73534,2.368308&destination=48.83534,2.368308&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
},
{
"lang": "python",
"label": "Python",
- "source": "import requests\n\nurl = \"https://api.woosmap.com/indoor/venues/west_pal/pois/autocomplete?q=cham&language=en&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/transit/route?origin=48.73534,2.368308&destination=48.83534,2.368308&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"
},
{
"lang": "javascript",
"label": "JavaScript",
- "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/indoor/venues/west_pal/pois/autocomplete?q=cham&language=en&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
+ "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/transit/route?origin=48.73534,2.368308&destination=48.83534,2.368308&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
}
]
}
},
- "/indoor/venues/{venue_id}/features/{feature_id}": {
+ "/datasets/{dataset_id}": {
"get": {
- "operationId": "api_routers_indoor_get_feature_by_key",
- "summary": "Get Feature By Key",
- "parameters": [
+ "tags": [
+ "Datasets API"
+ ],
+ "summary": "Get Dataset",
+ "description": "Gets dataset details.\n\n**Rate limit**: `1/1s`",
+ "operationId": "get_dataset_datasets__dataset_id__get",
+ "security": [
{
- "in": "path",
- "name": "venue_id",
- "schema": {
- "description": "ID of the venue",
- "title": "Venue Id",
- "type": "string"
- },
- "required": true,
- "description": "ID of the venue"
+ "Datasets_PrivateKeyWithWrite": []
},
{
+ "Datasets_PrivateKeyWithWriteHeader": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "dataset_id",
"in": "path",
- "name": "feature_id",
- "schema": {
- "description": "ID of the feature",
- "title": "Feature Id",
- "type": "integer"
- },
"required": true,
- "description": "ID of the feature"
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Dataset Id"
+ }
}
],
"responses": {
"200": {
- "description": "OK",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Indoor_API_SingleIndoorFeatureSchema"
+ "$ref": "#/components/schemas/Datasets_DatasetResponse"
}
}
}
},
"401": {
- "description": "Unauthorized",
+ "description": "Unable to locate credentials.",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Indoor_API_ErrorResponseSchema"
+ "$ref": "#/components/schemas/Datasets_AuthenticationErrorResponse"
}
}
}
},
"402": {
- "description": "Payment Required",
+ "description": "Out of free quota.",
"content": {
"application/json": {
"schema": {
- "description": "A more detailed explanation on what went wrong.",
- "title": "Detail",
- "type": "string"
+ "$ref": "#/components/schemas/Datasets_AuthenticationErrorResponse"
}
}
}
},
"403": {
- "description": "Forbidden",
+ "description": "Credentials found, but not matching.",
"content": {
"application/json": {
"schema": {
- "description": "A more detailed explanation on what went wrong.",
- "title": "Detail",
- "type": "string"
+ "$ref": "#/components/schemas/Datasets_AuthenticationErrorResponse"
}
}
}
},
- "422": {
- "description": "Unprocessable Entity",
+ "404": {
+ "description": "Dataset was not found",
"content": {
"application/json": {
"schema": {
- "properties": {
- "detail": {
- "description": "The validation errors.",
- "items": {
- "additionalProperties": true,
- "type": "object"
- },
- "title": "Detail",
- "type": "array"
- },
- "context": {
- "additionalProperties": true,
- "description": "Context",
- "title": "Context",
- "type": "object"
- }
- },
- "required": [
- "detail",
- "context"
- ],
- "title": "ValidationErrorSchema",
- "type": "object"
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Datasets_HTTPValidationError"
+ }
+ }
+ }
+ },
+ "429": {
+ "description": "Rate limit reached",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
}
- },
- "description": "Returns a single feature using its ID.\n\n**Rate limit**: `20/1s`",
+ }
+ },
+ "delete": {
"tags": [
- "Indoor API"
+ "Datasets API"
],
+ "summary": "Delete Dataset",
+ "description": "Schedule a dataset for deletion, deletion will happen in 7 days.\n\n\n**Rate limit**: `1/1s`",
+ "operationId": "delete_dataset_datasets__dataset_id__delete",
"security": [
{
- "Indoor_API_PrivateKeyAuth": []
- },
- {
- "Indoor_API_PrivateKeyHeaderAuth": []
+ "Datasets_PrivateKeyWithWrite": []
},
{
- "Indoor_API_PublicKeyAuth": []
+ "Datasets_PrivateKeyWithWriteHeader": []
}
],
- "x-codeSamples": [
- {
- "lang": "curl",
- "label": "cURL",
- "source": "curl -L -X GET 'https://api.woosmap.com/indoor/venues/west_pal/features/3623459?key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
- },
- {
- "lang": "python",
- "label": "Python",
- "source": "import requests\n\nurl = \"https://api.woosmap.com/indoor/venues/west_pal/features/3623459?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"
- },
- {
- "lang": "javascript",
- "label": "JavaScript",
- "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/indoor/venues/west_pal/features/3623459?key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
- }
- ]
- }
- },
- "/indoor/venues/{venue_id}/tiles/{z}/{x}/{y}.pbf": {
- "get": {
- "operationId": "api_routers_indoor_tiles_by_key",
- "summary": "Tiles By Key",
"parameters": [
{
+ "name": "dataset_id",
"in": "path",
- "name": "venue_id",
- "schema": {
- "description": "ID of the venue",
- "title": "Venue Id",
- "type": "string"
- },
- "required": true,
- "description": "ID of the venue"
- },
- {
- "in": "path",
- "name": "x",
- "schema": {
- "description": "X coordinate of the tile",
- "title": "X",
- "type": "integer"
- },
- "required": true,
- "description": "X coordinate of the tile"
- },
- {
- "in": "path",
- "name": "y",
- "schema": {
- "description": "Y coordinate of the tile",
- "title": "Y",
- "type": "integer"
- },
- "required": true,
- "description": "Y coordinate of the tile"
- },
- {
- "in": "path",
- "name": "z",
- "schema": {
- "description": "Zoom level",
- "title": "Z",
- "type": "integer"
- },
"required": true,
- "description": "Zoom level"
- },
- {
- "in": "query",
- "name": "advanced_filter",
- "schema": {
- "description": "Filter POI labels by advanced filter.",
- "title": "Advanced Filter",
- "type": "string"
- },
- "required": false,
- "description": "Filter POI labels by advanced filter."
- },
- {
- "in": "query",
- "name": "disable_zoom_min",
"schema": {
- "default": false,
- "description": "Disable the zoom_min for POIs.",
- "title": "Disable Zoom Min",
- "type": "boolean"
- },
- "required": false,
- "description": "Disable the zoom_min for POIs."
+ "type": "string",
+ "format": "uuid",
+ "title": "Dataset Id"
+ }
}
],
"responses": {
"200": {
- "description": "OK",
+ "description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "format": "binary",
- "title": "Response",
- "type": "string"
+ "type": "object",
+ "additionalProperties": true,
+ "title": "Response Delete Dataset Datasets Dataset Id Delete"
}
}
}
},
"401": {
- "description": "Unauthorized",
+ "description": "Unable to locate credentials.",
"content": {
"application/json": {
"schema": {
- "description": "A more detailed explanation on what went wrong.",
- "title": "Detail",
- "type": "string"
+ "$ref": "#/components/schemas/Datasets_AuthenticationErrorResponse"
}
}
}
},
"402": {
- "description": "Payment Required",
+ "description": "Out of free quota.",
"content": {
"application/json": {
"schema": {
- "description": "A more detailed explanation on what went wrong.",
- "title": "Detail",
- "type": "string"
+ "$ref": "#/components/schemas/Datasets_AuthenticationErrorResponse"
}
}
}
},
"403": {
- "description": "Forbidden",
+ "description": "Credentials found, but not matching.",
"content": {
"application/json": {
"schema": {
- "description": "A more detailed explanation on what went wrong.",
- "title": "Detail",
- "type": "string"
+ "$ref": "#/components/schemas/Datasets_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Dataset was not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
+ }
+ }
+ }
+ },
+ "409": {
+ "description": "The Dataset was already scheduled for deletion.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
},
"422": {
- "description": "Unprocessable Entity",
+ "description": "Validation Error",
"content": {
"application/json": {
"schema": {
- "properties": {
- "detail": {
- "description": "The validation errors.",
- "items": {
- "additionalProperties": true,
- "type": "object"
- },
- "title": "Detail",
- "type": "array"
- },
- "context": {
- "additionalProperties": true,
- "description": "Context",
- "title": "Context",
- "type": "object"
- }
- },
- "required": [
- "detail",
- "context"
- ],
- "title": "ValidationErrorSchema",
- "type": "object"
+ "$ref": "#/components/schemas/Datasets_HTTPValidationError"
+ }
+ }
+ }
+ },
+ "429": {
+ "description": "Rate limit reached",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
}
- },
- "description": "Returns a tile for the venue.\n\n**Rate limit**: `50/1s`",
+ }
+ },
+ "put": {
"tags": [
- "Indoor API"
+ "Datasets API"
],
+ "summary": "Update Dataset",
+ "description": "Updates a dataset url or name.\n\n**Rate limit**: `1/1s`",
+ "operationId": "update_dataset_datasets__dataset_id__put",
"security": [
{
- "Indoor_API_PrivateKeyAuth": []
- },
- {
- "Indoor_API_PrivateKeyHeaderAuth": []
+ "Datasets_PrivateKeyWithWrite": []
},
{
- "Indoor_API_PublicKeyAuth": []
+ "Datasets_PrivateKeyWithWriteHeader": []
}
- ]
- }
- },
- "/transit/route": {
- "get": {
- "tags": [
- "Transit API"
],
- "summary": "Transit Route",
- "description": "**Rate limit**: `10/1s`",
- "operationId": "transit_route_transit_route_get",
- "security": [
- {
- "External-api-wrapper_PublicAPIKey": []
- },
+ "parameters": [
{
- "External-api-wrapper_PrivateApiKey": []
- },
- {
- "External-api-wrapper_PrivateApiKeyHeader": []
- }
- ],
- "parameters": [
- {
- "name": "departure_time",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "date-time"
- },
- {
- "type": "null"
- }
- ],
- "title": "Departure Time",
- "description": "DateTime with or without timezone, if not set the default datetime is the current one",
- "examples": [
- "2024-01-01T12:00:00%2B01:00"
- ]
- },
- "description": "DateTime with or without timezone, if not set the default datetime is the current one"
- },
- {
- "name": "arrival_time",
- "in": "query",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "type": "string",
- "format": "date-time"
- },
- {
- "type": "null"
- }
- ],
- "title": "Arrival Time",
- "description": "DateTime with or without timezone, if departure_time is defined this parameter is ignored",
- "examples": [
- "2024-01-01T14:00:00%2B01:00"
- ]
- },
- "description": "DateTime with or without timezone, if departure_time is defined this parameter is ignored"
- },
- {
- "name": "origin",
- "in": "query",
- "required": true,
- "schema": {
- "type": "string",
- "title": "Position",
- "description": "WGS84 coordinates as format lat,lng",
- "examples": [
- "lat,lng"
- ]
- },
- "description": "WGS84 coordinates as format lat,lng"
- },
- {
- "name": "destination",
- "in": "query",
+ "name": "dataset_id",
+ "in": "path",
"required": true,
"schema": {
"type": "string",
- "title": "Position",
- "description": "WGS84 coordinates as format lat,lng",
- "examples": [
- "lat,lng"
- ]
- },
- "description": "WGS84 coordinates as format lat,lng"
- },
- {
- "name": "modes",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "title": "Array of Modes (string) or Excluded modes (string) (TransitModesFilter)",
- "description": "Transit mode filter used to determine which modes of transit to include in the response. \n By default, all supported transit modes are permitted. Supported modes: `highSpeedTrain` `intercityTrain` `interRegionalTrain` `regionalTrain` `cityTrain` `bus` `ferry` `subway` `lightRail` `privateBus` `inclined` `aerial` `busRapid` `monorail` `flight` `spaceship` This parameter also support an exclusion list: It's sufficient to specify each mode to exclude by prefixing it with `-`. \n Mixing of inclusive and exclusive transit modes is not allowed.",
- "examples": [
- "subway,bus",
- "-subway,-bus"
- ]
- },
- "description": "Transit mode filter used to determine which modes of transit to include in the response. \n By default, all supported transit modes are permitted. Supported modes: `highSpeedTrain` `intercityTrain` `interRegionalTrain` `regionalTrain` `cityTrain` `bus` `ferry` `subway` `lightRail` `privateBus` `inclined` `aerial` `busRapid` `monorail` `flight` `spaceship` This parameter also support an exclusion list: It's sufficient to specify each mode to exclude by prefixing it with `-`. \n Mixing of inclusive and exclusive transit modes is not allowed."
+ "format": "uuid",
+ "title": "Dataset Id"
+ }
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Datasets_DatasetUpdate"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/External-api-wrapper_Transit"
+ "$ref": "#/components/schemas/Datasets_DatasetResponse"
}
}
}
@@ -8940,7 +8153,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/External-api-wrapper_AuthenticationErrorResponse"
+ "$ref": "#/components/schemas/Datasets_AuthenticationErrorResponse"
}
}
}
@@ -8950,7 +8163,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/External-api-wrapper_AuthenticationErrorResponse"
+ "$ref": "#/components/schemas/Datasets_AuthenticationErrorResponse"
}
}
}
@@ -8960,7 +8173,17 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/External-api-wrapper_AuthenticationErrorResponse"
+ "$ref": "#/components/schemas/Datasets_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Dataset was not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
@@ -8970,7 +8193,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/External-api-wrapper_HTTPValidationError"
+ "$ref": "#/components/schemas/Datasets_HTTPValidationError"
}
}
}
@@ -8980,39 +8203,22 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/External-api-wrapper_HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
}
- },
- "x-codeSamples": [
- {
- "lang": "curl",
- "label": "cURL",
- "source": "curl -L -X GET 'https://api.woosmap.com/transit/route?origin=48.73534,2.368308&destination=48.83534,2.368308&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'"
- },
- {
- "lang": "python",
- "label": "Python",
- "source": "import requests\n\nurl = \"https://api.woosmap.com/transit/route?origin=48.73534,2.368308&destination=48.83534,2.368308&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"
- },
- {
- "lang": "javascript",
- "label": "JavaScript",
- "source": "var requestOptions = {\n method: 'GET',\n redirect: 'follow'\n};\n\nfetch(\"https://api.woosmap.com/transit/route?origin=48.73534,2.368308&destination=48.83534,2.368308&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));"
- }
- ]
+ }
}
},
- "/datasets/{dataset_id}": {
+ "/datasets/": {
"get": {
"tags": [
"Datasets API"
],
- "summary": "Get Dataset",
- "description": "Gets dataset details.\n\n**Rate limit**: `1/1s`",
- "operationId": "get_dataset_datasets__dataset_id__get",
+ "summary": "List Datasets",
+ "description": "Lists datasets.\n\n**Rate limit**: `1/1s`",
+ "operationId": "list_datasets_datasets__get",
"security": [
{
"Datasets_PrivateKeyWithWrite": []
@@ -9023,14 +8229,31 @@
],
"parameters": [
{
- "name": "dataset_id",
- "in": "path",
- "required": true,
+ "name": "per_page",
+ "in": "query",
+ "required": false,
"schema": {
- "type": "string",
- "format": "uuid",
- "title": "Dataset Id"
- }
+ "type": "integer",
+ "maximum": 20,
+ "minimum": 1,
+ "description": "The maximum number of elements to return in a result page.",
+ "default": 10,
+ "title": "Per Page"
+ },
+ "description": "The maximum number of elements to return in a result page."
+ },
+ {
+ "name": "page",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "description": "The result page to fetch.",
+ "default": 1,
+ "title": "Page"
+ },
+ "description": "The result page to fetch."
}
],
"responses": {
@@ -9039,7 +8262,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_DatasetResponse"
+ "$ref": "#/components/schemas/Datasets_DatasetListResponse"
}
}
}
@@ -9074,16 +8297,6 @@
}
}
},
- "404": {
- "description": "Dataset was not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
- }
- }
- }
- },
"422": {
"description": "Validation Error",
"content": {
@@ -9099,20 +8312,20 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
}
}
},
- "delete": {
+ "post": {
"tags": [
"Datasets API"
],
- "summary": "Delete Dataset",
- "description": "Schedule a dataset for deletion, deletion will happen in 7 days.\n\n\n**Rate limit**: `1/1s`",
- "operationId": "delete_dataset_datasets__dataset_id__delete",
+ "summary": "Create Dataset",
+ "description": "Creates a dataset.\n\n**Rate limit**: `1/1s`",
+ "operationId": "create_dataset_datasets__post",
"security": [
{
"Datasets_PrivateKeyWithWrite": []
@@ -9121,27 +8334,23 @@
"Datasets_PrivateKeyWithWriteHeader": []
}
],
- "parameters": [
- {
- "name": "dataset_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Dataset Id"
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Datasets_DatasetCreateRequest"
+ }
}
}
- ],
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "type": "object",
- "additionalProperties": true,
- "title": "Response Delete Dataset Datasets Dataset Id Delete"
+ "$ref": "#/components/schemas/Datasets_DatasetResponse"
}
}
}
@@ -9176,26 +8385,6 @@
}
}
},
- "404": {
- "description": "Dataset was not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
- }
- }
- }
- },
- "409": {
- "description": "The Dataset was already scheduled for deletion.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
- }
- }
- }
- },
"422": {
"description": "Validation Error",
"content": {
@@ -9211,20 +8400,22 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
}
}
- },
- "put": {
+ }
+ },
+ "/datasets/{dataset_id}/status": {
+ "get": {
"tags": [
"Datasets API"
],
- "summary": "Update Dataset",
- "description": "Updates a dataset url or name.\n\n**Rate limit**: `1/1s`",
- "operationId": "update_dataset_datasets__dataset_id__put",
+ "summary": "Get Dataset Status",
+ "description": "Returns the dataset import status.\n\n**Rate limit**: `1/5s`",
+ "operationId": "get_dataset_status_datasets__dataset_id__status_get",
"security": [
{
"Datasets_PrivateKeyWithWrite": []
@@ -9245,23 +8436,13 @@
}
}
],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Datasets_DatasetUpdate"
- }
- }
- }
- },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_DatasetResponse"
+ "$ref": "#/components/schemas/Datasets_DatasetStatusResponse"
}
}
}
@@ -9301,7 +8482,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
@@ -9321,7 +8502,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
@@ -9329,14 +8510,14 @@
}
}
},
- "/datasets/": {
- "get": {
+ "/datasets/{dataset_id}/import": {
+ "post": {
"tags": [
"Datasets API"
],
- "summary": "List Datasets",
- "description": "Lists datasets.\n\n**Rate limit**: `1/1s`",
- "operationId": "list_datasets_datasets__get",
+ "summary": "Trigger Import",
+ "description": "Trigger the dataset import.\n\n**Rate limit**: `1/90s`",
+ "operationId": "trigger_import_datasets__dataset_id__import_post",
"security": [
{
"Datasets_PrivateKeyWithWrite": []
@@ -9347,40 +8528,23 @@
],
"parameters": [
{
- "name": "per_page",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "maximum": 20,
- "minimum": 1,
- "description": "The maximum number of elements to return in a result page.",
- "default": 10,
- "title": "Per Page"
- },
- "description": "The maximum number of elements to return in a result page."
- },
- {
- "name": "page",
- "in": "query",
- "required": false,
+ "name": "dataset_id",
+ "in": "path",
+ "required": true,
"schema": {
- "type": "integer",
- "minimum": 1,
- "description": "The result page to fetch.",
- "default": 1,
- "title": "Page"
- },
- "description": "The result page to fetch."
+ "type": "string",
+ "format": "uuid",
+ "title": "Dataset Id"
+ }
}
],
"responses": {
- "200": {
+ "202": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_DatasetListResponse"
+ "$ref": "#/components/schemas/Datasets_ImportResponse"
}
}
}
@@ -9415,6 +8579,16 @@
}
}
},
+ "404": {
+ "description": "Dataset was not found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
+ }
+ }
+ }
+ },
"422": {
"description": "Validation Error",
"content": {
@@ -9430,75 +8604,60 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
}
}
- },
+ }
+ },
+ "/datasets/hooks/reimport/{reimport_key}": {
"post": {
"tags": [
"Datasets API"
],
- "summary": "Create Dataset",
- "description": "Creates a dataset.\n\n**Rate limit**: `1/1s`",
- "operationId": "create_dataset_datasets__post",
- "security": [
- {
- "Datasets_PrivateKeyWithWrite": []
- },
+ "summary": "Reimport Dataset Webhook",
+ "description": "Triggers the reimport of the dataset linked to the dataset.\n\n**Rate limit**: `1/90s`",
+ "operationId": "reimport_dataset_webhook_datasets_hooks_reimport__reimport_key__post",
+ "parameters": [
{
- "Datasets_PrivateKeyWithWriteHeader": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Datasets_DatasetCreateRequest"
- }
+ "name": "reimport_key",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Reimport Key"
}
}
- },
+ ],
"responses": {
- "200": {
+ "202": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_DatasetResponse"
+ "$ref": "#/components/schemas/Datasets_ImportResponse"
}
}
}
},
"401": {
- "description": "Unable to locate credentials.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Datasets_AuthenticationErrorResponse"
- }
- }
- }
+ "description": "Unauthorized"
},
"402": {
- "description": "Out of free quota.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Datasets_AuthenticationErrorResponse"
- }
- }
- }
+ "description": "Payment Required"
},
"403": {
- "description": "Credentials found, but not matching.",
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Dataset was not found",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_AuthenticationErrorResponse"
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
@@ -9518,28 +8677,32 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
}
- }
+ },
+ "security": []
}
},
- "/datasets/{dataset_id}/status": {
- "get": {
+ "/datasets/{dataset_id}/features/search/": {
+ "post": {
"tags": [
"Datasets API"
],
- "summary": "Get Dataset Status",
- "description": "Returns the dataset import status.\n\n**Rate limit**: `1/5s`",
- "operationId": "get_dataset_status_datasets__dataset_id__status_get",
+ "summary": "Search Features",
+ "description": "Search for features.\n\n**Rate limit**: `20/1s`",
+ "operationId": "search_features_datasets__dataset_id__features_search__post",
"security": [
{
- "Datasets_PrivateKeyWithWrite": []
+ "Datasets_PublicAPIKey": []
},
{
- "Datasets_PrivateKeyWithWriteHeader": []
+ "Datasets_PrivateApiKey": []
+ },
+ {
+ "Datasets_PrivateApiKeyHeader": []
}
],
"parameters": [
@@ -9552,15 +8715,66 @@
"format": "uuid",
"title": "Dataset Id"
}
+ },
+ {
+ "name": "format",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "enum": [
+ "geojson",
+ "wkb"
+ ],
+ "type": "string",
+ "default": "geojson",
+ "title": "Format"
+ }
+ },
+ {
+ "name": "per_page",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "maximum": 20,
+ "minimum": 1,
+ "description": "The maximum number of elements to return in a result page.",
+ "default": 10,
+ "title": "Per Page"
+ },
+ "description": "The maximum number of elements to return in a result page."
+ },
+ {
+ "name": "page",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "description": "The result page to fetch.",
+ "default": 1,
+ "title": "Page"
+ },
+ "description": "The result page to fetch."
}
],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Datasets_SearchRequest"
+ }
+ }
+ }
+ },
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_DatasetStatusResponse"
+ "$ref": "#/components/schemas/Datasets_SearchResultResponse"
}
}
}
@@ -9600,7 +8814,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
@@ -9620,7 +8834,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
@@ -9628,20 +8842,23 @@
}
}
},
- "/datasets/{dataset_id}/import": {
+ "/datasets/{dataset_id}/features/nearby/": {
"post": {
"tags": [
"Datasets API"
],
- "summary": "Trigger Import",
- "description": "Trigger the dataset import.\n\n**Rate limit**: `1/90s`",
- "operationId": "trigger_import_datasets__dataset_id__import_post",
+ "summary": "Nearby Features",
+ "description": "Search for features nearby geometry.\n\n**Rate limit**: `20/1s`",
+ "operationId": "nearby_features_datasets__dataset_id__features_nearby__post",
"security": [
{
- "Datasets_PrivateKeyWithWrite": []
+ "Datasets_PublicAPIKey": []
},
{
- "Datasets_PrivateKeyWithWriteHeader": []
+ "Datasets_PrivateApiKey": []
+ },
+ {
+ "Datasets_PrivateApiKeyHeader": []
}
],
"parameters": [
@@ -9654,198 +8871,19 @@
"format": "uuid",
"title": "Dataset Id"
}
- }
- ],
- "responses": {
- "202": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Datasets_ImportResponse"
- }
- }
- }
},
- "401": {
- "description": "Unable to locate credentials.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Datasets_AuthenticationErrorResponse"
- }
- }
- }
- },
- "402": {
- "description": "Out of free quota.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Datasets_AuthenticationErrorResponse"
- }
- }
- }
- },
- "403": {
- "description": "Credentials found, but not matching.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Datasets_AuthenticationErrorResponse"
- }
- }
- }
- },
- "404": {
- "description": "Dataset was not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Datasets_HTTPValidationError"
- }
- }
- }
- },
- "429": {
- "description": "Rate limit reached",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
- }
- }
- }
- }
- }
- }
- },
- "/datasets/hooks/reimport/{reimport_key}": {
- "post": {
- "tags": [
- "Datasets API"
- ],
- "summary": "Reimport Dataset Webhook",
- "description": "Triggers the reimport of the dataset linked to the dataset.\n\n**Rate limit**: `1/90s`",
- "operationId": "reimport_dataset_webhook_datasets_hooks_reimport__reimport_key__post",
- "parameters": [
- {
- "name": "reimport_key",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Reimport Key"
- }
- }
- ],
- "responses": {
- "202": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Datasets_ImportResponse"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "402": {
- "description": "Payment Required"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Dataset was not found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
- }
- }
- }
- },
- "422": {
- "description": "Validation Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Datasets_HTTPValidationError"
- }
- }
- }
- },
- "429": {
- "description": "Rate limit reached",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
- }
- }
- }
- }
- },
- "security": []
- }
- },
- "/datasets/{dataset_id}/features/search/": {
- "post": {
- "tags": [
- "Datasets API - Search"
- ],
- "summary": "Search Features",
- "description": "Search for features.\n\n**Rate limit**: `20/1s`",
- "operationId": "search_features_datasets__dataset_id__features_search__post",
- "security": [
- {
- "Datasets_PublicAPIKey": []
- },
- {
- "Datasets_PrivateApiKey": []
- },
- {
- "Datasets_PrivateApiKeyHeader": []
- }
- ],
- "parameters": [
- {
- "name": "dataset_id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string",
- "format": "uuid",
- "title": "Dataset Id"
- }
- },
- {
- "name": "format",
- "in": "query",
- "required": false,
- "schema": {
- "enum": [
- "geojson",
- "wkb"
- ],
- "type": "string",
- "default": "geojson",
- "title": "Format"
+ {
+ "name": "format",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "enum": [
+ "geojson",
+ "wkb"
+ ],
+ "type": "string",
+ "default": "geojson",
+ "title": "Format"
}
},
{
@@ -9881,7 +8919,93 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_SearchRequest"
+ "$ref": "#/components/schemas/Datasets_SearchRequestWithGeometry"
+ },
+ "examples": {
+ "point_geojson": {
+ "summary": "Request with point geojson geometry",
+ "value": {
+ "geometry": {
+ "type": "Point",
+ "coordinates": [
+ 3.883,
+ 43.6
+ ]
+ }
+ }
+ },
+ "linestring_geojson": {
+ "summary": "Request with linestring geojson geometry",
+ "value": {
+ "geometry": {
+ "type": "LineString",
+ "coordinates": [
+ [
+ 3.85882,
+ 43.60912
+ ],
+ [
+ 3.86276,
+ 43.60807
+ ],
+ [
+ 3.8649,
+ 43.60572
+ ],
+ [
+ 3.86513,
+ 43.60412
+ ],
+ [
+ 3.86681,
+ 43.60245
+ ],
+ [
+ 3.86822,
+ 43.60093
+ ],
+ [
+ 3.87003,
+ 43.6
+ ]
+ ]
+ }
+ }
+ },
+ "polygon_geojson": {
+ "summary": "Request with polygon geojson geometry, a 10 meters buffer and a where clause",
+ "value": {
+ "geometry": {
+ "type": "Polygon",
+ "coordinates": [
+ [
+ [
+ -10,
+ -10
+ ],
+ [
+ 10,
+ -10
+ ],
+ [
+ 10,
+ 10
+ ],
+ [
+ -10,
+ 10
+ ],
+ [
+ -10,
+ -10
+ ]
+ ]
+ ]
+ },
+ "buffer": 10,
+ "where": "cost:<500"
+ }
+ }
}
}
}
@@ -9932,7 +9056,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
@@ -9952,7 +9076,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
@@ -9960,14 +9084,14 @@
}
}
},
- "/datasets/{dataset_id}/features/nearby/": {
+ "/datasets/{dataset_id}/features/intersects/": {
"post": {
"tags": [
- "Datasets API - Search"
+ "Datasets API"
],
- "summary": "Nearby Features",
- "description": "Search for features nearby geometry.\n\n**Rate limit**: `20/1s`",
- "operationId": "nearby_features_datasets__dataset_id__features_nearby__post",
+ "summary": "Intersect Features",
+ "description": "Returns the features that are intersecting with geometry.\n\n**Rate limit**: `20/1s`\n\n",
+ "operationId": "intersect_features_datasets__dataset_id__features_intersects__post",
"security": [
{
"Datasets_PublicAPIKey": []
@@ -10174,7 +9298,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
@@ -10194,7 +9318,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
@@ -10202,14 +9326,14 @@
}
}
},
- "/datasets/{dataset_id}/features/intersects/": {
+ "/datasets/{dataset_id}/features/contains/": {
"post": {
"tags": [
- "Datasets API - Search"
+ "Datasets API"
],
- "summary": "Intersect Features",
- "description": "Returns the features that are intersecting with geometry.\n\n**Rate limit**: `20/1s`\n\n",
- "operationId": "intersect_features_datasets__dataset_id__features_intersects__post",
+ "summary": "Contains Features",
+ "description": "Search for features containing geometry.\n\n**Rate limit**: `20/1s`\n\n",
+ "operationId": "contains_features_datasets__dataset_id__features_contains__post",
"security": [
{
"Datasets_PublicAPIKey": []
@@ -10416,7 +9540,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
@@ -10436,7 +9560,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
@@ -10444,14 +9568,14 @@
}
}
},
- "/datasets/{dataset_id}/features/contains/": {
+ "/datasets/{dataset_id}/features/within/": {
"post": {
"tags": [
- "Datasets API - Search"
+ "Datasets API"
],
- "summary": "Contains Features",
- "description": "Search for features containing geometry.\n\n**Rate limit**: `20/1s`\n\n",
- "operationId": "contains_features_datasets__dataset_id__features_contains__post",
+ "summary": "Within Features",
+ "description": "Search for features within geometry.\n\n**Rate limit**: `20/1s`\n\n",
+ "operationId": "within_features_datasets__dataset_id__features_within__post",
"security": [
{
"Datasets_PublicAPIKey": []
@@ -10521,61 +9645,11 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_SearchRequestWithGeometry"
+ "$ref": "#/components/schemas/Datasets_SearchRequestWithPolygonGeometry"
},
"examples": {
- "point_geojson": {
- "summary": "Request with point geojson geometry",
- "value": {
- "geometry": {
- "type": "Point",
- "coordinates": [
- 3.883,
- 43.6
- ]
- }
- }
- },
- "linestring_geojson": {
- "summary": "Request with linestring geojson geometry",
- "value": {
- "geometry": {
- "type": "LineString",
- "coordinates": [
- [
- 3.85882,
- 43.60912
- ],
- [
- 3.86276,
- 43.60807
- ],
- [
- 3.8649,
- 43.60572
- ],
- [
- 3.86513,
- 43.60412
- ],
- [
- 3.86681,
- 43.60245
- ],
- [
- 3.86822,
- 43.60093
- ],
- [
- 3.87003,
- 43.6
- ]
- ]
- }
- }
- },
"polygon_geojson": {
- "summary": "Request with polygon geojson geometry, a 10 meters buffer and a where clause",
+ "summary": "An with polygon geojson geometry, a 10 meters buffer and a where clause",
"value": {
"geometry": {
"type": "Polygon",
@@ -10658,7 +9732,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
@@ -10678,7 +9752,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
@@ -10686,14 +9760,14 @@
}
}
},
- "/datasets/{dataset_id}/features/within/": {
- "post": {
+ "/datasets/{dataset_id}/features/{feature_id}": {
+ "get": {
"tags": [
- "Datasets API - Search"
+ "Datasets API"
],
- "summary": "Within Features",
- "description": "Search for features within geometry.\n\n**Rate limit**: `20/1s`\n\n",
- "operationId": "within_features_datasets__dataset_id__features_within__post",
+ "summary": "Get Feature",
+ "description": "Gets a feature from its ID.\n\n**Rate limit**: `20/1s`",
+ "operationId": "get_feature_datasets__dataset_id__features__feature_id__get",
"security": [
{
"Datasets_PublicAPIKey": []
@@ -10716,6 +9790,16 @@
"title": "Dataset Id"
}
},
+ {
+ "name": "feature_id",
+ "in": "path",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Feature Id"
+ }
+ },
{
"name": "format",
"in": "query",
@@ -10731,86 +9815,29 @@
}
},
{
- "name": "per_page",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "maximum": 20,
- "minimum": 1,
- "description": "The maximum number of elements to return in a result page.",
- "default": 10,
- "title": "Per Page"
- },
- "description": "The maximum number of elements to return in a result page."
- },
- {
- "name": "page",
- "in": "query",
+ "name": "X-Field-Mask",
+ "in": "header",
"required": false,
"schema": {
- "type": "integer",
- "minimum": 1,
- "description": "The result page to fetch.",
- "default": 1,
- "title": "Page"
- },
- "description": "The result page to fetch."
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Datasets_SearchRequestWithPolygonGeometry"
- },
- "examples": {
- "polygon_geojson": {
- "summary": "An with polygon geojson geometry, a 10 meters buffer and a where clause",
- "value": {
- "geometry": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- -10,
- -10
- ],
- [
- 10,
- -10
- ],
- [
- 10,
- 10
- ],
- [
- -10,
- 10
- ],
- [
- -10,
- -10
- ]
- ]
- ]
- },
- "buffer": 10,
- "where": "cost:<500"
- }
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
}
- }
+ ],
+ "title": "X-Field-Mask"
}
}
- },
+ ],
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_SearchResultResponse"
+ "$ref": "#/components/schemas/Datasets_FeatureRead"
}
}
}
@@ -10846,11 +9873,11 @@
}
},
"404": {
- "description": "Dataset was not found",
+ "description": "Feature or Dataset were not found",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
@@ -10870,7 +9897,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
+ "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel"
}
}
}
@@ -10878,63 +9905,107 @@
}
}
},
- "/datasets/{dataset_id}/features/{feature_id}": {
+ "/distance/isochrone/json/": {
"get": {
"tags": [
- "Datasets API - Features"
+ "Isochrone API"
],
- "summary": "Get Feature",
- "description": "Gets a feature from its ID.\n\n**Rate limit**: `20/1s`",
- "operationId": "get_feature_datasets__dataset_id__features__feature_id__get",
+ "summary": "Calculate Isochrone",
+ "description": "Find all destinations that can be reached in a specific amount of time or a maximum travel distance.\n\n**Rate limit**: `10/1s`",
+ "operationId": "isochrone_distance_isochrone_json__get",
"security": [
{
- "Datasets_PublicAPIKey": []
+ "Distance_PublicAPIKey": []
},
{
- "Datasets_PrivateApiKey": []
+ "Distance_PrivateApiKey": []
},
{
- "Datasets_PrivateApiKeyHeader": []
+ "Distance_PrivateApiKeyHeader": []
}
],
"parameters": [
{
- "name": "dataset_id",
- "in": "path",
- "required": true,
+ "name": "mode",
+ "in": "query",
+ "required": false,
"schema": {
+ "enum": [
+ "driving",
+ "walking",
+ "cycling"
+ ],
"type": "string",
- "format": "uuid",
- "title": "Dataset Id"
- }
+ "description": "Specifies the mode of transport to use for the calculation.",
+ "default": "driving",
+ "title": "Mode"
+ },
+ "description": "Specifies the mode of transport to use for the calculation."
},
{
- "name": "feature_id",
- "in": "path",
- "required": true,
+ "name": "method",
+ "in": "query",
+ "required": false,
"schema": {
+ "enum": [
+ "time",
+ "distance"
+ ],
"type": "string",
- "format": "uuid",
- "title": "Feature Id"
- }
+ "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": "Method"
+ },
+ "description": "Specifies how to compute the route between the start point and the end point:\n* `time`: fastest route \n* `distance`: shortest route"
},
{
- "name": "format",
+ "name": "units",
"in": "query",
"required": false,
"schema": {
"enum": [
- "geojson",
- "wkb"
+ "metric",
+ "imperial"
],
"type": "string",
- "default": "geojson",
- "title": "Format"
- }
+ "description": "Specifies the unit system to use when displaying results.",
+ "default": "metric",
+ "title": "Units"
+ },
+ "description": "Specifies the unit system to use when displaying results."
},
{
- "name": "X-Field-Mask",
- "in": "header",
+ "name": "language",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "enum": [
+ "en",
+ "fr",
+ "ca",
+ "de",
+ "es",
+ "he",
+ "it",
+ "ja",
+ "nl",
+ "pl",
+ "pt",
+ "ro",
+ "ru",
+ "uk",
+ "zh"
+ ],
+ "type": "string",
+ "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": "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`."
+ },
+ {
+ "name": "avoid",
+ "in": "query",
"required": false,
"schema": {
"anyOf": [
@@ -10945,37 +10016,86 @@
"type": "null"
}
],
- "title": "X-Field-Mask"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Successful Response",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Datasets_FeatureRead"
- }
- }
- }
- },
- "401": {
- "description": "Unable to locate credentials.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Datasets_AuthenticationErrorResponse"
- }
- }
- }
+ "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"
+ ],
+ "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."
},
- "402": {
- "description": "Out of free quota.",
- "content": {
- "application/json": {
+ {
+ "name": "origin",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "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"
+ ],
+ "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."
+ },
+ {
+ "name": "value",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "number",
+ "maximum": 120,
+ "minimum": 0,
+ "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.",
+ "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."
+ },
+ {
+ "name": "accept-language",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Accept-Language"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_AuthenticationErrorResponse"
+ "$ref": "#/components/schemas/Distance_IsochroneResponse"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unable to locate credentials.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "402": {
+ "description": "Out of free quota.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_AuthenticationErrorResponse"
}
}
}
@@ -10985,17 +10105,116 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_AuthenticationErrorResponse"
+ "$ref": "#/components/schemas/Distance_AuthenticationErrorResponse"
}
}
}
},
- "404": {
- "description": "Feature or Dataset were not found",
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_HTTPValidationError"
+ }
+ }
+ }
+ },
+ "429": {
+ "description": "Rate limit reached",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_HTTPErrorModel"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Isochrone API"
+ ],
+ "summary": "Calculate Isochrone",
+ "description": "Find all destinations that can be reached in a specific amount of time or a maximum travel distance.\n\n**Rate limit**: `10/1s`",
+ "operationId": "isochrone_post_distance_isochrone_json__post",
+ "security": [
+ {
+ "Distance_PublicAPIKey": []
+ },
+ {
+ "Distance_PrivateApiKey": []
+ },
+ {
+ "Distance_PrivateApiKeyHeader": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "accept-language",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Accept-Language"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_IsochroneRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_IsochroneResponse"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unable to locate credentials.",
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
+ "$ref": "#/components/schemas/Distance_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "402": {
+ "description": "Out of free quota.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Credentials found, but not matching.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_AuthenticationErrorResponse"
}
}
}
@@ -11005,7 +10224,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_HTTPValidationError"
+ "$ref": "#/components/schemas/Distance_HTTPValidationError"
}
}
}
@@ -11015,122 +10234,1126 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/Datasets_HTTPErrorModel"
+ "$ref": "#/components/schemas/Distance_HTTPErrorModel"
}
}
}
}
}
}
- }
- },
- "components": {
- "parameters": {
- "Woosmap_Platform_API_Reference_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"
- }
- },
- "Woosmap_Platform_API_Reference_limit": {
- "name": "limit",
- "description": "To limit number of assets retrieved from an IP location.\n",
- "schema": {
- "type": "integer",
- "minimum": 1,
- "maximum": 300,
- "example": 10
- },
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_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"
- },
- "Woosmap_Platform_API_Reference_lat": {
- "name": "lat",
- "description": "Latitude bias for the results. Should be pass with `lng`.\n",
- "schema": {
- "type": "number",
- "example": 5.2
- },
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_lng": {
- "name": "lng",
- "description": "Longitude bias for the results. Should be pass with `lat`.\n",
- "schema": {
- "type": "number",
- "example": 3.5
- },
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_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"
- },
- "Woosmap_Platform_API_Reference_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"
- },
- "Woosmap_Platform_API_Reference_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"
- },
- "Woosmap_Platform_API_Reference_page": {
- "name": "page",
- "description": "Page number when accessing paginated assets feature collection\n",
- "schema": {
- "type": "integer",
- "example": 2
- },
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_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.\n"
- },
- "Woosmap_Platform_API_Reference_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.\n",
- "schema": {
- "type": "string",
- "example": "en"
- },
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_limit-2": {
- "name": "limit",
+ },
+ "/distance/tolls/json/": {
+ "get": {
+ "tags": [
+ "Tolls API"
+ ],
+ "summary": "Find Tolls",
+ "description": "Get distance, duration and tolls for an origin,destination pair, based on the recommended route between those two points for a specified travel mode.\n\n**Rate limit**: `5/1s`",
+ "operationId": "tolls_distance_tolls_json__get",
+ "security": [
+ {
+ "Distance_PublicAPIKey": []
+ },
+ {
+ "Distance_PrivateApiKey": []
+ },
+ {
+ "Distance_PrivateApiKeyHeader": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "arrival_time",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "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"
+ ],
+ "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."
+ },
+ {
+ "name": "departure_time",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "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"
+ ],
+ "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."
+ },
+ {
+ "name": "waypoints",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "A list of points by which the route should pass (the route response is divided into legs, one leg corresponding to a route between two waypoints). Waypoints should be separated by | character. \n \nOptionally, you may pass 'optimize:true' as the first argument within the waypoints parameter. This way the provided route is optimized by rearranging the waypoints in a more efficient order based on distance or time according to the method parameter. The route start point and end point order is not changed, their position is considered fixed. \n \n`alternatives` and `waypoints` can not be used at the same time.",
+ "examples": [
+ "optimize:true|48.850077,3.311124|48.850077,3.411124",
+ "48.850077,3.311124|48.850077,3.411124"
+ ],
+ "title": "Waypoints"
+ },
+ "description": "A list of points by which the route should pass (the route response is divided into legs, one leg corresponding to a route between two waypoints). Waypoints should be separated by | character. \n \nOptionally, you may pass 'optimize:true' as the first argument within the waypoints parameter. This way the provided route is optimized by rearranging the waypoints in a more efficient order based on distance or time according to the method parameter. The route start point and end point order is not changed, their position is considered fixed. \n \n`alternatives` and `waypoints` can not be used at the same time."
+ },
+ {
+ "name": "mode",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "enum": [
+ "driving",
+ "walking",
+ "cycling",
+ "truck"
+ ],
+ "type": "string",
+ "default": "driving",
+ "title": "Mode"
+ }
+ },
+ {
+ "name": "method",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "enum": [
+ "time",
+ "distance"
+ ],
+ "type": "string",
+ "default": "time",
+ "title": "Method"
+ }
+ },
+ {
+ "name": "units",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "enum": [
+ "metric",
+ "imperial"
+ ],
+ "type": "string",
+ "default": "metric",
+ "title": "Units"
+ }
+ },
+ {
+ "name": "language",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "enum": [
+ "en",
+ "fr",
+ "ca",
+ "de",
+ "es",
+ "he",
+ "it",
+ "ja",
+ "nl",
+ "pl",
+ "pt",
+ "ro",
+ "ru",
+ "uk",
+ "zh"
+ ],
+ "type": "string",
+ "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": "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`."
+ },
+ {
+ "name": "origin",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "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"
+ ],
+ "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."
+ },
+ {
+ "name": "destination",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "description": "The ending point for the route. It should be supplied in the form of `latitude,longitude` coordinates. Ensure that no space exists between the latitude and longitude values.",
+ "examples": [
+ "48.768,2.338"
+ ],
+ "title": "Destination"
+ },
+ "description": "The ending point for the route. It should be supplied in the form of `latitude,longitude` coordinates. Ensure that no space exists between the latitude and longitude values."
+ },
+ {
+ "name": "alternatives",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "description": "Specifies if alternative routes should be returned. Depending on the calculated route, alternatives may not be provided. `alternatives` and `waypoints` can not be used at the same time.",
+ "default": false,
+ "title": "Alternatives"
+ },
+ "description": "Specifies if alternative routes should be returned. Depending on the calculated route, alternatives may not be provided. `alternatives` and `waypoints` can not be used at the same time."
+ },
+ {
+ "name": "accept-language",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Accept-Language"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_TollsResponse"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unable to locate credentials.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "402": {
+ "description": "Out of free quota.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Credentials found, but not matching.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_HTTPValidationError"
+ }
+ }
+ }
+ },
+ "429": {
+ "description": "Rate limit reached",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_HTTPErrorModel"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/distance/route/json/": {
+ "get": {
+ "tags": [
+ "Route API"
+ ],
+ "summary": "Find Routes",
+ "description": "Get distance, duration and path (as a polyline) for a pair of origin and destination, based on the recommended route between those two points for a specified travel mode.\n\n**Rate limit**: `10/1s`\n\n**Rate limit with TRAFFIC**: `20/1s`",
+ "operationId": "route_distance_route_json__get",
+ "security": [
+ {
+ "Distance_PublicAPIKey": []
+ },
+ {
+ "Distance_PrivateApiKey": []
+ },
+ {
+ "Distance_PrivateApiKeyHeader": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "waypoints",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "A list of points by which the route should pass (the route response is divided into legs, one leg corresponding to a route between two waypoints). Waypoints should be separated by | character. \n \nOptionally, you may pass 'optimize:true' as the first argument within the waypoints parameter. This way the provided route is optimized by rearranging the waypoints in a more efficient order based on distance or time according to the method parameter. The route start point and end point order is not changed, their position is considered fixed. \n \n`alternatives` and `waypoints` can not be used at the same time.",
+ "examples": [
+ "optimize:true|48.850077,3.311124|48.850077,3.411124",
+ "48.850077,3.311124|48.850077,3.411124"
+ ],
+ "title": "Waypoints"
+ },
+ "description": "A list of points by which the route should pass (the route response is divided into legs, one leg corresponding to a route between two waypoints). Waypoints should be separated by | character. \n \nOptionally, you may pass 'optimize:true' as the first argument within the waypoints parameter. This way the provided route is optimized by rearranging the waypoints in a more efficient order based on distance or time according to the method parameter. The route start point and end point order is not changed, their position is considered fixed. \n \n`alternatives` and `waypoints` can not be used at the same time."
+ },
+ {
+ "name": "mode",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "enum": [
+ "driving",
+ "walking",
+ "cycling"
+ ],
+ "type": "string",
+ "description": "Specifies the mode of transport to use for the calculation.",
+ "default": "driving",
+ "title": "Mode"
+ },
+ "description": "Specifies the mode of transport to use for the calculation."
+ },
+ {
+ "name": "method",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "enum": [
+ "time",
+ "distance"
+ ],
+ "type": "string",
+ "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": "Method"
+ },
+ "description": "Specifies how to compute the route between the start point and the end point:\n* `time`: fastest route \n* `distance`: shortest route"
+ },
+ {
+ "name": "units",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "enum": [
+ "metric",
+ "imperial"
+ ],
+ "type": "string",
+ "description": "Specifies the unit system to use when displaying results.",
+ "default": "metric",
+ "title": "Units"
+ },
+ "description": "Specifies the unit system to use when displaying results."
+ },
+ {
+ "name": "language",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "enum": [
+ "en",
+ "fr",
+ "ca",
+ "de",
+ "es",
+ "he",
+ "it",
+ "ja",
+ "nl",
+ "pl",
+ "pt",
+ "ro",
+ "ru",
+ "uk",
+ "zh"
+ ],
+ "type": "string",
+ "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": "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`."
+ },
+ {
+ "name": "avoid",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "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"
+ ],
+ "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."
+ },
+ {
+ "name": "arrival_time",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "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"
+ ],
+ "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."
+ },
+ {
+ "name": "departure_time",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "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"
+ ],
+ "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."
+ },
+ {
+ "name": "origin",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "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"
+ ],
+ "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."
+ },
+ {
+ "name": "destination",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "description": "The ending point for the route. It should be supplied in the form of `latitude,longitude` coordinates. Ensure that no space exists between the latitude and longitude values.",
+ "examples": [
+ "48.768,2.338"
+ ],
+ "title": "Destination"
+ },
+ "description": "The ending point for the route. It should be supplied in the form of `latitude,longitude` coordinates. Ensure that no space exists between the latitude and longitude values."
+ },
+ {
+ "name": "alternatives",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "description": "Specifies if alternative routes should be returned. Depending on the calculated route, alternatives may not be provided. `alternatives` and `waypoints` can not be used at the same time.",
+ "default": false,
+ "title": "Alternatives"
+ },
+ "description": "Specifies if alternative routes should be returned. Depending on the calculated route, alternatives may not be provided. `alternatives` and `waypoints` can not be used at the same time."
+ },
+ {
+ "name": "details",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "enum": [
+ "full",
+ "none"
+ ],
+ "type": "string",
+ "description": "Specifies if maneuver instructions should be returned (roadbook)",
+ "default": "none",
+ "title": "Details"
+ },
+ "description": "Specifies if maneuver instructions should be returned (roadbook)"
+ },
+ {
+ "name": "accept-language",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Accept-Language"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_RouteResponse"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unable to locate credentials.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "402": {
+ "description": "Out of free quota.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Credentials found, but not matching.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_HTTPValidationError"
+ }
+ }
+ }
+ },
+ "429": {
+ "description": "Rate limit reached",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_HTTPErrorModel"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/distance/distancematrix/json/": {
+ "get": {
+ "tags": [
+ "Matrix API"
+ ],
+ "summary": "Calculate Matrix",
+ "description": "Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode.\n\n**Rate limit**: `10 requests/1s` GET and POST\n\n**Elements limit**: `1000 elements/1s` GET and POST\n\n**Rate limit with TRAFFIC**: `10 requests/1s` GET and POST\n\n**Elements limit with TRAFFIC**: `1000 elements/1s`GET and POST",
+ "operationId": "matrix_distance_distancematrix_json__get",
+ "security": [
+ {
+ "Distance_PublicAPIKey": []
+ },
+ {
+ "Distance_PrivateApiKey": []
+ },
+ {
+ "Distance_PrivateApiKeyHeader": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "mode",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "enum": [
+ "driving",
+ "walking",
+ "cycling"
+ ],
+ "type": "string",
+ "description": "Specifies the mode of transport to use for the calculation.",
+ "default": "driving",
+ "title": "Mode"
+ },
+ "description": "Specifies the mode of transport to use for the calculation."
+ },
+ {
+ "name": "method",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "enum": [
+ "time",
+ "distance"
+ ],
+ "type": "string",
+ "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": "Method"
+ },
+ "description": "Specifies how to compute the route between the start point and the end point:\n* `time`: fastest route \n* `distance`: shortest route"
+ },
+ {
+ "name": "units",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "enum": [
+ "metric",
+ "imperial"
+ ],
+ "type": "string",
+ "description": "Specifies the unit system to use when displaying results.",
+ "default": "metric",
+ "title": "Units"
+ },
+ "description": "Specifies the unit system to use when displaying results."
+ },
+ {
+ "name": "language",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "enum": [
+ "en",
+ "fr",
+ "ca",
+ "de",
+ "es",
+ "he",
+ "it",
+ "ja",
+ "nl",
+ "pl",
+ "pt",
+ "ro",
+ "ru",
+ "uk",
+ "zh"
+ ],
+ "type": "string",
+ "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": "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`."
+ },
+ {
+ "name": "avoid",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "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"
+ ],
+ "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."
+ },
+ {
+ "name": "origins",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "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`@:"
+ ],
+ "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::`"
+ },
+ {
+ "name": "destinations",
+ "in": "query",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "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`@:"
+ ],
+ "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::`"
+ },
+ {
+ "name": "arrival_time",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "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"
+ ],
+ "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."
+ },
+ {
+ "name": "departure_time",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "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"
+ ],
+ "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."
+ },
+ {
+ "name": "elements",
+ "in": "query",
+ "required": false,
+ "schema": {
+ "enum": [
+ "distance",
+ "duration",
+ "duration_distance"
+ ],
+ "type": "string",
+ "description": "Specifies element values that will be part of the API response (`distance` and/or `duration`).",
+ "default": "distance",
+ "title": "Elements"
+ },
+ "description": "Specifies element values that will be part of the API response (`distance` and/or `duration`)."
+ },
+ {
+ "name": "accept-language",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Accept-Language"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_MatrixResponse"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unable to locate credentials.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "402": {
+ "description": "Out of free quota.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Credentials found, but not matching.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_HTTPValidationError"
+ }
+ }
+ }
+ },
+ "429": {
+ "description": "Rate limit reached",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_HTTPErrorModel"
+ }
+ }
+ }
+ }
+ }
+ },
+ "post": {
+ "tags": [
+ "Matrix API"
+ ],
+ "summary": "Calculate Matrix",
+ "description": "Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode.\n\n**Rate limit**: `10 requests/1s` GET and POST\n\n**Elements limit**: `1000 elements/1s` GET and POST\n\n**Rate limit with TRAFFIC**: `10 requests/1s` GET and POST\n\n**Elements limit with TRAFFIC**: `1000 elements/1s` GET and POST",
+ "operationId": "matrix_post_distance_distancematrix_json__post",
+ "security": [
+ {
+ "Distance_PublicAPIKey": []
+ },
+ {
+ "Distance_PrivateApiKey": []
+ },
+ {
+ "Distance_PrivateApiKeyHeader": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "accept-language",
+ "in": "header",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Accept-Language"
+ }
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_MatrixRequest"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "Successful Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_MatrixResponse"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unable to locate credentials.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "402": {
+ "description": "Out of free quota.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Credentials found, but not matching.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_AuthenticationErrorResponse"
+ }
+ }
+ }
+ },
+ "422": {
+ "description": "Validation Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_HTTPValidationError"
+ }
+ }
+ }
+ },
+ "429": {
+ "description": "Rate limit reached",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Distance_HTTPErrorModel"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "components": {
+ "parameters": {
+ "Woosmap_Platform_API_Reference_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"
+ }
+ },
+ "Woosmap_Platform_API_Reference_limit": {
+ "name": "limit",
+ "description": "To limit number of assets retrieved from an IP location.\n",
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 300,
+ "example": 10
+ },
+ "in": "query"
+ },
+ "Woosmap_Platform_API_Reference_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"
+ },
+ "Woosmap_Platform_API_Reference_lat": {
+ "name": "lat",
+ "description": "Latitude bias for the results. Should be pass with `lng`.\n",
+ "schema": {
+ "type": "number",
+ "example": 5.2
+ },
+ "in": "query"
+ },
+ "Woosmap_Platform_API_Reference_lng": {
+ "name": "lng",
+ "description": "Longitude bias for the results. Should be pass with `lat`.\n",
+ "schema": {
+ "type": "number",
+ "example": 3.5
+ },
+ "in": "query"
+ },
+ "Woosmap_Platform_API_Reference_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"
+ },
+ "Woosmap_Platform_API_Reference_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"
+ },
+ "Woosmap_Platform_API_Reference_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"
+ },
+ "Woosmap_Platform_API_Reference_page": {
+ "name": "page",
+ "description": "Page number when accessing paginated assets feature collection\n",
+ "schema": {
+ "type": "integer",
+ "example": 2
+ },
+ "in": "query"
+ },
+ "Woosmap_Platform_API_Reference_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.\n"
+ },
+ "Woosmap_Platform_API_Reference_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.\n",
+ "schema": {
+ "type": "string",
+ "example": "en"
+ },
+ "in": "query"
+ },
+ "Woosmap_Platform_API_Reference_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).\n",
"schema": {
"type": "integer",
@@ -11412,246 +11635,73 @@
"schema": {
"type": "string",
"example": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMDA1MTI2"
- },
- "required": true,
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_fields-2": {
- "name": "fields",
- "description": "Used to limit the returning fields (by default, all fields are return). Available fields are (geometry) (fields should be separated by a `,`). By using this parameter you will limit content of responses to the geometry part. No address component will be returned.\n",
- "schema": {
- "type": "string",
- "enum": [
- "geometry"
- ],
- "example": "geometry"
- },
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_address-2": {
- "name": "address",
- "description": "The address of which to find the coordinates for. A partial address is less likely to return the proper coordinates than the complete address.\n",
- "schema": {
- "type": "string",
- "example": "224%20Rue%20de%20Rivoli%2C%20Paris"
- },
- "required": false,
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_latlng-2": {
- "name": "latlng",
- "description": "Geographic coordinates. Should be pass in `lat`,`lng` format.\n",
- "schema": {
- "type": "string",
- "example": "5.2,-2.3"
- },
- "required": false,
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_limit-3": {
- "name": "limit",
- "description": "Maximum number of results to be returned (value from 1 to 100, default values for geocode request [20] and for reverse geocode request [1])\n",
- "schema": {
- "type": "integer",
- "minimum": 1,
- "maximum": 100,
- "example": 10
- },
- "in": "query"
- },
- "Woosmap_Platform_API_Reference_limit-4": {
- "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"
- },
- "Woosmap_Platform_API_Reference_origins": {
- "name": "origins",
- "in": "query",
- "required": true,
- "schema": {
- "type": "string",
- "example": "48.709,2.403"
- },
- "description": "The starting point for calculating travel distance. You can supply one or more locations separated by the pipe character (|), in the form of latitude/longitude coordinates. They are used unchanged to calculate distance. Ensure that no space exists between the latitude and longitude values. In order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc:encoded-polyline:`\n"
- },
- "Woosmap_Platform_API_Reference_destinations": {
- "name": "destinations",
- "in": "query",
- "required": true,
- "schema": {
- "type": "string",
- "example": "48.709,2.403|48.768,2.338"
- },
- "description": "One or more locations to use as the finishing point for calculating travel distance. The options for the destinations parameter are the same as for the origins parameter, described above. In order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc:encoded-polyline:`\n"
- },
- "Woosmap_Platform_API_Reference_mode": {
- "name": "mode",
- "in": "query",
- "schema": {
- "type": "string",
- "enum": [
- "driving",
- "cycling",
- "walking"
- ],
- "example": "driving"
- },
- "description": "Specifies the mode of transport to use when calculating distance\n"
- },
- "Woosmap_Platform_API_Reference_language-4": {
- "name": "language",
- "in": "query",
- "schema": {
- "type": "string",
- "example": "en"
- },
- "description": "The language code, indicating in which language the results should be returned, if possible. If language is not supplied, the Distance API service will use the navigator language or “en”.\n"
- },
- "Woosmap_Platform_API_Reference_units": {
- "name": "units",
- "in": "query",
- "schema": {
- "type": "string",
- "enum": [
- "imperial",
- "metric"
- ],
- "example": "metric"
- },
- "description": "Specifies the unit system parameter to use when expressing distance as text. Two different units supported:\n * `metric` (default) returns distances in kilometers and meters\n * `imperial` returns distances in miles and feet\n"
- },
- "Woosmap_Platform_API_Reference_elements": {
- "name": "elements",
- "in": "query",
- "schema": {
- "type": "string",
- "enum": [
- "distance",
- "duration",
- "duration_distance"
- ],
- "example": "duration_distance"
- },
- "description": "Specifies element values that will be part of the API response (distance and/or duration). if not specified default is `distance`\n"
- },
- "Woosmap_Platform_API_Reference_method": {
- "name": "method",
- "in": "query",
- "schema": {
- "type": "string",
- "enum": [
- "time",
- "distance"
- ],
- "example": "distance"
- },
- "description": "Specifies the method to compute the route between the start point and the end point:\n- `time`: fastest route (default) - `distance`: shortest route\n"
- },
- "Woosmap_Platform_API_Reference_avoid": {
- "name": "avoid",
- "in": "query",
- "schema": {
- "type": "string",
- "example": "tolls|highways|43.3,3.4;42.1,3.5;41.4,3.6"
- },
- "description": "The 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. To add multiple polygons, separate them with the `|` character.\n"
- },
- "Woosmap_Platform_API_Reference_departure_time": {
- "name": "departure_time",
- "in": "query",
- "schema": {
- "type": "string",
- "example": "1600799173"
- },
- "description": "By using this parameter, Distance will calculate the duration with traffic Specifies the date/time at which to base the calculations on for traffic purposes. Valid values are a timestamp (e.g. `1600799173` for the date:`22/09/2020 20:26:13`) or `now`.\nUse either `arrival_time` or `departure_time`, not both.\n"
- },
- "Woosmap_Platform_API_Reference_origin": {
- "name": "origin",
- "in": "query",
- "required": true,
- "schema": {
- "type": "string",
- "example": "48.709,2.403"
- },
- "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.\n"
- },
- "Woosmap_Platform_API_Reference_destination": {
- "name": "destination",
- "in": "query",
+ },
"required": true,
+ "in": "query"
+ },
+ "Woosmap_Platform_API_Reference_fields-2": {
+ "name": "fields",
+ "description": "Used to limit the returning fields (by default, all fields are return). Available fields are (geometry) (fields should be separated by a `,`). By using this parameter you will limit content of responses to the geometry part. No address component will be returned.\n",
"schema": {
"type": "string",
- "example": "48.768,2.338"
+ "enum": [
+ "geometry"
+ ],
+ "example": "geometry"
},
- "description": "The ending point for the route. It should be supplied in the form of latitude/longitude coordinates. Ensure that no space exists between the latitude and longitude values.\n"
+ "in": "query"
},
- "Woosmap_Platform_API_Reference_alternatives": {
- "name": "alternatives",
- "in": "query",
+ "Woosmap_Platform_API_Reference_address-2": {
+ "name": "address",
+ "description": "The address of which to find the coordinates for. A partial address is less likely to return the proper coordinates than the complete address.\n",
"schema": {
- "type": "boolean",
- "example": true
+ "type": "string",
+ "example": "224%20Rue%20de%20Rivoli%2C%20Paris"
},
- "description": "Specifies if alternative routes should be returned. default is `false`. Depending on the calculated route, alternatives may not be provided.\n`alternatives` and `waypoints` can not be used at the same time.\n"
+ "required": false,
+ "in": "query"
},
- "Woosmap_Platform_API_Reference_waypoints": {
- "name": "waypoints",
- "in": "query",
+ "Woosmap_Platform_API_Reference_latlng-2": {
+ "name": "latlng",
+ "description": "Geographic coordinates. Should be pass in `lat`,`lng` format.\n",
"schema": {
"type": "string",
- "example": "optimize:true|48.850077,3.311124|48.850077,3.411124"
+ "example": "5.2,-2.3"
},
- "description": "A list of points by which the route should pass (route response is divided into legs, one leg corresponding to a route between two waypoints). Waypoints should be separated by | character.\nOptionally, you may pass `optimize:true` as the first argument within the waypoints parameter. This way the provided route is optimized by rearranging the waypoints in a more efficient order based on distance or time according to the method parameter. The route start point and end point order is not changed, their position is considered fixed.\n`alternatives` and `waypoints` can not be used at the same time.\n"
+ "required": false,
+ "in": "query"
},
- "Woosmap_Platform_API_Reference_details": {
- "name": "details",
- "in": "query",
+ "Woosmap_Platform_API_Reference_limit-3": {
+ "name": "limit",
+ "description": "Maximum number of results to be returned (value from 1 to 100, default values for geocode request [20] and for reverse geocode request [1])\n",
"schema": {
- "type": "string",
- "enum": [
- "full",
- "none"
- ],
- "example": "full"
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 100,
+ "example": 10
},
- "description": "Specifies if maneuver instructions should be returned (roadbook). Valid values are `none` and `full` (default is `none`)\n"
+ "in": "query"
},
- "Woosmap_Platform_API_Reference_arrival_time": {
- "name": "arrival_time",
- "in": "query",
+ "Woosmap_Platform_API_Reference_limit-4": {
+ "name": "limit",
+ "description": "To limit number of zones retrieved (max 50).\n",
"schema": {
- "type": "string",
- "example": "1600799173"
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 50,
+ "example": 10
},
- "description": "By using this parameter, Distance will calculate the duration with traffic Specifies the arrival date/time as a timestamp to base the calculation on (e.g. `1600799173` for the date:`22/09/2020 20:26:13`).\nUse either `arrival_time` or `departure_time`, not both.\n"
+ "in": "query"
},
- "Woosmap_Platform_API_Reference_value": {
- "name": "value",
- "in": "query",
- "required": true,
+ "Woosmap_Platform_API_Reference_offset": {
+ "name": "offset",
+ "description": "To retrieve zones starting from an offset value.\n",
"schema": {
"type": "integer",
"minimum": 1,
- "maximum": 120,
- "example": 120
+ "example": 20
},
- "description": "The value to use for isochrone contour. You can specify time in minutes or distance in kilometers (cf. method parameter). The maximum value that can be specified is 120 (120 minutes : 2 hours or 120 km).\n"
+ "in": "query"
},
"Woosmap_Platform_API_Reference_address_address_components": {
"$ref": "#/components/parameters/Woosmap_Platform_API_Reference_address_components"
@@ -11683,54 +11733,6 @@
"Woosmap_Platform_API_Reference_address_public_id": {
"$ref": "#/components/parameters/Woosmap_Platform_API_Reference_public_id-2"
},
- "Woosmap_Platform_API_Reference_distance_alternatives": {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_alternatives"
- },
- "Woosmap_Platform_API_Reference_distance_arrival_time": {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_arrival_time"
- },
- "Woosmap_Platform_API_Reference_distance_avoid": {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_avoid"
- },
- "Woosmap_Platform_API_Reference_distance_departure_time": {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_departure_time"
- },
- "Woosmap_Platform_API_Reference_distance_destination": {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_destination"
- },
- "Woosmap_Platform_API_Reference_distance_destinations": {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_destinations"
- },
- "Woosmap_Platform_API_Reference_distance_details": {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_details"
- },
- "Woosmap_Platform_API_Reference_distance_elements": {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_elements"
- },
- "Woosmap_Platform_API_Reference_distance_language": {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_language-4"
- },
- "Woosmap_Platform_API_Reference_distance_method": {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_method"
- },
- "Woosmap_Platform_API_Reference_distance_mode": {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_mode"
- },
- "Woosmap_Platform_API_Reference_distance_origin": {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_origin"
- },
- "Woosmap_Platform_API_Reference_distance_origins": {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_origins"
- },
- "Woosmap_Platform_API_Reference_distance_units": {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_units"
- },
- "Woosmap_Platform_API_Reference_distance_value": {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_value"
- },
- "Woosmap_Platform_API_Reference_distance_waypoints": {
- "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_waypoints"
- },
"Woosmap_Platform_API_Reference_geolocation_ip_address": {
"$ref": "#/components/parameters/Woosmap_Platform_API_Reference_ip_address"
},
@@ -15661,1089 +15663,941 @@
}
}
},
- "Woosmap_Platform_API_Reference_DistanceStatus": {
- "title": "DistanceStatus",
+ "Woosmap_Platform_API_Reference_Destinations": {
+ "title": "Destinations",
+ "example": "48.709,2.403|48.768,2.338",
+ "type": "string",
+ "description": "One or more locations to use as the finishing point for calculating travel distance. The options for the destinations parameter are the same as for the origins parameter, described above. In order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc:encoded-polyline:`\n"
+ },
+ "Woosmap_Platform_API_Reference_Origins": {
+ "title": "Origins",
+ "example": "48.709,2.403",
+ "type": "string",
+ "description": "The starting point for calculating travel distance. You can supply one or more locations separated by the pipe character, in the form of latitude/longitude coordinates. They are used unchanged to calculate distance. Ensure that no space exists between the latitude and longitude values. In order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc:encoded-polyline:`\n"
+ },
+ "Woosmap_Platform_API_Reference_Units": {
+ "title": "Units",
+ "example": "metric",
"type": "string",
- "description": "Returns more info on if the request was successful or not.\n * `OK` indicates the response contains a valid result.\n * `INVALID_REQUEST` indicates that the provided request was invalid (e.g. wrong URL syntax).\n * `MAX_ELEMENTS_EXCEEDED` indicates that the product of origins and destinations exceeds the per-query limit (fixed at 200 elts/q).\n * `MAX_ROUTE_LENGTH_EXCEEDED` indicates that at least one of requested route is too long and the matrix cannot be processed (>500km).\n * `REQUEST_DENIED` indicates that the service denied use of the Distance API service (e.g. wrong API Key, wrong/no referer, …).\n * `BACKEND_ERROR` indicates a Distance API request could not be processed due to a server error. This may indicate that the origin and/or destination of this pairing could not be matched to the network. The request may or may not succeed if you try again.\n * `OVER_QUERY_LIMIT` (associated to a 429 status code) indicates that the number of queries per second (QPS) or the number of elements per second (EPS) exceed the [usage limits](https://developers.woosmap.com/products/distance-api/distance-matrix-endpoint/#usage-limits)\n",
"enum": [
- "OK",
- "INVALID_REQUEST",
- "MAX_ELEMENTS_EXCEEDED",
- "MAX_ROUTE_LENGTH_EXCEEDED",
- "REQUEST_DENIED",
- "BACKEND_ERROR",
- "OVER_QUERY_LIMIT"
- ]
+ "imperial",
+ "metric"
+ ],
+ "description": "Specifies the unit system to use when expressing distance as text. Two different units supported:\n * `metric` (default) returns distances in kilometers and meters\n * `imperial` returns distances in miles and feet\n"
},
- "Woosmap_Platform_API_Reference_DurationValue": {
- "title": "DurationValue",
- "description": "The total duration to travel this route/leg, expressed in seconds (value) and as text. The textual value gives a structured string for duration in the specified language (if available).",
+ "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": {
- "value": {
- "description": "The duration in seconds",
- "type": "number",
- "example": 272.5
+ "details": {
+ "type": "string",
+ "title": "Details"
+ }
+ },
+ "type": "object",
+ "required": [
+ "details"
+ ],
+ "title": "HTTPErrorModel"
+ },
+ "Maps_HTTPValidationError": {
+ "properties": {
+ "detail": {
+ "items": {
+ "$ref": "#/components/schemas/Maps_ValidationError"
+ },
+ "type": "array",
+ "title": "Detail"
+ }
+ },
+ "type": "object",
+ "title": "HTTPValidationError"
+ },
+ "Maps_MapStyle": {
+ "properties": {
+ "featureType": {
+ "type": "string",
+ "title": "Featuretype"
},
- "text": {
+ "elementType": {
"type": "string",
- "description": "The readable duration value",
- "example": "5 mins"
+ "title": "Elementtype",
+ "default": "all"
+ },
+ "stylers": {
+ "items": {
+ "$ref": "#/components/schemas/Maps_MapStyler"
+ },
+ "type": "array",
+ "title": "Stylers"
+ }
+ },
+ "type": "object",
+ "required": [
+ "featureType",
+ "stylers"
+ ],
+ "title": "MapStyle"
+ },
+ "Maps_MapStyler": {
+ "properties": {
+ "visibility": {
+ "anyOf": [
+ {
+ "type": "string",
+ "enum": [
+ "on",
+ "off"
+ ]
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Visibility"
+ },
+ "color": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Color"
+ },
+ "hue": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Hue"
+ },
+ "saturation": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Saturation"
+ },
+ "gamma": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Gamma"
+ },
+ "lightness": {
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Lightness"
+ }
+ },
+ "type": "object",
+ "title": "MapStyler"
+ },
+ "Maps_MarkerWithUrlOptions": {
+ "properties": {
+ "lat": {
+ "type": "number",
+ "title": "Lat"
+ },
+ "lng": {
+ "type": "number",
+ "title": "Lng"
+ },
+ "url": {
+ "anyOf": [
+ {
+ "type": "string",
+ "maxLength": 2083,
+ "minLength": 1,
+ "format": "uri"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Url"
}
},
+ "type": "object",
+ "required": [
+ "lat",
+ "lng"
+ ],
+ "title": "MarkerWithUrlOptions",
"example": {
- "value": 272.5,
- "text": "5 mins"
+ "lat": 43.6,
+ "lng": 3.883,
+ "url": "https://webapp.woosmap.com/img/geolocated_marker.png?retina=yes"
}
},
- "Woosmap_Platform_API_Reference_DistanceValue": {
- "title": "DistanceValue",
- "description": "The total distance expressed in meters (value) and as text. The textual value uses the unit system specified with the units parameter of the original request.",
- "type": "object",
+ "Maps_PolygonOptions": {
"properties": {
- "value": {
- "description": "The distance in meters.",
- "type": "number",
- "example": 2775.1
+ "shape": {
+ "type": "string",
+ "title": "Shape"
},
- "text": {
- "description": "The readable distance using the unit system specified.",
+ "color": {
+ "type": "string",
+ "title": "Color",
+ "default": "rgb(65, 176, 246)"
+ },
+ "fill_color": {
"type": "string",
- "example": "2.8 km"
+ "title": "Fill Color",
+ "default": "rgba(65, 176, 246, 0.5)"
+ },
+ "weight": {
+ "type": "number",
+ "title": "Weight",
+ "default": 1
}
},
+ "type": "object",
+ "required": [
+ "shape"
+ ],
+ "title": "PolygonOptions",
"example": {
- "value": 2775.1,
- "text": "2.8 km"
+ "color": "rgba(199, 21, 133, 0.7)",
+ "fill_color": "rgba(255, 20, 147, 0.5)",
+ "shape": "ymgiGm|rV~uAtaB|dAefCqeBwuFu~@njC??"
}
},
- "Woosmap_Platform_API_Reference_DistanceMatrixElementResponse": {
- "title": "DistanceMatrixElementResponse",
- "type": "object",
- "description": "Attributes describing an element of origin and destination returned in distance Matrix response.",
+ "Maps_PolylineOptions": {
"properties": {
- "status": {
+ "enc": {
"type": "string",
- "description": "Status returned for Distance Matrix Element Response.\n - `OK` indicates the response contains a valid result.\n - `NOT_FOUND` indicates that the origin and/or destination of this pairing could not be matched to the network.\n - `ZERO_RESULTS` indicates no route could be found between the origin and destination.\n",
- "enum": [
- "OK",
- "NOT_FOUND",
- "ZERO_RESULTS"
- ]
+ "title": "Enc"
},
- "duration": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DurationValue"
+ "color": {
+ "type": "string",
+ "title": "Color",
+ "default": "rgb(65, 176, 246)"
},
- "distance": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceValue"
- }
- }
- },
- "Woosmap_Platform_API_Reference_DistanceMatrixElementsResponse": {
- "title": "DistanceMatrixElementsResponse",
- "type": "object",
- "description": "Attributes describing elements of origin and destination returned in distance Matrix response.",
- "properties": {
- "elements": {
- "type": "array",
- "description": "the route element",
- "items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceMatrixElementResponse"
- }
+ "weight": {
+ "type": "number",
+ "title": "Weight",
+ "default": 1
}
},
+ "type": "object",
+ "required": [
+ "enc"
+ ],
+ "title": "PolylineOptions",
"example": {
- "elements": [
- {
- "status": "OK",
- "duration": {
- "value": 866,
- "text": "14 mins"
- },
- "distance": {
- "value": 10613,
- "text": "10.6 km"
- }
- },
- {
- "status": "OK",
- "duration": {
- "value": 935,
- "text": "16 mins"
- },
- "distance": {
- "value": 10287,
- "text": "10.3 km"
- }
- }
- ]
+ "color": "magenta",
+ "enc": "ydjiG_}jVjn@cjAf`AycBnc@mqCp\\ewBrQmlBzrAeuCreBw_C",
+ "weight": 4
}
},
- "Woosmap_Platform_API_Reference_DistanceMatrixResponse": {
- "title": "DistanceMatrixResponse",
- "type": "object",
- "description": "Attributes describing an distance Matrix response.",
+ "Maps_ValidationError": {
"properties": {
- "status": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceStatus"
- },
- "rows": {
- "description": "Contains an array of elements for each pair of origin and destination",
- "type": "array",
+ "loc": {
"items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceMatrixElementsResponse"
- }
- }
- },
- "example": {
- "status": "OK",
- "rows": [
- {
- "elements": [
+ "anyOf": [
{
- "status": "OK",
- "duration": {
- "value": 978,
- "text": "16 mins"
- },
- "distance": {
- "value": 10796,
- "text": "10.8 km"
- }
+ "type": "string"
},
{
- "status": "OK",
- "duration": {
- "value": 942,
- "text": "16 mins"
- },
- "distance": {
- "value": 10322,
- "text": "10.3 km"
- }
+ "type": "integer"
}
]
- }
- ]
- }
- },
- "Woosmap_Platform_API_Reference_Origins": {
- "title": "Origins",
- "example": "48.709,2.403",
- "type": "string",
- "description": "The starting point for calculating travel distance. You can supply one or more locations separated by the pipe character, in the form of latitude/longitude coordinates. They are used unchanged to calculate distance. Ensure that no space exists between the latitude and longitude values. In order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc:encoded-polyline:`\n"
- },
- "Woosmap_Platform_API_Reference_Destinations": {
- "title": "Destinations",
- "example": "48.709,2.403|48.768,2.338",
- "type": "string",
- "description": "One or more locations to use as the finishing point for calculating travel distance. The options for the destinations parameter are the same as for the origins parameter, described above. In order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc:encoded-polyline:`\n"
- },
- "Woosmap_Platform_API_Reference_Units": {
- "title": "Units",
- "example": "metric",
- "type": "string",
- "enum": [
- "imperial",
- "metric"
- ],
- "description": "Specifies the unit system to use when expressing distance as text. Two different units supported:\n * `metric` (default) returns distances in kilometers and meters\n * `imperial` returns distances in miles and feet\n"
- },
- "Woosmap_Platform_API_Reference_DistanceMatrixRequest": {
- "title": "DistanceMatrixRequest",
- "type": "object",
- "description": "Attributes describing a distance Matrix request",
- "required": [
- "origins",
- "destinations"
- ],
- "properties": {
- "origins": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Origins"
- },
- "destinations": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Destinations"
- },
- "mode": {
- "example": "driving",
- "type": "string",
- "enum": [
- "driving",
- "cycling",
- "walking"
- ],
- "description": "Specifies the mode of transport to use when calculating distance\n"
+ },
+ "type": "array",
+ "title": "Location"
},
- "language": {
- "example": "en",
+ "msg": {
"type": "string",
- "description": "The language code, indicating in which language the results should be returned, if possible. If language is not supplied, the Distance API service will use the navigator language or “en”.\n"
- },
- "units": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Units"
+ "title": "Message"
},
- "elements": {
- "example": "duration_distance",
+ "type": {
"type": "string",
- "enum": [
- "distance",
- "duration",
- "duration_distance"
- ],
- "description": "Specifies element values that will be part of the API response (distance and/or duration). if not specified default is `distance`\n"
- },
- "method": {
- "example": "distance",
+ "title": "Error Type"
+ }
+ },
+ "type": "object",
+ "required": [
+ "loc",
+ "msg",
+ "type"
+ ],
+ "title": "ValidationError"
+ },
+ "External-api-wrapper_what3words_AddressSummary": {
+ "properties": {
+ "public_id": {
"type": "string",
- "enum": [
- "time",
- "distance"
- ],
- "description": "Specifies the method to compute the route between the start point and the end point:\n - `time`: fastest route (default)\n - `distance`: shortest route\n"
+ "title": "Public Id",
+ "description": "Public ID of address listed as sub_building"
},
- "departure_time": {
- "example": "now",
+ "description": {
"type": "string",
- "description": "Specifies the date/time at which to base the calculations on for traffic purposes. Valid values are a timestamp (e.g. `1600799173` for the date:`22/09/2020 20:26:13`) or `now`.\n"
+ "title": "Description",
+ "description": "Human readable address"
}
},
- "example": {
- "origins": "48.73534,2.368308|48.73534,2.368308",
- "destinations": "48.83534,2.368308",
- "units": "imperial",
- "elements": "duration_distance",
- "method": "distance",
- "departure_time": "now"
- }
- },
- "Woosmap_Platform_API_Reference_EncodedPolyline": {
- "title": "EncodedPolyline",
"type": "object",
- "description": "The polyline of the route (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm)).",
+ "required": [
+ "public_id",
+ "description"
+ ],
+ "title": "AddressSummary"
+ },
+ "External-api-wrapper_what3words_AuthenticationErrorResponse": {
"properties": {
- "points": {
+ "detail": {
"type": "string",
- "description": "The encoded string value for points of the polyline",
- "example": "a_jyHfol@aAfEzGlIfER~JqV_KqLu@pDiHv@bAfEeCfE"
+ "title": "Detail"
}
},
- "example": {
- "points": "a_jyHfol@aAfEzGlIfER~JqV_KqLu@pDiHv@bAfEeCfE"
- }
- },
- "Woosmap_Platform_API_Reference_DistanceInstructions": {
- "title": "DistanceInstructions",
"type": "object",
- "description": "Formatted instructions for this leg",
+ "required": [
+ "detail"
+ ],
+ "title": "AuthenticationErrorResponse",
+ "description": "AuthenticationErrorResponse is the base authentication error model."
+ },
+ "External-api-wrapper_what3words_AutoSuggestResponse": {
"properties": {
- "action": {
- "type": "integer",
- "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).",
- "example": 2
- },
- "summary": {
- "type": "string",
- "description": "Written maneuver instruction.",
- "example": "Drive northeast on D 151."
- },
- "verbal_alert": {
- "type": "string",
- "description": "The transition alert instruction will prepare the user for the forthcoming transition.",
- "example": "Enter the roundabout and take the 2nd exit onto D 30."
- },
- "verbal_succint": {
- "type": "string",
- "description": "Text suitable for use as a verbal alert in a navigation application",
- "example": "Drive northeast. Then Enter the roundabout and take the 2nd exit onto D 30."
- },
- "verbal_before": {
- "type": "string",
- "description": "Text suitable for use as a verbal message immediately prior to the maneuver transition",
- "example": "Drive northeast on D 151. Then Enter the roundabout and take the 2nd exit onto D 30."
- },
- "verbal_after": {
- "type": "string",
- "description": "Text suitable for use as a verbal message immediately after the maneuver transition",
- "example": "Continue for 700 meters."
+ "suggestions": {
+ "items": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_AutoSuggestions"
+ },
+ "type": "array",
+ "title": "Suggestions"
}
},
+ "type": "object",
+ "required": [
+ "suggestions"
+ ],
+ "title": "AutoSuggestResponse",
"example": {
- "action": 2,
- "summary": "Drive northeast on D 151.",
- "verbal_alert": "Enter the roundabout and take the 2nd exit onto D 30.",
- "verbal_before": "Drive northeast on D 151. Then Enter the roundabout and take the 2nd exit onto D 30."
+ "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"
+ }
+ ]
}
},
- "Woosmap_Platform_API_Reference_DistanceStep": {
- "title": "DistanceStep",
- "type": "object",
- "description": "step in a leg",
+ "External-api-wrapper_what3words_AutoSuggestions": {
"properties": {
- "distance": {
- "description": "the distance as text covered by this step until the next step.",
+ "country": {
"type": "string",
- "example": "2.8 km"
+ "title": "Country",
+ "description": "Country Code"
},
- "duration": {
- "description": "the typical time as text required to perform the step, until the next step",
+ "nearestPlace": {
"type": "string",
- "example": "5 minutes"
+ "title": "Nearestplace",
+ "description": "Nearest Place"
},
- "polyline": {
+ "words": {
"type": "string",
- "description": "the polyline representation of the step (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm)",
- "example": "_igoHa~hYgApBMHOEKO"
+ "title": "Words",
+ "description": "The what3words address"
},
- "start_location": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LatLngLiteral"
+ "distanceToFocusKm": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Distancetofocuskm",
+ "description": "Distance to the Lat Lng focus (if provided)"
},
- "end_location": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LatLngLiteral"
+ "rank": {
+ "type": "integer",
+ "title": "Rank",
+ "description": "Suggestion Rank"
},
- "travel_mode": {
+ "language": {
"type": "string",
- "description": "the type of travel mode used",
- "example": "driving"
- },
- "instructions": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceInstructions"
+ "title": "Language",
+ "description": "Language Code"
}
},
- "example": {
- "distance": "46 m",
- "duration": "1 min",
- "polyline": "iu~kHsziXJBJAHGFIDMBSAS",
- "start_location": {
- "lat": 49.314292,
- "lng": 4.151623
- },
- "end_location": {
- "lat": 49.314041,
- "lng": 4.151976
- },
- "travel_mode": "DRIVING"
- }
- },
- "Woosmap_Platform_API_Reference_DistanceLeg": {
- "title": "DistanceLeg",
"type": "object",
- "description": "Leg in a route",
+ "required": [
+ "country",
+ "nearestPlace",
+ "words",
+ "rank",
+ "language"
+ ],
+ "title": "AutoSuggestions"
+ },
+ "External-api-wrapper_what3words_Coordinates": {
"properties": {
- "distance": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceValue"
- },
- "duration": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DurationValue"
- },
- "start_location": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LatLngLiteral"
- },
- "end_location": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LatLngLiteral"
- },
- "start_waypoint": {
- "type": "integer",
- "description": "The start waypoint order number",
- "example": 1
- },
- "end_waypoint": {
- "type": "integer",
- "description": "The end waypoint order number",
- "example": 2
- },
- "start_address": {
- "type": "string",
- "description": "the starting address of the leg",
- "example": "Chemin de la Tuilerie"
- },
- "end_address": {
- "type": "string",
- "description": "the ending address of the leg",
- "example": "D 8043, E 44"
+ "lng": {
+ "type": "number",
+ "title": "Lng",
+ "description": "Longitude"
},
- "steps": {
- "description": "List of steps constituting the leg. Steps are returned when `details=full` parameter is specified. 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.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceStep"
- }
+ "lat": {
+ "type": "number",
+ "title": "Lat",
+ "description": "Latitude"
}
},
- "example": {
- "distance": {
- "text": "1 km",
- "value": 1038
- },
- "duration": {
- "text": "1 min",
- "value": 75
- },
- "start_location": {
- "lat": 49.31067,
- "lng": 4.14525
- },
- "end_location": {
- "lat": 49.31344,
- "lng": 4.15293
- },
- "start_waypoint": 0,
- "end_waypoint": 1,
- "end_address": "D 30",
- "start_address": "D 151"
- }
- },
- "Woosmap_Platform_API_Reference_DistanceRouteElementsResponse": {
- "title": "DistanceRouteElementsResponse",
"type": "object",
- "description": "Attributes describing routes from an origin to a destination returned in distance route response.",
"required": [
- "overview_polyline",
- "bounds",
- "notice",
- "legs"
+ "lng",
+ "lat"
],
+ "title": "Coordinates"
+ },
+ "External-api-wrapper_what3words_GeoJsonCoordinatesResponse": {
"properties": {
- "overview_polyline": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_EncodedPolyline"
- },
- "bounds": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Bounds"
- },
- "notice": {
- "type": "string",
- "description": "Some noticeable information about the route",
- "example": "Has toll segments"
- },
- "legs": {
- "type": "array",
- "description": "Legs part of the route response",
+ "features": {
"items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceLeg"
- }
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_GeoJsonFeature"
+ },
+ "type": "array",
+ "title": "Features",
+ "description": "GeoJSON Features"
},
- "main_route_name": {
+ "type": {
"type": "string",
- "description": "The main route name based on the longest step length to differentiate routes when alternates are returned.",
- "example": "Fillmore Street"
- },
- "recommended": {
- "type": "boolean",
- "description": "Optional field. Only present and set to true when the route is the recommended route.",
- "example": true
- }
- }
- },
- "Woosmap_Platform_API_Reference_DistanceRouteResponse": {
- "title": "DistanceRouteResponse",
- "type": "object",
- "description": "Attributes describing a distance route response.",
- "properties": {
- "status": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceStatus"
- },
- "routes": {
- "description": "Contains an array of routes from origin to destination (only one if alternatives is not specified)",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceRouteElementsResponse"
- }
+ "title": "Type",
+ "description": "GeoJSON Type"
}
},
+ "type": "object",
+ "required": [
+ "features",
+ "type"
+ ],
+ "title": "GeoJsonCoordinatesResponse",
"example": {
- "status": "OK",
- "routes": [
+ "features": [
{
- "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@eAHO"
- },
- "bounds": {
- "northeast": {
- "lat": 49.315678,
- "lng": 4.152915
- },
- "southwest": {
- "lat": 49.31073,
- "lng": 4.145162
- }
- },
- "notice": "",
- "legs": [
- {
- "distance": {
- "text": "1 km",
- "value": 1038
- },
- "duration": {
- "text": "1 min",
- "value": 75
- },
- "start_location": {
- "lat": 49.31067,
- "lng": 4.14525
- },
- "end_location": {
- "lat": 49.31344,
- "lng": 4.15293
- },
- "start_waypoint": 0,
- "end_waypoint": 1,
- "end_address": "D 30",
- "start_address": "D 151",
- "steps": [
- {
- "distance": "676 m",
- "duration": "1 min",
- "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
- },
- "end_location": {
- "lat": 49.315679,
- "lng": 4.149621
- },
- "travel_mode": "DRIVING",
- "instructions": {
- "action": 2,
- "summary": "Drive northeast on D 151.",
- "verbal_succint": "Drive northeast. Then Enter the roundabout and take the 2nd exit onto D 30.",
- "verbal_before": "Drive northeast on D 151. Then Enter the roundabout and take the 2nd exit onto D 30.",
- "verbal_after": "Continue for 700 meters."
- }
- },
- {
- "distance": "22 m",
- "duration": "1 min",
- "polyline": "}}~kHcniXBIBU?W",
- "start_location": {
- "lat": 49.315679,
- "lng": 4.149621
- },
- "end_location": {
- "lat": 49.31563,
- "lng": 4.149905
- },
- "travel_mode": "DRIVING",
- "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_succint": "Enter the roundabout and take the 2nd exit.",
- "verbal_before": "Enter the roundabout and take the 2nd exit onto D 30."
- }
- },
- {
- "distance": "198 m",
- "duration": "1 min",
- "polyline": "u}~kH{oiXFWDOLUP[P]j@y@^g@`@i@NUNONMJKJIFELC",
- "start_location": {
- "lat": 49.31563,
- "lng": 4.149905
- },
- "end_location": {
- "lat": 49.314292,
- "lng": 4.151623
- },
- "travel_mode": "DRIVING",
- "instructions": {
- "action": 27,
- "summary": "Exit the roundabout onto D 30.",
- "verbal_succint": "Exit the roundabout.",
- "verbal_before": "Exit the roundabout onto D 30.",
- "verbal_after": "Continue for 200 meters."
- }
- },
- {
- "distance": "46 m",
- "duration": "1 min",
- "polyline": "iu~kHsziXJBJAHGFIDMBSAS",
- "start_location": {
- "lat": 49.314292,
- "lng": 4.151623
- },
- "end_location": {
- "lat": 49.314041,
- "lng": 4.151976
- },
- "travel_mode": "DRIVING",
- "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_succint": "Enter the roundabout and take the 2nd exit.",
- "verbal_before": "Enter the roundabout and take the 2nd exit onto D 30."
- }
- },
- {
- "distance": "96 m",
- "duration": "1 min",
- "polyline": "ws~kHy|iXBKDILURa@LWt@eAHO",
- "start_location": {
- "lat": 49.314041,
- "lng": 4.151976
- },
- "end_location": {
- "lat": 49.313431,
- "lng": 4.152916
- },
- "travel_mode": "DRIVING",
- "instructions": {
- "action": 27,
- "summary": "Exit the roundabout onto D 30.",
- "verbal_succint": "Exit the roundabout. Then, in 100 meters, You will arrive at your destination.",
- "verbal_before": "Exit the roundabout onto D 30. Then, in 100 meters, You will arrive at your destination.",
- "verbal_after": "Continue for 100 meters."
- }
- },
- {
- "distance": "1 m",
- "duration": "1 min",
- "polyline": "}o~kHubjX",
- "start_location": {
- "lat": 49.313431,
- "lng": 4.152916
- },
- "end_location": {
- "lat": 49.313431,
- "lng": 4.152916
- },
- "travel_mode": "DRIVING",
- "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."
- }
- }
- ]
- }
+ "bbox": [
+ 2.294494,
+ 48.85829,
+ 2.294535,
+ 48.858317
],
- "main_route_name": "D 151",
- "recommended": true
+ "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"
}
},
- "Woosmap_Platform_API_Reference_DistanceTollsStep": {
- "title": "DistanceTollsStep",
- "type": "object",
+ "External-api-wrapper_what3words_GeoJsonFeature": {
"properties": {
- "countryCode": {
+ "bbox": {
+ "items": {
+ "type": "number"
+ },
+ "type": "array",
+ "maxItems": 4,
+ "minItems": 4,
+ "title": "Bbox",
+ "description": "Bounding Box"
+ },
+ "geometry": {
+ "additionalProperties": true,
+ "type": "object",
+ "title": "Geometry",
+ "description": "Geometry"
+ },
+ "type": {
"type": "string",
- "description": "Country Code"
+ "title": "Type",
+ "description": "GeoJSON type"
+ },
+ "properties": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_Properties",
+ "description": "Feature Properties"
}
},
- "additionalProperties": true,
- "description": "Detail of tolls to be paid for traversing the specified section. Directly come from Here API",
- "example": {
- "tolls": "some_value"
- }
- },
- "Woosmap_Platform_API_Reference_DistanceTollsSystemStep": {
- "title": "DistanceTollsSystemStep",
"type": "object",
+ "required": [
+ "bbox",
+ "geometry",
+ "type",
+ "properties"
+ ],
+ "title": "GeoJsonFeature"
+ },
+ "External-api-wrapper_what3words_HTTPErrorModel": {
"properties": {
- "id": {
- "type": "integer",
- "description": "Tolls System Id"
- },
- "name": {
+ "details": {
"type": "string",
- "description": "Tolls System Name"
+ "title": "Details"
}
},
- "description": "An array of toll authorities that collect payments for the use of (part of) the specified section of the route. Directly come from Here API",
- "example": {
- "id": 12,
- "name": "ASF"
- }
+ "type": "object",
+ "required": [
+ "details"
+ ],
+ "title": "HTTPErrorModel"
},
- "Woosmap_Platform_API_Reference_DistanceTollsLeg": {
- "title": "DistanceTollsLeg",
+ "External-api-wrapper_what3words_HTTPValidationError": {
+ "properties": {
+ "detail": {
+ "items": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_ValidationError"
+ },
+ "type": "array",
+ "title": "Detail"
+ }
+ },
"type": "object",
- "description": "Leg in a route",
+ "title": "HTTPValidationError"
+ },
+ "External-api-wrapper_what3words_JsonCoordinatesResponse": {
"properties": {
- "distance": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceValue"
- },
- "duration": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DurationValue"
+ "country": {
+ "type": "string",
+ "title": "Country",
+ "description": "Country Code"
},
- "start_location": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LatLngLiteral"
+ "nearestPlace": {
+ "type": "string",
+ "title": "Nearestplace",
+ "description": "Nearest Place"
},
- "end_location": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LatLngLiteral"
+ "words": {
+ "type": "string",
+ "title": "Words",
+ "description": "The what3words address"
},
- "tolls": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceTollsStep"
- }
+ "language": {
+ "type": "string",
+ "title": "Language",
+ "description": "Language Code"
},
- "tollSystems": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceTollsSystemStep"
- }
- }
- },
- "example": {
- "distance": {
- "text": "1 km",
- "value": 1038
+ "locale": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Locale",
+ "description": "Language Locale"
},
- "duration": {
- "text": "1 min",
- "value": 75
+ "map": {
+ "type": "string",
+ "title": "Map",
+ "description": "Link to what3words address on a map"
},
- "start_location": {
- "lat": 49.31067,
- "lng": 4.14525
+ "square": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_Square",
+ "description": "Lat Lng coordinate Square"
},
- "end_location": {
- "lat": 49.31344,
- "lng": 4.15293
+ "coordinates": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_Coordinates",
+ "description": "Lat Lng coordinate"
}
- }
- },
- "Woosmap_Platform_API_Reference_DistanceTollsElementsResponse": {
- "title": "DistanceTollsElementsResponse",
+ },
"type": "object",
- "description": "Attributes describing routes from an origin to a destination returned in distance tolls response.",
"required": [
- "overview_polyline",
- "bounds",
- "legs"
+ "country",
+ "nearestPlace",
+ "words",
+ "language",
+ "map",
+ "square",
+ "coordinates"
],
- "properties": {
- "overview_polyline": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_EncodedPolyline"
- },
- "bounds": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Bounds"
+ "title": "JsonCoordinatesResponse",
+ "example": {
+ "coordinates": {
+ "lat": 48.858304,
+ "lng": 2.294514
},
- "legs": {
- "type": "array",
- "description": "Legs part of the route response",
- "items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceTollsLeg"
+ "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"
}
},
- "Woosmap_Platform_API_Reference_DistanceTollsResponse": {
- "title": "DistanceTollsResponse",
- "type": "object",
- "description": "Attributes describing a distance tolls response.",
+ "External-api-wrapper_what3words_LiteAddressResponse": {
"properties": {
- "status": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceStatus"
- },
- "routes": {
- "description": "Contains an array of routes with tolls informations from origin to destination",
- "type": "array",
+ "results": {
"items": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceTollsElementsResponse"
- }
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_LiteAddressResult"
+ },
+ "type": "array",
+ "title": "Results",
+ "description": "Results"
}
},
+ "type": "object",
+ "required": [
+ "results"
+ ],
+ "title": "LiteAddressResponse",
"example": {
- "status": "OK",
- "routes": [
- {
- "legs": [
- {
- "distance": {
- "value": 272304,
- "text": "272 km"
- },
- "duration": {
- "value": 8834,
- "text": "2 hours 27 mins"
- },
- "start_location": {
- "lat": 43.7037562,
- "lng": 4.1217688
- },
- "end_location": {
- "lat": 45.7196995,
- "lng": 4.848819
- },
- "tolls": [
- {
- "countryCode": "FRA",
- "tollSystemRef": 0,
- "tollSystem": "ASF",
- "tollSystems": [
- 0
- ],
- "fares": [
- {
- "id": "e4626716-1e29-4f9a-905a-19f0376cfb38",
- "name": "ASF",
- "price": {
- "type": "value",
- "currency": "EUR",
- "value": 28.9
- },
- "reason": "toll",
- "paymentMethods": [
- "cash",
- "bankCard",
- "creditCard",
- "transponder",
- "travelCard"
- ],
- "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": [
- {
- "name": "MONTPELLIER (M.EST)",
- "location": {
- "lat": 43.70291,
- "lng": 4.11982
- }
- },
- {
- "name": "VIENNE",
- "location": {
- "lat": 45.4761,
- "lng": 4.83378
- }
- }
- ]
- }
- ],
- "tollSystems": [
- {
- "id": 7607,
- "name": "ASF"
- }
- ]
+ "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=="
}
],
- "bounds": {
- "northeast": {
- "lat": 45.7197,
- "lng": 4.89669
+ "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=="
},
- "southwest": {
- "lat": 43.7022,
- "lng": 4.11696
+ {
+ "description": "Flat 2, Astley House, Alfred Road, London, W2 5EX",
+ "public_id": "N3VCclhUODduWjJxd2NCSUdFclJ6SnRseGxrPV9fN3VCclhUODduWjJxd2NCSUdFclJ6SnRseGxrPQ=="
}
- },
- "overview_polyline": {
- "points": "m{viG_`dXDGLUDU@a@C]GUGMOOOEQCQDMFMPGPGf@@\\H\\HPJHNF\\@N?RFTNNTVh@Rh@Nl@^zBXlAb@|A\\~@\\t@Rx@RhADl@?VCd@EZGTKRUZUL]FM?MCQISOcAaA]WwF{HcDoEgA}AkBoCeCyDuE_IqEkIoEiI_@s@gBiDmCkFkC_FmRw^sB_Ea@w@c@y@sDcHuH{NyDwH}AeD{AoDy@uBmBuFiAuDeA{DiAcFOq@w@eEk@cDs@iFo@}Fo@iI[oGSaHGmFCyEGaXGmHG}DKkEKmDWqG_@qHa@wGi@aHMsAMsAk@mGK}@i@yEKu@_@uCAKWgBU}ASoAUwAWaBgAkGm@iDWoAy@cDaAkDiAeDcAgCeAaCoAcCmAuBaCqDsAcB}@eA_BaBq@m@aCoBgBoAgBeAaAg@iBy@w@[}Bu@sM}D_Cy@gEiBmCuAaBaAwDcCs@i@sBcByAsAiBeBwB_CiBwBqCwDoAiBoCsEgAqBoBgEqAyCmA_DiAcDgAeDc@{Aq@aCu@}CQw@_AwEc@gCy@oFi@{EUgCUyCWsEOkDO{GAkHBsEB_BFoBLiDNsCf@{Hx@qLTsCdI{iAj@}INeEFcGAkDGyCUiFSqCk@cFQqA]uBw@}Dq@mCoAoEa@mAi@wAyAkDm@qAWe@}AmCw@iAgBcCoA{A_C_CwKyJaEkDiL_KsHwGwC_CsE_D_DkBmBcAmEcCeBkAwBcByAqAq@o@}AgB}AoBuAsBk@_AyAmCaAqBuAiDq@sB{@{CeDmL{@sCmB{FuBwF{BaFuAqC{@_BuBmDaBeCqBqCw@cAwAeBgAmA{CyCgD_D_BsAoC_CyG{FyByBuB_CmCaDcByBgCuDoBcDcIsNk@_A_BgCu@eAcByBmB{BaEmE_GiG_DcDwD}DmBmBsAuAcB}AoCcCcA}@s@k@}CcCgDeC{FcEuAeAmAiAmAiAuAyAiAsAe@o@sAoB}@{Au@uAw@_Bq@}AoAgDa@oAiAeEm@sCa@wB]yBUiBi@wEYuCg@{EEe@K_AGk@y@uHYeCGe@}AcMi@qDOaAeBoK{AcIwDiQwC}LqD}NkAaF}@_EuAmGo@sC_ByIWaBq@oD]oB[yBw@cFo@oDi@uDcBiKkB_LSqAw@yEc@_CcAyFo@iDiA{Fm@aDmA_GsDuPGYoCeL_CcJqAwEw@sC_DuKoC}ImCmIgAcDmAiDyDmKaDqIeDiI_@{@Ui@eAkCeEwJuSoe@iFyLmCsGkDwI}FsOSk@kE_MoHoTgDsJSi@]}@gBgEyA_Ds@uA_BsCq@gAaCkD{BqCe@k@cDeDaB{AgA_AyBcBoAy@mBgAsBiAiEyBm@YsB{@aD}As@[eFaC_Bw@gCuA{B{AqCuBwBgByLsKmC_C_EoDgB_B_Ay@qO_NyFkFoAiAyE_E{I_IOMkSsQyDoDi@g@s@s@qCuCyBgCaDcEcCkDuBeDqBmDeC{EsAuCkBsEWq@{@}BgA{CmAqDcLg^wDuLiBaGe@wAuAmEwAsEwAwEgAyDgBgHw@uDq@wDqA{JW_CUaC_@iFc@}JQiH_@}RMeEWuGI}AWuD}@mK[_DeA{Im@qEeAmH}@sFs@cEeAsFkCaM_@cB{B_J_AmDiC_JcAcDuCuIwCcImAcDmCmG}BgFcCiFyCcGwCmFiB_DcDiFsEcHuHgLwC}EwAkCiBwDuBeF{AmEe@yAoAmE_BwG_AsEy@wEc@qCIk@w@iG{@_Ji@kHa@gG}@uOm@qJ_@cH]eGGoAi@qJGaAg@kIqAyUIuAEs@e@wHiAuO_@sEUyBi@_Fk@iEgAcHy@uEs@sDEQwAiGkAsEiA_Eu@cCwDaL{AaEuCmHeEwIkCkFiCuEcBuCkAmBsFoIgNyRiCqDeD_F_A}AkGaLuAcCy@{AcEsH}AsC[k@_Tc`@{@yAyFiKkDiGmCqE}A_CcDsEuBkCuBcC{BcCaAeA}BcCa@c@c@e@s@w@yAaBsD}EgBkC}AgC}C_GgA{BqBiE}AoD}BcF}BaFiA}B{Pg[aD}Fu@oAmIcOmB{CoAcByAeBuCwC_Aw@uAcAeBeAqDsBgFmCoCyAeC{AkCgBy@o@q@g@}AqA_EuDsCuC}CeDmEcF_D{D}CaEuEsGsCkEwDiGwD{G_@o@u@yAmA}BuAgCgBoDcAmBuAqCqBuDy@}A_BuC{CaFoBcDuFqIgK}NuB_DeA_BwBkDaAeBmCeF{AaDaCqF{ByFwBwFyBgGoAcD_C{FyAcD_AqByA_DcDyGaDaHwCaH{BaGsB{FiBuFmA_E}GmUqC{IaD_JoBcFqCuGaAyBmEiJoCmF_ByCcEmHyC_FcEqGkBuC_AsAsAoBm@y@eEwFeBcCqC_EiAeBkCiEm@eAm@gAuBgEkAyB_BiDmAuCyGuPeBiEm@yA]w@aCaFg@eA}AqCgB}CgCaEwCgEeEoFkByBqFcGwHkIsCkDmBgCcCiDeBoCw@mAcDmFyCqFsB}D}AcD_AuBy@wB}@mCq@_C_AcEe@gC[oB_@kCeAiIy@kFkAyFi@qBc@sAkBaFe@eAsAmCmAuBoBwCu@cAwCyDoFmHiBgCgAaBgDmFqBeDgB_DmCeFoB}D}B}E}AoDaA_CeEyKkAcDqBeGoBsGkBsG_E_OiBsGiBuFoAiDk@sAuAyC}AsCeBiCmCqDoAwAqBqBaA{@kCoBkBmAcCqAcAe@cAa@cA[gA[gAWkCe@kAOkCOmAEeA?oCHmAHkCViCZgFh@qBLaBFkBD}@CaAEeAK{@KiASmAYy@Y{Bw@aAc@c@QiCqAmE{BeEiBo@SqCm@cAO{AMw@Iu@C{A?yBD_AF}BVaCh@gAZeCx@cAb@uDzAgC`AeA\\eCp@cARyC`@w@FmADmC@}@CmCQqAQ{@OcAUiCs@oDsA{@]cBq@o@WsAm@iGgC_IcDi@S{@a@kQsH_FcCuBeA_CsAqD_CeCeB}BgB_CmB{BuBMMoBiBe@c@mAyAaBiB_AgAyEgG}KgO{BwCaCwC_@e@qCcDwBaCwA{A_DoCiCqBiBoAyA_A}BoAiAi@aBw@wCiAgCy@QGy@SwCs@}Cm@sB[iH}@cAIkBQ{D[}He@sCMo@?uE?aCDkF^u@HqBXkDn@iAViCn@mAb@y@PqBd@cDr@gC^cBR}ADmBB}BAeBKo@E}@MyAUuA[oBk@yAi@qCkA}DmBgG{CmB_AoBy@q@WgE}AqBm@sCs@{Be@mASiDa@oAIwAE_A?eBFuARiBd@k@RiB~@]Pu@j@]Tk@f@e@f@gAvAgA~Aa@p@wCxFcEbJkCnFq@rAcAjBs@hA{CzE}@fAgAnAyAxAYXo@j@_BrA}BbB}@l@cBbAsHjEkEbCoKjGoBbA}BbAq@XwChAoCjAm@VgHnCgBp@a@NcBf@c@TiGfCqDpAsLtEuJpDuDxAmAh@aBv@q@^yFlDmAz@eAt@qBnAmBpAmBlAmBpAkD|B{HdF{E~CaLpHeDtBmMxI{DhC[TmGdEuc@xYiAv@{FtDeGlEyBdBwD`DgE|DsDpDiBnBqElFqE|FmBlCiCxDqEjHcBvCaCnEIN{ChGaDhHuElLqBjFk@zAgCxGkBrEqArC}BtEq@nAiCbEkBdCmAvAeAfAkAdAgCpBqBjAmAn@gAf@{Bz@kBh@oB`@gAPiCVyCL_B@kC?yIMkCFyADwBNkAL_ANuB`@q@N{@RmA\\aAZoAf@kBx@{BlAsAx@wCrBwAhAmAfAeC`CmAnAaAbAiBrB}AfBcJzKuCfDsD|DuDnD{@r@uAhAwDrCiBnAiBhAoAr@}Ax@}HrDmJdEiDvA}Ap@kDrAyC`AgAXsCj@sATeBNsCPyDFqBEkCMqBOiSuBiBSiHu@mDg@uAYeBa@wBm@sBs@{CsAkBcAmAu@gMgIkTwN_SoMwDgC_C}Aa_@mVez@mj@yIgGsFcEcG_F{FiFyBuBsIqIwNeOm@m@}@_AkHqH{GaHqFqFwBoB{BeBw@k@aC}AeCuA_CgAaDoAaA[gAYkEaAeAOuBYgBOaFUiAEaGOgACw@Ac@Ac@?iEM_Sa@iCCmC@eBFoBHqALwAPeBZwAVwA^iA\\wAf@eBp@aBt@sDfBwJhF{FtCoFjCmD|AmBt@iBp@mDfAsA^cEdAiB\\mEt@{C`@kBR}@JoDZaDPmQnAaEV_OdAyG^oI`@_FRoDJgGRwGLoDDeJHiC@wX?iGCkMBoAByBFuCDiCFsBFa@BiADiHb@mBLsBN{Iz@iD`@mDd@iGbAcF|@qLbC{M|CgKxBoEv@uDl@uEn@gIz@sE`@gk@vEcCPmDXmD\\i`@`DcCT{Jv@oFd@gIl@gHf@_CNqJf@qELgB@yDD_HEaBCwDKwBKsBGsAKcEYkBQmBQgCYaH_AiEs@kAUk@Ki@Ke@I]ImCi@mEiAaHmBaEoAyHsC_DqAuDaBkAk@{F{CcHeEm@[oBoAyAeAsB{AyHoG}AuA_CuBeIcIiHeIkC{CcBuBk@q@yBiCmBuBqBsBsBsBgD}CgDoCyAiAaBkAgAw@mD{BoBiAeEwB}As@cCcAeE{AiCy@yC{@mCo@mE{@y@UcF_A_F_AkN{CuD{@oGgBcAY_AYUGqDiAwE_BeA]aBk@eEcBeBs@sEoBsDaBkFmCk@[gIkE{SuLqDmByCyAqCoAyEgBuFiB}Bk@mBe@{E_AuB[iEi@aCSaDSqEQwAEwCC}CCoIIeHIsJMoDGaLI{FIuDGaCEkX[mACuHW_Fa@iBSaEk@kASiDq@kAW_EkAiCy@aC{@w@YyAm@yCsAqBcAeFsCwDeC{AeAiFgE}AsAyAuAqCqC}@_Ao@u@oAwAsD{Ek@s@_@k@_AsAyBgDwC_Fs@kAwFiKaIsOgBeDmD_HwB{D}CqFaBmCiCaEyAyBcGeIaCyC{AgBeCqC_DgDeCeC{GiGwFsEqDkCmCkB_DqB_JiFo@]gFeCcCeA_CaAq@YqAg@_C_AsB{@cRyGkPqFu@UoImCQGoBm@uHyBkA]cMiDgHeBqEw@iCc@aEe@cDW{AIgEM_DGeD?wEFmCDgGTeFVwE\\sALwLlAuG|@_BVcKhByE`AsFrAyCt@eGdB{IpCe[rKgQhGWHq@VcLzDuE`B]Jg@PuAh@kAb@mHtC_Ab@aEbBiKvEsAp@sCtAeItDcEfB{DzAiDnAuBr@yDjA{Bl@{EhAeCn@aCd@qIxAsBZqBVsDb@aGj@oDXqDVmGZeFPwDHcEDmIBcHAoNCa@?uMCgQLaNRkJTsJZ_Md@yOx@mIXiCH_@?c@@oGBaCAkEIcFQsE[kHs@_@CwB[iC]{E{@oFiASESC{Bi@iEgAcJsBmGsAkFeAkDm@kEq@yGy@uCYsFc@uCWaJg@s@AsG[iE]q@EYA{@?wC?mCM_S{@s@CcGO}BMcBIkDMgEKmBC}B?yCDgAD_EVeBPkBVqB\\uDv@iCr@_Cv@mBr@gBt@mAj@yAt@cAj@{CfBsSdN}D~BiGfDsEtBwB|@}Aj@wFjBu@VeCr@}Bh@gCj@yDv@oEv@aJxAqHpA_MtBy@LkC\\uGx@kFh@cAHwF\\oDPqHLuDB{GGeEIgGWw@GwCOoSwA{Jw@yDa@gDi@y@MkCm@{Aa@qA[aCu@cEoAeF}AuAc@qFsAmEy@{B]aAKeCUyAKcEOoDC}B?aCFy@D_Kl@gBNmIf@sCJcEFcA?mFIoDQsAKcCWeC]sB[kBa@_B_@{Cw@sBo@qBq@}B_AsF_C_Bo@aGoCw@]qFeCkAg@yBaAeAc@u@[cNkGqAm@eCiAy@[kGqC_DuAm@[gJmEkDgB{CaBq@_@kBeAUMwBsAgFiDoA}@wDuCqF{EoBoBgAiA{@aAmCaD{CeEeBiCgEkH_B_Dy@gBwCeHuAyDQg@cAaDgBiGkB_IyAuHmAgH_Fc\\sA}HcAiF}@{DgA_E]kAaBiFa@kA_AcCu@iBs@_BaAwBkA_CeB_DoAwBoAmBmBmC_CwCY]]a@yB_C_B}AmFwEsD{CiUwQoQ{NuMmKcNsKaGiEoFmDcF{CuDqBqCuAkAi@o@[_EeBsAi@iE}A_IiC}MgE{FcBsEoAwBi@cBc@eDs@gEy@cCe@uQuCoFw@_m@iJs]gFkC]oWqDwFw@qC_@gd@gGgGw@yGw@uEc@iCSeDQeBGaCG{CEkA?{FFkDJwDRYBkE\\eBPg@FcH|@_QfCuDd@cEb@g@BsCRcDL}BB}E?yDKaCK}@G_CScCWuCa@qF_AsCm@YKUGiF{Ae@OsFiBgIuCg@Q{h@aRoE}AmG{ByCcA_A[s@Ww@Y_Cw@cA]mC_AiDaAyAc@oKoCsDo@mB]{AUkDe@qB[aBWmC[oB[wAU{B]oIoAeC]gBUwAQcAK}@KyCWuEUgCKgEEmBBcGHwDL{G^}CLoCHsA?aCCgAE}C[oASwB_@iAWkA[gC{@uAi@u@[yBkAcBeAeCaByBcBiCsBiByAi@_@iG}E]YcIkGcBoAo@i@mDgDs@y@wE_Gm@o@cB}Aw@o@w@k@yEiCeBq@iA]cAWaAQuC[cI]gFUaFYuBWgASwFoAsBa@}@MaAIgACy@?aBHsAL}@Lc@LeBf@aA`@]RcDjBsAn@cBl@wBj@q@LuAP{O~AcAH_BRmBPaBViB\\}LrCkBd@mBh@s@RyAh@aA`@oB|@eBz@wBlAi@TmAd@gAZuAXgAL{AHqB@oCQ_AIiAUkDu@sEaAuA[oAU_B[s@MkB]y@KeAImACu@Ci@?g@@yADeBNaC^qBd@YHoAf@q@Tu@\\yB|@qIlD_DlAsBr@QD[H}@XeB^uB`@aBT_CX_BN_AFuAFaCDeIFqGLaBL_CZoAPyBd@k@LiAZcBf@uBx@mB|@{PlJwDjBuD`Bs@VcA`@}Ah@yEvAyDz@iB\\w@LkDh@eAPsCV{CTqBJo@BaGJyDAmR]iJQoEIsIMgC?uA@kELcBJg@BaY~AyAFmFXmCL}BFsCFmEBuC?o@A{CCiAEoHWkIo@{Eg@yEk@mGeAuN}CuGyAwDs@wB]iAOyEg@uF[mEKuCAiA@mFL{CLoBJeDTkY|AsWzAa@BiBL{BR_D`@uDp@wCn@sDbA{DrAqDzA_ErB}@d@iAn@aCzAyAbAsAbAcDrC}ApAsDhD{@z@{@t@[RiAx@mAr@o@Z]Pq@^y@X{@XiDr@cCV_DLuEM_Dc@iBc@qA_@_A_@]O{Aw@m@]w@g@wB_ByAuAuA{AcBuBqGwI}@oAgD{Dk@m@gDyCoAeAkBsAkAs@{@i@kAo@mAm@{B_AqBq@cBk@yAa@wA[{AWgBUeEa@cCOeCIcCBeBJkD^oARcK`C_BPmANyALyABsBAgBG}AKsDg@qDcAoDuAiDkBwEgDqB{AeL}IgHuFwJsHsJuHyAsAiBgBiAmAqCcDiC_DuCuDiDgEgBuBiAmAsAoAgCyBoCkBeC}AQKSKiDwA{B{@{Cw@wB]_Ca@yE[kBE_DBsEZeFr@sq@rOaOhDyDdA}Af@yAh@_C`AaBv@wEdC_HzDkB|@{B|@kBl@_AVmAXyB`@aCZkAJcBHiCDsB?sCCo@C_BAcDIgLYiHMk@AiGO{BGmBCk@CoFMO?Y?a^s@iJWaEG}BAeE@}AD{BLiBPgCZwAToAVyCv@}Br@yBx@oBx@mB~@{@f@yAz@uDfCiBzA[XUR}ArA}ApAmAbA_BhAsBpAu@^cBv@uAd@mAZsCd@wAPwCd@qAV_AViA^}An@}Av@cAl@sBxAuAjAyEjEgF|EuBdBeAv@y@h@w@d@}Ar@eA^]Lo@Rm@PwAZ{@LsBPoBHwA@yBK_AGu@MgB[mBe@wBs@y@[}Ae@uBi@}AYkBUeCKgBBu@@aBJqBVkAT_Bb@y@Xm@RyBbAiAn@aAn@sAbA{BtBy@~@q@z@qAhBe@r@W`@qAdCm@tAaAbCs@xBaAjDi@dCiA~Es@lC]tAg@xA_BzDe@`As@tAo@dA}AxBk@r@iBnBw@r@w@p@mBrA}BpAgAd@aA^w@VkBh@_Cp@yN~D}CdA_C|@uBz@aDxAgCrAqDtBoAv@eBjAa@VqCrBeCtBmAlA_BfBqA`BwBtCsDbFwAhBgAjAcAdAyArA_Av@kBvAo@b@yCdB}BhAsCnA}VjKeBv@uAr@g@ZQH}AbA_Ar@u@l@u@r@aBjBmA|A_AtAw@pAmA~B_AnBsCnFsAxBcAzA{@fAmCtCkBbBkA`ASLyAdAe@XuCzAoBx@eCx@sCp@}@RiCZeBLkCDwCEqBKcBMcZiCcIs@cCQkCMuAEiCCiA@oDL}DXyDj@qCj@qBh@sC|@wChAk@ViB~@gBbAaB`AgAr@eBrAk@^oB|AwE`EuBjBqAhA{BnBqC~BoNzLwEdEkGjF{F`FiA~@eAr@_@VeAn@q@\\mBx@qBn@iBb@s@LiBRy@FsBF{BEgCSmBYaCi@oBc@kPiEoE_A}@MwAK}@Cs@Cg@?cCFmBNgBVwBd@gBh@iBt@i@VmAp@{AbAmA~@{AxAyA|Aq@x@iA|AsB`D_FlHoBxCmCxD{AjBiApAmDfDy@r@qCpBmAv@sAt@ULsB`AqAd@}Ah@eAZ{A^aBZ_CZ_DXsAFc@?oB?eCE_IYeACoLe@oO]oACyB@qD?aFFcJH}@B_IZS@iCNkEVwJx@{Db@wKtAuHlA_[tFyB^iJdBmJbBk`@bHmB`@]Hk@JgFbA{J|AcCZkAJeAJcEN{C@kBCkCKqAIcCSoBWmRwBqDe@_Eo@qFkAaB]oMsCcGkAaBQkACgBDg@FsARuA\\aBl@}Az@kA|@g@f@oErEsAjAc@ZgAp@cBv@{@V_APaALmAHaA?aAGyAKy@McC]oBW_Fs@sAOwG{@qBQiBIgBIqAAsAAmA@aBDsFXqABgCAcDMoBO_AKyB[aBYyA[aBe@_EkA}@[yB_A}@a@qCwAwBsAqA{@cBmA{AmAo@i@yBuBwZgYuDiDyBqBiG{F_EwDwCoCkEaEaA{@gAgA_A}@sCmCg@e@_FsEaQ_PSQmAcA{CsBk@c@qAo@kAi@cAc@{@[s@UyBm@wBa@{AS_CSiAGoC?kA@u@BuBLiBToB\\aCj@mA`@kBt@mAh@_A`@c@Tk@V_@PmAh@oLfFq@VaDdAkCn@wB`@{C`@wBL}@BiBDgA?iAGqDY_BQoASqEy@eEaAeIcBwIkBgLeCqQsDgCm@_B[oGsA{D}@aCe@aDs@mLcCgDs@kNyCcHwA{GyAiE_AcEy@qCe@qFw@_Ee@}AOuKu@w@EiGU{BIoDA{BAq@@iCB{@BmCH{BF_@@_@@qDKeCMcAKo@KkBa@aAMs@Ko@Ai@Ck@BmALwCf@_AL}APc@@W?oFE_BIaAIs@MyA]iA[qFeBi@QsA]uAYmAMk@Ck@?iADe@DgAPc@JkA`@oAl@mGbDeBx@wAj@g@Pg@He@FkAHkA@qAIgAQeAYe@QcAe@iAs@a@[iAcAiAoAkAyAeFiHq@_AqC{Du@cAy@}@u@s@s@i@k@[eAa@cA[]Im@K[EmAMeAC}ABkBFgERwDHq@BoBDu@AoBKiB]_CeASKm@a@m@e@k@k@oA}Ae@q@]m@c@}@q@}ASi@[_AcAuCg@qAs@}Ak@eAw@oAg@o@}@cAkAkAgAaA_D_DqDcDwAwAu@cA]i@g@_Ac@}@{@wBqAaEoB}G]uA_EaN}@cCy@kBg@_Ai@{@kA{Ak@m@o@q@e@a@_BgA{@c@s@]s@Uy@W}AYuAKgHYoBQeAO_@KyAa@q@UaNkFyBu@eBc@m@M}AY}AOm@EeCCyA@_AF}ANaC`@}A`@qAd@aCdAeBbA{B~AuBbBoBdBuC|BoBnAeB`AaC`AuG|BoC`A{HhCaEvAc@TUJi@Xk@^a@Zu@r@w@`Ak@|@mAbCi@|Aa@~AQx@WfBIz@K|AIbC@tBPpFRjFBrA?fBE|AGdAMrAc@bDc@`Cg@~BqAfFs@hC{@lCu@rBy@zBoA~CKXKR}AtDa@x@qB`E}@bBGHeAjBiBzCiDdF{FzHcEfFoEdFyB`CkClCkDjDsElEuEfEyKtJa@Z{AlA{AlAoDrCyFhEyEfDqCfBqBjAuBdAkE`BkCfAeDdBgBhAm@b@wBbBo@j@yCxCuA|Ao@v@_@d@yAtBm@`Am@bAkAxBaApB{ApDi@tAiA`DeAtCu@fBiAxB_A|Ak@z@}BzCuBrBiA~@kAz@iAr@cAh@qAn@sDjBeHjDsHbDoDxAsEhBa@Rq@Tw@Ze@RwFnBgA`@sDnA}EzAwCr@cFpAqE`AoB^g@JgBVkEp@iEj@{AP_Ed@mAJoCPmCPkCLeC@cBIyBS{@Qy@Q}@WaBo@e@UoAs@_@WkByAwAsA_CcCmC_D{AoB{AuBiHmKyEgGqDiEwCaDcCcCeE{D{DcDeCiBsDeCkBiA_FuCsGmDwGcDeEqBuCoAyFyB}JuD_UmIiEeB_Aa@kIuDgB{@mHuDiBcAs@_@qAw@cEcCkAs@kFqD}CyB{DaDi@c@s@m@WUaCqB}AuAq@o@iBgBmDmDyPaR_EeEw@w@qCwCoJcJiC}BkJgIyGsFiF{DgDaCoCgBaBaAaFgCgEkBeCeAgGuBwHuBsF}AiIiCyK{DeHsCgVmKkBs@mA_@eAWyBi@{Bc@gDi@_AKo@CWEkESi@AmBC{ABu@@}AFcEVs@FwKt@kHf@{BPuE\\c@FmAJy@Js@HqBV_Fr@o@J{PfCcBXu@LQBwAHo@J_AZ_A^g@RoAd@oAZoB`@eANcAHmADkAAsAMq@Mm@Qa@MqE{AcA]q@MuB[eAIqBIyA?_CJuBVmAT[DcAVcAZkG|BeCp@}AVcAH_@DsAFeK`@aHXiCHu@DwDToAHi@DaGRsCDiABoA?WAqAAe@?]KQGQKQOQUUk@I_@MiAKeBIsBKmEOmDE_AKwBUsFEs@MuCMoCSuD@W@sA?cAB]PaAKuBS]OYSQ[MOUc@c@]@_@Fa@V}@L}@HkBLS?gAFFxFLnL@rAB`C@n@BhA?RAl@yA`@QD"
- }
+ ],
+ "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"
+ ]
}
]
}
},
- "Woosmap_Platform_API_Reference_DistanceIsochroneResponse": {
- "title": "DistanceIsochroneResponse",
- "type": "object",
- "description": "Attributes describing a distance isochrone response.",
+ "External-api-wrapper_what3words_LiteAddressResult": {
"properties": {
- "status": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_DistanceStatus"
+ "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"
},
- "isoline": {
- "description": "Contains the properties of isoline",
- "type": "object",
- "properties": {
- "origin": {
- "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LatLngLiteral"
- },
- "time": {
- "description": "The time of the isochrone (returned as default or when specifying `method=time` in parameters)",
- "type": "object",
- "properties": {
- "value": {
- "description": "The time in minutes",
- "type": "number",
- "example": 30
- },
- "text": {
- "description": "The readable time in minutes",
- "type": "string",
- "example": "30 minutes"
- }
- }
+ "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"
},
- "distance": {
- "description": "The distance of the isochrone (returned only if `method=distance` in parameters)",
- "type": "object",
- "properties": {
- "value": {
- "description": "The distance in kilometers",
- "type": "number",
- "example": 10
- },
- "text": {
- "description": "The readable distance in kilometers",
- "type": "string",
- "example": "10 km"
- }
- }
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Status",
+ "description": "Address Status"
+ },
+ "sub_buildings": {
+ "anyOf": [
+ {
+ "items": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_AddressSummary"
+ },
+ "type": "array"
},
- "geometry": {
- "type": "string",
- "description": "The polyline of the isoline (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm)).",
- "example": "a_jyHfol@aAfEzGlIfER~JqV_KqLu@pDiHv@bAfEeCfE"
+ {
+ "type": "null"
}
- }
+ ],
+ "title": "Sub Buildings",
+ "description": "list of specific addresses at that location"
}
},
- "example": {
- "status": "OK",
- "isoline": {
- "origin": {
- "lat": 48.709,
- "lng": 2.403
- },
- "distance": {
- "value": 1,
- "text": "1 km"
- },
- "geometry": "s|ihHouuMZ`GdClCsA~QhCnQmBhEpCfF|HxGpBtFfEnBnHqJpH}ADaEcCaB@sBnEiEYiGmVyFaG{G[eFoCw@gAiIkDYg@_DwA@"
- }
- }
+ "type": "object",
+ "required": [
+ "types",
+ "formatted_address",
+ "public_id"
+ ],
+ "title": "LiteAddressResult"
},
- "Maps_AuthenticationErrorResponse": {
+ "External-api-wrapper_what3words_Properties": {
"properties": {
- "detail": {
+ "country": {
"type": "string",
- "title": "Detail"
+ "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": "null"
+ }
+ ],
+ "title": "Locale",
+ "description": "Language Locale"
+ },
+ "map": {
+ "type": "string",
+ "title": "Map",
+ "description": "Link to what3words address on a map"
}
},
"type": "object",
"required": [
- "detail"
+ "country",
+ "nearestPlace",
+ "words",
+ "language",
+ "map"
],
- "title": "AuthenticationErrorResponse",
- "description": "AuthenticationErrorResponse is the base authentication error model."
+ "title": "Properties"
},
- "Maps_HTTPErrorModel": {
+ "External-api-wrapper_what3words_Square": {
"properties": {
- "details": {
- "type": "string",
- "title": "Details"
+ "southwest": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_Coordinates",
+ "description": "Lat Lng coordinate"
+ },
+ "northeast": {
+ "$ref": "#/components/schemas/External-api-wrapper_what3words_Coordinates",
+ "description": "Lat Lng coordinate"
}
},
"type": "object",
"required": [
- "details"
+ "southwest",
+ "northeast"
],
- "title": "HTTPErrorModel"
+ "title": "Square"
},
- "Maps_HTTPValidationError": {
+ "External-api-wrapper_what3words_ValidationError": {
"properties": {
- "detail": {
+ "loc": {
"items": {
- "$ref": "#/components/schemas/Maps_ValidationError"
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ }
+ ]
},
"type": "array",
- "title": "Detail"
- }
- },
- "type": "object",
- "title": "HTTPValidationError"
- },
- "Maps_MapStyle": {
- "properties": {
- "featureType": {
- "type": "string",
- "title": "Featuretype"
+ "title": "Location"
},
- "elementType": {
+ "msg": {
"type": "string",
- "title": "Elementtype",
- "default": "all"
+ "title": "Message"
},
- "stylers": {
- "items": {
- "$ref": "#/components/schemas/Maps_MapStyler"
- },
- "type": "array",
- "title": "Stylers"
+ "type": {
+ "type": "string",
+ "title": "Error Type"
+ }
+ },
+ "type": "object",
+ "required": [
+ "loc",
+ "msg",
+ "type"
+ ],
+ "title": "ValidationError"
+ },
+ "Indoor_API_ErrorResponseSchema": {
+ "properties": {
+ "detail": {
+ "title": "Detail",
+ "type": "string"
}
},
- "type": "object",
"required": [
- "featureType",
- "stylers"
+ "detail"
],
- "title": "MapStyle"
+ "title": "ErrorResponseSchema",
+ "type": "object"
},
- "Maps_MapStyler": {
+ "Indoor_API_Building": {
"properties": {
- "visibility": {
+ "ref": {
+ "description": "Reference to identify Building",
+ "title": "Ref",
+ "type": "string"
+ },
+ "name": {
"anyOf": [
{
- "type": "string",
- "enum": [
- "on",
- "off"
- ]
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Visibility"
+ "description": "Name of the Building",
+ "title": "Name"
},
- "color": {
+ "localized_name": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "default": {},
+ "description": "Translated names of the Building",
+ "title": "Localized Name",
+ "type": "object"
+ },
+ "description": {
"anyOf": [
{
"type": "string"
@@ -16752,9 +16606,10 @@
"type": "null"
}
],
- "title": "Color"
+ "description": "Building Description",
+ "title": "Description"
},
- "hue": {
+ "opening_hours": {
"anyOf": [
{
"type": "string"
@@ -16763,989 +16618,1075 @@
"type": "null"
}
],
- "title": "Hue"
+ "description": "Building Opening Hours",
+ "title": "Opening Hours"
},
- "saturation": {
+ "logo": {
"anyOf": [
{
- "type": "number"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Saturation"
+ "description": "",
+ "title": "Logo"
},
- "gamma": {
+ "cover": {
"anyOf": [
{
- "type": "number"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Gamma"
+ "description": "",
+ "title": "Cover"
},
- "lightness": {
+ "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"
}
],
- "title": "Lightness"
- }
- },
- "type": "object",
- "title": "MapStyler"
- },
- "Maps_MarkerWithUrlOptions": {
- "properties": {
- "lat": {
- "type": "number",
- "title": "Lat"
- },
- "lng": {
- "type": "number",
- "title": "Lng"
+ "description": "Name of the floor level",
+ "title": "Name"
},
- "url": {
+ "ref": {
"anyOf": [
{
- "type": "string",
- "maxLength": 2083,
- "minLength": 1,
- "format": "uri"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Url"
+ "description": "Reference to identify floor level",
+ "title": "Ref"
+ },
+ "bbox": {
+ "description": "Bounding Box of floor level",
+ "items": {
+ "type": "number"
+ },
+ "title": "Bbox",
+ "type": "array"
}
},
- "type": "object",
"required": [
- "lat",
- "lng"
+ "level",
+ "bbox"
],
- "title": "MarkerWithUrlOptions",
- "example": {
- "lat": 43.6,
- "lng": 3.883,
- "url": "https://webapp.woosmap.com/img/geolocated_marker.png?retina=yes"
- }
+ "title": "Level",
+ "type": "object"
},
- "Maps_PolygonOptions": {
+ "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"
+ },
"properties": {
- "shape": {
- "type": "string",
- "title": "Shape"
- },
- "color": {
- "type": "string",
- "title": "Color",
- "default": "rgb(65, 176, 246)"
+ "venue_id": {
+ "description": "ID of the Venue",
+ "title": "Venue Id",
+ "type": "string"
},
- "fill_color": {
- "type": "string",
- "title": "Fill Color",
- "default": "rgba(65, 176, 246, 0.5)"
+ "name": {
+ "description": "Name of the Venue",
+ "title": "Name",
+ "type": "string"
},
- "weight": {
- "type": "number",
- "title": "Weight",
- "default": 1
- }
- },
- "type": "object",
- "required": [
- "shape"
- ],
- "title": "PolygonOptions",
- "example": {
- "color": "rgba(199, 21, 133, 0.7)",
- "fill_color": "rgba(255, 20, 147, 0.5)",
- "shape": "ymgiGm|rV~uAtaB|dAefCqeBwuFu~@njC??"
- }
- },
- "Maps_PolylineOptions": {
- "properties": {
- "enc": {
- "type": "string",
- "title": "Enc"
+ "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"
},
- "color": {
- "type": "string",
- "title": "Color",
- "default": "rgb(65, 176, 246)"
+ "levels": {
+ "default": [],
+ "description": "Information on each level of the venue",
+ "items": {
+ "$ref": "#/components/schemas/Indoor_API_Level"
+ },
+ "title": "Levels",
+ "type": "array"
},
- "weight": {
- "type": "number",
- "title": "Weight",
- "default": 1
- }
- },
- "type": "object",
- "required": [
- "enc"
- ],
- "title": "PolylineOptions",
- "example": {
- "color": "magenta",
- "enc": "ydjiG_}jVjn@cjAf`AycBnc@mqCp\\ewBrQmlBzrAeuCreBw_C",
- "weight": 4
- }
- },
- "Maps_ValidationError": {
- "properties": {
- "loc": {
+ "routing_profiles": {
+ "default": [],
+ "description": "Available routing profiles for the venue",
"items": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "integer"
- }
- ]
+ "type": "string"
},
- "type": "array",
- "title": "Location"
+ "title": "Routing Profiles",
+ "type": "array"
},
- "msg": {
- "type": "string",
- "title": "Message"
+ "categories": {
+ "default": [],
+ "description": "",
+ "items": {
+ "type": "string"
+ },
+ "title": "Categories",
+ "type": "array"
},
- "type": {
- "type": "string",
- "title": "Error Type"
- }
- },
- "type": "object",
- "required": [
- "loc",
- "msg",
- "type"
- ],
- "title": "ValidationError"
- },
- "External-api-wrapper_what3words_AddressSummary": {
- "properties": {
- "public_id": {
- "type": "string",
- "title": "Public Id",
- "description": "Public ID of address listed as sub_building"
+ "buildings": {
+ "default": [],
+ "description": "Buildings present at the venue",
+ "items": {
+ "$ref": "#/components/schemas/Indoor_API_Building"
+ },
+ "title": "Buildings",
+ "type": "array"
},
- "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": {
+ "languages": {
+ "description": "Language translations available for the venue",
"items": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_AutoSuggestions"
+ "type": "string"
},
- "type": "array",
- "title": "Suggestions"
+ "title": "Languages",
+ "type": "array"
+ },
+ "updated_at": {
+ "description": "When this venue was last updated",
+ "format": "date-time",
+ "title": "Updated At",
+ "type": "string"
}
},
- "type": "object",
"required": [
- "suggestions"
+ "venue_id",
+ "name",
+ "bbox",
+ "languages",
+ "updated_at"
],
- "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"
- }
- ]
- }
+ "title": "VenueSchema",
+ "type": "object"
},
- "External-api-wrapper_what3words_AutoSuggestions": {
- "properties": {
- "country": {
- "type": "string",
- "title": "Country",
- "description": "Country Code"
+ "Indoor_API_VenueListSchema": {
+ "example": [
+ {
+ "bbox": [
+ -0.1258015,
+ 51.4981306,
+ -0.1236527,
+ 51.5008191
+ ],
+ "name": "Westminster palace",
+ "venue_id": "west_pal"
},
- "nearestPlace": {
- "type": "string",
- "title": "Nearestplace",
- "description": "Nearest Place"
+ {
+ "bbox": [
+ 3.9215275,
+ 43.6062712,
+ 3.922097,
+ 43.606972
+ ],
+ "name": "Woosmap HQ",
+ "venue_id": "woosmap_wgs_office"
},
- "words": {
- "type": "string",
- "title": "Words",
- "description": "The what3words address"
+ {
+ "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"
},
- "distanceToFocusKm": {
+ "name": {
+ "description": "Name of the Venue",
+ "title": "Name",
+ "type": "string"
+ },
+ "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)"
- },
- "rank": {
- "type": "integer",
- "title": "Rank",
- "description": "Suggestion Rank"
- },
- "language": {
- "type": "string",
- "title": "Language",
- "description": "Language Code"
+ "description": "Bounding Box of Venue",
+ "title": "Bbox"
}
},
- "type": "object",
"required": [
- "country",
- "nearestPlace",
- "words",
- "rank",
- "language"
+ "venue_id",
+ "name",
+ "bbox"
],
- "title": "AutoSuggestions"
+ "title": "VenueListSchema",
+ "type": "object"
},
- "External-api-wrapper_what3words_Coordinates": {
+ "Indoor_API_Distance": {
"properties": {
- "lng": {
- "type": "number",
- "title": "Lng",
- "description": "Longitude"
+ "value": {
+ "description": "Distance in metres",
+ "title": "Value",
+ "type": "number"
},
- "lat": {
- "type": "number",
- "title": "Lat",
- "description": "Latitude"
+ "text": {
+ "description": "Distance as text based response with unit type",
+ "title": "Text",
+ "type": "string"
}
},
- "type": "object",
"required": [
- "lng",
- "lat"
+ "value",
+ "text"
],
- "title": "Coordinates"
+ "title": "Distance",
+ "type": "object"
},
- "External-api-wrapper_what3words_GeoJsonCoordinatesResponse": {
+ "Indoor_API_DistanceMatrixCollection": {
+ "example": {
+ "rows": [],
+ "status": "OK"
+ },
"properties": {
- "features": {
+ "status": {
+ "description": "A string to indicate the success of the request",
+ "title": "Status",
+ "type": "string"
+ },
+ "rows": {
"items": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_GeoJsonFeature"
+ "$ref": "#/components/schemas/Indoor_API_DistanceMatrixRow"
},
- "type": "array",
- "title": "Features",
- "description": "GeoJSON Features"
+ "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"
},
- "type": {
- "type": "string",
- "title": "Type",
- "description": "GeoJSON Type"
+ "duration": {
+ "$ref": "#/components/schemas/Indoor_API_Duration"
+ },
+ "distance": {
+ "$ref": "#/components/schemas/Indoor_API_Distance"
}
},
- "type": "object",
"required": [
- "features",
- "type"
+ "status",
+ "duration",
+ "distance"
],
- "title": "GeoJsonCoordinatesResponse",
- "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"
- }
+ "title": "DistanceMatrixElement",
+ "type": "object"
},
- "External-api-wrapper_what3words_GeoJsonFeature": {
+ "Indoor_API_DistanceMatrixRow": {
"properties": {
- "bbox": {
+ "elements": {
"items": {
- "type": "number"
+ "$ref": "#/components/schemas/Indoor_API_DistanceMatrixElement"
},
- "type": "array",
- "maxItems": 4,
- "minItems": 4,
- "title": "Bbox",
- "description": "Bounding Box"
- },
- "geometry": {
- "additionalProperties": true,
- "type": "object",
- "title": "Geometry",
- "description": "Geometry"
+ "title": "Elements",
+ "type": "array"
+ }
+ },
+ "required": [
+ "elements"
+ ],
+ "title": "DistanceMatrixRow",
+ "type": "object"
+ },
+ "Indoor_API_Duration": {
+ "properties": {
+ "value": {
+ "description": "Duration in seconds",
+ "title": "Value",
+ "type": "number"
},
- "type": {
- "type": "string",
- "title": "Type",
- "description": "GeoJSON type"
+ "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"
},
- "properties": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_Properties",
- "description": "Feature Properties"
+ "instruction_type": {
+ "title": "Instruction Type",
+ "type": "string"
}
},
- "type": "object",
"required": [
- "bbox",
- "geometry",
- "type",
- "properties"
+ "summary",
+ "instruction_type"
],
- "title": "GeoJsonFeature"
+ "title": "Instruction",
+ "type": "object"
},
- "External-api-wrapper_what3words_HTTPErrorModel": {
+ "Indoor_API_LatLngLevel": {
"properties": {
- "details": {
- "type": "string",
- "title": "Details"
+ "lat": {
+ "title": "Lat",
+ "type": "number"
+ },
+ "lng": {
+ "title": "Lng",
+ "type": "number"
+ },
+ "level": {
+ "title": "Level",
+ "type": "integer"
}
},
- "type": "object",
"required": [
- "details"
+ "lat",
+ "lng",
+ "level"
],
- "title": "HTTPErrorModel"
+ "title": "LatLngLevel",
+ "type": "object"
},
- "External-api-wrapper_what3words_HTTPValidationError": {
+ "Indoor_API_Leg": {
"properties": {
- "detail": {
+ "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/External-api-wrapper_what3words_ValidationError"
+ "$ref": "#/components/schemas/Indoor_API_Step"
},
- "type": "array",
- "title": "Detail"
+ "title": "Steps",
+ "type": "array"
}
},
- "type": "object",
- "title": "HTTPValidationError"
+ "required": [
+ "distance",
+ "duration",
+ "start_location",
+ "end_location",
+ "steps"
+ ],
+ "title": "Leg",
+ "type": "object"
},
- "External-api-wrapper_what3words_JsonCoordinatesResponse": {
+ "Indoor_API_Route": {
"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": [
+ "bounds": {
+ "description": "Bounding box of the route",
+ "maxItems": 4,
+ "minItems": 4,
+ "prefixItems": [
{
- "type": "string"
+ "type": "number"
},
{
- "type": "null"
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
}
],
- "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
- }
+ "title": "Bounds",
+ "type": "array"
},
- "words": "couch.spotted.amended"
- }
- },
- "External-api-wrapper_what3words_LiteAddressResponse": {
- "properties": {
- "results": {
+ "legs": {
+ "description": "List of different legs of the journey",
"items": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_LiteAddressResult"
+ "$ref": "#/components/schemas/Indoor_API_Leg"
},
- "type": "array",
- "title": "Results",
- "description": "Results"
+ "title": "Legs",
+ "type": "array"
}
},
- "type": "object",
"required": [
- "results"
+ "bounds",
+ "legs"
],
- "title": "LiteAddressResponse",
+ "title": "Route",
+ "type": "object"
+ },
+ "Indoor_API_RouteCollection": {
"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"
- ]
- },
+ "routes": [
{
- "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=="
- }
+ "bounds": [
+ -0.12493997331,
+ 51.498230882255,
+ -0.12456220772511746,
+ 51.49992534993494
],
- "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=="
- },
+ "legs": [
{
- "description": "Carnot Ltd, 65 Alfred Road, London, W2 5EU",
- "public_id": "MUVBZWttTlo4OUYxL2dQWmJteDdFV2VidmVvPV9fRDRPb0VLd0UvNEZYMlpLR21EMC9xRGQvMUZJPQ=="
+ "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
+ }
+ }
+ ]
}
- ],
- "types": [
- "address"
]
}
- ]
- }
- },
- "External-api-wrapper_what3words_LiteAddressResult": {
+ ],
+ "status": "ok"
+ },
"properties": {
- "types": {
+ "status": {
+ "const": "ok",
+ "default": "ok",
+ "title": "Status",
+ "type": "string"
+ },
+ "routes": {
"items": {
- "type": "string",
- "enum": [
- "address",
- "route",
- "named_place",
- "locality",
- "city",
- "town",
- "village",
- "hamlet",
- "borough",
- "suburb",
- "quarter",
- "neighbourhood",
- "postal_code",
- "admin_level"
- ]
+ "$ref": "#/components/schemas/Indoor_API_Route"
},
- "type": "array",
- "title": "Types",
- "description": "Address Types"
- },
- "formatted_address": {
- "type": "string",
- "title": "Formatted Address",
- "description": "Human readable address"
+ "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"
},
- "public_id": {
- "type": "string",
- "title": "Public Id",
- "description": "Public ID of the POI"
+ "duration": {
+ "$ref": "#/components/schemas/Indoor_API_Duration",
+ "description": "Duration of this Step"
},
- "status": {
+ "poi_id": {
"anyOf": [
{
- "type": "string",
- "const": "not_yet_built"
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Status",
- "description": "Address Status"
+ "description": "If a POI exists, its ID is given.",
+ "title": "Poi Id"
},
- "sub_buildings": {
- "anyOf": [
- {
- "items": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_AddressSummary"
- },
- "type": "array"
- },
- {
- "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"
+ "bearing_start": {
+ "description": "TODO",
+ "title": "Bearing Start",
+ "type": "number"
},
- "nearestPlace": {
- "type": "string",
- "title": "Nearestplace",
- "description": "Nearest Place"
+ "bearing_end": {
+ "description": "TODO",
+ "title": "Bearing End",
+ "type": "number"
},
- "words": {
- "type": "string",
- "title": "Words",
- "description": "The what3words address"
+ "start_location": {
+ "$ref": "#/components/schemas/Indoor_API_LatLngLevel",
+ "description": "Starting Location of this Step, 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 Step, as a Lat,Lng pair with a floor level number."
},
- "locale": {
+ "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"
}
],
- "title": "Locale",
- "description": "Language Locale"
+ "description": "A text based instruction for this step"
},
- "map": {
- "type": "string",
- "title": "Map",
- "description": "Link to what3words address on a map"
+ "routing_profiles": {
+ "default": [],
+ "items": {
+ "type": "string"
+ },
+ "title": "Routing Profiles",
+ "type": "array"
}
},
- "type": "object",
"required": [
- "country",
- "nearestPlace",
- "words",
- "language",
- "map"
+ "distance",
+ "duration",
+ "bearing_start",
+ "bearing_end",
+ "start_location",
+ "end_location",
+ "polyline"
],
- "title": "Properties"
+ "title": "Step",
+ "type": "object"
},
- "External-api-wrapper_what3words_Square": {
+ "Indoor_API_GeometryCollection": {
+ "description": "GeometryCollection Model",
"properties": {
- "southwest": {
- "$ref": "#/components/schemas/External-api-wrapper_what3words_Coordinates",
- "description": "Lat Lng coordinate"
+ "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"
},
- "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": {
+ "type": {
+ "const": "GeometryCollection",
+ "title": "Type",
+ "type": "string"
+ },
+ "geometries": {
"items": {
- "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": [
{
- "type": "string"
+ "$ref": "#/components/schemas/Indoor_API_Point"
},
{
- "type": "integer"
+ "$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": "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": "Geometries",
+ "type": "array"
}
},
"required": [
- "detail"
+ "type",
+ "geometries"
],
- "title": "ErrorResponseSchema",
+ "title": "GeometryCollection",
"type": "object"
},
- "Indoor_API_Building": {
+ "Indoor_API_IndoorFeatureSchema": {
"properties": {
- "ref": {
- "description": "Reference to identify Building",
- "title": "Ref",
- "type": "string"
- },
- "name": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Name of the Building",
- "title": "Name"
+ "properties": {
+ "type": "object",
+ "additionalProperties": true,
+ "description": "Additional properties associated with this feature",
+ "title": "Properties"
},
- "localized_name": {
- "additionalProperties": {
- "type": "string"
- },
- "default": {},
- "description": "Translated names of the Building",
- "title": "Localized Name",
- "type": "object"
+ "type": {
+ "const": "Feature",
+ "default": "Feature",
+ "title": "Type",
+ "type": "string"
},
- "description": {
+ "geometry": {
"anyOf": [
{
- "type": "string"
+ "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"
+ }
+ ]
},
{
- "type": "null"
+ "$ref": "#/components/schemas/Indoor_API_GeometryCollection"
}
],
- "description": "Building Description",
- "title": "Description"
+ "description": "GeoJSON Geometry or Geometry Collection",
+ "title": "Geometry"
},
- "opening_hours": {
+ "id": {
"anyOf": [
{
- "type": "string"
+ "type": "integer"
},
{
"type": "null"
}
],
- "description": "Building Opening Hours",
- "title": "Opening Hours"
+ "title": "Id"
},
- "logo": {
+ "distance": {
"anyOf": [
{
- "type": "string"
+ "type": "number"
},
{
"type": "null"
}
],
- "description": "",
- "title": "Logo"
+ "title": "Distance"
},
- "cover": {
+ "duration": {
"anyOf": [
{
- "type": "string"
+ "type": "number"
},
{
"type": "null"
}
],
- "description": "",
- "title": "Cover"
- },
- "levels": {
- "description": "Levels associated with the Building",
- "items": {
- "$ref": "#/components/schemas/Indoor_API_Level"
- },
- "title": "Levels",
- "type": "array"
+ "title": "Duration"
}
},
"required": [
- "ref",
- "levels"
+ "properties",
+ "geometry"
],
- "title": "Building",
+ "title": "IndoorFeatureSchema",
"type": "object"
},
- "Indoor_API_Level": {
+ "Indoor_API_LineString": {
+ "description": "LineString Model",
"properties": {
- "level": {
- "description": "Floor level as a number",
- "title": "Level",
- "type": "integer"
- },
- "name": {
+ "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": "Name of the floor level",
- "title": "Name"
+ "title": "Bbox"
},
- "ref": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Reference to identify floor level",
- "title": "Ref"
+ "type": {
+ "const": "LineString",
+ "title": "Type",
+ "type": "string"
},
- "bbox": {
- "description": "Bounding Box of floor level",
+ "coordinates": {
"items": {
- "type": "number"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Indoor_API_Position2D"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_Position3D"
+ }
+ ]
},
- "title": "Bbox",
+ "minItems": 2,
+ "title": "Coordinates",
"type": "array"
}
},
"required": [
- "level",
- "bbox"
+ "type",
+ "coordinates"
],
- "title": "Level",
+ "title": "LineString",
"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_MultiLineString": {
+ "description": "MultiLineString 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": [
{
@@ -17767,123 +17708,95 @@
],
"type": "array"
},
+ {
+ "maxItems": 6,
+ "minItems": 6,
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "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"
+ "type": {
+ "const": "MultiLineString",
+ "title": "Type",
+ "type": "string"
},
- "languages": {
- "description": "Language translations available for the venue",
+ "coordinates": {
"items": {
- "type": "string"
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Indoor_API_Position2D"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_Position3D"
+ }
+ ]
+ },
+ "minItems": 2,
+ "type": "array"
},
- "title": "Languages",
+ "title": "Coordinates",
"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"
+ "type",
+ "coordinates"
],
- "title": "VenueSchema",
+ "title": "MultiLineString",
"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"
- }
- ],
+ "Indoor_API_MultiPoint": {
+ "description": "MultiPoint 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": [
{
- "maxItems": 4,
- "minItems": 4,
+ "maxItems": 4,
+ "minItems": 4,
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "type": "array"
+ },
+ {
+ "maxItems": 6,
+ "minItems": 6,
"prefixItems": [
{
"type": "number"
@@ -17894,6 +17807,12 @@
{
"type": "number"
},
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ },
{
"type": "number"
}
@@ -17904,470 +17823,237 @@
"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": "string"
- },
- "rows": {
- "items": {
- "$ref": "#/components/schemas/Indoor_API_DistanceMatrixRow"
- },
- "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"
- },
- "duration": {
- "$ref": "#/components/schemas/Indoor_API_Duration"
- },
- "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"
- },
- "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": {
+ "const": "MultiPoint",
+ "title": "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",
+ "coordinates": {
"items": {
- "$ref": "#/components/schemas/Indoor_API_Step"
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Indoor_API_Position2D"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_Position3D"
+ }
+ ]
},
- "title": "Steps",
+ "title": "Coordinates",
"type": "array"
}
},
"required": [
- "distance",
- "duration",
- "start_location",
- "end_location",
- "steps"
+ "type",
+ "coordinates"
],
- "title": "Leg",
+ "title": "MultiPoint",
"type": "object"
},
- "Indoor_API_Route": {
+ "Indoor_API_MultiPolygon": {
+ "description": "MultiPolygon 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": "MultiPolygon",
+ "title": "Type",
+ "type": "string"
+ },
+ "coordinates": {
"items": {
- "$ref": "#/components/schemas/Indoor_API_Leg"
+ "items": {
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Indoor_API_Position2D"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_Position3D"
+ }
+ ]
+ },
+ "minItems": 4,
+ "type": "array"
+ },
+ "type": "array"
},
- "title": "Legs",
+ "title": "Coordinates",
"type": "array"
}
},
"required": [
- "bounds",
- "legs"
+ "type",
+ "coordinates"
],
- "title": "Route",
+ "title": "MultiPolygon",
"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"
- },
+ "Indoor_API_PaginationSchema": {
"properties": {
- "status": {
- "const": "ok",
- "default": "ok",
- "title": "Status",
- "type": "string"
+ "page": {
+ "description": "Current page number",
+ "title": "Page",
+ "type": "integer"
},
- "routes": {
- "items": {
- "$ref": "#/components/schemas/Indoor_API_Route"
- },
- "title": "Routes",
- "type": "array"
+ "page_count": {
+ "description": "Total number of pages",
+ "title": "Page Count",
+ "type": "integer"
+ },
+ "total": {
+ "description": "Total number of items",
+ "title": "Total",
+ "type": "integer"
+ },
+ "per_page": {
+ "description": "Number of items per page",
+ "title": "Per Page",
+ "type": "integer"
}
},
"required": [
- "routes"
+ "page",
+ "page_count",
+ "total",
+ "per_page"
],
- "title": "RouteCollection",
+ "title": "PaginationSchema",
"type": "object"
},
- "Indoor_API_Step": {
+ "Indoor_API_Point": {
+ "description": "Point Model",
"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": {
+ "bbox": {
"anyOf": [
{
- "type": "integer"
+ "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 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."
+ "title": "Bbox"
},
- "polyline": {
- "description": "TODO",
- "items": {
- "maxItems": 2,
- "minItems": 2,
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
- }
- ],
- "type": "array"
- },
- "title": "Polyline",
- "type": "array"
+ "type": {
+ "const": "Point",
+ "title": "Type",
+ "type": "string"
},
- "instruction": {
+ "coordinates": {
"anyOf": [
{
- "$ref": "#/components/schemas/Indoor_API_Instruction"
+ "$ref": "#/components/schemas/Indoor_API_Position2D"
},
{
- "type": "null"
+ "$ref": "#/components/schemas/Indoor_API_Position3D"
}
],
- "description": "A text based instruction for this step"
- },
- "routing_profiles": {
- "default": [],
- "items": {
- "type": "string"
- },
- "title": "Routing Profiles",
- "type": "array"
+ "title": "Coordinates"
}
},
"required": [
- "distance",
- "duration",
- "bearing_start",
- "bearing_end",
- "start_location",
- "end_location",
- "polyline"
+ "type",
+ "coordinates"
],
- "title": "Step",
+ "title": "Point",
"type": "object"
},
- "Indoor_API_GeometryCollection": {
- "description": "GeometryCollection Model",
+ "Indoor_API_Polygon": {
+ "description": "Polygon Model",
"properties": {
"bbox": {
"anyOf": [
@@ -18422,131 +18108,228 @@
"title": "Bbox"
},
"type": {
- "const": "GeometryCollection",
+ "const": "Polygon",
"title": "Type",
"type": "string"
},
- "geometries": {
+ "coordinates": {
+ "items": {
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/Indoor_API_Position2D"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_Position3D"
+ }
+ ]
+ },
+ "minItems": 4,
+ "type": "array"
+ },
+ "title": "Coordinates",
+ "type": "array"
+ }
+ },
+ "required": [
+ "type",
+ "coordinates"
+ ],
+ "title": "Polygon",
+ "type": "object"
+ },
+ "Indoor_API_Position2D": {
+ "maxItems": 2,
+ "minItems": 2,
+ "prefixItems": [
+ {
+ "title": "Longitude",
+ "type": "number"
+ },
+ {
+ "title": "Latitude",
+ "type": "number"
+ }
+ ],
+ "type": "array"
+ },
+ "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": "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
+ }
+ },
+ "properties": {
+ "pagination": {
+ "$ref": "#/components/schemas/Indoor_API_PaginationSchema",
+ "description": "Pagination Information"
+ },
+ "features": {
+ "default": [],
+ "description": "List of Indoor features",
+ "items": {
+ "$ref": "#/components/schemas/Indoor_API_IndoorFeatureSchema"
+ },
+ "title": "Features",
+ "type": "array"
+ }
+ },
+ "required": [
+ "pagination"
+ ],
+ "title": "SearchPagination",
+ "type": "object"
+ },
+ "Indoor_API_AutocompletePagination": {
+ "example": {
+ "pagination": {
+ "page": 1,
+ "page_count": 1,
+ "per_page": 2,
+ "total": 2
+ },
+ "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"
+ },
+ "predictions": {
+ "default": [],
+ "description": "List of Indoor features",
"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"
- },
- "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_PredictionSchema"
},
- "title": "Geometries",
+ "title": "Predictions",
"type": "array"
}
},
"required": [
- "type",
- "geometries"
+ "pagination"
],
- "title": "GeometryCollection",
+ "title": "AutocompletePagination",
"type": "object"
},
- "Indoor_API_IndoorFeatureSchema": {
+ "Indoor_API_PredictionSchema": {
"properties": {
- "properties": {
- "type": "object",
- "additionalProperties": true,
- "description": "Additional properties associated with this feature",
- "title": "Properties"
- },
- "type": {
- "const": "Feature",
- "default": "Feature",
- "title": "Type",
- "type": "string"
+ "id": {
+ "description": "ID of the Feature",
+ "title": "Id",
+ "type": "integer"
},
- "geometry": {
+ "name": {
"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"
- }
- ]
+ "type": "string"
},
{
- "$ref": "#/components/schemas/Indoor_API_GeometryCollection"
+ "type": "null"
}
],
- "description": "GeoJSON Geometry or Geometry Collection",
- "title": "Geometry"
+ "description": "Name of the Feature",
+ "title": "Name"
},
- "id": {
+ "distance": {
"anyOf": [
{
- "type": "integer"
+ "type": "number"
},
{
"type": "null"
}
],
- "title": "Id"
+ "description": "If from location provided, is the distance in metres from that location",
+ "title": "Distance"
},
- "distance": {
+ "duration": {
"anyOf": [
{
"type": "number"
@@ -18555,792 +18338,1020 @@
"type": "null"
}
],
- "title": "Distance"
+ "description": "If from location provided, is the duration in seconds from that location",
+ "title": "Duration"
},
- "duration": {
+ "level": {
"anyOf": [
{
- "type": "number"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Duration"
+ "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": [
- "properties",
- "geometry"
+ "id"
],
- "title": "IndoorFeatureSchema",
+ "title": "PredictionSchema",
"type": "object"
},
- "Indoor_API_LineString": {
- "description": "LineString 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"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- }
- ],
- "type": "array"
- },
- {
- "maxItems": 6,
- "minItems": 6,
- "prefixItems": [
+ "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"
+ "$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"
+ },
+ {
+ "$ref": "#/components/schemas/Indoor_API_GeometryCollection"
}
- ],
- "type": "array"
+ ]
},
{
- "type": "null"
+ "$ref": "#/components/schemas/Indoor_API_GeometryCollection"
}
],
- "title": "Bbox"
+ "description": "GeoJSON Geometry or Geometry Collection",
+ "title": "Geometry"
},
- "type": {
- "const": "LineString",
- "title": "Type",
- "type": "string"
+ "id": {
+ "description": "ID of the feature",
+ "title": "Id",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "properties",
+ "geometry",
+ "id"
+ ],
+ "title": "SingleIndoorFeatureSchema",
+ "type": "object"
+ },
+ "External-api-wrapper_AuthenticationErrorResponse": {
+ "properties": {
+ "detail": {
+ "type": "string",
+ "title": "Detail"
+ }
+ },
+ "type": "object",
+ "required": [
+ "detail"
+ ],
+ "title": "AuthenticationErrorResponse",
+ "description": "AuthenticationErrorResponse is the base authentication error model."
+ },
+ "External-api-wrapper_HTTPErrorModel": {
+ "properties": {
+ "details": {
+ "type": "string",
+ "title": "Details"
+ }
+ },
+ "type": "object",
+ "required": [
+ "details"
+ ],
+ "title": "HTTPErrorModel"
+ },
+ "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": {
+ "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"
+ ]
},
- "coordinates": {
+ "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": [
+ "origins",
+ "destinations"
+ ],
+ "title": "MatrixRequest"
+ },
+ "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."
+ },
+ "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": {
+ "type": "string",
+ "title": "Status"
+ },
+ "routes": {
"items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/Indoor_API_Position2D"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_Position3D"
- }
- ]
+ "$ref": "#/components/schemas/External-api-wrapper_TransitRoute"
},
- "minItems": 2,
- "title": "Coordinates",
- "type": "array"
+ "type": "array",
+ "title": "Routes",
+ "default": []
}
},
+ "type": "object",
"required": [
- "type",
- "coordinates"
+ "status"
],
- "title": "LineString",
- "type": "object"
+ "title": "Transit"
},
- "Indoor_API_MultiLineString": {
- "description": "MultiLineString Model",
+ "External-api-wrapper_TransitAttributions": {
"properties": {
- "bbox": {
+ "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": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Polyline"
+ },
+ "start_location": {
+ "$ref": "#/components/schemas/External-api-wrapper_TransitPlace"
+ },
+ "end_location": {
+ "$ref": "#/components/schemas/External-api-wrapper_TransitPlace"
+ },
+ "transport": {
"anyOf": [
{
- "maxItems": 4,
- "minItems": 4,
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- }
- ],
- "type": "array"
+ "$ref": "#/components/schemas/External-api-wrapper_TransitTransport"
},
{
- "maxItems": 6,
- "minItems": 6,
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- }
- ],
+ "type": "null"
+ }
+ ]
+ },
+ "attributions": {
+ "anyOf": [
+ {
+ "items": {
+ "$ref": "#/components/schemas/External-api-wrapper_TransitAttributions"
+ },
"type": "array"
},
{
"type": "null"
}
],
- "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"
+ "title": "Attributions"
}
},
+ "type": "object",
"required": [
- "type",
- "coordinates"
+ "travel_mode",
+ "duration",
+ "distance",
+ "polyline",
+ "start_location",
+ "end_location"
],
- "title": "MultiLineString",
- "type": "object"
+ "title": "TransitLeg"
},
- "Indoor_API_MultiPoint": {
- "description": "MultiPoint Model",
+ "External-api-wrapper_TransitPlace": {
"properties": {
- "bbox": {
+ "name": {
"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": "string"
},
{
"type": "null"
}
],
- "title": "Bbox"
+ "title": "Name"
},
"type": {
- "const": "MultiPoint",
- "title": "Type",
- "type": "string"
+ "type": "string",
+ "title": "Type"
},
- "coordinates": {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/Indoor_API_Position2D"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_Position3D"
- }
- ]
- },
- "title": "Coordinates",
- "type": "array"
+ "location": {
+ "$ref": "#/components/schemas/External-api-wrapper_TransitPosition"
}
},
+ "type": "object",
"required": [
"type",
- "coordinates"
+ "location"
],
- "title": "MultiPoint",
- "type": "object"
+ "title": "TransitPlace"
},
- "Indoor_API_MultiPolygon": {
- "description": "MultiPolygon Model",
+ "External-api-wrapper_TransitPosition": {
"properties": {
- "bbox": {
+ "lat": {
"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": "number",
+ "maximum": 90,
+ "minimum": -90
},
{
- "type": "null"
+ "type": "string",
+ "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
}
],
- "title": "Bbox"
- },
- "type": {
- "const": "MultiPolygon",
- "title": "Type",
- "type": "string"
+ "title": "Lat"
},
- "coordinates": {
- "items": {
- "items": {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/Indoor_API_Position2D"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_Position3D"
- }
- ]
- },
- "minItems": 4,
- "type": "array"
- },
- "type": "array"
- },
- "title": "Coordinates",
- "type": "array"
+ "lng": {
+ "anyOf": [
+ {
+ "type": "number",
+ "maximum": 180,
+ "minimum": -180
+ },
+ {
+ "type": "string",
+ "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
+ }
+ ],
+ "title": "Lng"
}
},
+ "type": "object",
"required": [
- "type",
- "coordinates"
+ "lat",
+ "lng"
],
- "title": "MultiPolygon",
- "type": "object"
+ "title": "TransitPosition"
},
- "Indoor_API_PaginationSchema": {
+ "External-api-wrapper_TransitRoute": {
"properties": {
- "page": {
- "description": "Current page number",
- "title": "Page",
- "type": "integer"
- },
- "page_count": {
- "description": "Total number of pages",
- "title": "Page Count",
- "type": "integer"
+ "notice": {
+ "type": "string",
+ "title": "Notice",
+ "default": ""
},
- "total": {
- "description": "Total number of items",
- "title": "Total",
- "type": "integer"
+ "duration": {
+ "type": "integer",
+ "title": "Duration"
},
- "per_page": {
- "description": "Number of items per page",
- "title": "Per Page",
- "type": "integer"
+ "legs": {
+ "items": {
+ "$ref": "#/components/schemas/External-api-wrapper_TransitLeg"
+ },
+ "type": "array",
+ "title": "Legs",
+ "default": []
}
},
+ "type": "object",
"required": [
- "page",
- "page_count",
- "total",
- "per_page"
+ "duration"
],
- "title": "PaginationSchema",
- "type": "object"
+ "title": "TransitRoute"
},
- "Indoor_API_Point": {
- "description": "Point Model",
+ "External-api-wrapper_TransitTransport": {
"properties": {
- "bbox": {
+ "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"
+ }
+ ],
+ "title": "Name"
+ },
+ "mode": {
+ "type": "string",
+ "title": "Mode"
+ },
+ "category": {
+ "anyOf": [
+ {
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Bbox"
+ "title": "Category"
},
- "type": {
- "const": "Point",
- "title": "Type",
- "type": "string"
+ "headsign": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Headsign"
},
- "coordinates": {
+ "short_name": {
"anyOf": [
{
- "$ref": "#/components/schemas/Indoor_API_Position2D"
+ "type": "string"
},
{
- "$ref": "#/components/schemas/Indoor_API_Position3D"
+ "type": "null"
}
],
- "title": "Coordinates"
+ "title": "Short Name"
+ },
+ "long_name": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Long Name"
+ },
+ "color": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Color"
+ },
+ "text_color": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Text Color"
}
},
+ "type": "object",
"required": [
- "type",
- "coordinates"
+ "mode"
],
- "title": "Point",
- "type": "object"
+ "title": "TransitTransport"
},
- "Indoor_API_Polygon": {
- "description": "Polygon Model",
+ "External-api-wrapper_ValidationError": {
"properties": {
- "bbox": {
- "anyOf": [
- {
- "maxItems": 4,
- "minItems": 4,
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- }
- ],
- "type": "array"
- },
+ "loc": {
+ "items": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "integer"
+ }
+ ]
+ },
+ "type": "array",
+ "title": "Location"
+ },
+ "msg": {
+ "type": "string",
+ "title": "Message"
+ },
+ "type": {
+ "type": "string",
+ "title": "Error Type"
+ }
+ },
+ "type": "object",
+ "required": [
+ "loc",
+ "msg",
+ "type"
+ ],
+ "title": "ValidationError"
+ },
+ "Datasets_AuthenticationErrorResponse": {
+ "properties": {
+ "detail": {
+ "type": "string",
+ "title": "Detail"
+ }
+ },
+ "type": "object",
+ "required": [
+ "detail"
+ ],
+ "title": "AuthenticationErrorResponse",
+ "description": "AuthenticationErrorResponse is the base authentication error model."
+ },
+ "Datasets_DatasetCreateRequest": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "title": "Name",
+ "description": "The friendly name "
+ },
+ "url": {
+ "type": "string",
+ "maxLength": 2083,
+ "minLength": 1,
+ "format": "uri",
+ "title": "Url"
+ },
+ "schema_mapping": {
+ "anyOf": [
{
- "maxItems": 6,
- "minItems": 6,
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- },
- {
- "type": "number"
- }
- ],
+ "items": {
+ "$ref": "#/components/schemas/Datasets_DatasetSchemaMapping"
+ },
"type": "array"
},
{
"type": "null"
}
],
- "title": "Bbox"
- },
- "type": {
- "const": "Polygon",
- "title": "Type",
- "type": "string"
- },
- "coordinates": {
- "items": {
- "items": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/Indoor_API_Position2D"
- },
- {
- "$ref": "#/components/schemas/Indoor_API_Position3D"
- }
- ]
- },
- "minItems": 4,
- "type": "array"
- },
- "title": "Coordinates",
- "type": "array"
+ "title": "Schema Mapping"
}
},
+ "type": "object",
"required": [
- "type",
- "coordinates"
+ "name",
+ "url"
],
- "title": "Polygon",
- "type": "object"
+ "title": "DatasetCreateRequest",
+ "description": "DatasetCreateRequest represents the parameters for dataset creation."
},
- "Indoor_API_Position2D": {
- "maxItems": 2,
- "minItems": 2,
- "prefixItems": [
- {
- "title": "Longitude",
- "type": "number"
+ "Datasets_DatasetListResponse": {
+ "properties": {
+ "datasets": {
+ "items": {
+ "$ref": "#/components/schemas/Datasets_DatasetSummaryResponse"
+ },
+ "type": "array",
+ "title": "Datasets"
},
- {
- "title": "Latitude",
- "type": "number"
+ "pagination": {
+ "$ref": "#/components/schemas/Datasets_Pagination"
}
+ },
+ "type": "object",
+ "required": [
+ "datasets",
+ "pagination"
],
- "type": "array"
+ "title": "DatasetListResponse"
},
- "Indoor_API_Position3D": {
- "maxItems": 3,
- "minItems": 3,
- "prefixItems": [
- {
- "title": "Longitude",
- "type": "number"
+ "Datasets_DatasetLogEntry": {
+ "properties": {
+ "created_at": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Created At",
+ "description": "The date of the log entry."
},
- {
- "title": "Latitude",
- "type": "number"
+ "detail": {
+ "type": "string",
+ "title": "Detail",
+ "description": "The detail of the log entry."
},
- {
- "title": "Altitude",
- "type": "number"
+ "level": {
+ "$ref": "#/components/schemas/Datasets_LoggerLevel",
+ "description": "The level of the log entry."
}
+ },
+ "type": "object",
+ "required": [
+ "created_at",
+ "detail",
+ "level"
],
- "type": "array"
+ "title": "DatasetLogEntry"
},
- "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"
+ "Datasets_DatasetResponse": {
+ "properties": {
+ "id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Id"
+ },
+ "name": {
+ "type": "string",
+ "title": "Name"
+ },
+ "url": {
+ "anyOf": [
+ {
+ "type": "string",
+ "maxLength": 2083,
+ "minLength": 1,
+ "format": "uri"
},
- "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": "Url",
+ "description": "The url of the data to fetch"
+ },
+ "reimport_key": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "uuid"
},
- "type": "Feature"
- }
- ],
- "pagination": {
- "page": 0,
- "page_count": 1,
- "per_page": 0,
- "total": 1
- }
- },
- "properties": {
- "pagination": {
- "$ref": "#/components/schemas/Indoor_API_PaginationSchema",
- "description": "Pagination Information"
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Reimport Key",
+ "description": "The reimport key to be used with the reimport hook endpoint."
},
- "features": {
- "default": [],
- "description": "List of Indoor features",
- "items": {
- "$ref": "#/components/schemas/Indoor_API_IndoorFeatureSchema"
- },
- "title": "Features",
- "type": "array"
+ "created_at": {
+ "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."
+ },
+ "scheduled_for_deletion_after": {
+ "anyOf": [
+ {
+ "type": "string",
+ "format": "date"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Scheduled For Deletion After",
+ "description": "After this date the dataset will be automatically removed"
}
},
+ "type": "object",
"required": [
- "pagination"
+ "id",
+ "name",
+ "created_at",
+ "updated_at"
],
- "title": "SearchPagination",
- "type": "object"
+ "title": "DatasetResponse"
},
- "Indoor_API_AutocompletePagination": {
- "example": {
- "pagination": {
- "page": 1,
- "page_count": 1,
- "per_page": 2,
- "total": 2
- },
- "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
- }
- ]
- },
+ "Datasets_DatasetSchemaMapping": {
"properties": {
- "pagination": {
- "$ref": "#/components/schemas/Indoor_API_PaginationSchema",
- "description": "Pagination Information"
+ "schema_key": {
+ "$ref": "#/components/schemas/Datasets_SchemaKeys"
},
- "predictions": {
- "default": [],
- "description": "List of Indoor features",
- "items": {
- "$ref": "#/components/schemas/Indoor_API_PredictionSchema"
- },
- "title": "Predictions",
- "type": "array"
+ "data_key": {
+ "type": "string",
+ "title": "Data Key"
}
},
+ "type": "object",
"required": [
- "pagination"
+ "schema_key",
+ "data_key"
],
- "title": "AutocompletePagination",
- "type": "object"
+ "title": "DatasetSchemaMapping",
+ "description": "DatasetSchemaMapping defines a mapping between `schema_key` and user provided `data_key`."
},
- "Indoor_API_PredictionSchema": {
+ "Datasets_DatasetStatusResponse": {
"properties": {
"id": {
- "description": "ID of the Feature",
+ "type": "string",
+ "format": "uuid",
"title": "Id",
- "type": "integer"
+ "description": "The id of the run, can be used in communication with the support to better identify the run."
},
- "name": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "description": "Name of the Feature",
- "title": "Name"
+ "steps": {
+ "items": {
+ "$ref": "#/components/schemas/Datasets_DatasetStatusStep"
+ },
+ "type": "array",
+ "title": "Steps",
+ "description": "The steps of the run, ordered by start date."
},
- "distance": {
- "anyOf": [
+ "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": [
{
- "type": "number"
+ "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"
}
+ ]
+ }
+ ]
+ },
+ "Datasets_DatasetStatusStep": {
+ "properties": {
+ "name": {
+ "type": "string",
+ "enum": [
+ "fetch",
+ "import"
],
- "description": "If from location provided, is the distance in metres from that location",
- "title": "Distance"
+ "title": "Name",
+ "description": "The name of the step. Currently can only be `fetch` of `import`"
},
- "duration": {
+ "start": {
+ "type": "string",
+ "format": "date-time",
+ "title": "Start",
+ "description": "The date at which the step started."
+ },
+ "end": {
"anyOf": [
{
- "type": "number"
+ "type": "string",
+ "format": "date-time"
},
{
"type": "null"
}
],
- "description": "If from location provided, is the duration in seconds from that location",
- "title": "Duration"
+ "title": "End",
+ "description": "The date at which the step ended or null if in progress."
},
- "level": {
+ "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"
}
],
- "description": "Level of the Feature",
- "title": "Level"
+ "title": "Updated At",
+ "description": "The date when the dataset was last updated."
},
- "ref": {
+ "scheduled_for_deletion_after": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "format": "date"
},
{
"type": "null"
}
],
- "description": "Reference of the Feature",
- "title": "Ref"
- },
- "building": {
+ "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"
@@ -19349,570 +19360,545 @@
"type": "null"
}
],
- "description": "Building the Feature is in",
- "title": "Building"
+ "title": "Name",
+ "description": "The friendly name "
},
- "category": {
+ "url": {
"anyOf": [
{
- "type": "string"
+ "type": "string",
+ "maxLength": 2083,
+ "minLength": 1,
+ "format": "uri"
},
{
"type": "null"
}
],
- "description": "Catagory of the Feature",
- "title": "Category"
+ "title": "Url"
}
},
- "required": [
- "id"
- ],
- "title": "PredictionSchema",
- "type": "object"
+ "type": "object",
+ "title": "DatasetUpdate"
},
- "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"
- },
+ "Datasets_FeatureRead": {
"properties": {
- "properties": {
- "type": "object",
- "additionalProperties": true,
- "description": "Additional properties associated with this feature",
- "title": "Properties"
- },
- "type": {
- "const": "Feature",
- "default": "Feature",
- "title": "Type",
- "type": "string"
+ "id": {
+ "type": "string",
+ "format": "uuid",
+ "title": "Id"
},
"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"
- }
- ]
+ "type": "string"
},
{
- "$ref": "#/components/schemas/Indoor_API_GeometryCollection"
+ "$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"
}
],
- "description": "GeoJSON Geometry or Geometry Collection",
"title": "Geometry"
},
- "id": {
- "description": "ID of the feature",
- "title": "Id",
- "type": "integer"
- }
- },
- "required": [
- "properties",
- "geometry",
- "id"
- ],
- "title": "SingleIndoorFeatureSchema",
- "type": "object"
- },
- "External-api-wrapper_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"
},
- "External-api-wrapper_HTTPErrorModel": {
+ "Datasets_FeatureSummaryResponse": {
"properties": {
- "details": {
+ "id": {
"type": "string",
- "title": "Details"
+ "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"
+ },
+ "attributes": {
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Attributes",
+ "description": "The feature attributes"
}
},
"type": "object",
"required": [
- "details"
+ "id"
],
- "title": "HTTPErrorModel"
+ "title": "FeatureSummaryResponse",
+ "description": "FeatureSummaryResponse represents the minimal amount of information to be able to fetch a feature details."
},
- "External-api-wrapper_HTTPValidationError": {
+ "Datasets_HTTPValidationError": {
"properties": {
"detail": {
"items": {
- "$ref": "#/components/schemas/External-api-wrapper_ValidationError"
+ "$ref": "#/components/schemas/Datasets_ValidationError"
},
"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"
- }
- },
- "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"
- ]
- },
- "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": "object",
+ "title": "HTTPValidationError"
+ },
+ "Datasets_ImportResponse": {
+ "properties": {
+ "dataset_id": {
"type": "string",
- "enum": [
- "driving",
- "truck"
- ],
- "title": "Mode",
- "description": "Specifies the mode of transport to use when calculating distance",
- "default": "driving",
- "examples": [
- "driving"
- ]
+ "format": "uuid",
+ "title": "Dataset Id",
+ "description": "The dataset id that was scheduled for import."
}
},
"type": "object",
"required": [
- "origins",
- "destinations"
+ "dataset_id"
],
- "title": "MatrixRequest"
+ "title": "ImportResponse"
},
- "External-api-wrapper_MatrixResponse": {
+ "Datasets_LineStringGeometry": {
"properties": {
- "matrix_id": {
+ "type": {
"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."
+ "const": "LineString",
+ "title": "Type",
+ "default": "LineString"
},
- "status": {
- "type": "string",
- "enum": [
- "accepted",
- "inProgress",
- "completed",
- "timeout",
- "error"
- ],
- "title": "Status",
- "description": "Status of the matrix calculation"
+ "coordinates": {
+ "items": {
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "type": "array",
+ "maxItems": 2,
+ "minItems": 2
+ },
+ "type": "array",
+ "title": "Coordinates"
}
},
"type": "object",
"required": [
- "matrix_id",
- "status"
+ "coordinates"
],
- "title": "MatrixResponse"
+ "title": "LineStringGeometry"
},
- "External-api-wrapper_Transit": {
+ "Datasets_LoggerLevel": {
+ "type": "string",
+ "enum": [
+ "info",
+ "warning",
+ "error"
+ ],
+ "title": "LoggerLevel"
+ },
+ "Datasets_MultiLineStringGeometry": {
"properties": {
- "status": {
+ "type": {
"type": "string",
- "title": "Status"
+ "const": "MultiLineString",
+ "title": "Type",
+ "default": "MultiLineString"
},
- "routes": {
+ "coordinates": {
"items": {
- "$ref": "#/components/schemas/External-api-wrapper_TransitRoute"
+ "items": {
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "type": "array",
+ "maxItems": 2,
+ "minItems": 2
+ },
+ "type": "array"
},
"type": "array",
- "title": "Routes",
- "default": []
+ "title": "Coordinates"
}
},
"type": "object",
"required": [
- "status"
+ "coordinates"
],
- "title": "Transit"
+ "title": "MultiLineStringGeometry"
},
- "External-api-wrapper_TransitAttributions": {
+ "Datasets_MultiPointGeometry": {
"properties": {
- "id": {
- "type": "string",
- "title": "Id"
- },
- "href": {
- "type": "string",
- "title": "Href"
- },
- "text": {
- "type": "string",
- "title": "Text"
- },
"type": {
"type": "string",
- "title": "Type"
+ "const": "MultiPoint",
+ "title": "Type",
+ "default": "MultiPoint"
+ },
+ "coordinates": {
+ "items": {
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "type": "array",
+ "maxItems": 2,
+ "minItems": 2
+ },
+ "type": "array",
+ "title": "Coordinates"
}
},
"type": "object",
"required": [
- "id",
- "href",
- "text",
- "type"
+ "coordinates"
],
- "title": "TransitAttributions"
+ "title": "MultiPointGeometry"
},
- "External-api-wrapper_TransitLeg": {
+ "Datasets_MultiPolygonGeometry": {
"properties": {
- "travel_mode": {
+ "type": {
"type": "string",
- "title": "Travel Mode"
- },
- "duration": {
- "type": "integer",
- "title": "Duration"
- },
- "distance": {
- "type": "number",
- "title": "Distance"
- },
- "polyline": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Polyline"
- },
- "start_location": {
- "$ref": "#/components/schemas/External-api-wrapper_TransitPlace"
- },
- "end_location": {
- "$ref": "#/components/schemas/External-api-wrapper_TransitPlace"
- },
- "transport": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/External-api-wrapper_TransitTransport"
- },
- {
- "type": "null"
- }
- ]
+ "const": "MultiPolygon",
+ "title": "Type",
+ "default": "MultiPolygon"
},
- "attributions": {
- "anyOf": [
- {
+ "coordinates": {
+ "items": {
+ "items": {
"items": {
- "$ref": "#/components/schemas/External-api-wrapper_TransitAttributions"
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "type": "array",
+ "maxItems": 2,
+ "minItems": 2
},
"type": "array"
},
- {
- "type": "null"
- }
- ],
- "title": "Attributions"
+ "type": "array"
+ },
+ "type": "array",
+ "title": "Coordinates"
}
},
"type": "object",
"required": [
- "travel_mode",
- "duration",
- "distance",
- "polyline",
- "start_location",
- "end_location"
+ "coordinates"
],
- "title": "TransitLeg"
+ "title": "MultiPolygonGeometry"
},
- "External-api-wrapper_TransitPlace": {
+ "Datasets_Pagination": {
"properties": {
- "name": {
+ "prev": {
"anyOf": [
{
- "type": "string"
+ "type": "integer"
},
{
"type": "null"
}
],
- "title": "Name"
+ "title": "Prev",
+ "description": "The previous page number if any."
},
- "type": {
- "type": "string",
- "title": "Type"
+ "next": {
+ "anyOf": [
+ {
+ "type": "integer"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Next",
+ "description": "The next page number if any."
},
- "location": {
- "$ref": "#/components/schemas/External-api-wrapper_TransitPosition"
+ "page": {
+ "type": "integer",
+ "title": "Page",
+ "description": "The current page number."
}
},
"type": "object",
"required": [
- "type",
- "location"
+ "page"
],
- "title": "TransitPlace"
+ "title": "Pagination",
+ "description": "Pagination represents page information."
},
- "External-api-wrapper_TransitPosition": {
+ "Datasets_PointGeometry": {
"properties": {
- "lat": {
- "anyOf": [
- {
- "type": "number",
- "maximum": 90,
- "minimum": -90
- },
- {
- "type": "string",
- "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
- }
- ],
- "title": "Lat"
+ "type": {
+ "type": "string",
+ "const": "Point",
+ "title": "Type",
+ "default": "Point"
},
- "lng": {
- "anyOf": [
+ "coordinates": {
+ "prefixItems": [
{
- "type": "number",
- "maximum": 180,
- "minimum": -180
+ "type": "number"
},
{
- "type": "string",
- "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
+ "type": "number"
}
],
- "title": "Lng"
+ "type": "array",
+ "maxItems": 2,
+ "minItems": 2,
+ "title": "Coordinates"
}
},
"type": "object",
"required": [
- "lat",
- "lng"
+ "coordinates"
],
- "title": "TransitPosition"
+ "title": "PointGeometry"
},
- "External-api-wrapper_TransitRoute": {
+ "Datasets_PolygonGeometry": {
"properties": {
- "notice": {
+ "type": {
"type": "string",
- "title": "Notice",
- "default": ""
- },
- "duration": {
- "type": "integer",
- "title": "Duration"
+ "const": "Polygon",
+ "title": "Type",
+ "default": "Polygon"
},
- "legs": {
+ "coordinates": {
"items": {
- "$ref": "#/components/schemas/External-api-wrapper_TransitLeg"
+ "items": {
+ "prefixItems": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "number"
+ }
+ ],
+ "type": "array",
+ "maxItems": 2,
+ "minItems": 2
+ },
+ "type": "array"
},
"type": "array",
- "title": "Legs",
- "default": []
+ "title": "Coordinates"
}
},
"type": "object",
"required": [
- "duration"
+ "coordinates"
],
- "title": "TransitRoute"
+ "title": "PolygonGeometry"
},
- "External-api-wrapper_TransitTransport": {
+ "Datasets_SchemaKeys": {
+ "type": "string",
+ "enum": [
+ "title"
+ ],
+ "title": "SchemaKeys",
+ "description": "SchemaKeys are the allowed fields to be mapped."
+ },
+ "Datasets_SearchRequest": {
"properties": {
- "name": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "title": "Name"
- },
- "mode": {
+ "where": {
"type": "string",
- "title": "Mode"
- },
- "category": {
+ "title": "Where",
+ "description": "Applies a Woosmap filter on feature attributes.",
+ "examples": [
+ "cost_col:>32.3"
+ ]
+ }
+ },
+ "type": "object",
+ "required": [
+ "where"
+ ],
+ "title": "SearchRequest"
+ },
+ "Datasets_SearchRequestWithGeometry": {
+ "properties": {
+ "geometry": {
"anyOf": [
{
"type": "string"
},
{
- "type": "null"
- }
- ],
- "title": "Category"
- },
- "headsign": {
- "anyOf": [
- {
- "type": "string"
+ "$ref": "#/components/schemas/Datasets_PointGeometry"
},
{
- "type": "null"
- }
- ],
- "title": "Headsign"
- },
- "short_name": {
- "anyOf": [
- {
- "type": "string"
+ "$ref": "#/components/schemas/Datasets_LineStringGeometry"
},
{
- "type": "null"
+ "$ref": "#/components/schemas/Datasets_PolygonGeometry"
}
],
- "title": "Short Name"
+ "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 "
},
- "long_name": {
+ "buffer": {
"anyOf": [
{
- "type": "string"
+ "type": "number"
},
{
"type": "null"
}
],
- "title": "Long Name"
+ "title": "Buffer",
+ "description": "When set applies a buffer operation to input geometry see [Buffer Analysis](https://en.wikipedia.org/wiki/Buffer_analysis)."
},
- "color": {
+ "where": {
+ "type": "string",
+ "title": "Where",
+ "description": "Applies a Woosmap filter on feature attributes.",
+ "examples": [
+ "cost_col:>32.3"
+ ]
+ }
+ },
+ "type": "object",
+ "required": [
+ "geometry"
+ ],
+ "title": "SearchRequestWithGeometry",
+ "description": "Subclass with the Point, LineString & Polygon geometry type"
+ },
+ "Datasets_SearchRequestWithPolygonGeometry": {
+ "properties": {
+ "geometry": {
"anyOf": [
{
"type": "string"
},
{
- "type": "null"
+ "$ref": "#/components/schemas/Datasets_PolygonGeometry"
}
],
- "title": "Color"
+ "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 "
},
- "text_color": {
+ "buffer": {
"anyOf": [
{
- "type": "string"
+ "type": "number"
},
{
"type": "null"
}
],
- "title": "Text Color"
+ "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": [
- "mode"
+ "geometry"
],
- "title": "TransitTransport"
+ "title": "SearchRequestWithPolygonGeometry",
+ "description": "Subclass with the Polygon geometry type"
},
- "External-api-wrapper_ValidationError": {
+ "Datasets_SearchResultResponse": {
+ "properties": {
+ "features": {
+ "items": {
+ "$ref": "#/components/schemas/Datasets_FeatureSummaryResponse"
+ },
+ "type": "array",
+ "title": "Features",
+ "description": "The list of FeatureSummaryResponse that matched the search"
+ },
+ "pagination": {
+ "$ref": "#/components/schemas/Datasets_Pagination",
+ "description": "The pagination information"
+ }
+ },
+ "type": "object",
+ "required": [
+ "features",
+ "pagination"
+ ],
+ "title": "SearchResultResponse"
+ },
+ "Datasets_Status": {
+ "type": "string",
+ "enum": [
+ "success",
+ "in_progress",
+ "failed"
+ ],
+ "title": "Status"
+ },
+ "Datasets_ValidationError": {
"properties": {
"loc": {
"items": {
@@ -19945,7 +19931,20 @@
],
"title": "ValidationError"
},
- "Datasets_AuthenticationErrorResponse": {
+ "Datasets_features__internal__responses__HTTPErrorModel": {
+ "properties": {
+ "details": {
+ "type": "string",
+ "title": "Details"
+ }
+ },
+ "type": "object",
+ "required": [
+ "details"
+ ],
+ "title": "HTTPErrorModel"
+ },
+ "Distance_AuthenticationErrorResponse": {
"properties": {
"detail": {
"type": "string",
@@ -19959,687 +19958,785 @@
"title": "AuthenticationErrorResponse",
"description": "AuthenticationErrorResponse is the base authentication error model."
},
- "Datasets_DatasetCreateRequest": {
+ "Distance_BaseElementResponse": {
"properties": {
- "name": {
- "type": "string",
- "title": "Name",
- "description": "The friendly name "
- },
- "url": {
+ "status": {
"type": "string",
- "maxLength": 2083,
- "minLength": 1,
- "format": "uri",
- "title": "Url"
- },
- "schema_mapping": {
- "anyOf": [
- {
- "items": {
- "$ref": "#/components/schemas/Datasets_DatasetSchemaMapping"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
+ "enum": [
+ "OK",
+ "NOT_FOUND",
+ "ZERO_RESULTS",
+ "ERROR"
],
- "title": "Schema Mapping"
+ "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": [
- "name",
- "url"
+ "status"
],
- "title": "DatasetCreateRequest",
- "description": "DatasetCreateRequest represents the parameters for dataset creation."
+ "title": "BaseElementResponse"
},
- "Datasets_DatasetListResponse": {
+ "Distance_Bounds": {
"properties": {
- "datasets": {
- "items": {
- "$ref": "#/components/schemas/Datasets_DatasetSummaryResponse"
- },
- "type": "array",
- "title": "Datasets"
+ "northeast": {
+ "$ref": "#/components/schemas/Distance_LatLng"
},
- "pagination": {
- "$ref": "#/components/schemas/Datasets_Pagination"
+ "southwest": {
+ "$ref": "#/components/schemas/Distance_LatLng"
}
},
"type": "object",
"required": [
- "datasets",
- "pagination"
+ "northeast",
+ "southwest"
],
- "title": "DatasetListResponse"
+ "title": "Bounds"
},
- "Datasets_DatasetLogEntry": {
+ "Distance_DistanceResponse": {
"properties": {
- "created_at": {
- "type": "string",
- "format": "date-time",
- "title": "Created At",
- "description": "The date of the log entry."
- },
- "detail": {
+ "status": {
"type": "string",
- "title": "Detail",
- "description": "The detail of the log entry."
+ "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."
},
- "level": {
- "$ref": "#/components/schemas/Datasets_LoggerLevel",
- "description": "The level of the log entry."
+ "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": [
- "created_at",
- "detail",
- "level"
+ "status",
+ "distance"
],
- "title": "DatasetLogEntry"
+ "title": "DistanceResponse"
},
- "Datasets_DatasetResponse": {
+ "Distance_DurationDistanceResponse": {
"properties": {
- "id": {
- "type": "string",
- "format": "uuid",
- "title": "Id"
- },
- "name": {
+ "status": {
"type": "string",
- "title": "Name"
- },
- "url": {
- "anyOf": [
- {
- "type": "string",
- "maxLength": 2083,
- "minLength": 1,
- "format": "uri"
- },
- {
- "type": "null"
- }
+ "enum": [
+ "OK",
+ "NOT_FOUND",
+ "ZERO_RESULTS",
+ "ERROR"
],
- "title": "Url",
- "description": "The url of the data to fetch"
+ "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."
},
- "reimport_key": {
- "anyOf": [
- {
- "type": "string",
- "format": "uuid"
- },
- {
- "type": "null"
- }
- ],
- "title": "Reimport Key",
- "description": "The reimport key to be used with the reimport hook endpoint."
+ "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."
},
- "created_at": {
+ "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",
- "format": "date-time",
- "title": "Created At",
- "description": "The date when the dataset was created."
- },
- "updated_at": {
- "anyOf": [
- {
- "type": "string",
- "format": "date-time"
- },
- {
- "type": "null"
- }
+ "enum": [
+ "OK",
+ "NOT_FOUND",
+ "ZERO_RESULTS",
+ "ERROR"
],
- "title": "Updated At",
- "description": "The date when the dataset was last updated."
+ "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."
},
- "scheduled_for_deletion_after": {
- "anyOf": [
- {
- "type": "string",
- "format": "date"
- },
- {
- "type": "null"
- }
- ],
- "title": "Scheduled For Deletion After",
- "description": "After this date the dataset will be automatically removed"
+ "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": [
- "id",
- "name",
- "created_at",
- "updated_at"
+ "status",
+ "duration"
],
- "title": "DatasetResponse"
+ "title": "DurationResponse"
},
- "Datasets_DatasetSchemaMapping": {
+ "Distance_HTTPErrorModel": {
"properties": {
- "schema_key": {
- "$ref": "#/components/schemas/Datasets_SchemaKeys"
- },
- "data_key": {
+ "details": {
"type": "string",
- "title": "Data Key"
+ "title": "Details"
}
},
"type": "object",
"required": [
- "schema_key",
- "data_key"
+ "details"
],
- "title": "DatasetSchemaMapping",
- "description": "DatasetSchemaMapping defines a mapping between `schema_key` and user provided `data_key`."
+ "title": "HTTPErrorModel"
},
- "Datasets_DatasetStatusResponse": {
+ "Distance_HTTPValidationError": {
"properties": {
- "id": {
- "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."
- },
- "steps": {
+ "detail": {
"items": {
- "$ref": "#/components/schemas/Datasets_DatasetStatusStep"
+ "$ref": "#/components/schemas/Distance_ValidationError"
},
"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."
+ "title": "Detail"
}
},
"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"
- },
- {
- "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"
- },
- {
- "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": "HTTPValidationError"
},
- "Datasets_DatasetStatusStep": {
+ "Distance_IsochroneRequest": {
"properties": {
- "name": {
+ "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": [
- "fetch",
- "import"
+ "time",
+ "distance"
],
- "title": "Name",
- "description": "The name of the step. Currently can only be `fetch` of `import`"
+ "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": {
+ "units": {
"type": "string",
- "format": "date-time",
- "title": "Start",
- "description": "The date at which the step started."
+ "enum": [
+ "metric",
+ "imperial"
+ ],
+ "title": "Units",
+ "description": "Specifies the unit system to use when displaying results.",
+ "default": "metric"
},
- "end": {
+ "language": {
+ "type": "string",
+ "enum": [
+ "en",
+ "fr",
+ "ca",
+ "de",
+ "es",
+ "he",
+ "it",
+ "ja",
+ "nl",
+ "pl",
+ "pt",
+ "ro",
+ "ru",
+ "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",
- "format": "date-time"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "End",
- "description": "The date at which the step ended or null if in progress."
+ "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"
+ ]
},
- "entries": {
- "items": {
- "$ref": "#/components/schemas/Datasets_DatasetLogEntry"
- },
- "type": "array",
- "title": "Entries",
- "description": "The log entries for the step."
+ "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"
+ ]
},
- "status": {
- "$ref": "#/components/schemas/Datasets_Status",
- "description": "The status of the step."
+ "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": [
- "name",
- "start",
- "end",
- "entries",
- "status"
+ "origin",
+ "value"
],
- "title": "DatasetStatusStep"
+ "title": "IsochroneRequest"
},
- "Datasets_DatasetSummaryResponse": {
+ "Distance_IsochroneResponse": {
"properties": {
- "id": {
- "type": "string",
- "format": "uuid",
- "title": "Id"
- },
- "name": {
- "type": "string",
- "title": "Name"
- },
- "created_at": {
+ "status": {
"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"
- }
+ "enum": [
+ "OK",
+ "INVALID_REQUEST",
+ "MAX_ELEMENTS_EXCEEDED",
+ "MAX_ROUTE_LENGTH_EXCEEDED",
+ "REQUEST_DENIED",
+ "BACKEND_ERROR",
+ "OVER_QUERY_LIMIT",
+ "ZERO_RESULTS"
],
- "title": "Updated At",
- "description": "The date when the dataset was last updated."
+ "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"
},
- "scheduled_for_deletion_after": {
+ "isoline": {
"anyOf": [
{
- "type": "string",
- "format": "date"
+ "$ref": "#/components/schemas/Distance_IsolineResponseTime"
},
{
- "type": "null"
+ "$ref": "#/components/schemas/Distance_IsolineResponseDistance"
}
],
- "title": "Scheduled For Deletion After",
- "description": "After this date the dataset will be automatically removed"
+ "title": "Isoline"
}
},
"type": "object",
"required": [
- "id",
- "name",
- "created_at"
+ "isoline"
],
- "title": "DatasetSummaryResponse"
- },
- "Datasets_DatasetUpdate": {
- "properties": {
- "name": {
- "anyOf": [
- {
- "type": "string"
+ "title": "IsochroneResponse",
+ "examples": [
+ {
+ "isoline": {
+ "distance": {
+ "text": "1 km",
+ "value": 1
},
- {
- "type": "null"
+ "geometry": "s|ihHouuMZ`GdClCsA~QhCnQmBhEpCfF|HxGpBtFfEnBnHqJpH}AF_EeCcB@sBnEiEYiGmVyFaG{G[eFoCw@gAiIkDYg@_DwA@",
+ "origin": {
+ "lat": 48.709,
+ "lng": 2.403
}
- ],
- "title": "Name",
- "description": "The friendly name "
+ },
+ "status": "OK"
+ }
+ ]
+ },
+ "Distance_IsochroneTimeDistance": {
+ "properties": {
+ "value": {
+ "type": "integer",
+ "title": "Value"
},
- "url": {
- "anyOf": [
- {
- "type": "string",
- "maxLength": 2083,
- "minLength": 1,
- "format": "uri"
- },
- {
- "type": "null"
- }
- ],
- "title": "Url"
+ "text": {
+ "type": "string",
+ "title": "Text"
}
},
"type": "object",
- "title": "DatasetUpdate"
+ "required": [
+ "value",
+ "text"
+ ],
+ "title": "IsochroneTimeDistance"
},
- "Datasets_FeatureRead": {
+ "Distance_IsolineResponseDistance": {
"properties": {
- "id": {
+ "origin": {
+ "$ref": "#/components/schemas/Distance_LatLng",
+ "description": "The origin point of the isochrone contour."
+ },
+ "geometry": {
"type": "string",
- "format": "uuid",
- "title": "Id"
+ "title": "Geometry",
+ "description": "The polyline of the isoline (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm))."
+ },
+ "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": [
+ "origin",
+ "geometry",
+ "distance"
+ ],
+ "title": "IsolineResponseDistance"
+ },
+ "Distance_IsolineResponseTime": {
+ "properties": {
+ "origin": {
+ "$ref": "#/components/schemas/Distance_LatLng",
+ "description": "The origin point of the isochrone contour."
},
"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"
+ "type": "string",
+ "title": "Geometry",
+ "description": "The polyline of the isoline (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm))."
},
- "attributes": {
- "additionalProperties": true,
- "type": "object",
- "title": "Attributes"
+ "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": [
- "id",
+ "origin",
"geometry",
- "attributes"
+ "time"
],
- "title": "FeatureRead"
+ "title": "IsolineResponseTime"
},
- "Datasets_FeatureSummaryResponse": {
+ "Distance_LatLng": {
"properties": {
- "id": {
+ "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": [
+ "lat",
+ "lng"
+ ],
+ "title": "LatLng"
+ },
+ "Distance_MatrixDistanceDuration": {
+ "properties": {
+ "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",
+ "ca",
+ "de",
+ "es",
+ "he",
+ "it",
+ "ja",
+ "nl",
+ "pl",
+ "pt",
+ "ro",
+ "ru",
+ "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",
- "format": "uuid",
- "title": "Id",
- "description": "The feature ID."
+ "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`@:"
+ ]
},
- "geometry": {
+ "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"
},
- {
- "$ref": "#/components/schemas/Datasets_PolygonGeometry"
- },
- {
- "$ref": "#/components/schemas/Datasets_PointGeometry"
- },
{
"type": "null"
}
],
- "title": "Geometry",
- "description": "The geometry WKB base64-encoded"
+ "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"
+ ]
},
- "attributes": {
+ "departure_time": {
"anyOf": [
{
- "additionalProperties": true,
- "type": "object"
+ "type": "string"
},
{
"type": "null"
}
],
- "title": "Attributes",
- "description": "The feature attributes"
- }
- },
- "type": "object",
- "required": [
- "id"
- ],
- "title": "FeatureSummaryResponse",
- "description": "FeatureSummaryResponse represents the minimal amount of information to be able to fetch a feature details."
- },
- "Datasets_HTTPErrorModel": {
- "properties": {
- "details": {
+ "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",
- "title": "Details"
+ "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": [
- "details"
+ "origins",
+ "destinations"
],
- "title": "HTTPErrorModel"
+ "title": "MatrixRequest"
},
- "Datasets_HTTPValidationError": {
+ "Distance_MatrixResponse": {
"properties": {
- "detail": {
+ "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/Datasets_ValidationError"
+ "$ref": "#/components/schemas/Distance_MatrixRowsResponse"
},
"type": "array",
- "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."
+ "title": "Rows",
+ "description": "Contains an array of elements for each pair of origin and destination"
}
},
"type": "object",
"required": [
- "dataset_id"
+ "rows"
],
- "title": "ImportResponse"
+ "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"
+ }
+ ]
},
- "Datasets_LineStringGeometry": {
+ "Distance_MatrixRowsResponse": {
"properties": {
- "type": {
- "type": "string",
- "const": "LineString",
- "title": "Type",
- "default": "LineString"
- },
- "coordinates": {
+ "elements": {
"items": {
- "prefixItems": [
+ "anyOf": [
{
- "type": "number"
+ "$ref": "#/components/schemas/Distance_DistanceResponse"
},
{
- "type": "number"
+ "$ref": "#/components/schemas/Distance_DurationResponse"
+ },
+ {
+ "$ref": "#/components/schemas/Distance_DurationDistanceResponse"
+ },
+ {
+ "$ref": "#/components/schemas/Distance_BaseElementResponse"
}
- ],
- "type": "array",
- "maxItems": 2,
- "minItems": 2
+ ]
},
"type": "array",
- "title": "Coordinates"
+ "title": "Elements",
+ "description": "An array of each route element."
}
},
"type": "object",
"required": [
- "coordinates"
- ],
- "title": "LineStringGeometry"
- },
- "Datasets_LoggerLevel": {
- "type": "string",
- "enum": [
- "info",
- "warning",
- "error"
+ "elements"
],
- "title": "LoggerLevel"
+ "title": "MatrixRowsResponse"
},
- "Datasets_MultiLineStringGeometry": {
+ "Distance_Polyline": {
"properties": {
- "type": {
+ "points": {
"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": "Points"
}
},
"type": "object",
"required": [
- "coordinates"
+ "points"
],
- "title": "MultiLineStringGeometry"
+ "title": "Polyline"
},
- "Datasets_MultiPointGeometry": {
+ "Distance_RouteDistanceDuration": {
"properties": {
- "type": {
- "type": "string",
- "const": "MultiPoint",
- "title": "Type",
- "default": "MultiPoint"
+ "value": {
+ "type": "integer",
+ "title": "Value"
},
- "coordinates": {
- "items": {
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
- }
- ],
- "type": "array",
- "maxItems": 2,
- "minItems": 2
- },
- "type": "array",
- "title": "Coordinates"
+ "text": {
+ "type": "string",
+ "title": "Text"
}
},
"type": "object",
"required": [
- "coordinates"
+ "value",
+ "text"
],
- "title": "MultiPointGeometry"
+ "title": "RouteDistanceDuration"
},
- "Datasets_MultiPolygonGeometry": {
+ "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": {
- "type": "string",
- "const": "MultiPolygon",
- "title": "Type",
- "default": "MultiPolygon"
+ "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."
},
- "coordinates": {
- "items": {
- "items": {
- "items": {
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
- }
- ],
- "type": "array",
- "maxItems": 2,
- "minItems": 2
- },
- "type": "array"
+ "verbal_after": {
+ "anyOf": [
+ {
+ "type": "string"
},
- "type": "array"
- },
- "type": "array",
- "title": "Coordinates"
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Verbal After",
+ "description": "Text suitable for use as a verbal message immediately after the maneuver transition."
}
},
"type": "object",
- "required": [
- "coordinates"
- ],
- "title": "MultiPolygonGeometry"
+ "title": "RouteInstruction"
},
- "Datasets_Pagination": {
+ "Distance_RouteLeg": {
"properties": {
- "prev": {
+ "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"
@@ -20648,10 +20745,10 @@
"type": "null"
}
],
- "title": "Prev",
- "description": "The previous page number if any."
+ "title": "Start Waypoint",
+ "description": "The index of the waypoint that is the starting point of this leg."
},
- "next": {
+ "end_waypoint": {
"anyOf": [
{
"type": "integer"
@@ -20660,233 +20757,616 @@
"type": "null"
}
],
- "title": "Next",
- "description": "The next page number if any."
+ "title": "End Waypoint",
+ "description": "The index of the waypoint that is the ending point of this leg."
},
- "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",
- "const": "Point",
- "title": "Type",
- "default": "Point"
+ "start_address": {
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "title": "Start Address",
+ "description": "The address of the starting point of this leg."
},
- "coordinates": {
- "prefixItems": [
+ "end_address": {
+ "anyOf": [
{
- "type": "number"
+ "type": "string"
},
{
- "type": "number"
+ "type": "null"
}
],
- "type": "array",
- "maxItems": 2,
- "minItems": 2,
- "title": "Coordinates"
+ "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": [
- "coordinates"
+ "distance",
+ "duration",
+ "start_location",
+ "end_location"
],
- "title": "PointGeometry"
+ "title": "RouteLeg"
},
- "Datasets_PolygonGeometry": {
+ "Distance_RouteOption": {
"properties": {
- "type": {
+ "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",
- "const": "Polygon",
- "title": "Type",
- "default": "Polygon"
+ "title": "Notice",
+ "description": "Some noticeable information about the route."
},
- "coordinates": {
+ "legs": {
"items": {
- "items": {
- "prefixItems": [
- {
- "type": "number"
- },
- {
- "type": "number"
- }
- ],
- "type": "array",
- "maxItems": 2,
- "minItems": 2
- },
- "type": "array"
+ "$ref": "#/components/schemas/Distance_RouteLeg"
},
"type": "array",
- "title": "Coordinates"
+ "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": [
- "coordinates"
- ],
- "title": "PolygonGeometry"
- },
- "Datasets_SchemaKeys": {
- "type": "string",
- "enum": [
- "title"
+ "overview_polyline",
+ "bounds",
+ "notice",
+ "legs"
],
- "title": "SchemaKeys",
- "description": "SchemaKeys are the allowed fields to be mapped."
+ "title": "RouteOption"
},
- "Datasets_SearchRequest": {
+ "Distance_RouteResponse": {
"properties": {
- "where": {
+ "status": {
"type": "string",
- "title": "Where",
- "description": "Applies a Woosmap filter on feature attributes.",
- "examples": [
- "cost_col:>32.3"
- ]
+ "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"
+ },
+ "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": [
- "where"
+ "routes"
],
- "title": "SearchRequest"
- },
- "Datasets_SearchRequestWithGeometry": {
- "properties": {
- "geometry": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/Datasets_PointGeometry"
- },
- {
- "$ref": "#/components/schemas/Datasets_LineStringGeometry"
- },
+ "title": "RouteResponse",
+ "examples": [
+ {
+ "routes": [
{
- "$ref": "#/components/schemas/Datasets_PolygonGeometry"
+ "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": "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 "
+ "status": "OK"
+ }
+ ]
+ },
+ "Distance_RouteStep": {
+ "properties": {
+ "distance": {
+ "type": "string",
+ "title": "Distance",
+ "description": "The distance as text covered by this step until the next step."
},
- "buffer": {
+ "duration": {
+ "type": "string",
+ "title": "Duration",
+ "description": "The typical time as text required until the next step."
+ },
+ "polyline": {
+ "type": "string",
+ "title": "Polyline",
+ "description": "The polyline of the step (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm))."
+ },
+ "start_location": {
+ "$ref": "#/components/schemas/Distance_LatLng",
+ "description": "The starting location of this step."
+ },
+ "end_location": {
+ "$ref": "#/components/schemas/Distance_LatLng",
+ "description": "The ending location of this step."
+ },
+ "travel_mode": {
+ "type": "string",
+ "title": "Travel Mode",
+ "description": "The travel mode of this step."
+ },
+ "instructions": {
"anyOf": [
{
- "type": "number"
+ "$ref": "#/components/schemas/Distance_RouteInstruction"
},
{
"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"
- ]
+ "description": "The maneuver instructions for this step."
}
},
"type": "object",
"required": [
- "geometry"
+ "distance",
+ "duration",
+ "polyline",
+ "start_location",
+ "end_location",
+ "travel_mode"
],
- "title": "SearchRequestWithGeometry",
- "description": "Subclass with the Point, LineString & Polygon geometry type"
+ "title": "RouteStep"
},
- "Datasets_SearchRequestWithPolygonGeometry": {
+ "Distance_TollLeg": {
"properties": {
- "geometry": {
- "anyOf": [
- {
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/Datasets_PolygonGeometry"
- }
- ],
- "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 "
+ "distance": {
+ "$ref": "#/components/schemas/Distance_RouteDistanceDuration"
},
- "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)."
+ "duration": {
+ "$ref": "#/components/schemas/Distance_RouteDistanceDuration"
},
- "where": {
- "type": "string",
- "title": "Where",
- "description": "Applies a Woosmap filter on feature attributes.",
- "examples": [
- "cost_col:>32.3"
- ]
+ "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": [
- "geometry"
+ "distance",
+ "duration",
+ "start_location",
+ "end_location",
+ "tolls",
+ "tollSystems"
],
- "title": "SearchRequestWithPolygonGeometry",
- "description": "Subclass with the Polygon geometry type"
+ "title": "TollLeg"
},
- "Datasets_SearchResultResponse": {
+ "Distance_TollStep": {
+ "properties": {},
+ "additionalProperties": true,
+ "type": "object",
+ "title": "TollStep"
+ },
+ "Distance_TollSystem": {
+ "properties": {},
+ "additionalProperties": true,
+ "type": "object",
+ "title": "TollSystem"
+ },
+ "Distance_TollsResponse": {
"properties": {
- "features": {
+ "status": {
+ "type": "string",
+ "title": "Status"
+ },
+ "routes": {
"items": {
- "$ref": "#/components/schemas/Datasets_FeatureSummaryResponse"
+ "$ref": "#/components/schemas/Distance_TollsRoute"
},
"type": "array",
- "title": "Features",
- "description": "The list of FeatureSummaryResponse that matched the search"
- },
- "pagination": {
- "$ref": "#/components/schemas/Datasets_Pagination",
- "description": "The pagination information"
+ "title": "Routes"
}
},
"type": "object",
"required": [
- "features",
- "pagination"
+ "status",
+ "routes"
],
- "title": "SearchResultResponse"
+ "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
+ ]
+ }
+ ]
+ }
+ ],
+ "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"
+ }
+ ]
},
- "Datasets_Status": {
- "type": "string",
- "enum": [
- "success",
- "in_progress",
- "failed"
+ "Distance_TollsRoute": {
+ "properties": {
+ "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": "Status"
+ "title": "TollsRoute"
},
- "Datasets_ValidationError": {
+ "Distance_ValidationError": {
"properties": {
"loc": {
"items": {
@@ -21064,7 +21544,60 @@
"in": "header",
"name": "X-Api-Key",
"x-displayName": "PrivateApiKeyHeader"
+ },
+ "Distance_PublicAPIKey": {
+ "type": "apiKey",
+ "description": "Public key of the project usually starts with `woos-`",
+ "in": "query",
+ "name": "key",
+ "x-displayName": "PublicAPIKey"
+ },
+ "Distance_PrivateApiKey": {
+ "type": "apiKey",
+ "description": "Private key with or without write permission.",
+ "in": "query",
+ "name": "private_key",
+ "x-displayName": "PrivateApiKey"
+ },
+ "Distance_PrivateApiKeyHeader": {
+ "type": "apiKey",
+ "description": "Private key with or without write permission.",
+ "in": "header",
+ "name": "X-Api-Key",
+ "x-displayName": "PrivateApiKeyHeader"
}
}
- }
+ },
+ "x-tagGroups": [
+ {
+ "name": "Search",
+ "tags": [
+ "Store Search API",
+ "Data Management API",
+ "Geolocation API",
+ "Localities API",
+ "Address API",
+ "Datasets API",
+ "Woosmap for what3words API",
+ "Zones API"
+ ]
+ },
+ {
+ "name": "Map",
+ "tags": [
+ "Static Map API",
+ "Indoor API"
+ ]
+ },
+ {
+ "name": "Route",
+ "tags": [
+ "Route API",
+ "Matrix API",
+ "Transit API",
+ "Isochrone API",
+ "Tolls API"
+ ]
+ }
+ ]
}
\ No newline at end of file
diff --git a/dist/woosmap-openapi3.json b/dist/woosmap-openapi3.json
index 75646aa1..fc8f7381 100755
--- a/dist/woosmap-openapi3.json
+++ b/dist/woosmap-openapi3.json
@@ -65,13 +65,6 @@
"url": "https://developers.woosmap.com/products/address-api/get-started/"
}
},
- {
- "name": "Distance API",
- "description": "Woosmap Distance API is a service providing road travel distance and duration calculations, on a Worldwide scale. Request is done over HTTPS using GET or POST. 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/distance-api/get-started/"
- }
- },
{
"name": "Zones API",
"description": "Woosmap Zones API is a web service that uses an HTTP request to manage, create or edit your Zones (polygons) attached to your assets.\nThe general principle is that sometimes searching assets using crowfly distance is not good enough. For example to search the restaurant that will do the delivery for a specified address, each restaurant has a delivery zone and for topological or business reasons it’s not always the nearest restaurant in charge of your delivery. Woosmap Zones API allows you to associate a delivery zone to each of the restaurants.\n",
@@ -5151,3098 +5144,660 @@
}
]
}
- },
- "/distance/distancematrix/json": {
- "get": {
- "summary": "Distance Matrix",
- "operationId": "getDistanceMatrix",
- "servers": [
- {
- "url": "https://api.woosmap.com"
- }
- ],
- "tags": [
- "Distance API"
- ],
- "description": "Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode.\n",
- "security": [
- {
- "PublicApiKeyAuth": [],
- "RefererHeader": []
- },
- {
- "PrivateApiKeyAuth": []
- },
- {
- "PrivateApiKeyHeaderAuth": []
- }
- ],
- "parameters": [
- {
- "$ref": "#/components/parameters/origins"
- },
- {
- "$ref": "#/components/parameters/destinations"
- },
- {
- "$ref": "#/components/parameters/mode"
- },
- {
- "$ref": "#/components/parameters/language-4"
- },
- {
- "$ref": "#/components/parameters/units"
- },
- {
- "$ref": "#/components/parameters/elements"
- },
- {
- "$ref": "#/components/parameters/method"
- },
- {
- "$ref": "#/components/parameters/avoid"
- },
- {
- "$ref": "#/components/parameters/departure_time"
- }
- ],
- "responses": {
- "200": {
- "description": "Distance Matrix successfully retrieved",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DistanceMatrixResponse"
- },
- "examples": {
- "default": {
- "summary": "Distance Matrix Result for driving from origins `48.709,2.403` to destinations `48.709,2.303|48.768,2.338`,",
- "value": {
- "status": "OK",
- "rows": [
- {
- "elements": [
- {
- "status": "OK",
- "duration": {
- "value": 978,
- "text": "16 mins"
- },
- "distance": {
- "value": 10796,
- "text": "10.8 km"
- }
- },
- {
- "status": "OK",
- "duration": {
- "value": 942,
- "text": "16 mins"
- },
- "distance": {
- "value": 10322,
- "text": "10.3 km"
- }
- }
- ]
- }
- ]
- }
- }
- }
- }
- }
- },
- "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"
- }
- }
- }
- }
- }
- }
+ }
+ },
+ "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"
+ }
+ },
+ "limit": {
+ "name": "limit",
+ "description": "To limit number of assets retrieved from an IP location.\n",
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 300,
+ "example": 10
},
- "x-codeSamples": [
- {
- "lang": "curl",
- "label": "cURL",
- "source": "curl -L 'https://api.woosmap.com/distance/distancematrix/json?origins=48.709%2C2.403&destinations=48.709%2C2.303%7C48.768%2C2.338&mode=driving&language=en&elements=duration_distance&method=distance&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/distance/distancematrix/json?origins=48.709%2C2.403&destinations=48.709%2C2.303%7C48.768%2C2.338&mode=driving&language=en&elements=duration_distance&method=distance&key=YOUR_PUBLIC_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/distance/distancematrix/json?origins=48.709%2C2.403&destinations=48.709%2C2.303%7C48.768%2C2.338&mode=driving&language=en&elements=duration_distance&method=distance&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"
- }
- ]
+ "in": "query"
},
- "post": {
- "summary": "Distance Matrix using POST",
- "operationId": "postDistanceMatrix",
- "servers": [
- {
- "url": "https://api.woosmap.com"
- }
- ],
- "tags": [
- "Distance API"
- ],
- "description": "Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode. If the URL size is too short for your origins and destinations, you should request the server using this POST method and passing arguments as json.\n",
- "security": [
- {
- "PublicApiKeyAuth": [],
- "RefererHeader": []
- },
- {
- "PrivateApiKeyAuth": []
- },
- {
- "PrivateApiKeyHeaderAuth": []
- }
- ],
- "requestBody": {
- "description": "The request body of Distance Matrix must be formatted as JSON.",
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DistanceMatrixRequest"
- },
- "examples": {
- "default": {
- "summary": "Request as a JSON for a distance matrix call",
- "value": {
- "origins": "48.73534,2.368308|48.73534,2.368308",
- "destinations": "48.83534,2.368308",
- "units": "imperial",
- "elements": "duration_distance",
- "method": "distance",
- "departure_time": "now"
- }
- }
- }
- }
- }
+ "query": {
+ "name": "query",
+ "in": "query",
+ "schema": {
+ "type": "string",
+ "example": "name:'My cool store'|type:'click_and_collect'"
},
- "responses": {
- "200": {
- "description": "Distance Matrix with POST successfully retrieved",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DistanceMatrixResponse"
- },
- "examples": {
- "default": {
- "summary": "Distance Matrix Result for driving from origins `48.73534,2.368308|48.73534,2.368308` to destinations `48.83534,2.368308`,",
- "value": {
- "status": "OK",
- "rows": [
- {
- "elements": [
- {
- "status": "OK",
- "duration": {
- "value": 978,
- "text": "16 mins"
- },
- "distance": {
- "value": 10796,
- "text": "10.8 km"
- }
- },
- {
- "status": "OK",
- "duration": {
- "value": 942,
- "text": "16 mins"
- },
- "distance": {
- "value": 10322,
- "text": "10.3 km"
- }
- }
- ]
- }
- ]
- }
- }
- }
- }
- }
- },
- "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."
- }
- }
- }
- }
- }
- },
- "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/distance/distancematrix/json?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"origins\": \"48.73534,2.368308|48.73534,2.368308\",\n \"destinations\": \"48.83534,2.368308\",\n \"units\": \"imperial\",\n \"elements\": \"duration_distance\",\n \"method\": \"distance\",\n \"departure_time\": \"now\"\n}'"
- },
- {
- "lang": "python",
- "label": "Python",
- "source": "import requests\nimport json\n\nurl = \"https://api.woosmap.com/distance/distancematrix/json?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"origins\": \"48.73534,2.368308|48.73534,2.368308\",\n \"destinations\": \"48.83534,2.368308\",\n \"units\": \"imperial\",\n \"elements\": \"duration_distance\",\n \"method\": \"distance\",\n \"departure_time\": \"now\"\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 \"origins\": \"48.73534,2.368308|48.73534,2.368308\",\n \"destinations\": \"48.83534,2.368308\",\n \"units\": \"imperial\",\n \"elements\": \"duration_distance\",\n \"method\": \"distance\",\n \"departure_time\": \"now\"\n});\n\nlet config = {\n method: 'post',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/distance/distancematrix/json?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"
- }
- ]
- }
- },
- "/distance/route/json": {
- "get": {
- "summary": "Route",
- "operationId": "getRoute",
- "servers": [
- {
- "url": "https://api.woosmap.com"
- }
- ],
- "tags": [
- "Distance API"
- ],
- "description": "Get distance, duration and path (as a polyline) for a pair of origin and destination, based on the recommended route between those two points for a specified travel mode.\n",
- "security": [
- {
- "PublicApiKeyAuth": [],
- "RefererHeader": []
- },
- {
- "PrivateApiKeyAuth": []
- },
- {
- "PrivateApiKeyHeaderAuth": []
- }
- ],
- "parameters": [
- {
- "$ref": "#/components/parameters/origin"
- },
- {
- "$ref": "#/components/parameters/destination"
- },
- {
- "$ref": "#/components/parameters/mode"
- },
- {
- "$ref": "#/components/parameters/language-4"
- },
- {
- "$ref": "#/components/parameters/units"
- },
- {
- "$ref": "#/components/parameters/alternatives"
- },
- {
- "$ref": "#/components/parameters/waypoints"
- },
- {
- "$ref": "#/components/parameters/method"
- },
- {
- "$ref": "#/components/parameters/details"
- },
- {
- "$ref": "#/components/parameters/avoid"
- },
- {
- "$ref": "#/components/parameters/departure_time"
- },
- {
- "$ref": "#/components/parameters/arrival_time"
- }
- ],
- "responses": {
- "200": {
- "description": "Route successfully retrieved",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DistanceRouteResponse"
- },
- "examples": {
- "default": {
- "summary": "Distance Route Result for driving from origin `49.31067,4.14525` to destination `49.31344,4.15293` and retrieving alternatives routes.",
- "value": {
- "status": "OK",
- "routes": [
- {
- "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@eAHO"
- },
- "bounds": {
- "northeast": {
- "lat": 49.315678,
- "lng": 4.152915
- },
- "southwest": {
- "lat": 49.31073,
- "lng": 4.145162
- }
- },
- "notice": "",
- "legs": [
- {
- "distance": {
- "text": "1 km",
- "value": 1038
- },
- "duration": {
- "text": "1 min",
- "value": 75
- },
- "start_location": {
- "lat": 49.31067,
- "lng": 4.14525
- },
- "end_location": {
- "lat": 49.31344,
- "lng": 4.15293
- },
- "start_waypoint": 0,
- "end_waypoint": 1,
- "end_address": "D 30",
- "start_address": "D 151",
- "steps": [
- {
- "distance": "676 m",
- "duration": "1 min",
- "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
- },
- "end_location": {
- "lat": 49.315679,
- "lng": 4.149621
- },
- "travel_mode": "DRIVING",
- "instructions": {
- "action": 2,
- "summary": "Drive northeast on D 151.",
- "verbal_succint": "Drive northeast. Then Enter the roundabout and take the 2nd exit onto D 30.",
- "verbal_before": "Drive northeast on D 151. Then Enter the roundabout and take the 2nd exit onto D 30.",
- "verbal_after": "Continue for 700 meters."
- }
- },
- {
- "distance": "22 m",
- "duration": "1 min",
- "polyline": "}}~kHcniXBIBU?W",
- "start_location": {
- "lat": 49.315679,
- "lng": 4.149621
- },
- "end_location": {
- "lat": 49.31563,
- "lng": 4.149905
- },
- "travel_mode": "DRIVING",
- "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_succint": "Enter the roundabout and take the 2nd exit.",
- "verbal_before": "Enter the roundabout and take the 2nd exit onto D 30."
- }
- },
- {
- "distance": "198 m",
- "duration": "1 min",
- "polyline": "u}~kH{oiXFWDOLUP[P]j@y@^g@`@i@NUNONMJKJIFELC",
- "start_location": {
- "lat": 49.31563,
- "lng": 4.149905
- },
- "end_location": {
- "lat": 49.314292,
- "lng": 4.151623
- },
- "travel_mode": "DRIVING",
- "instructions": {
- "action": 27,
- "summary": "Exit the roundabout onto D 30.",
- "verbal_succint": "Exit the roundabout.",
- "verbal_before": "Exit the roundabout onto D 30.",
- "verbal_after": "Continue for 200 meters."
- }
- },
- {
- "distance": "46 m",
- "duration": "1 min",
- "polyline": "iu~kHsziXJBJAHGFIDMBSAS",
- "start_location": {
- "lat": 49.314292,
- "lng": 4.151623
- },
- "end_location": {
- "lat": 49.314041,
- "lng": 4.151976
- },
- "travel_mode": "DRIVING",
- "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_succint": "Enter the roundabout and take the 2nd exit.",
- "verbal_before": "Enter the roundabout and take the 2nd exit onto D 30."
- }
- },
- {
- "distance": "96 m",
- "duration": "1 min",
- "polyline": "ws~kHy|iXBKDILURa@LWt@eAHO",
- "start_location": {
- "lat": 49.314041,
- "lng": 4.151976
- },
- "end_location": {
- "lat": 49.313431,
- "lng": 4.152916
- },
- "travel_mode": "DRIVING",
- "instructions": {
- "action": 27,
- "summary": "Exit the roundabout onto D 30.",
- "verbal_succint": "Exit the roundabout. Then, in 100 meters, You will arrive at your destination.",
- "verbal_before": "Exit the roundabout onto D 30. Then, in 100 meters, You will arrive at your destination.",
- "verbal_after": "Continue for 100 meters."
- }
- },
- {
- "distance": "1 m",
- "duration": "1 min",
- "polyline": "}o~kHubjX",
- "start_location": {
- "lat": 49.313431,
- "lng": 4.152916
- },
- "end_location": {
- "lat": 49.313431,
- "lng": 4.152916
- },
- "travel_mode": "DRIVING",
- "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."
- }
- }
- ]
- }
- ],
- "main_route_name": "D 151",
- "recommended": true
- }
- ]
- }
- }
- }
- }
- }
- },
- "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/distance/route/json?origin=49.31067%2C4.14525&destination=49.31344%2C4.15293&mode=driving&language=en&alternatives=true&method=distance&details=full&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/distance/route/json?origin=49.31067%2C4.14525&destination=49.31344%2C4.15293&mode=driving&language=en&alternatives=true&method=distance&details=full&key=YOUR_PUBLIC_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/distance/route/json?origin=49.31067%2C4.14525&destination=49.31344%2C4.15293&mode=driving&language=en&alternatives=true&method=distance&details=full&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"
- }
- ]
- }
- },
- "/distance/tolls/json": {
- "get": {
- "summary": "Tolls",
- "operationId": "getTolls",
- "servers": [
- {
- "url": "https://api.woosmap.com"
- }
- ],
- "tags": [
- "Distance API"
- ],
- "description": "Get Tolls\n",
- "security": [
- {
- "PublicApiKeyAuth": [],
- "RefererHeader": []
- },
- {
- "PrivateApiKeyAuth": []
- },
- {
- "PrivateApiKeyHeaderAuth": []
- }
- ],
- "parameters": [
- {
- "$ref": "#/components/parameters/origin"
- },
- {
- "$ref": "#/components/parameters/destination"
- },
- {
- "$ref": "#/components/parameters/mode"
- },
- {
- "$ref": "#/components/parameters/language-4"
- },
- {
- "$ref": "#/components/parameters/units"
- },
- {
- "$ref": "#/components/parameters/alternatives"
- },
- {
- "$ref": "#/components/parameters/waypoints"
- },
- {
- "$ref": "#/components/parameters/method"
- },
- {
- "$ref": "#/components/parameters/departure_time"
- },
- {
- "$ref": "#/components/parameters/arrival_time"
- }
- ],
- "responses": {
- "200": {
- "description": "Tolls successfully retrieved",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DistanceTollsResponse"
- },
- "examples": {
- "default": {
- "summary": "Distance Tolls Result for driving by car from origin `Lunel, France` to `Lyon, France`",
- "value": {
- "status": "OK",
- "routes": [
- {
- "legs": [
- {
- "distance": {
- "value": 272304,
- "text": "272 km"
- },
- "duration": {
- "value": 8834,
- "text": "2 hours 27 mins"
- },
- "start_location": {
- "lat": 43.7037562,
- "lng": 4.1217688
- },
- "end_location": {
- "lat": 45.7196995,
- "lng": 4.848819
- },
- "tolls": [
- {
- "countryCode": "FRA",
- "tollSystemRef": 0,
- "tollSystem": "ASF",
- "tollSystems": [
- 0
- ],
- "fares": [
- {
- "id": "e4626716-1e29-4f9a-905a-19f0376cfb38",
- "name": "ASF",
- "price": {
- "type": "value",
- "currency": "EUR",
- "value": 28.9
- },
- "reason": "toll",
- "paymentMethods": [
- "cash",
- "bankCard",
- "creditCard",
- "transponder",
- "travelCard"
- ],
- "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": [
- {
- "name": "MONTPELLIER (M.EST)",
- "location": {
- "lat": 43.70291,
- "lng": 4.11982
- }
- },
- {
- "name": "VIENNE",
- "location": {
- "lat": 45.4761,
- "lng": 4.83378
- }
- }
- ]
- }
- ],
- "tollSystems": [
- {
- "id": 7607,
- "name": "ASF"
- }
- ]
- }
- ],
- "bounds": {
- "northeast": {
- "lat": 45.7197,
- "lng": 4.89669
- },
- "southwest": {
- "lat": 43.7022,
- "lng": 4.11696
- }
- },
- "overview_polyline": {
- "points": "m{viG_`dXDGLUDU@a@C]GUGMOOOEQCQDMFMPGPGf@@\\H\\HPJHNF\\@N?RFTNNTVh@Rh@Nl@^zBXlAb@|A\\~@\\t@Rx@RhADl@?VCd@EZGTKRUZUL]FM?MCQISOcAaA]WwF{HcDoEgA}AkBoCeCyDuE_IqEkIoEiI_@s@gBiDmCkFkC_FmRw^sB_Ea@w@c@y@sDcHuH{NyDwH}AeD{AoDy@uBmBuFiAuDeA{DiAcFOq@w@eEk@cDs@iFo@}Fo@iI[oGSaHGmFCyEGaXGmHG}DKkEKmDWqG_@qHa@wGi@aHMsAMsAk@mGK}@i@yEKu@_@uCAKWgBU}ASoAUwAWaBgAkGm@iDWoAy@cDaAkDiAeDcAgCeAaCoAcCmAuBaCqDsAcB}@eA_BaBq@m@aCoBgBoAgBeAaAg@iBy@w@[}Bu@sM}D_Cy@gEiBmCuAaBaAwDcCs@i@sBcByAsAiBeBwB_CiBwBqCwDoAiBoCsEgAqBoBgEqAyCmA_DiAcDgAeDc@{Aq@aCu@}CQw@_AwEc@gCy@oFi@{EUgCUyCWsEOkDO{GAkHBsEB_BFoBLiDNsCf@{Hx@qLTsCdI{iAj@}INeEFcGAkDGyCUiFSqCk@cFQqA]uBw@}Dq@mCoAoEa@mAi@wAyAkDm@qAWe@}AmCw@iAgBcCoA{A_C_CwKyJaEkDiL_KsHwGwC_CsE_D_DkBmBcAmEcCeBkAwBcByAqAq@o@}AgB}AoBuAsBk@_AyAmCaAqBuAiDq@sB{@{CeDmL{@sCmB{FuBwF{BaFuAqC{@_BuBmDaBeCqBqCw@cAwAeBgAmA{CyCgD_D_BsAoC_CyG{FyByBuB_CmCaDcByBgCuDoBcDcIsNk@_A_BgCu@eAcByBmB{BaEmE_GiG_DcDwD}DmBmBsAuAcB}AoCcCcA}@s@k@}CcCgDeC{FcEuAeAmAiAmAiAuAyAiAsAe@o@sAoB}@{Au@uAw@_Bq@}AoAgDa@oAiAeEm@sCa@wB]yBUiBi@wEYuCg@{EEe@K_AGk@y@uHYeCGe@}AcMi@qDOaAeBoK{AcIwDiQwC}LqD}NkAaF}@_EuAmGo@sC_ByIWaBq@oD]oB[yBw@cFo@oDi@uDcBiKkB_LSqAw@yEc@_CcAyFo@iDiA{Fm@aDmA_GsDuPGYoCeL_CcJqAwEw@sC_DuKoC}ImCmIgAcDmAiDyDmKaDqIeDiI_@{@Ui@eAkCeEwJuSoe@iFyLmCsGkDwI}FsOSk@kE_MoHoTgDsJSi@]}@gBgEyA_Ds@uA_BsCq@gAaCkD{BqCe@k@cDeDaB{AgA_AyBcBoAy@mBgAsBiAiEyBm@YsB{@aD}As@[eFaC_Bw@gCuA{B{AqCuBwBgByLsKmC_C_EoDgB_B_Ay@qO_NyFkFoAiAyE_E{I_IOMkSsQyDoDi@g@s@s@qCuCyBgCaDcEcCkDuBeDqBmDeC{EsAuCkBsEWq@{@}BgA{CmAqDcLg^wDuLiBaGe@wAuAmEwAsEwAwEgAyDgBgHw@uDq@wDqA{JW_CUaC_@iFc@}JQiH_@}RMeEWuGI}AWuD}@mK[_DeA{Im@qEeAmH}@sFs@cEeAsFkCaM_@cB{B_J_AmDiC_JcAcDuCuIwCcImAcDmCmG}BgFcCiFyCcGwCmFiB_DcDiFsEcHuHgLwC}EwAkCiBwDuBeF{AmEe@yAoAmE_BwG_AsEy@wEc@qCIk@w@iG{@_Ji@kHa@gG}@uOm@qJ_@cH]eGGoAi@qJGaAg@kIqAyUIuAEs@e@wHiAuO_@sEUyBi@_Fk@iEgAcHy@uEs@sDEQwAiGkAsEiA_Eu@cCwDaL{AaEuCmHeEwIkCkFiCuEcBuCkAmBsFoIgNyRiCqDeD_F_A}AkGaLuAcCy@{AcEsH}AsC[k@_Tc`@{@yAyFiKkDiGmCqE}A_CcDsEuBkCuBcC{BcCaAeA}BcCa@c@c@e@s@w@yAaBsD}EgBkC}AgC}C_GgA{BqBiE}AoD}BcF}BaFiA}B{Pg[aD}Fu@oAmIcOmB{CoAcByAeBuCwC_Aw@uAcAeBeAqDsBgFmCoCyAeC{AkCgBy@o@q@g@}AqA_EuDsCuC}CeDmEcF_D{D}CaEuEsGsCkEwDiGwD{G_@o@u@yAmA}BuAgCgBoDcAmBuAqCqBuDy@}A_BuC{CaFoBcDuFqIgK}NuB_DeA_BwBkDaAeBmCeF{AaDaCqF{ByFwBwFyBgGoAcD_C{FyAcD_AqByA_DcDyGaDaHwCaH{BaGsB{FiBuFmA_E}GmUqC{IaD_JoBcFqCuGaAyBmEiJoCmF_ByCcEmHyC_FcEqGkBuC_AsAsAoBm@y@eEwFeBcCqC_EiAeBkCiEm@eAm@gAuBgEkAyB_BiDmAuCyGuPeBiEm@yA]w@aCaFg@eA}AqCgB}CgCaEwCgEeEoFkByBqFcGwHkIsCkDmBgCcCiDeBoCw@mAcDmFyCqFsB}D}AcD_AuBy@wB}@mCq@_C_AcEe@gC[oB_@kCeAiIy@kFkAyFi@qBc@sAkBaFe@eAsAmCmAuBoBwCu@cAwCyDoFmHiBgCgAaBgDmFqBeDgB_DmCeFoB}D}B}E}AoDaA_CeEyKkAcDqBeGoBsGkBsG_E_OiBsGiBuFoAiDk@sAuAyC}AsCeBiCmCqDoAwAqBqBaA{@kCoBkBmAcCqAcAe@cAa@cA[gA[gAWkCe@kAOkCOmAEeA?oCHmAHkCViCZgFh@qBLaBFkBD}@CaAEeAK{@KiASmAYy@Y{Bw@aAc@c@QiCqAmE{BeEiBo@SqCm@cAO{AMw@Iu@C{A?yBD_AF}BVaCh@gAZeCx@cAb@uDzAgC`AeA\\eCp@cARyC`@w@FmADmC@}@CmCQqAQ{@OcAUiCs@oDsA{@]cBq@o@WsAm@iGgC_IcDi@S{@a@kQsH_FcCuBeA_CsAqD_CeCeB}BgB_CmB{BuBMMoBiBe@c@mAyAaBiB_AgAyEgG}KgO{BwCaCwC_@e@qCcDwBaCwA{A_DoCiCqBiBoAyA_A}BoAiAi@aBw@wCiAgCy@QGy@SwCs@}Cm@sB[iH}@cAIkBQ{D[}He@sCMo@?uE?aCDkF^u@HqBXkDn@iAViCn@mAb@y@PqBd@cDr@gC^cBR}ADmBB}BAeBKo@E}@MyAUuA[oBk@yAi@qCkA}DmBgG{CmB_AoBy@q@WgE}AqBm@sCs@{Be@mASiDa@oAIwAE_A?eBFuARiBd@k@RiB~@]Pu@j@]Tk@f@e@f@gAvAgA~Aa@p@wCxFcEbJkCnFq@rAcAjBs@hA{CzE}@fAgAnAyAxAYXo@j@_BrA}BbB}@l@cBbAsHjEkEbCoKjGoBbA}BbAq@XwChAoCjAm@VgHnCgBp@a@NcBf@c@TiGfCqDpAsLtEuJpDuDxAmAh@aBv@q@^yFlDmAz@eAt@qBnAmBpAmBlAmBpAkD|B{HdF{E~CaLpHeDtBmMxI{DhC[TmGdEuc@xYiAv@{FtDeGlEyBdBwD`DgE|DsDpDiBnBqElFqE|FmBlCiCxDqEjHcBvCaCnEIN{ChGaDhHuElLqBjFk@zAgCxGkBrEqArC}BtEq@nAiCbEkBdCmAvAeAfAkAdAgCpBqBjAmAn@gAf@{Bz@kBh@oB`@gAPiCVyCL_B@kC?yIMkCFyADwBNkAL_ANuB`@q@N{@RmA\\aAZoAf@kBx@{BlAsAx@wCrBwAhAmAfAeC`CmAnAaAbAiBrB}AfBcJzKuCfDsD|DuDnD{@r@uAhAwDrCiBnAiBhAoAr@}Ax@}HrDmJdEiDvA}Ap@kDrAyC`AgAXsCj@sATeBNsCPyDFqBEkCMqBOiSuBiBSiHu@mDg@uAYeBa@wBm@sBs@{CsAkBcAmAu@gMgIkTwN_SoMwDgC_C}Aa_@mVez@mj@yIgGsFcEcG_F{FiFyBuBsIqIwNeOm@m@}@_AkHqH{GaHqFqFwBoB{BeBw@k@aC}AeCuA_CgAaDoAaA[gAYkEaAeAOuBYgBOaFUiAEaGOgACw@Ac@Ac@?iEM_Sa@iCCmC@eBFoBHqALwAPeBZwAVwA^iA\\wAf@eBp@aBt@sDfBwJhF{FtCoFjCmD|AmBt@iBp@mDfAsA^cEdAiB\\mEt@{C`@kBR}@JoDZaDPmQnAaEV_OdAyG^oI`@_FRoDJgGRwGLoDDeJHiC@wX?iGCkMBoAByBFuCDiCFsBFa@BiADiHb@mBLsBN{Iz@iD`@mDd@iGbAcF|@qLbC{M|CgKxBoEv@uDl@uEn@gIz@sE`@gk@vEcCPmDXmD\\i`@`DcCT{Jv@oFd@gIl@gHf@_CNqJf@qELgB@yDD_HEaBCwDKwBKsBGsAKcEYkBQmBQgCYaH_AiEs@kAUk@Ki@Ke@I]ImCi@mEiAaHmBaEoAyHsC_DqAuDaBkAk@{F{CcHeEm@[oBoAyAeAsB{AyHoG}AuA_CuBeIcIiHeIkC{CcBuBk@q@yBiCmBuBqBsBsBsBgD}CgDoCyAiAaBkAgAw@mD{BoBiAeEwB}As@cCcAeE{AiCy@yC{@mCo@mE{@y@UcF_A_F_AkN{CuD{@oGgBcAY_AYUGqDiAwE_BeA]aBk@eEcBeBs@sEoBsDaBkFmCk@[gIkE{SuLqDmByCyAqCoAyEgBuFiB}Bk@mBe@{E_AuB[iEi@aCSaDSqEQwAEwCC}CCoIIeHIsJMoDGaLI{FIuDGaCEkX[mACuHW_Fa@iBSaEk@kASiDq@kAW_EkAiCy@aC{@w@YyAm@yCsAqBcAeFsCwDeC{AeAiFgE}AsAyAuAqCqC}@_Ao@u@oAwAsD{Ek@s@_@k@_AsAyBgDwC_Fs@kAwFiKaIsOgBeDmD_HwB{D}CqFaBmCiCaEyAyBcGeIaCyC{AgBeCqC_DgDeCeC{GiGwFsEqDkCmCkB_DqB_JiFo@]gFeCcCeA_CaAq@YqAg@_C_AsB{@cRyGkPqFu@UoImCQGoBm@uHyBkA]cMiDgHeBqEw@iCc@aEe@cDW{AIgEM_DGeD?wEFmCDgGTeFVwE\\sALwLlAuG|@_BVcKhByE`AsFrAyCt@eGdB{IpCe[rKgQhGWHq@VcLzDuE`B]Jg@PuAh@kAb@mHtC_Ab@aEbBiKvEsAp@sCtAeItDcEfB{DzAiDnAuBr@yDjA{Bl@{EhAeCn@aCd@qIxAsBZqBVsDb@aGj@oDXqDVmGZeFPwDHcEDmIBcHAoNCa@?uMCgQLaNRkJTsJZ_Md@yOx@mIXiCH_@?c@@oGBaCAkEIcFQsE[kHs@_@CwB[iC]{E{@oFiASESC{Bi@iEgAcJsBmGsAkFeAkDm@kEq@yGy@uCYsFc@uCWaJg@s@AsG[iE]q@EYA{@?wC?mCM_S{@s@CcGO}BMcBIkDMgEKmBC}B?yCDgAD_EVeBPkBVqB\\uDv@iCr@_Cv@mBr@gBt@mAj@yAt@cAj@{CfBsSdN}D~BiGfDsEtBwB|@}Aj@wFjBu@VeCr@}Bh@gCj@yDv@oEv@aJxAqHpA_MtBy@LkC\\uGx@kFh@cAHwF\\oDPqHLuDB{GGeEIgGWw@GwCOoSwA{Jw@yDa@gDi@y@MkCm@{Aa@qA[aCu@cEoAeF}AuAc@qFsAmEy@{B]aAKeCUyAKcEOoDC}B?aCFy@D_Kl@gBNmIf@sCJcEFcA?mFIoDQsAKcCWeC]sB[kBa@_B_@{Cw@sBo@qBq@}B_AsF_C_Bo@aGoCw@]qFeCkAg@yBaAeAc@u@[cNkGqAm@eCiAy@[kGqC_DuAm@[gJmEkDgB{CaBq@_@kBeAUMwBsAgFiDoA}@wDuCqF{EoBoBgAiA{@aAmCaD{CeEeBiCgEkH_B_Dy@gBwCeHuAyDQg@cAaDgBiGkB_IyAuHmAgH_Fc\\sA}HcAiF}@{DgA_E]kAaBiFa@kA_AcCu@iBs@_BaAwBkA_CeB_DoAwBoAmBmBmC_CwCY]]a@yB_C_B}AmFwEsD{CiUwQoQ{NuMmKcNsKaGiEoFmDcF{CuDqBqCuAkAi@o@[_EeBsAi@iE}A_IiC}MgE{FcBsEoAwBi@cBc@eDs@gEy@cCe@uQuCoFw@_m@iJs]gFkC]oWqDwFw@qC_@gd@gGgGw@yGw@uEc@iCSeDQeBGaCG{CEkA?{FFkDJwDRYBkE\\eBPg@FcH|@_QfCuDd@cEb@g@BsCRcDL}BB}E?yDKaCK}@G_CScCWuCa@qF_AsCm@YKUGiF{Ae@OsFiBgIuCg@Q{h@aRoE}AmG{ByCcA_A[s@Ww@Y_Cw@cA]mC_AiDaAyAc@oKoCsDo@mB]{AUkDe@qB[aBWmC[oB[wAU{B]oIoAeC]gBUwAQcAK}@KyCWuEUgCKgEEmBBcGHwDL{G^}CLoCHsA?aCCgAE}C[oASwB_@iAWkA[gC{@uAi@u@[yBkAcBeAeCaByBcBiCsBiByAi@_@iG}E]YcIkGcBoAo@i@mDgDs@y@wE_Gm@o@cB}Aw@o@w@k@yEiCeBq@iA]cAWaAQuC[cI]gFUaFYuBWgASwFoAsBa@}@MaAIgACy@?aBHsAL}@Lc@LeBf@aA`@]RcDjBsAn@cBl@wBj@q@LuAP{O~AcAH_BRmBPaBViB\\}LrCkBd@mBh@s@RyAh@aA`@oB|@eBz@wBlAi@TmAd@gAZuAXgAL{AHqB@oCQ_AIiAUkDu@sEaAuA[oAU_B[s@MkB]y@KeAImACu@Ci@?g@@yADeBNaC^qBd@YHoAf@q@Tu@\\yB|@qIlD_DlAsBr@QD[H}@XeB^uB`@aBT_CX_BN_AFuAFaCDeIFqGLaBL_CZoAPyBd@k@LiAZcBf@uBx@mB|@{PlJwDjBuD`Bs@VcA`@}Ah@yEvAyDz@iB\\w@LkDh@eAPsCV{CTqBJo@BaGJyDAmR]iJQoEIsIMgC?uA@kELcBJg@BaY~AyAFmFXmCL}BFsCFmEBuC?o@A{CCiAEoHWkIo@{Eg@yEk@mGeAuN}CuGyAwDs@wB]iAOyEg@uF[mEKuCAiA@mFL{CLoBJeDTkY|AsWzAa@BiBL{BR_D`@uDp@wCn@sDbA{DrAqDzA_ErB}@d@iAn@aCzAyAbAsAbAcDrC}ApAsDhD{@z@{@t@[RiAx@mAr@o@Z]Pq@^y@X{@XiDr@cCV_DLuEM_Dc@iBc@qA_@_A_@]O{Aw@m@]w@g@wB_ByAuAuA{AcBuBqGwI}@oAgD{Dk@m@gDyCoAeAkBsAkAs@{@i@kAo@mAm@{B_AqBq@cBk@yAa@wA[{AWgBUeEa@cCOeCIcCBeBJkD^oARcK`C_BPmANyALyABsBAgBG}AKsDg@qDcAoDuAiDkBwEgDqB{AeL}IgHuFwJsHsJuHyAsAiBgBiAmAqCcDiC_DuCuDiDgEgBuBiAmAsAoAgCyBoCkBeC}AQKSKiDwA{B{@{Cw@wB]_Ca@yE[kBE_DBsEZeFr@sq@rOaOhDyDdA}Af@yAh@_C`AaBv@wEdC_HzDkB|@{B|@kBl@_AVmAXyB`@aCZkAJcBHiCDsB?sCCo@C_BAcDIgLYiHMk@AiGO{BGmBCk@CoFMO?Y?a^s@iJWaEG}BAeE@}AD{BLiBPgCZwAToAVyCv@}Br@yBx@oBx@mB~@{@f@yAz@uDfCiBzA[XUR}ArA}ApAmAbA_BhAsBpAu@^cBv@uAd@mAZsCd@wAPwCd@qAV_AViA^}An@}Av@cAl@sBxAuAjAyEjEgF|EuBdBeAv@y@h@w@d@}Ar@eA^]Lo@Rm@PwAZ{@LsBPoBHwA@yBK_AGu@MgB[mBe@wBs@y@[}Ae@uBi@}AYkBUeCKgBBu@@aBJqBVkAT_Bb@y@Xm@RyBbAiAn@aAn@sAbA{BtBy@~@q@z@qAhBe@r@W`@qAdCm@tAaAbCs@xBaAjDi@dCiA~Es@lC]tAg@xA_BzDe@`As@tAo@dA}AxBk@r@iBnBw@r@w@p@mBrA}BpAgAd@aA^w@VkBh@_Cp@yN~D}CdA_C|@uBz@aDxAgCrAqDtBoAv@eBjAa@VqCrBeCtBmAlA_BfBqA`BwBtCsDbFwAhBgAjAcAdAyArA_Av@kBvAo@b@yCdB}BhAsCnA}VjKeBv@uAr@g@ZQH}AbA_Ar@u@l@u@r@aBjBmA|A_AtAw@pAmA~B_AnBsCnFsAxBcAzA{@fAmCtCkBbBkA`ASLyAdAe@XuCzAoBx@eCx@sCp@}@RiCZeBLkCDwCEqBKcBMcZiCcIs@cCQkCMuAEiCCiA@oDL}DXyDj@qCj@qBh@sC|@wChAk@ViB~@gBbAaB`AgAr@eBrAk@^oB|AwE`EuBjBqAhA{BnBqC~BoNzLwEdEkGjF{F`FiA~@eAr@_@VeAn@q@\\mBx@qBn@iBb@s@LiBRy@FsBF{BEgCSmBYaCi@oBc@kPiEoE_A}@MwAK}@Cs@Cg@?cCFmBNgBVwBd@gBh@iBt@i@VmAp@{AbAmA~@{AxAyA|Aq@x@iA|AsB`D_FlHoBxCmCxD{AjBiApAmDfDy@r@qCpBmAv@sAt@ULsB`AqAd@}Ah@eAZ{A^aBZ_CZ_DXsAFc@?oB?eCE_IYeACoLe@oO]oACyB@qD?aFFcJH}@B_IZS@iCNkEVwJx@{Db@wKtAuHlA_[tFyB^iJdBmJbBk`@bHmB`@]Hk@JgFbA{J|AcCZkAJeAJcEN{C@kBCkCKqAIcCSoBWmRwBqDe@_Eo@qFkAaB]oMsCcGkAaBQkACgBDg@FsARuA\\aBl@}Az@kA|@g@f@oErEsAjAc@ZgAp@cBv@{@V_APaALmAHaA?aAGyAKy@McC]oBW_Fs@sAOwG{@qBQiBIgBIqAAsAAmA@aBDsFXqABgCAcDMoBO_AKyB[aBYyA[aBe@_EkA}@[yB_A}@a@qCwAwBsAqA{@cBmA{AmAo@i@yBuBwZgYuDiDyBqBiG{F_EwDwCoCkEaEaA{@gAgA_A}@sCmCg@e@_FsEaQ_PSQmAcA{CsBk@c@qAo@kAi@cAc@{@[s@UyBm@wBa@{AS_CSiAGoC?kA@u@BuBLiBToB\\aCj@mA`@kBt@mAh@_A`@c@Tk@V_@PmAh@oLfFq@VaDdAkCn@wB`@{C`@wBL}@BiBDgA?iAGqDY_BQoASqEy@eEaAeIcBwIkBgLeCqQsDgCm@_B[oGsA{D}@aCe@aDs@mLcCgDs@kNyCcHwA{GyAiE_AcEy@qCe@qFw@_Ee@}AOuKu@w@EiGU{BIoDA{BAq@@iCB{@BmCH{BF_@@_@@qDKeCMcAKo@KkBa@aAMs@Ko@Ai@Ck@BmALwCf@_AL}APc@@W?oFE_BIaAIs@MyA]iA[qFeBi@QsA]uAYmAMk@Ck@?iADe@DgAPc@JkA`@oAl@mGbDeBx@wAj@g@Pg@He@FkAHkA@qAIgAQeAYe@QcAe@iAs@a@[iAcAiAoAkAyAeFiHq@_AqC{Du@cAy@}@u@s@s@i@k@[eAa@cA[]Im@K[EmAMeAC}ABkBFgERwDHq@BoBDu@AoBKiB]_CeASKm@a@m@e@k@k@oA}Ae@q@]m@c@}@q@}ASi@[_AcAuCg@qAs@}Ak@eAw@oAg@o@}@cAkAkAgAaA_D_DqDcDwAwAu@cA]i@g@_Ac@}@{@wBqAaEoB}G]uA_EaN}@cCy@kBg@_Ai@{@kA{Ak@m@o@q@e@a@_BgA{@c@s@]s@Uy@W}AYuAKgHYoBQeAO_@KyAa@q@UaNkFyBu@eBc@m@M}AY}AOm@EeCCyA@_AF}ANaC`@}A`@qAd@aCdAeBbA{B~AuBbBoBdBuC|BoBnAeB`AaC`AuG|BoC`A{HhCaEvAc@TUJi@Xk@^a@Zu@r@w@`Ak@|@mAbCi@|Aa@~AQx@WfBIz@K|AIbC@tBPpFRjFBrA?fBE|AGdAMrAc@bDc@`Cg@~BqAfFs@hC{@lCu@rBy@zBoA~CKXKR}AtDa@x@qB`E}@bBGHeAjBiBzCiDdF{FzHcEfFoEdFyB`CkClCkDjDsElEuEfEyKtJa@Z{AlA{AlAoDrCyFhEyEfDqCfBqBjAuBdAkE`BkCfAeDdBgBhAm@b@wBbBo@j@yCxCuA|Ao@v@_@d@yAtBm@`Am@bAkAxBaApB{ApDi@tAiA`DeAtCu@fBiAxB_A|Ak@z@}BzCuBrBiA~@kAz@iAr@cAh@qAn@sDjBeHjDsHbDoDxAsEhBa@Rq@Tw@Ze@RwFnBgA`@sDnA}EzAwCr@cFpAqE`AoB^g@JgBVkEp@iEj@{AP_Ed@mAJoCPmCPkCLeC@cBIyBS{@Qy@Q}@WaBo@e@UoAs@_@WkByAwAsA_CcCmC_D{AoB{AuBiHmKyEgGqDiEwCaDcCcCeE{D{DcDeCiBsDeCkBiA_FuCsGmDwGcDeEqBuCoAyFyB}JuD_UmIiEeB_Aa@kIuDgB{@mHuDiBcAs@_@qAw@cEcCkAs@kFqD}CyB{DaDi@c@s@m@WUaCqB}AuAq@o@iBgBmDmDyPaR_EeEw@w@qCwCoJcJiC}BkJgIyGsFiF{DgDaCoCgBaBaAaFgCgEkBeCeAgGuBwHuBsF}AiIiCyK{DeHsCgVmKkBs@mA_@eAWyBi@{Bc@gDi@_AKo@CWEkESi@AmBC{ABu@@}AFcEVs@FwKt@kHf@{BPuE\\c@FmAJy@Js@HqBV_Fr@o@J{PfCcBXu@LQBwAHo@J_AZ_A^g@RoAd@oAZoB`@eANcAHmADkAAsAMq@Mm@Qa@MqE{AcA]q@MuB[eAIqBIyA?_CJuBVmAT[DcAVcAZkG|BeCp@}AVcAH_@DsAFeK`@aHXiCHu@DwDToAHi@DaGRsCDiABoA?WAqAAe@?]KQGQKQOQUUk@I_@MiAKeBIsBKmEOmDE_AKwBUsFEs@MuCMoCSuD@W@sA?cAB]PaAKuBS]OYSQ[MOUc@c@]@_@Fa@V}@L}@HkBLS?gAFFxFLnL@rAB`C@n@BhA?RAl@yA`@QD"
- }
- }
- ]
- }
- }
- }
- }
- }
- },
- "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/distance/tolls/json?origin=43.70386%2C%204.12200&destination=45.71971%2C%204.84891&mode=driving&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/distance/tolls/json?origin=43.70386%2C%204.12200&destination=45.71971%2C%204.84891&mode=driving&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/distance/tolls/json?origin=43.70386%2C%204.12200&destination=45.71971%2C%204.84891&mode=driving&private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
- }
- ]
- }
- },
- "/distance/isochrone/json": {
- "get": {
- "summary": "Isochrone (Early Access)",
- "operationId": "getIsochrone",
- "servers": [
- {
- "url": "https://api.woosmap.com"
- }
- ],
- "tags": [
- "Distance API"
- ],
- "description": "Find all destinations that can be reached in a specific amount of time or a maximum travel distance\n",
- "security": [
- {
- "PublicApiKeyAuth": [],
- "RefererHeader": []
- },
- {
- "PrivateApiKeyAuth": []
- },
- {
- "PrivateApiKeyHeaderAuth": []
- }
- ],
- "parameters": [
- {
- "$ref": "#/components/parameters/origin"
- },
- {
- "$ref": "#/components/parameters/value"
- },
- {
- "$ref": "#/components/parameters/mode"
- },
- {
- "$ref": "#/components/parameters/language-4"
- },
- {
- "$ref": "#/components/parameters/units"
- },
- {
- "$ref": "#/components/parameters/method"
- },
- {
- "$ref": "#/components/parameters/avoid"
- }
- ],
- "responses": {
- "200": {
- "description": "Isochrone successfully retrieved",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DistanceIsochroneResponse"
- },
- "examples": {
- "default": {
- "summary": "Distance Isochrone Result for driving 1km by car from origin `48.709,2.403`",
- "value": {
- "status": "OK",
- "isoline": {
- "origin": {
- "lat": 48.709,
- "lng": 2.403
- },
- "distance": {
- "value": 1,
- "text": "1 km"
- },
- "geometry": "s|ihHouuMZ`GdClCsA~QhCnQmBhEpCfF|HxGpBtFfEnBnHqJpH}ADaEcCaB@sBnEiEYiGmVyFaG{G[eFoCw@gAiIkDYg@_DwA@"
- }
- }
- }
- }
- }
- }
- },
- "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/distance/isochrone/json?origin=48.709%2C2.403&value=1&mode=driving&language=en&method=distance&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/distance/isochrone/json?origin=48.709%2C2.403&value=1&mode=driving&language=en&method=distance&key=YOUR_PUBLIC_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/distance/isochrone/json?origin=48.709%2C2.403&value=1&mode=driving&language=en&method=distance&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"
- }
- ]
- }
- }
- },
- "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"
- }
- },
- "limit": {
- "name": "limit",
- "description": "To limit number of assets retrieved from an IP location.\n",
- "schema": {
- "type": "integer",
- "minimum": 1,
- "maximum": 300,
- "example": 10
- },
- "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",
- "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.\n"
- },
- "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.\n",
- "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).\n",
- "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\".\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 100 000.\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": "MkvnYy6K6oVGqeqfWJGO/6eCgqo="
- },
- "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 `alpha3`).\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"
- },
- "cc_format-2": {
- "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"
- },
- "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"
- },
- "input-2": {
- "name": "input",
- "description": "The text string on which to search, for example: \"london\" or \"123 Cross Road\". The Woosmap Address API will return predictions matches based on this string and order the results based on their perceived relevance.\n",
- "schema": {
- "type": "string",
- "example": "London"
- },
- "required": true,
- "in": "query"
- },
- "address_components": {
- "name": "components",
- "description": "To restrict your results to specific areas. Currently, you can use components to filter over countries. Countries must be passed as three characters string (ISO 3166-1 Alpha 3). Components should be passed as an array of different options which are separated by a `|`.\n",
- "schema": {
- "type": "string",
- "example": "country:CAN|country:BEL"
- },
- "in": "query"
- },
- "location-2": {
- "name": "location",
- "description": "Bias for the results. Should be pass in `lat`,`lng` format.\n",
- "schema": {
- "type": "string",
- "example": "5.2,-2.3"
- },
- "in": "query"
- },
- "language-3": {
- "name": "language",
- "description": "The language code, using ISO 639-1 country codes, indicating in which language the results should be returned, if possible. If language is not supplied, the Localities service will use the default language of each country.\n",
- "schema": {
- "type": "string",
- "example": "en"
- },
- "in": "query"
- },
- "public_id-2": {
- "name": "public_id",
- "description": "A textual identifier that uniquely identifies a locality, returned from an [Address Autocomplete](https://developers.woosmap.com/products/address-api/autocomplete/).\n",
- "schema": {
- "type": "string",
- "example": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMDA1MTI2"
- },
- "required": true,
- "in": "query"
- },
- "fields-2": {
- "name": "fields",
- "description": "Used to limit the returning fields (by default, all fields are return). Available fields are (geometry) (fields should be separated by a `,`). By using this parameter you will limit content of responses to the geometry part. No address component will be returned.\n",
- "schema": {
- "type": "string",
- "enum": [
- "geometry"
- ],
- "example": "geometry"
- },
- "in": "query"
- },
- "address-2": {
- "name": "address",
- "description": "The address of which to find the coordinates for. A partial address is less likely to return the proper coordinates than the complete address.\n",
- "schema": {
- "type": "string",
- "example": "224%20Rue%20de%20Rivoli%2C%20Paris"
- },
- "required": false,
- "in": "query"
- },
- "latlng-2": {
- "name": "latlng",
- "description": "Geographic coordinates. Should be pass in `lat`,`lng` format.\n",
- "schema": {
- "type": "string",
- "example": "5.2,-2.3"
- },
- "required": false,
- "in": "query"
- },
- "limit-3": {
- "name": "limit",
- "description": "Maximum number of results to be returned (value from 1 to 100, default values for geocode request [20] and for reverse geocode request [1])\n",
- "schema": {
- "type": "integer",
- "minimum": 1,
- "maximum": 100,
- "example": 10
- },
- "in": "query"
+ "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"
},
- "limit-4": {
- "name": "limit",
- "description": "To limit number of zones retrieved (max 50).\n",
+ "lat": {
+ "name": "lat",
+ "description": "Latitude bias for the results. Should be pass with `lng`.\n",
"schema": {
- "type": "integer",
- "minimum": 1,
- "maximum": 50,
- "example": 10
+ "type": "number",
+ "example": 5.2
},
"in": "query"
},
- "offset": {
- "name": "offset",
- "description": "To retrieve zones starting from an offset value.\n",
+ "lng": {
+ "name": "lng",
+ "description": "Longitude bias for the results. Should be pass with `lat`.\n",
"schema": {
- "type": "integer",
- "minimum": 1,
- "example": 20
+ "type": "number",
+ "example": 3.5
},
"in": "query"
},
- "origins": {
- "name": "origins",
- "in": "query",
- "required": true,
- "schema": {
- "type": "string",
- "example": "48.709,2.403"
- },
- "description": "The starting point for calculating travel distance. You can supply one or more locations separated by the pipe character (|), in the form of latitude/longitude coordinates. They are used unchanged to calculate distance. Ensure that no space exists between the latitude and longitude values. In order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc:encoded-polyline:`\n"
- },
- "destinations": {
- "name": "destinations",
- "in": "query",
- "required": true,
- "schema": {
- "type": "string",
- "example": "48.709,2.403|48.768,2.338"
- },
- "description": "One or more locations to use as the finishing point for calculating travel distance. The options for the destinations parameter are the same as for the origins parameter, described above. In order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc:encoded-polyline:`\n"
- },
- "mode": {
- "name": "mode",
- "in": "query",
- "schema": {
- "type": "string",
- "enum": [
- "driving",
- "cycling",
- "walking"
- ],
- "example": "driving"
- },
- "description": "Specifies the mode of transport to use when calculating distance\n"
- },
- "language-4": {
- "name": "language",
- "in": "query",
- "schema": {
- "type": "string",
- "example": "en"
- },
- "description": "The language code, indicating in which language the results should be returned, if possible. If language is not supplied, the Distance API service will use the navigator language or “en”.\n"
- },
- "units": {
- "name": "units",
- "in": "query",
- "schema": {
- "type": "string",
- "enum": [
- "imperial",
- "metric"
- ],
- "example": "metric"
- },
- "description": "Specifies the unit system parameter to use when expressing distance as text. Two different units supported:\n * `metric` (default) returns distances in kilometers and meters\n * `imperial` returns distances in miles and feet\n"
- },
- "elements": {
- "name": "elements",
- "in": "query",
- "schema": {
- "type": "string",
- "enum": [
- "distance",
- "duration",
- "duration_distance"
- ],
- "example": "duration_distance"
- },
- "description": "Specifies element values that will be part of the API response (distance and/or duration). if not specified default is `distance`\n"
- },
- "method": {
- "name": "method",
- "in": "query",
- "schema": {
- "type": "string",
- "enum": [
- "time",
- "distance"
- ],
- "example": "distance"
- },
- "description": "Specifies the method to compute the route between the start point and the end point:\n- `time`: fastest route (default) - `distance`: shortest route\n"
- },
- "avoid": {
- "name": "avoid",
- "in": "query",
- "schema": {
- "type": "string",
- "example": "tolls|highways|43.3,3.4;42.1,3.5;41.4,3.6"
- },
- "description": "The 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. To add multiple polygons, separate them with the `|` character.\n"
- },
- "departure_time": {
- "name": "departure_time",
- "in": "query",
- "schema": {
- "type": "string",
- "example": "1600799173"
- },
- "description": "By using this parameter, Distance will calculate the duration with traffic Specifies the date/time at which to base the calculations on for traffic purposes. Valid values are a timestamp (e.g. `1600799173` for the date:`22/09/2020 20:26:13`) or `now`.\nUse either `arrival_time` or `departure_time`, not both.\n"
- },
- "origin": {
- "name": "origin",
- "in": "query",
- "required": true,
- "schema": {
- "type": "string",
- "example": "48.709,2.403"
- },
- "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.\n"
- },
- "destination": {
- "name": "destination",
- "in": "query",
- "required": true,
- "schema": {
- "type": "string",
- "example": "48.768,2.338"
- },
- "description": "The ending point for the route. It should be supplied in the form of latitude/longitude coordinates. Ensure that no space exists between the latitude and longitude values.\n"
- },
- "alternatives": {
- "name": "alternatives",
- "in": "query",
- "schema": {
- "type": "boolean",
- "example": true
- },
- "description": "Specifies if alternative routes should be returned. default is `false`. Depending on the calculated route, alternatives may not be provided.\n`alternatives` and `waypoints` can not be used at the same time.\n"
- },
- "waypoints": {
- "name": "waypoints",
- "in": "query",
- "schema": {
- "type": "string",
- "example": "optimize:true|48.850077,3.311124|48.850077,3.411124"
- },
- "description": "A list of points by which the route should pass (route response is divided into legs, one leg corresponding to a route between two waypoints). Waypoints should be separated by | character.\nOptionally, you may pass `optimize:true` as the first argument within the waypoints parameter. This way the provided route is optimized by rearranging the waypoints in a more efficient order based on distance or time according to the method parameter. The route start point and end point order is not changed, their position is considered fixed.\n`alternatives` and `waypoints` can not be used at the same time.\n"
- },
- "details": {
- "name": "details",
- "in": "query",
- "schema": {
- "type": "string",
- "enum": [
- "full",
- "none"
- ],
- "example": "full"
- },
- "description": "Specifies if maneuver instructions should be returned (roadbook). Valid values are `none` and `full` (default is `none`)\n"
- },
- "arrival_time": {
- "name": "arrival_time",
- "in": "query",
- "schema": {
- "type": "string",
- "example": "1600799173"
- },
- "description": "By using this parameter, Distance will calculate the duration with traffic Specifies the arrival date/time as a timestamp to base the calculation on (e.g. `1600799173` for the date:`22/09/2020 20:26:13`).\nUse either `arrival_time` or `departure_time`, not both.\n"
- },
- "value": {
- "name": "value",
- "in": "query",
- "required": true,
- "schema": {
- "type": "integer",
- "minimum": 1,
- "maximum": 120,
- "example": 120
- },
- "description": "The value to use for isochrone contour. You can specify time in minutes or distance in kilometers (cf. method parameter). The maximum value that can be specified is 120 (120 minutes : 2 hours or 120 km).\n"
- },
- "address_address_components": {
- "$ref": "#/components/parameters/address_components"
- },
- "address_address": {
- "$ref": "#/components/parameters/address-2"
- },
- "address_cc_format": {
- "$ref": "#/components/parameters/cc_format"
- },
- "address_fields": {
- "$ref": "#/components/parameters/fields-2"
- },
- "address_input": {
- "$ref": "#/components/parameters/input-2"
- },
- "address_language": {
- "$ref": "#/components/parameters/language-3"
- },
- "address_latlng": {
- "$ref": "#/components/parameters/latlng-2"
- },
- "address_limit": {
- "$ref": "#/components/parameters/limit-3"
- },
- "address_location": {
- "$ref": "#/components/parameters/location-2"
- },
- "address_public_id": {
- "$ref": "#/components/parameters/public_id-2"
- },
- "distance_alternatives": {
- "$ref": "#/components/parameters/alternatives"
- },
- "distance_arrival_time": {
- "$ref": "#/components/parameters/arrival_time"
- },
- "distance_avoid": {
- "$ref": "#/components/parameters/avoid"
- },
- "distance_departure_time": {
- "$ref": "#/components/parameters/departure_time"
- },
- "distance_destination": {
- "$ref": "#/components/parameters/destination"
- },
- "distance_destinations": {
- "$ref": "#/components/parameters/destinations"
- },
- "distance_details": {
- "$ref": "#/components/parameters/details"
- },
- "distance_elements": {
- "$ref": "#/components/parameters/elements"
- },
- "distance_language": {
- "$ref": "#/components/parameters/language-4"
- },
- "distance_method": {
- "$ref": "#/components/parameters/method"
- },
- "distance_mode": {
- "$ref": "#/components/parameters/mode"
- },
- "distance_origin": {
- "$ref": "#/components/parameters/origin"
- },
- "distance_origins": {
- "$ref": "#/components/parameters/origins"
- },
- "distance_units": {
- "$ref": "#/components/parameters/units"
- },
- "distance_value": {
- "$ref": "#/components/parameters/value"
- },
- "distance_waypoints": {
- "$ref": "#/components/parameters/waypoints"
- },
- "geolocation_ip_address": {
- "$ref": "#/components/parameters/ip_address"
- },
- "geolocation_limit": {
- "$ref": "#/components/parameters/limit"
- },
- "localities_address": {
- "$ref": "#/components/parameters/address"
- },
- "localities_addresses_per_page": {
- "$ref": "#/components/parameters/addresses_per_page"
- },
- "localities_cc_format": {
- "$ref": "#/components/parameters/cc_format-2"
- },
- "localities_custom_description": {
- "$ref": "#/components/parameters/custom_description"
- },
- "localities_data": {
- "$ref": "#/components/parameters/data"
- },
- "localities_excluded_types": {
- "$ref": "#/components/parameters/excluded_types"
- },
- "localities_extended": {
- "$ref": "#/components/parameters/extended"
- },
- "localities_fields": {
- "$ref": "#/components/parameters/fields"
- },
- "localities_geocode_types": {
- "$ref": "#/components/parameters/geocode_types"
- },
- "localities_input": {
- "$ref": "#/components/parameters/input"
- },
- "localities_language": {
- "$ref": "#/components/parameters/language-2"
- },
- "localities_latlng": {
- "$ref": "#/components/parameters/latlng"
- },
- "localities_list_sub_buildings": {
- "$ref": "#/components/parameters/list_sub_buildings"
- },
- "localities_localities_components": {
- "$ref": "#/components/parameters/localities_components"
- },
- "localities_location": {
- "$ref": "#/components/parameters/location"
- },
- "localities_nearby_excluded_types": {
- "$ref": "#/components/parameters/nearby_excluded_types"
- },
- "localities_nearby_types": {
- "$ref": "#/components/parameters/nearby_types"
- },
- "localities_page": {
- "$ref": "#/components/parameters/page-2"
- },
- "localities_public_id": {
- "$ref": "#/components/parameters/public_id"
- },
- "localities_radius": {
- "$ref": "#/components/parameters/radius-2"
- },
- "localities_types": {
- "$ref": "#/components/parameters/types"
- },
- "search_encoded_polyline": {
- "$ref": "#/components/parameters/encoded_polyline"
- },
- "search_language": {
- "$ref": "#/components/parameters/language"
- },
- "search_lat": {
- "$ref": "#/components/parameters/lat"
- },
- "search_limit": {
- "$ref": "#/components/parameters/limit-2"
- },
- "search_lng": {
- "$ref": "#/components/parameters/lng"
+ "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"
},
- "search_page": {
- "$ref": "#/components/parameters/page"
+ "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"
},
- "search_query": {
- "$ref": "#/components/parameters/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"
},
- "search_radius": {
- "$ref": "#/components/parameters/radius"
+ "page": {
+ "name": "page",
+ "description": "Page number when accessing paginated assets feature collection\n",
+ "schema": {
+ "type": "integer",
+ "example": 2
+ },
+ "in": "query"
},
- "search_stores_by_page": {
- "$ref": "#/components/parameters/stores_by_page"
+ "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.\n"
},
- "search_zone": {
- "$ref": "#/components/parameters/zone"
+ "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.\n",
+ "schema": {
+ "type": "string",
+ "example": "en"
+ },
+ "in": "query"
},
- "zones_limit": {
- "$ref": "#/components/parameters/limit-4"
+ "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).\n",
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 50,
+ "example": 15
+ },
+ "in": "query"
},
- "zones_offset": {
- "$ref": "#/components/parameters/offset"
- }
- },
- "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
+ "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"
},
- "properties": {
- "lat": {
- "type": "number",
- "description": "Latitude in decimal degrees",
- "example": 42.3
- },
- "lng": {
- "type": "number",
- "description": "Longitude in decimal degrees",
- "example": 3.46
- }
- }
+ "required": true,
+ "in": "query"
},
- "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"
- }
+ "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"
},
- "example": {
- "northeast": {
- "lat": 49.315678,
- "lng": 4.15292
- },
- "southwest": {
- "lat": 49.31073,
- "lng": 4.145162
- }
- }
+ "in": "query"
},
- "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"
+ "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"
},
- "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
- }
+ "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"
},
- "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
- }
+ "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"
},
- "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"
- }
- }
+ "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"
},
- "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"
- }
- }
+ "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 100 000.\n",
+ "schema": {
+ "type": "integer",
+ "example": 200000
+ },
+ "in": "query",
+ "required": false
},
- "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"
- }
- }
+ "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"
},
- "AssetName": {
- "title": "AssetName",
- "description": "The asset's name.",
- "type": "string",
- "example": "My Cool Store"
+ "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"
},
- "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"
+ "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"
},
- "AssetAddressLines": {
- "title": "AssetAddressLines",
- "description": "An Array for lines of an Asset Address",
- "type": "array",
- "example": [
- "Building Centre",
- "26 Store Street"
- ],
- "items": {
+ "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": "26 Store Street"
- }
+ "example": "MkvnYy6K6oVGqeqfWJGO/6eCgqo="
+ },
+ "required": true,
+ "in": "query"
},
- "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"
- }
+ "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"
},
- "example": {
- "lines": [
- "8 Southwark St"
+ "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 `alpha3`).\n",
+ "schema": {
+ "type": "string",
+ "enum": [
+ "alpha2",
+ "alpha3"
],
- "country_code": "UK",
- "city": "London",
- "zipcode": "SE1 1TL"
- }
+ "example": "alpha2"
+ },
+ "in": "query"
},
- "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"
- }
+ "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"
+ },
+ "cc_format-2": {
+ "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"
},
- "example": {
- "website": "https://www.woosmap.com",
- "phone": "+44 20 7693 4000",
- "email": "contact@woosmap.com"
- }
+ "in": "query"
},
- "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"
+ "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": [
- "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"
- }
- }
+ "required": true,
+ "in": "query"
},
- "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
- }
+ "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"
},
- "example": {
- "open_now": true,
- "open_hours": [
- {
- "end": "20:00",
- "start": "05:00"
- }
- ],
- "week_day": 1,
- "current_slice": {
- "end": "20:00",
- "start": "05:00"
- }
- }
+ "in": "query"
},
- "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
- }
+ "input-2": {
+ "name": "input",
+ "description": "The text string on which to search, for example: \"london\" or \"123 Cross Road\". The Woosmap Address API will return predictions matches based on this string and order the results based on their perceived relevance.\n",
+ "schema": {
+ "type": "string",
+ "example": "London"
},
- "example": {
- "hours": [
- {
- "start": "06:30",
- "end": "18:00"
- }
- ],
- "isSpecial": false
- }
+ "required": true,
+ "in": "query"
},
- "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"
- }
+ "address_components": {
+ "name": "components",
+ "description": "To restrict your results to specific areas. Currently, you can use components to filter over countries. Countries must be passed as three characters string (ISO 3166-1 Alpha 3). Components should be passed as an array of different options which are separated by a `|`.\n",
+ "schema": {
+ "type": "string",
+ "example": "country:CAN|country:BEL"
},
- "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"
- }
+ "in": "query"
},
- "AssetTypes": {
- "title": "AssetTypes",
- "description": "Contains an array of types describing the Asset.",
- "type": "array",
- "items": {
+ "location-2": {
+ "name": "location",
+ "description": "Bias for the results. Should be pass in `lat`,`lng` format.\n",
+ "schema": {
+ "type": "string",
+ "example": "5.2,-2.3"
+ },
+ "in": "query"
+ },
+ "language-3": {
+ "name": "language",
+ "description": "The language code, using ISO 639-1 country codes, indicating in which language the results should be returned, if possible. If language is not supplied, the Localities service will use the default language of each country.\n",
+ "schema": {
"type": "string",
- "example": "drive"
+ "example": "en"
},
- "example": [
- "drive",
- "click_and_collect"
- ]
+ "in": "query"
},
- "AssetTags": {
- "title": "AssetTags",
- "description": "Contains an array of tags describing the Asset. For example a list of available amenities.",
- "type": "array",
- "items": {
+ "public_id-2": {
+ "name": "public_id",
+ "description": "A textual identifier that uniquely identifies a locality, returned from an [Address Autocomplete](https://developers.woosmap.com/products/address-api/autocomplete/).\n",
+ "schema": {
"type": "string",
- "example": "wifi"
+ "example": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMDA1MTI2"
},
- "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"
- }
- }
- }
+ "required": true,
+ "in": "query"
},
- "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"
- }
+ "fields-2": {
+ "name": "fields",
+ "description": "Used to limit the returning fields (by default, all fields are return). Available fields are (geometry) (fields should be separated by a `,`). By using this parameter you will limit content of responses to the geometry part. No address component will be returned.\n",
+ "schema": {
+ "type": "string",
+ "enum": [
+ "geometry"
+ ],
+ "example": "geometry"
},
- "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
- }
- }
+ "in": "query"
},
- "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"
- }
+ "address-2": {
+ "name": "address",
+ "description": "The address of which to find the coordinates for. A partial address is less likely to return the proper coordinates than the complete address.\n",
+ "schema": {
+ "type": "string",
+ "example": "224%20Rue%20de%20Rivoli%2C%20Paris"
+ },
+ "required": false,
+ "in": "query"
},
- "GeoJsonPoint": {
- "title": "GeoJsonPoint",
- "type": "object",
- "description": "GeoJSon Point Geometry",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "Point"
- ],
- "description": "the geometry type"
- },
- "coordinates": {
- "$ref": "#/components/schemas/LatLngArrayString"
- }
+ "latlng-2": {
+ "name": "latlng",
+ "description": "Geographic coordinates. Should be pass in `lat`,`lng` format.\n",
+ "schema": {
+ "type": "string",
+ "example": "5.2,-2.3"
+ },
+ "required": false,
+ "in": "query"
+ },
+ "limit-3": {
+ "name": "limit",
+ "description": "Maximum number of results to be returned (value from 1 to 100, default values for geocode request [20] and for reverse geocode request [1])\n",
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 100,
+ "example": 10
},
- "example": {
- "type": "Point",
- "coordinates": [
- -0.14408,
- 51.5088
- ]
- }
+ "in": "query"
},
- "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"
- }
+ "limit-4": {
+ "name": "limit",
+ "description": "To limit number of zones retrieved (max 50).\n",
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 50,
+ "example": 10
},
- "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
- ]
- }
- }
+ "in": "query"
+ },
+ "offset": {
+ "name": "offset",
+ "description": "To retrieve zones starting from an offset value.\n",
+ "schema": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 20
+ },
+ "in": "query"
+ },
+ "address_address_components": {
+ "$ref": "#/components/parameters/address_components"
+ },
+ "address_address": {
+ "$ref": "#/components/parameters/address-2"
+ },
+ "address_cc_format": {
+ "$ref": "#/components/parameters/cc_format"
+ },
+ "address_fields": {
+ "$ref": "#/components/parameters/fields-2"
+ },
+ "address_input": {
+ "$ref": "#/components/parameters/input-2"
+ },
+ "address_language": {
+ "$ref": "#/components/parameters/language-3"
+ },
+ "address_latlng": {
+ "$ref": "#/components/parameters/latlng-2"
+ },
+ "address_limit": {
+ "$ref": "#/components/parameters/limit-3"
},
- "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
- }
- }
+ "address_location": {
+ "$ref": "#/components/parameters/location-2"
},
- "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
+ "address_public_id": {
+ "$ref": "#/components/parameters/public_id-2"
+ },
+ "geolocation_ip_address": {
+ "$ref": "#/components/parameters/ip_address"
+ },
+ "geolocation_limit": {
+ "$ref": "#/components/parameters/limit"
+ },
+ "localities_address": {
+ "$ref": "#/components/parameters/address"
+ },
+ "localities_addresses_per_page": {
+ "$ref": "#/components/parameters/addresses_per_page"
+ },
+ "localities_cc_format": {
+ "$ref": "#/components/parameters/cc_format-2"
+ },
+ "localities_custom_description": {
+ "$ref": "#/components/parameters/custom_description"
+ },
+ "localities_data": {
+ "$ref": "#/components/parameters/data"
+ },
+ "localities_excluded_types": {
+ "$ref": "#/components/parameters/excluded_types"
+ },
+ "localities_extended": {
+ "$ref": "#/components/parameters/extended"
+ },
+ "localities_fields": {
+ "$ref": "#/components/parameters/fields"
+ },
+ "localities_geocode_types": {
+ "$ref": "#/components/parameters/geocode_types"
+ },
+ "localities_input": {
+ "$ref": "#/components/parameters/input"
+ },
+ "localities_language": {
+ "$ref": "#/components/parameters/language-2"
+ },
+ "localities_latlng": {
+ "$ref": "#/components/parameters/latlng"
+ },
+ "localities_list_sub_buildings": {
+ "$ref": "#/components/parameters/list_sub_buildings"
+ },
+ "localities_localities_components": {
+ "$ref": "#/components/parameters/localities_components"
+ },
+ "localities_location": {
+ "$ref": "#/components/parameters/location"
+ },
+ "localities_nearby_excluded_types": {
+ "$ref": "#/components/parameters/nearby_excluded_types"
+ },
+ "localities_nearby_types": {
+ "$ref": "#/components/parameters/nearby_types"
+ },
+ "localities_page": {
+ "$ref": "#/components/parameters/page-2"
+ },
+ "localities_public_id": {
+ "$ref": "#/components/parameters/public_id"
+ },
+ "localities_radius": {
+ "$ref": "#/components/parameters/radius-2"
+ },
+ "localities_types": {
+ "$ref": "#/components/parameters/types"
+ },
+ "search_encoded_polyline": {
+ "$ref": "#/components/parameters/encoded_polyline"
+ },
+ "search_language": {
+ "$ref": "#/components/parameters/language"
+ },
+ "search_lat": {
+ "$ref": "#/components/parameters/lat"
+ },
+ "search_limit": {
+ "$ref": "#/components/parameters/limit-2"
+ },
+ "search_lng": {
+ "$ref": "#/components/parameters/lng"
+ },
+ "search_page": {
+ "$ref": "#/components/parameters/page"
+ },
+ "search_query": {
+ "$ref": "#/components/parameters/query"
+ },
+ "search_radius": {
+ "$ref": "#/components/parameters/radius"
+ },
+ "search_stores_by_page": {
+ "$ref": "#/components/parameters/stores_by_page"
+ },
+ "search_zone": {
+ "$ref": "#/components/parameters/zone"
+ },
+ "zones_limit": {
+ "$ref": "#/components/parameters/limit-4"
+ },
+ "zones_offset": {
+ "$ref": "#/components/parameters/offset"
+ }
+ },
+ "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"
},
@@ -8285,306 +5840,570 @@
"example": "Virginia"
},
"city": {
- "description": "City name when available",
+ "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": "Alexandria"
+ "example": "London"
},
- "postal_code": {
- "description": "A postal code close to the user's location, when available",
+ "zipcode": {
+ "description": "An Zipcode / Postal code of an Asset Address",
"type": "string",
- "example": "22309"
- },
- "timezone": {
- "$ref": "#/components/schemas/Timezone"
+ "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"
},
- "raw_offset": {
- "description": "The offset from utc in seconds",
- "type": "integer",
- "example": -18000
+ "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"
},
- "dst_offset": {
- "description": "The daylight saving time offset in seconds",
- "type": "integer",
- "example": 3600
+ "email": {
+ "description": "Contains the Asset's email contact.",
+ "type": "string",
+ "example": "contact@woosmap.com"
}
},
"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
+ "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"
}
},
- "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
- ]
- }
+ "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"
}
- ],
- "pagination": {
- "page": 1,
- "pageCount": 2
}
+ },
+ "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"
}
}
},
- "TimezoneResponse": {
- "title": "TimezoneResponse",
+ "AssetWeeklyOpeningHoursPeriod": {
+ "title": "AssetWeeklyOpeningHoursPeriod",
"type": "object",
- "description": "Timezone information, name, raw offset to UTC and dst offset.",
+ "description": "The opening Hours for Monday",
"properties": {
- "timezone": {
- "description": "The time zone identifier eg. 'Europe/Paris'. see ",
- "title": "Timezone id",
- "type": "string"
+ "hours": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssetOpeningHoursPeriod"
+ }
},
- "timezone_name": {
- "description": "The timezone name eg. `PDT`",
- "title": "Timezone name",
- "type": "string"
+ "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"
},
- "raw_offset": {
- "description": "offset from utc in seconds.",
- "title": "Raw offset",
- "type": "integer"
+ "2": {
+ "$ref": "#/components/schemas/AssetWeeklyOpeningHoursPeriod"
},
- "dst_offset": {
- "description": "The daylight saving time offset in seconds.",
- "title": "Dst offset",
- "type": "integer"
+ "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"
}
},
- "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"
+ }
+ },
+ "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"
+ }
+ }
}
},
- "AssetAddressRequest": {
- "title": "AssetAddressRequest",
+ "AssetOpeningHoursSpecial": {
+ "title": "AssetOpeningHoursSpecial",
+ "description": "An object describing the special opening hours of an Asset.",
"type": "object",
- "description": "An object containing the separate components applicable to this address.",
"properties": {
- "lines": {
- "$ref": "#/components/schemas/AssetAddressLines"
+ "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"
+ }
},
- "countryCode": {
- "description": "An ISO_3166-1 Country Code where the Asset is located (see for full list)",
- "type": [
- "string",
- "null"
- ],
- "example": "UK"
+ "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"
},
- "city": {
- "description": "A City where belongs an Asset",
- "type": "string",
- "example": "London"
+ "usual": {
+ "$ref": "#/components/schemas/AssetOpeningHoursUsual"
},
- "zipcode": {
- "description": "An Zipcode / Postal code of an Asset Address",
- "type": "string",
- "example": "WC1E 7BT"
+ "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",
@@ -8595,1915 +6414,1899 @@
"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
],
+ "type": "array",
+ "minItems": 2,
+ "maxItems": 2,
+ "items": {
+ "type": "number"
+ }
+ },
+ "GeoJsonPoint": {
+ "title": "GeoJsonPoint",
+ "type": "object",
+ "description": "GeoJSon Point Geometry",
"properties": {
- "stores": {
- "description": "The Assets collection",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AssetRequest"
- }
+ "type": {
+ "type": "string",
+ "enum": [
+ "Point"
+ ],
+ "description": "the geometry type"
+ },
+ "coordinates": {
+ "$ref": "#/components/schemas/LatLngArrayString"
}
},
"example": {
- "stores": [
- {
- "types": [
- "drive",
- "click_and_collect"
- ],
- "tags": [
- "wifi",
- "covered_parking"
+ "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"
],
- "location": {
- "lat": 38.719,
- "lng": -77.1067
+ "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
},
- "storeId": "STORE_ID_123456",
- "name": "My Cool Store",
- "address": {
- "lines": [
- "Building Centre",
- "26 Store Street"
+ "2": {
+ "hours": [
+ {
+ "end": "20:00",
+ "start": "05:00"
+ }
],
- "countryCode": "UK",
- "city": "London",
- "zipcode": "WC1E 7BT"
+ "isSpecial": false
},
- "contact": {
- "website": "https://www.woosmap.com",
- "phone": "+44 20 7693 4000",
- "email": "contact@woosmap.com"
+ "3": {
+ "hours": [
+ {
+ "end": "20:00",
+ "start": "05:00"
+ }
+ ],
+ "isSpecial": false
},
- "userProperties": {
- "some_user_properties": "associated user value"
+ "4": {
+ "hours": [
+ {
+ "end": "20:00",
+ "start": "05:00"
+ }
+ ],
+ "isSpecial": false
},
- "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
+ "5": {
+ "hours": [
+ {
+ "end": "20:00",
+ "start": "05:00"
+ }
+ ],
+ "isSpecial": false
},
- "storeId": "STORE_ID_45678",
- "name": "My Cool Store 2",
- "address": {
- "lines": [
- "1805-1899",
- "Orchard St"
+ "6": {
+ "hours": [
+ {
+ "end": "20:00",
+ "start": "05:00"
+ }
],
- "countryCode": "US",
- "city": "Alexandria",
- "zipcode": "22309"
+ "isSpecial": false
},
- "contact": {
- "website": "https://www.woosmap.com",
- "phone": "+44 20 7693 4000",
- "email": "contact@woosmap.com"
+ "7": {
+ "hours": [
+ {
+ "end": "20:00",
+ "start": "05:00"
+ }
+ ],
+ "isSpecial": false
},
- "userProperties": {
- "some_user_properties": "associated user value"
+ "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"
+ }
+ ]
},
- "openingHours": {
- "timezone": "America/New_York",
- "usual": {
- "1": [],
- "default": [
- {
- "start": "08:30",
- "end": "22:00"
- }
- ]
- }
- }
+ "special": {},
+ "timezone": "America/Los_Angeles"
}
- ]
- }
- },
- "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"
- }
+ "geometry": {
+ "type": "Point",
+ "coordinates": [
+ -122.712924,
+ 38.41244
]
}
}
},
- "Error400": {
- "title": "Error400",
+ "Pagination": {
+ "title": "Pagination",
"type": "object",
- "description": "The request is invalid",
+ "description": "Pagination to reach all returned assets. max 300 assets par page.",
"properties": {
- "status": {
- "type": "string",
- "description": "the status of the 400 response",
- "example": "error"
+ "page": {
+ "type": "integer",
+ "description": "the request page",
+ "example": 1
},
- "value": {
- "description": "the value of request causing the Error",
- "example": "The request is invalid, the data is not a valid JSON.",
- "type": "string"
+ "pageCount": {
+ "type": "integer",
+ "description": "the number of available pages",
+ "example": 10
}
}
},
- "MatchedSubstring": {
- "title": "MatchedSubstring",
+ "AssetFeatureCollectionResponse": {
+ "title": "AssetFeatureCollectionResponse",
"type": "object",
+ "description": "Assets Collection Response as a GeoJSon FeatureCollection with Asset properties",
"properties": {
- "length": {
- "description": "Length of the matched substring in the prediction result text.",
- "type": "number"
+ "type": {
+ "description": "the Geojson Type (only 'FeatureCollection')",
+ "type": "string",
+ "enum": [
+ "FeatureCollection"
+ ]
},
- "offset": {
- "description": "Start location of the matched substring in the prediction result text.",
- "type": "number"
+ "features": {
+ "description": "the Assets Features",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssetFeatureResponse"
+ }
+ },
+ "pagination": {
+ "$ref": "#/components/schemas/Pagination"
}
},
"example": {
- "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",
+ "type": "FeatureCollection",
+ "features": [
+ {
+ "type": "Feature",
"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 Commerciale Deria"
+ "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-"
},
- "store_id": {
- "$ref": "#/components/schemas/AssetId"
+ "address": {
+ "lines": [
+ "27 Berkeley St",
+ "London, ENG W1X 5AD"
+ ],
+ "country_code": "GB",
+ "city": "London",
+ "zipcode": "W1X 5AD"
},
- "types": {
- "$ref": "#/components/schemas/AssetTypes"
+ "user_properties": {
+ "take_away": "available"
},
- "matched_substrings": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/MatchedSubstring"
+ "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"
}
- }
- }
- }
- }
- },
- "example": {
- "predictions": [
- {
- "store_id": "2670",
- "name": "Sun Street",
- "types": [
- "Coffee shop"
- ],
- "matched_substrings": [
- {
- "offset": 4,
- "length": 6
- }
- ],
- "highlighted": "Sun Street"
- },
- {
- "store_id": "16069",
- "name": "7th Street",
- "types": [
- "Coffee shop"
- ],
- "matched_substrings": [
- {
- "offset": 4,
- "length": 6
- }
- ],
- "highlighted": "7th Street"
- },
- {
- "store_id": "1013873",
- "name": "The Street",
- "types": [
- "Coffee shop"
- ],
- "matched_substrings": [
- {
- "offset": 4,
- "length": 6
- }
- ],
- "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
- },
- "south": {
- "description": "The south latitude of bounds",
- "type": "number",
- "example": -51.5088
- },
- "east": {
- "description": "The east longitude of bounds",
- "type": "number",
- "example": -0.14408
+ },
+ "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"
+ }
},
- "north": {
- "description": "The north latitude of bounds",
- "type": "number",
- "example": 51.5088
+ "geometry": {
+ "type": "Point",
+ "coordinates": [
+ -0.14408,
+ 51.5088
+ ]
}
}
+ ],
+ "pagination": {
+ "page": 1,
+ "pageCount": 1
}
}
},
- "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",
- "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",
- "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"
- }
- }
- }
- },
- "LocalitiesAutocompleteRelatedItem": {
- "title": "LocalitiesAutocompleteRelatedItem",
+ "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": "Contains a set of related elements to the locality suggestion.",
"properties": {
- "public_id": {
- "type": "string",
- "description": "Public ID of a related Postal Code."
+ "stores": {
+ "$ref": "#/components/schemas/AssetFeatureCollectionResponse"
},
- "description": {
+ "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",
- "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 feedbacks on results. This ID is also required to perform Localities Details request.",
+ "example": "United States"
+ },
+ "continent": {
+ "description": "Continent name",
"type": "string",
- "example": "MkvnYy6K6oVGqeqfWJGO/6eCgqo="
+ "example": "North America"
},
- "types": {
- "description": "An array containing the types of the result",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/LocalitiesTypesAll"
- }
+ "region_state": {
+ "description": "Region name when available",
+ "type": "string",
+ "example": "Virginia"
},
- "type": {
- "deprecated": true,
- "description": "this field might be removed in the future, please use the `types` field which is more exhaustive",
- "type": "string"
+ "city": {
+ "description": "City name when available",
+ "type": "string",
+ "example": "Alexandria"
},
- "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.",
+ "postal_code": {
+ "description": "A postal code close to the user's location, when available",
"type": "string",
- "example": "20121, Milano, Italy"
+ "example": "22309"
},
- "matched_substrings": {
- "$ref": "#/components/schemas/LocalitiesAutocompleteMatchedFields"
+ "timezone": {
+ "$ref": "#/components/schemas/Timezone"
},
- "related": {
- "$ref": "#/components/schemas/LocalitiesAutocompleteRelated"
+ "raw_offset": {
+ "description": "The offset from utc in seconds",
+ "type": "integer",
+ "example": -18000
},
- "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"
- }
+ "dst_offset": {
+ "description": "The daylight saving time offset in seconds",
+ "type": "integer",
+ "example": 3600
}
},
"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
- }
- ]
- }
+ "country_code": "US",
+ "country_name": "United States",
+ "continent": "North America",
+ "latitude": 38.719,
+ "longitude": -77.1067,
+ "viewport": {
+ "northeast": {
+ "lat": 38.763915764205976,
+ "lng": -77.0491321464058
},
- {
- "public_id": "S/5AkUmMBhX35qVI2jR38+dALwk=",
- "type": "locality",
- "types": [
- "locality",
- "city"
- ],
- "description": "City of London, United Kingdom",
- "matched_substrings": {
- "description": [
- {
- "offset": 8,
- "length": 4
+ "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": {
+ "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
}
- ]
+ }
}
},
- "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",
+ "TimezoneResponse": {
+ "title": "TimezoneResponse",
"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": "Timezone information, name, raw offset to UTC and dst offset.",
"properties": {
- "type": {
- "type": "string",
- "enum": [
- "Polygon",
- "MultiPoligon"
- ],
- "description": "the geometry type"
+ "timezone": {
+ "description": "The time zone identifier eg. 'Europe/Paris'. see ",
+ "title": "Timezone id",
+ "type": "string"
},
- "coordinates": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/GeoJsonCoords"
- }
+ "timezone_name": {
+ "description": "The timezone name eg. `PDT`",
+ "title": "Timezone name",
+ "type": "string"
+ },
+ "raw_offset": {
+ "description": "offset from utc in seconds.",
+ "title": "Raw offset",
+ "type": "integer"
+ },
+ "dst_offset": {
+ "description": "The daylight saving time offset in seconds.",
+ "title": "Dst offset",
+ "type": "integer"
}
},
+ "required": [
+ "timezone",
+ "timezone_name",
+ "raw_offset",
+ "dst_offset"
+ ],
"example": {
- "type": "Polygon",
- "coordinates": [
- [
- [
- 2.06984,
- 48.77919
- ],
- [
- 2.07984,
- 48.77919
- ],
- [
- 2.07984,
- 48.78919
- ],
- [
- 2.06984,
- 48.78919
- ],
- [
- 2.06984,
- 48.77919
- ]
- ]
- ]
+ "timezone": "Europe/Paris",
+ "timezone_name": "CEST",
+ "raw_offset": 3600,
+ "dst_offset": 3600
}
},
- "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"
- ]
- }
+ "AssetAddressRequest": {
+ "title": "AssetAddressRequest",
+ "type": "object",
+ "description": "An object containing the separate components applicable to this address.",
+ "properties": {
+ "lines": {
+ "$ref": "#/components/schemas/AssetAddressLines"
},
- "example": {
- "types": [
- "country"
- ],
- "long_name": "United Kingdom",
- "short_name": "GBR"
- }
- },
- "example": [
- {
- "types": [
- "country"
+ "countryCode": {
+ "description": "An ISO_3166-1 Country Code where the Asset is located (see for full list)",
+ "type": [
+ "string",
+ "null"
],
- "long_name": "United Kingdom",
- "short_name": "GBR"
+ "example": "UK"
},
- {
- "long_name": "London",
- "short_name": "London",
- "types": [
- "locality"
- ]
+ "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"
}
- ]
- },
- "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 yey built by Royal Mail. Only one value yet.",
- "enum": [
- "not_yet_built"
- ]
+ },
+ "example": {
+ "lines": [
+ "8 Southwark St"
+ ],
+ "countryCode": "UK",
+ "city": "London",
+ "zipcode": "WC1E 7BT"
+ }
},
- "LocalitiesAddressSummary": {
- "title": "LocalitiesAddressSummary",
+ "AssetRequest": {
+ "title": "AssetRequest",
"type": "object",
- "description": "A short description of an address",
+ "description": "Attributes describing an Asset Request.",
"required": [
- "public_id",
- "description"
+ "location",
+ "name",
+ "storeId"
],
- "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=="
+ "location": {
+ "$ref": "#/components/schemas/LatLngLiteral"
},
- "description": {
- "type": "string",
- "description": "A human readable description of the address",
- "example": "Flat 1, Radway House, Alfred Road, London, W2 5ER"
+ "name": {
+ "$ref": "#/components/schemas/AssetName"
+ },
+ "storeId": {
+ "$ref": "#/components/schemas/AssetId"
+ },
+ "address": {
+ "$ref": "#/components/schemas/AssetAddressRequest"
+ },
+ "contact": {
+ "$ref": "#/components/schemas/AssetContact"
+ },
+ "types": {
+ "$ref": "#/components/schemas/AssetTypes"
+ },
+ "tags": {
+ "$ref": "#/components/schemas/AssetTags"
+ },
+ "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"
+ }
+ },
+ "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": {
+ "$ref": "#/components/schemas/AssetOpeningHours"
}
}
},
- "LocalitiesDetailsResponse": {
- "title": "LocalitiesDetailsResponse",
+ "AssetsCollectionRequest": {
+ "title": "AssetsCollectionRequest",
+ "description": "A Collection of Woosmap Assets as expected for Data Management Data API.",
"type": "object",
- "description": "Attributes describing a locality. Not all attributes are available for all locality types.",
+ "required": [
+ "stores"
+ ],
"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 feedbacks 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"
- }
+ "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
},
- "geometry": {
- "description": "The location of the PostalCode, in latitude and longitude, eventually associated with a Viewport and a shape.",
- "type": "object",
- "required": [
- "location"
+ "storeId": "STORE_ID_123456",
+ "name": "My Cool Store",
+ "address": {
+ "lines": [
+ "Building Centre",
+ "26 Store Street"
],
- "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"
+ "countryCode": "UK",
+ "city": "London",
+ "zipcode": "WC1E 7BT"
},
- "administrative_area_label": {
- "$ref": "#/components/schemas/AdministrativeAreaLabel"
+ "contact": {
+ "website": "https://www.woosmap.com",
+ "phone": "+44 20 7693 4000",
+ "email": "contact@woosmap.com"
},
- "status": {
- "$ref": "#/components/schemas/LocalitiesStatus"
+ "userProperties": {
+ "some_user_properties": "associated user value"
},
- "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`, `pages_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
- }
+ "openingHours": {
+ "timezone": "Europe/London",
+ "usual": {
+ "1": [],
+ "default": [
+ {
+ "start": "08:30",
+ "end": "22:00"
}
- },
- "list": {
- "type": "array",
- "description": "List of addresses",
- "items": {
- "$ref": "#/components/schemas/LocalitiesAddressSummary"
+ ]
+ },
+ "special": {
+ "2015-02-07": [
+ {
+ "start": "08:00",
+ "end": "23:00"
}
- }
+ ]
}
}
- }
- }
- },
- "example": {
- "result": {
- "public_id": "QaCU+fBtigK65ztSrqHqUoUDwZw=",
- "types": [
- "postal_code"
- ],
- "formatted_address": "SW1A 0AA, City of London",
- "name": "SW1A 0AA",
- "geometry": {
+ },
+ {
+ "types": [
+ "drive"
+ ],
+ "tags": [
+ "covered_parking"
+ ],
"location": {
- "lat": 51.499842,
- "lng": -0.124638
+ "lat": 38.5239,
+ "lng": -77.0157
},
- "accuracy": "GEOMETRIC_CENTER"
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
+ "storeId": "STORE_ID_45678",
+ "name": "My Cool Store 2",
+ "address": {
+ "lines": [
+ "1805-1899",
+ "Orchard St"
],
- "long_name": "United Kingdom",
- "short_name": "GB"
+ "countryCode": "US",
+ "city": "Alexandria",
+ "zipcode": "22309"
},
- {
- "types": [
- "state",
- "division_level_1"
- ],
- "long_name": "England",
- "short_name": "England"
+ "contact": {
+ "website": "https://www.woosmap.com",
+ "phone": "+44 20 7693 4000",
+ "email": "contact@woosmap.com"
},
- {
- "types": [
- "administrative_area_level_1",
- "county",
- "division_level_2"
- ],
- "long_name": "City of London",
- "short_name": "City of London"
+ "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": [
{
- "types": [
- "district",
- "division_level_3"
- ],
- "long_name": "Westminster",
- "short_name": "Westminster"
+ "type": "string"
},
{
- "types": [
- "postal_codes"
- ],
- "long_name": "SW1A 0AA",
- "short_name": "SW1A 0AA"
+ "type": "integer"
}
- ],
- "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",
+ "Error400": {
+ "title": "Error400",
"type": "object",
- "description": "The location of the result, in latitude and longitude. Accuracy is also provided.",
+ "description": "The request is invalid",
"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",
+ "status": {
"type": "string",
- "enum": [
- "ROOFTOP",
- "RANGE_INTERPOLATED",
- "GEOMETRIC_CENTER",
- "APPROXIMATE",
- "POSTAL_CODE",
- "DISTRICT"
- ]
- },
- "location": {
- "$ref": "#/components/schemas/LatLngLiteral"
- },
- "viewport": {
- "$ref": "#/components/schemas/Bounds"
+ "description": "the status of the 400 response",
+ "example": "error"
},
- "shape": {
- "$ref": "#/components/schemas/GeoJsonGeometry"
+ "value": {
+ "description": "the value of request causing the Error",
+ "example": "The request is invalid, the data is not a valid JSON.",
+ "type": "string"
}
- },
- "example": {
- "location": {
- "lat": 48.829405,
- "lng": 2.367944
- },
- "location_type": "GEOMETRIC_CENTER"
}
},
- "LocalitiesScoresPerComponents": {
- "title": "LocalitiesScoresPerComponents",
+ "MatchedSubstring": {
+ "title": "MatchedSubstring",
"type": "object",
"properties": {
- "street_name": {
- "description": "Street score",
- "type": "number"
- },
- "postal_code": {
- "description": "Postal code score",
+ "length": {
+ "description": "Length of the matched substring in the prediction result text.",
"type": "number"
},
- "locality": {
- "description": "Postal code score",
+ "offset": {
+ "description": "Start location of the matched substring in the prediction result text.",
"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 feedbacks 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"
- }
+ "offset": 0,
+ "length": 4
}
},
- "LocalitiesGeocodeCollectionResponse": {
- "title": "LocalitiesGeocodeCollectionResponse",
+ "AssetAutocompleteResponse": {
+ "title": "AssetAutocompleteResponse",
"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)",
+ "description": "Asset Autocomplete Response with highlighted results on asset name.",
"properties": {
- "results": {
- "type": "array",
+ "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": {
- "$ref": "#/components/schemas/LocalitiesGeocodeResponse"
+ "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 Commerciale Deria"
+ },
+ "store_id": {
+ "$ref": "#/components/schemas/AssetId"
+ },
+ "types": {
+ "$ref": "#/components/schemas/AssetTypes"
+ },
+ "matched_substrings": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/MatchedSubstring"
+ }
+ }
+ }
}
}
},
"example": {
- "results": [
+ "predictions": [
{
- "public_id": "0+FTYd/1MsiBSxLAKq+/Fiyy+uM=",
+ "store_id": "2670",
+ "name": "Sun Street",
"types": [
- "address",
- "route"
+ "Coffee shop"
],
- "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"
- },
+ "matched_substrings": [
{
- "types": [
- "locality"
- ],
- "long_name": "Paris",
- "short_name": "Paris"
- },
+ "offset": 4,
+ "length": 6
+ }
+ ],
+ "highlighted": "Sun Street"
+ },
+ {
+ "store_id": "16069",
+ "name": "7th Street",
+ "types": [
+ "Coffee shop"
+ ],
+ "matched_substrings": [
{
- "types": [
- "postal_codes"
- ],
- "long_name": "75013",
- "short_name": "75013"
- },
+ "offset": 4,
+ "length": 6
+ }
+ ],
+ "highlighted": "7th Street"
+ },
+ {
+ "store_id": "1013873",
+ "name": "The Street",
+ "types": [
+ "Coffee shop"
+ ],
+ "matched_substrings": [
{
- "types": [
- "route"
- ],
- "long_name": "Place Jeanne D'Arc",
- "short_name": "Place Jeanne D'Arc"
+ "offset": 4,
+ "length": 6
}
],
- "geometry": {
- "location": {
- "lat": 48.829405,
- "lng": 2.367944
- },
- "location_type": "GEOMETRIC_CENTER"
+ "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
},
- "scores_per_components": {
- "street_name": 1
+ "south": {
+ "description": "The south latitude of bounds",
+ "type": "number",
+ "example": -51.5088
+ },
+ "east": {
+ "description": "The east longitude of bounds",
+ "type": "number",
+ "example": -0.14408
+ },
+ "north": {
+ "description": "The north latitude of bounds",
+ "type": "number",
+ "example": 51.5088
}
}
- ]
+ }
}
},
- "LocalitiesNearbyResponse": {
- "title": "LocalitiesNearbyResponse",
+ "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",
+ "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",
+ "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": "Attributes describing a point of interest.",
+ "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": {
- "types": {
- "description": "An array containing the types of the result.",
+ "description": {
+ "description": "match substrings for localities `description`",
"type": "array",
- "example": [
- "point_of_interest",
- "transit.station.rail.train",
- "train_station"
- ],
"items": {
- "$ref": "#/components/schemas/LocalitiesTypesPoi"
+ "$ref": "#/components/schemas/MatchedSubstring"
}
- },
- "name": {
- "description": "The name of the result.",
- "type": "string"
- },
+ }
+ }
+ },
+ "LocalitiesAutocompleteRelatedItem": {
+ "title": "LocalitiesAutocompleteRelatedItem",
+ "type": "object",
+ "description": "Contains a set of related elements to the locality suggestion.",
+ "properties": {
"public_id": {
- "description": "Contains a unique ID for each result. Please use this ID to give feedbacks 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"
+ "description": "Public ID of a related Postal Code."
},
- "categories": {
- "description": "An array containing the categories of the result. This information is now available in the `types` field and will be removed.",
+ "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",
- "deprecated": true,
"items": {
- "$ref": "#/components/schemas/LocalitiesTypesPoi"
+ "$ref": "#/components/schemas/LocalitiesAutocompleteRelatedItem"
}
- },
- "formatted_address": {
- "$ref": "#/components/schemas/FormattedAddress"
}
}
},
- "LocalitiesNearbyCollectionResponse": {
- "title": "LocalitiesNearbyCollectionResponse",
+ "LocalitiesAutocompleteResponse": {
+ "title": "LocalitiesAutocompleteResponse",
"type": "object",
- "description": "Collection of nearby points of interest.",
+ "description": "Attributes describing a locality. Not all attributes will be available for all locality types.",
"properties": {
- "results": {
- "description": "The array of nearby points of interest.",
+ "public_id": {
+ "description": "Contains a unique ID for each suggestion. Please use this ID if you need to give us feedbacks on results. This ID is also required to perform Localities Details request.",
+ "type": "string",
+ "example": "MkvnYy6K6oVGqeqfWJGO/6eCgqo="
+ },
+ "types": {
+ "description": "An array containing the types of the result",
"type": "array",
"items": {
- "$ref": "#/components/schemas/LocalitiesNearbyResponse"
+ "$ref": "#/components/schemas/LocalitiesTypesAll"
}
},
- "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"
- ]
- }
- }
+ "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`.\n",
+ "type": "boolean",
+ "example": true
}
},
"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
- }
+ "public_id": "Ch6qA8cLmvyvEEoFy6nYeFcEdNU=",
+ "description": "London, City of London, United Kingdom",
+ "type": "locality",
+ "matched_substrings": {
+ "description": [
+ {
+ "offset": 0,
+ "length": 6
},
- "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"
- }
- ]
- },
+ {
+ "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": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmJlMWNkMTE2ZDQwM2E0Y2YwNGQ5NWQ2OTlmZWRmM2FhZTExNGU3ZWY=",
+ "public_id": "Ch6qA8cLmvyvEEoFy6nYeFcEdNU=",
+ "type": "locality",
"types": [
- "point_of_interest",
- "business.food_and_drinks.restaurant"
- ],
- "categories": [
- "business.food_and_drinks.restaurant"
+ "locality",
+ "city"
],
- "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"
- }
- ]
+ "description": "London, City of London, United Kingdom",
+ "matched_substrings": {
+ "description": [
+ {
+ "offset": 0,
+ "length": 4
+ }
+ ]
+ }
},
{
- "public_id": "cG9pOnVzOmJ1c2luZXNzLnNob3AuZ3JvY2VyeTo1YTczMjYxOTQyYjVlZmUwOGEzZjQ1NGZmMTMwMmJjNjA4ODE3NmRk",
+ "public_id": "m/T2C4YI2LgszkKXrELBC+9dfC8=",
+ "type": "locality",
"types": [
- "point_of_interest",
- "business.shop.grocery"
- ],
- "categories": [
- "business.shop.grocery"
+ "locality",
+ "city"
],
- "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
+ "description": "Derry/Londonderry, Derry City and Strabane, United Kingdom",
+ "matched_substrings": {
+ "description": [
+ {
+ "offset": 6,
+ "length": 4
}
- }
- },
- "address_components": [
- {
- "types": [
- "country",
- "administrative_area_level_0",
- "division_level_0"
- ],
- "long_name": "United States",
- "short_name": "US"
- }
- ]
+ ]
+ }
},
{
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZpbmFuY2UuYmFuazpiOGY5MDE4Nzc2ZDZjNmEwZTljOGM4YWM0OTAxZWZlNzNmODZkM2M3",
+ "public_id": "J6eISGMjjvQwPkao8rsByB3aVwM=",
+ "type": "locality",
"types": [
- "point_of_interest",
- "business.finance.bank"
+ "locality",
+ "village"
],
- "categories": [
- "business.finance.bank"
+ "description": "London Colney, Hertfordshire, United Kingdom",
+ "matched_substrings": {
+ "description": [
+ {
+ "offset": 0,
+ "length": 4
+ }
+ ]
+ }
+ },
+ {
+ "public_id": "52MnrbHVWH21CLWH8VY/YWKhqeM=",
+ "type": "locality",
+ "types": [
+ "locality",
+ "village"
],
- "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"
- }
- ]
+ "description": "London Apprentice, Cornwall, United Kingdom",
+ "matched_substrings": {
+ "description": [
+ {
+ "offset": 0,
+ "length": 4
+ }
+ ]
+ }
},
{
- "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQzMTMzZTJkODdiOGJjMGE3ZjI2YTdiMWVjYTZlZmI1MjQyYWE3MTE=",
+ "public_id": "S/5AkUmMBhX35qVI2jR38+dALwk=",
+ "type": "locality",
"types": [
- "point_of_interest",
- "business.food_and_drinks.restaurant"
+ "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": {
+ "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
],
- "categories": [
- "business.food_and_drinks.restaurant"
+ [
+ 2.07984,
+ 48.77919
],
- "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"
+ [
+ 2.07984,
+ 48.78919
],
- "categories": [
- "business.food_and_drinks.restaurant"
+ [
+ 2.06984,
+ 48.78919
],
- "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"
- }
+ [
+ 2.06984,
+ 48.77919
]
- },
- {
- "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"
- },
+ ]
+ ]
+ }
+ },
+ "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": [
{
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
+ "type": "string"
},
{
- "types": [
- "route"
- ],
- "long_name": "Reade Street",
- "short_name": "Reade Street"
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
- ]
- },
- {
- "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"
- },
+ "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": [
{
- "types": [
- "locality"
- ],
- "long_name": "New York",
- "short_name": "New York"
+ "type": "string"
},
{
- "types": [
- "route"
- ],
- "long_name": "Broadway",
- "short_name": "Broadway"
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
}
- ]
- },
- {
- "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
- }
+ "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"
},
- "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"
- }
+ "example": [
+ "country",
+ "administrative_area_level_0"
]
}
- ],
- "pagination": {
- "previous_page": 2,
- "next_page": 4
- }
- }
- },
- "AddressAutocompleteMatchedFields": {
- "title": "AddressAutocompleteMatchedFields",
- "type": "object",
- "description": "Contains a set of substrings for description. Each substring is identified by an `offset` and a `length`.`",
- "properties": {
- "description": {
- "description": "match substrings for address `description`",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/MatchedSubstring"
- }
+ },
+ "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"
+ ]
+ }
+ ]
},
- "AddressTypes": {
- "title": "AddressTypes",
+ "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",
- "description": "Contains the type of result.",
- "enum": [
- "house_number",
- "route",
- "address_block",
- "locality",
- "admin_level",
- "country"
- ]
+ "example": "district"
},
- "AddressStatus": {
- "title": "AddressStatus",
+ "LocalitiesStatus": {
+ "title": "LocalitiesStatus",
"type": "string",
- "example": "OK",
- "description": "Returns more info on if the request was successful or not, valid responses.\n * `OK` indicates the response contains a valid result.\n * `INVALID_REQUEST` indicates that the provided request was invalid (e.g. wrong URL syntax).\n * `REQUEST_DENIED` indicates that the service denied use of the Address API (e.g. wrong API Key, wrong/no referer, …).\n * `UNKNOWN_ERROR` indicates an Address API request could not be processed due to a server error. The request may succeed if you try again.\n",
+ "description": "This optional field is only available for UK addresses referenced as not yey built by Royal Mail. Only one value yet.",
"enum": [
- "OK",
- "INVALID_REQUEST",
- "REQUEST_DENIED",
- "UNKNOWN_ERROR"
+ "not_yet_built"
]
},
- "AddressAutocompleteResponse": {
- "title": "AddressAutocompleteResponse",
+ "LocalitiesAddressSummary": {
+ "title": "LocalitiesAddressSummary",
"type": "object",
- "description": "Attributes describing an Address.",
+ "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": {
- "description": {
- "description": "Address description to be used as suggestion in drop down list if needed.",
- "type": "string",
- "example": "London, England, United Kingdom"
- },
"public_id": {
- "description": "Contains a unique ID for each suggestion. Please use this ID if you need to give us feedbacks on results. This ID is also required to perform Address Details request.",
"type": "string",
- "example": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0"
- },
- "matched_substring": {
- "$ref": "#/components/schemas/AddressAutocompleteMatchedFields"
- },
- "type": {
- "$ref": "#/components/schemas/AddressTypes"
+ "description": "The public_id of the address can be used to gather details on that specific address",
+ "example": "Nmp0K1VVUFQ4eFI3S1BuaDZEZVVJVWhYY3A4PV9faitia1pNNURnOWYvQmRjMUdweXl5SjdLZUZnPQ=="
},
- "status": {
- "$ref": "#/components/schemas/AddressStatus"
+ "description": {
+ "type": "string",
+ "description": "A human readable description of the address",
+ "example": "Flat 1, Radway House, Alfred Road, London, W2 5ER"
}
- },
- "example": {
- "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0",
- "description": "London, England, United Kingdom",
- "matched_substring": {
- "description": [
- {
- "offset": 0,
- "length": 4
- }
- ]
- },
- "type": "locality"
}
},
- "AddressAutocompleteCollectionResponse": {
- "title": "AddressAutocompleteCollectionResponse",
+ "LocalitiesDetailsResponse": {
+ "title": "LocalitiesDetailsResponse",
"type": "object",
- "description": "Address Collection Response containing Localities",
+ "description": "Attributes describing a locality. Not all attributes are available for all locality types.",
"properties": {
- "predictions": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AddressAutocompleteResponse"
- }
- },
- "status": {
- "$ref": "#/components/schemas/AddressStatus"
- }
- },
- "example": {
- "predictions": [
- {
- "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0",
- "description": "London, England, United Kingdom",
- "matched_substring": {
- "description": [
- {
- "offset": 0,
- "length": 4
- }
- ]
+ "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 feedbacks on results.",
+ "type": "string",
+ "example": "MkvnYy6K6oVGqeqfWJGO/6eCgqo="
},
- "type": "locality"
- },
- {
- "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwNDE5Nzgz",
- "description": "Londonderry, Northern Ireland, United Kingdom",
- "matched_substring": {
- "description": [
- {
- "offset": 0,
- "length": 4
+ "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
+ }
+ }
},
- "type": "locality"
- },
- {
- "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NjEw",
- "description": "London Heathrow Airport, Hounslow, England, United Kingdom",
- "matched_substring": {
- "description": [
- {
- "offset": 0,
- "length": 4
+ "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`, `pages_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": "QaCU+fBtigK65ztSrqHqUoUDwZw=",
+ "types": [
+ "postal_code"
+ ],
+ "formatted_address": "SW1A 0AA, City of London",
+ "name": "SW1A 0AA",
+ "geometry": {
+ "location": {
+ "lat": 51.499842,
+ "lng": -0.124638
},
- "type": "locality"
+ "accuracy": "GEOMETRIC_CENTER"
},
- {
- "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM0NDEy",
- "description": "London Luton Airport, Luton, England, United Kingdom",
- "matched_substring": {
- "description": [
- {
- "offset": 0,
- "length": 4
- }
- ]
+ "address_components": [
+ {
+ "types": [
+ "country",
+ "administrative_area_level_0",
+ "division_level_0"
+ ],
+ "long_name": "United Kingdom",
+ "short_name": "GB"
},
- "type": "locality"
+ {
+ "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": "OK"
+ }
}
},
- "AddressGeometry": {
- "title": "AddressGeometry",
+ "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",
+ "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"
+ "APPROXIMATE",
+ "POSTAL_CODE",
+ "DISTRICT"
]
},
"location": {
@@ -10511,6 +8314,9 @@
},
"viewport": {
"$ref": "#/components/schemas/Bounds"
+ },
+ "shape": {
+ "$ref": "#/components/schemas/GeoJsonGeometry"
}
},
"example": {
@@ -10521,1402 +8327,1262 @@
"location_type": "GEOMETRIC_CENTER"
}
},
- "AddressDetailsResponse": {
- "title": "AddressDetailsResponse",
+ "LocalitiesScoresPerComponents": {
+ "title": "LocalitiesScoresPerComponents",
"type": "object",
- "description": "Address Details Response",
"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 feedbacks on results.",
+ "type": "string",
+ "example": "MkvnYy6K6oVGqeqfWJGO/6eCgqo="
+ },
+ "geometry": {
+ "$ref": "#/components/schemas/LocalitiesAddressGeometry"
+ },
"status": {
- "$ref": "#/components/schemas/AddressStatus"
+ "$ref": "#/components/schemas/LocalitiesStatus"
},
- "result": {
- "description": "the root node of address details",
- "type": "object",
- "properties": {
- "formatted_address": {
- "$ref": "#/components/schemas/FormattedAddress"
- },
- "types": {
- "description": "The types of result.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AddressTypes"
+ "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"
}
- },
- "public_id": {
- "description": "Contains a unique ID for each suggestion. Please use this ID to give feedbacks on results.",
- "type": "string",
- "example": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0"
- },
- "address_components": {
- "$ref": "#/components/schemas/AddressComponents"
- },
+ ],
"geometry": {
- "$ref": "#/components/schemas/AddressGeometry"
- }
- }
- }
- },
- "example": {
- "result": {
- "formatted_address": "London, England, United Kingdom",
- "types": [
- "locality"
- ],
- "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0",
- "address_components": [
- {
- "types": [
- "country"
- ],
- "long_name": "United Kingdom",
- "short_name": "GBR"
- },
- {
- "types": [
- "state"
- ],
- "long_name": "England",
- "short_name": "England"
- },
- {
- "types": [
- "county"
- ],
- "long_name": "London",
- "short_name": "LDN"
- },
- {
- "long_name": "London",
- "short_name": "London",
- "types": [
- "locality"
- ]
- },
- {
- "long_name": "SW1A 2",
- "short_name": "SW1A 2",
- "types": [
- "postal_code"
- ]
- }
- ],
- "geometry": {
- "location_type": "GEOMETRIC_CENTER",
- "location": {
- "lat": 51.50643,
- "lng": -0.12719
- },
- "viewport": {
- "northeast": {
- "lat": 51.68629,
- "lng": 0.28206
+ "location": {
+ "lat": 48.829405,
+ "lng": 2.367944
},
- "southwest": {
- "lat": 51.28043,
- "lng": -0.56316
- }
+ "location_type": "GEOMETRIC_CENTER"
+ },
+ "scores_per_components": {
+ "street_name": 1
}
}
- },
- "status": "OK"
+ ]
}
},
- "AddressGeocodeTypes": {
- "title": "AddressGeocodeTypes",
- "type": "string",
- "description": "Contains the type of result.",
- "enum": [
- "address",
- "house_number",
- "route",
- "address_block",
- "locality",
- "admin_level",
- "country",
- "place"
- ]
- },
- "AddressGeocodeResponse": {
- "title": "AddressGeocodeResponse",
+ "LocalitiesNearbyResponse": {
+ "title": "LocalitiesNearbyResponse",
"type": "object",
- "description": "Address Geocode Response",
+ "description": "Attributes describing a point of interest.",
"properties": {
- "formatted_address": {
- "$ref": "#/components/schemas/FormattedAddress"
- },
"types": {
- "description": "The types of result. If result type is a `place`, additional types may be returned (`eat_and_drink`, `going_out_entertainment`, `sights_and_museums`, `natural_and_geographical`, `transport`, `accommodations`, `leisure_and_outdoor`, `shopping`, `business_and_services`, `facilities`, `areas_and_buildings`)",
+ "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/AddressGeocodeTypes"
+ "$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 feedbacks 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"
},
- "geometry": {
- "$ref": "#/components/schemas/AddressGeometry"
+ "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"
}
}
},
- "AddressGeocodeCollectionResponse": {
- "title": "AddressGeocodeCollectionResponse",
+ "LocalitiesNearbyCollectionResponse": {
+ "title": "LocalitiesNearbyCollectionResponse",
"type": "object",
- "description": "Address Geocode Collection Response. Contains one or more Addresses with coordinates (default to one result for reverse geocoding)",
+ "description": "Collection of nearby points of interest.",
"properties": {
"results": {
+ "description": "The array of nearby points of interest.",
"type": "array",
"items": {
- "$ref": "#/components/schemas/AddressGeocodeResponse"
+ "$ref": "#/components/schemas/LocalitiesNearbyResponse"
}
},
- "status": {
- "$ref": "#/components/schemas/AddressStatus"
+ "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": [
{
- "formatted_address": "Place de la Résistance, 75007 Paris, France",
+ "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6ZTc2ZDA1YzBiM2M0M2NmNmVkNTJjNGQyZDFiZDE3Nzc0OTZkNjlmOA==",
"types": [
- "address",
- "route"
+ "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"
+ "country",
+ "administrative_area_level_0",
+ "division_level_0"
+ ],
+ "long_name": "United States",
+ "short_name": "US"
+ },
+ {
+ "types": [
+ "locality"
],
- "long_name": "France",
- "short_name": "FRA"
+ "long_name": "New York",
+ "short_name": "New York"
},
{
"types": [
- "state"
+ "route"
],
- "long_name": "Ile-de-France",
- "short_name": "IDF"
- },
+ "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": [
- "county"
+ "country",
+ "administrative_area_level_0",
+ "division_level_0"
],
- "long_name": "Paris",
- "short_name": "Paris"
+ "long_name": "United States",
+ "short_name": "US"
},
{
- "long_name": "Paris",
- "short_name": "Paris",
"types": [
"locality"
- ]
- },
- {
- "long_name": "7th Arrondissement",
- "short_name": "7th Arrondissement",
- "types": [
- "district"
- ]
+ ],
+ "long_name": "New York",
+ "short_name": "New York"
},
{
- "long_name": "Place de la Résistance",
- "short_name": "Place de la Résistance",
"types": [
"route"
- ]
- },
- {
- "long_name": "75007",
- "short_name": "75007",
- "types": [
- "postal_code"
- ]
+ ],
+ "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_type": "GEOMETRIC_CENTER",
"location": {
- "lat": 48.86213,
- "lng": 2.30152
+ "lat": 40.71283012706819,
+ "lng": -74.00727837935057
},
"viewport": {
"northeast": {
- "lat": 48.86231,
- "lng": 2.30541
+ "lat": 40.71286059528623,
+ "lng": -74.00724213866874
},
"southwest": {
- "lat": 48.86191,
- "lng": 2.30147
+ "lat": 40.71279957503111,
+ "lng": -74.00731464213119
}
}
- }
- }
- ],
- "status": "OK"
- }
- },
- "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/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"
+ },
+ "address_components": [
+ {
+ "types": [
+ "country",
+ "administrative_area_level_0",
+ "division_level_0"
+ ],
+ "long_name": "United States",
+ "short_name": "US"
+ }
+ ]
},
- "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"
- }
- },
- "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/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))",
+ "public_id": "cG9pOnVzOmJ1c2luZXNzLmZpbmFuY2UuYmFuazpiOGY5MDE4Nzc2ZDZjNmEwZTljOGM4YWM0OTAxZWZlNzNmODZkM2M3",
"types": [
- "delivery"
+ "point_of_interest",
+ "business.finance.bank"
],
- "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"
+ "categories": [
+ "business.finance.bank"
],
- "description": "Delivery Zone for Store C"
- }
- ],
- "status": "ok"
- }
- },
- "ZonesCollectionRequest": {
- "title": "ZonesCollectionRequest",
- "type": "object",
- "description": "A Collection of Woosmap Zones as expected for Data Management Data API.",
- "required": [
- "zones"
- ],
- "properties": {
- "zones": {
- "description": "The Zones collection",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Zone"
- }
- }
- },
- "example": {
- "zones": [
+ "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"
+ }
+ ]
+ },
{
- "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))",
+ "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQzMTMzZTJkODdiOGJjMGE3ZjI2YTdiMWVjYTZlZmI1MjQyYWE3MTE=",
"types": [
- "delivery"
+ "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"
+ }
]
},
{
- "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))",
+ "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQ1NjMyN2RiM2EyNWJlYmIwNjJjZjNlYWYwMDE3ZDIyYzEyNWNlMjY=",
"types": [
- "delivery"
+ "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"
+ }
]
},
{
- "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))",
+ "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5iYXI6MDE5ZGUzNTdiZDkyNzAyZDM4ZDUyOWQ0YmJiZjBmODQ5YWEzZmY1NA==",
"types": [
- "delivery"
+ "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"
+ }
]
- }
- ]
- }
- },
- "SuccessZones": {
- "title": "SuccessZones",
- "type": "object",
- "description": "Message returned to a success Zones request",
- "properties": {
- "status": {
- "type": "string",
- "description": "the status of the 2OO Zones response",
- "example": "success"
- },
- "message": {
- "description": "message returned with the 2OO Zones request",
- "example": "Zones successfully updated.",
- "type": "string"
- }
- }
- },
- "DistanceStatus": {
- "title": "DistanceStatus",
- "type": "string",
- "description": "Returns more info on if the request was successful or not.\n * `OK` indicates the response contains a valid result.\n * `INVALID_REQUEST` indicates that the provided request was invalid (e.g. wrong URL syntax).\n * `MAX_ELEMENTS_EXCEEDED` indicates that the product of origins and destinations exceeds the per-query limit (fixed at 200 elts/q).\n * `MAX_ROUTE_LENGTH_EXCEEDED` indicates that at least one of requested route is too long and the matrix cannot be processed (>500km).\n * `REQUEST_DENIED` indicates that the service denied use of the Distance API service (e.g. wrong API Key, wrong/no referer, …).\n * `BACKEND_ERROR` indicates a Distance API request could not be processed due to a server error. This may indicate that the origin and/or destination of this pairing could not be matched to the network. The request may or may not succeed if you try again.\n * `OVER_QUERY_LIMIT` (associated to a 429 status code) indicates that the number of queries per second (QPS) or the number of elements per second (EPS) exceed the [usage limits](https://developers.woosmap.com/products/distance-api/distance-matrix-endpoint/#usage-limits)\n",
- "enum": [
- "OK",
- "INVALID_REQUEST",
- "MAX_ELEMENTS_EXCEEDED",
- "MAX_ROUTE_LENGTH_EXCEEDED",
- "REQUEST_DENIED",
- "BACKEND_ERROR",
- "OVER_QUERY_LIMIT"
- ]
- },
- "DurationValue": {
- "title": "DurationValue",
- "description": "The total duration to travel this route/leg, expressed in seconds (value) and as text. The textual value gives a structured string for duration in the specified language (if available).",
- "type": "object",
- "properties": {
- "value": {
- "description": "The duration in seconds",
- "type": "number",
- "example": 272.5
- },
- "text": {
- "type": "string",
- "description": "The readable duration value",
- "example": "5 mins"
- }
- },
- "example": {
- "value": 272.5,
- "text": "5 mins"
- }
- },
- "DistanceValue": {
- "title": "DistanceValue",
- "description": "The total distance expressed in meters (value) and as text. The textual value uses the unit system specified with the units parameter of the original request.",
- "type": "object",
- "properties": {
- "value": {
- "description": "The distance in meters.",
- "type": "number",
- "example": 2775.1
- },
- "text": {
- "description": "The readable distance using the unit system specified.",
- "type": "string",
- "example": "2.8 km"
- }
- },
- "example": {
- "value": 2775.1,
- "text": "2.8 km"
- }
- },
- "DistanceMatrixElementResponse": {
- "title": "DistanceMatrixElementResponse",
- "type": "object",
- "description": "Attributes describing an element of origin and destination returned in distance Matrix response.",
- "properties": {
- "status": {
- "type": "string",
- "description": "Status returned for Distance Matrix Element Response.\n - `OK` indicates the response contains a valid result.\n - `NOT_FOUND` indicates that the origin and/or destination of this pairing could not be matched to the network.\n - `ZERO_RESULTS` indicates no route could be found between the origin and destination.\n",
- "enum": [
- "OK",
- "NOT_FOUND",
- "ZERO_RESULTS"
- ]
- },
- "duration": {
- "$ref": "#/components/schemas/DurationValue"
- },
- "distance": {
- "$ref": "#/components/schemas/DistanceValue"
- }
- }
- },
- "DistanceMatrixElementsResponse": {
- "title": "DistanceMatrixElementsResponse",
- "type": "object",
- "description": "Attributes describing elements of origin and destination returned in distance Matrix response.",
- "properties": {
- "elements": {
- "type": "array",
- "description": "the route element",
- "items": {
- "$ref": "#/components/schemas/DistanceMatrixElementResponse"
- }
- }
- },
- "example": {
- "elements": [
+ },
{
- "status": "OK",
- "duration": {
- "value": 866,
- "text": "14 mins"
+ "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
+ }
},
- "distance": {
- "value": 10613,
- "text": "10.6 km"
- }
+ "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"
+ }
+ ]
},
{
- "status": "OK",
- "duration": {
- "value": 935,
- "text": "16 mins"
+ "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
+ }
},
- "distance": {
- "value": 10287,
- "text": "10.3 km"
- }
+ "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
+ }
}
},
- "DistanceMatrixResponse": {
- "title": "DistanceMatrixResponse",
+ "AddressAutocompleteMatchedFields": {
+ "title": "AddressAutocompleteMatchedFields",
"type": "object",
- "description": "Attributes describing an distance Matrix response.",
+ "description": "Contains a set of substrings for description. Each substring is identified by an `offset` and a `length`.`",
"properties": {
- "status": {
- "$ref": "#/components/schemas/DistanceStatus"
- },
- "rows": {
- "description": "Contains an array of elements for each pair of origin and destination",
+ "description": {
+ "description": "match substrings for address `description`",
"type": "array",
"items": {
- "$ref": "#/components/schemas/DistanceMatrixElementsResponse"
+ "$ref": "#/components/schemas/MatchedSubstring"
}
}
- },
- "example": {
- "status": "OK",
- "rows": [
- {
- "elements": [
- {
- "status": "OK",
- "duration": {
- "value": 978,
- "text": "16 mins"
- },
- "distance": {
- "value": 10796,
- "text": "10.8 km"
- }
- },
- {
- "status": "OK",
- "duration": {
- "value": 942,
- "text": "16 mins"
- },
- "distance": {
- "value": 10322,
- "text": "10.3 km"
- }
- }
- ]
- }
- ]
}
},
- "Origins": {
- "title": "Origins",
- "example": "48.709,2.403",
- "type": "string",
- "description": "The starting point for calculating travel distance. You can supply one or more locations separated by the pipe character, in the form of latitude/longitude coordinates. They are used unchanged to calculate distance. Ensure that no space exists between the latitude and longitude values. In order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc:encoded-polyline:`\n"
- },
- "Destinations": {
- "title": "Destinations",
- "example": "48.709,2.403|48.768,2.338",
+ "AddressTypes": {
+ "title": "AddressTypes",
"type": "string",
- "description": "One or more locations to use as the finishing point for calculating travel distance. The options for the destinations parameter are the same as for the origins parameter, described above. In order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc:encoded-polyline:`\n"
+ "description": "Contains the type of result.",
+ "enum": [
+ "house_number",
+ "route",
+ "address_block",
+ "locality",
+ "admin_level",
+ "country"
+ ]
},
- "Units": {
- "title": "Units",
- "example": "metric",
+ "AddressStatus": {
+ "title": "AddressStatus",
"type": "string",
+ "example": "OK",
+ "description": "Returns more info on if the request was successful or not, valid responses.\n * `OK` indicates the response contains a valid result.\n * `INVALID_REQUEST` indicates that the provided request was invalid (e.g. wrong URL syntax).\n * `REQUEST_DENIED` indicates that the service denied use of the Address API (e.g. wrong API Key, wrong/no referer, …).\n * `UNKNOWN_ERROR` indicates an Address API request could not be processed due to a server error. The request may succeed if you try again.\n",
"enum": [
- "imperial",
- "metric"
- ],
- "description": "Specifies the unit system to use when expressing distance as text. Two different units supported:\n * `metric` (default) returns distances in kilometers and meters\n * `imperial` returns distances in miles and feet\n"
+ "OK",
+ "INVALID_REQUEST",
+ "REQUEST_DENIED",
+ "UNKNOWN_ERROR"
+ ]
},
- "DistanceMatrixRequest": {
- "title": "DistanceMatrixRequest",
+ "AddressAutocompleteResponse": {
+ "title": "AddressAutocompleteResponse",
"type": "object",
- "description": "Attributes describing a distance Matrix request",
- "required": [
- "origins",
- "destinations"
- ],
+ "description": "Attributes describing an Address.",
"properties": {
- "origins": {
- "$ref": "#/components/schemas/Origins"
- },
- "destinations": {
- "$ref": "#/components/schemas/Destinations"
- },
- "mode": {
- "example": "driving",
+ "description": {
+ "description": "Address description to be used as suggestion in drop down list if needed.",
"type": "string",
- "enum": [
- "driving",
- "cycling",
- "walking"
- ],
- "description": "Specifies the mode of transport to use when calculating distance\n"
+ "example": "London, England, United Kingdom"
},
- "language": {
- "example": "en",
+ "public_id": {
+ "description": "Contains a unique ID for each suggestion. Please use this ID if you need to give us feedbacks on results. This ID is also required to perform Address Details request.",
"type": "string",
- "description": "The language code, indicating in which language the results should be returned, if possible. If language is not supplied, the Distance API service will use the navigator language or “en”.\n"
- },
- "units": {
- "$ref": "#/components/schemas/Units"
+ "example": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0"
},
- "elements": {
- "example": "duration_distance",
- "type": "string",
- "enum": [
- "distance",
- "duration",
- "duration_distance"
- ],
- "description": "Specifies element values that will be part of the API response (distance and/or duration). if not specified default is `distance`\n"
+ "matched_substring": {
+ "$ref": "#/components/schemas/AddressAutocompleteMatchedFields"
},
- "method": {
- "example": "distance",
- "type": "string",
- "enum": [
- "time",
- "distance"
- ],
- "description": "Specifies the method to compute the route between the start point and the end point:\n - `time`: fastest route (default)\n - `distance`: shortest route\n"
+ "type": {
+ "$ref": "#/components/schemas/AddressTypes"
},
- "departure_time": {
- "example": "now",
- "type": "string",
- "description": "Specifies the date/time at which to base the calculations on for traffic purposes. Valid values are a timestamp (e.g. `1600799173` for the date:`22/09/2020 20:26:13`) or `now`.\n"
- }
- },
- "example": {
- "origins": "48.73534,2.368308|48.73534,2.368308",
- "destinations": "48.83534,2.368308",
- "units": "imperial",
- "elements": "duration_distance",
- "method": "distance",
- "departure_time": "now"
- }
- },
- "EncodedPolyline": {
- "title": "EncodedPolyline",
- "type": "object",
- "description": "The polyline of the route (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm)).",
- "properties": {
- "points": {
- "type": "string",
- "description": "The encoded string value for points of the polyline",
- "example": "a_jyHfol@aAfEzGlIfER~JqV_KqLu@pDiHv@bAfEeCfE"
+ "status": {
+ "$ref": "#/components/schemas/AddressStatus"
}
},
"example": {
- "points": "a_jyHfol@aAfEzGlIfER~JqV_KqLu@pDiHv@bAfEeCfE"
+ "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0",
+ "description": "London, England, United Kingdom",
+ "matched_substring": {
+ "description": [
+ {
+ "offset": 0,
+ "length": 4
+ }
+ ]
+ },
+ "type": "locality"
}
},
- "DistanceInstructions": {
- "title": "DistanceInstructions",
+ "AddressAutocompleteCollectionResponse": {
+ "title": "AddressAutocompleteCollectionResponse",
"type": "object",
- "description": "Formatted instructions for this leg",
+ "description": "Address Collection Response containing Localities",
"properties": {
- "action": {
- "type": "integer",
- "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).",
- "example": 2
- },
- "summary": {
- "type": "string",
- "description": "Written maneuver instruction.",
- "example": "Drive northeast on D 151."
- },
- "verbal_alert": {
- "type": "string",
- "description": "The transition alert instruction will prepare the user for the forthcoming transition.",
- "example": "Enter the roundabout and take the 2nd exit onto D 30."
- },
- "verbal_succint": {
- "type": "string",
- "description": "Text suitable for use as a verbal alert in a navigation application",
- "example": "Drive northeast. Then Enter the roundabout and take the 2nd exit onto D 30."
- },
- "verbal_before": {
- "type": "string",
- "description": "Text suitable for use as a verbal message immediately prior to the maneuver transition",
- "example": "Drive northeast on D 151. Then Enter the roundabout and take the 2nd exit onto D 30."
+ "predictions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AddressAutocompleteResponse"
+ }
},
- "verbal_after": {
- "type": "string",
- "description": "Text suitable for use as a verbal message immediately after the maneuver transition",
- "example": "Continue for 700 meters."
+ "status": {
+ "$ref": "#/components/schemas/AddressStatus"
}
},
"example": {
- "action": 2,
- "summary": "Drive northeast on D 151.",
- "verbal_alert": "Enter the roundabout and take the 2nd exit onto D 30.",
- "verbal_before": "Drive northeast on D 151. Then Enter the roundabout and take the 2nd exit onto D 30."
+ "predictions": [
+ {
+ "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0",
+ "description": "London, England, United Kingdom",
+ "matched_substring": {
+ "description": [
+ {
+ "offset": 0,
+ "length": 4
+ }
+ ]
+ },
+ "type": "locality"
+ },
+ {
+ "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwNDE5Nzgz",
+ "description": "Londonderry, Northern Ireland, United Kingdom",
+ "matched_substring": {
+ "description": [
+ {
+ "offset": 0,
+ "length": 4
+ }
+ ]
+ },
+ "type": "locality"
+ },
+ {
+ "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NjEw",
+ "description": "London Heathrow Airport, Hounslow, England, United Kingdom",
+ "matched_substring": {
+ "description": [
+ {
+ "offset": 0,
+ "length": 4
+ }
+ ]
+ },
+ "type": "locality"
+ },
+ {
+ "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM0NDEy",
+ "description": "London Luton Airport, Luton, England, United Kingdom",
+ "matched_substring": {
+ "description": [
+ {
+ "offset": 0,
+ "length": 4
+ }
+ ]
+ },
+ "type": "locality"
+ }
+ ],
+ "status": "OK"
}
},
- "DistanceStep": {
- "title": "DistanceStep",
+ "AddressGeometry": {
+ "title": "AddressGeometry",
"type": "object",
- "description": "step in a leg",
+ "description": "The location of the result, in latitude and longitude. Accuracy is also provided.",
"properties": {
- "distance": {
- "description": "the distance as text covered by this step until the next step.",
- "type": "string",
- "example": "2.8 km"
- },
- "duration": {
- "description": "the typical time as text required to perform the step, until the next step",
- "type": "string",
- "example": "5 minutes"
- },
- "polyline": {
+ "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",
"type": "string",
- "description": "the polyline representation of the step (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm)",
- "example": "_igoHa~hYgApBMHOEKO"
- },
- "start_location": {
- "$ref": "#/components/schemas/LatLngLiteral"
+ "enum": [
+ "ROOFTOP",
+ "RANGE_INTERPOLATED",
+ "GEOMETRIC_CENTER",
+ "APPROXIMATE"
+ ]
},
- "end_location": {
+ "location": {
"$ref": "#/components/schemas/LatLngLiteral"
},
- "travel_mode": {
- "type": "string",
- "description": "the type of travel mode used",
- "example": "driving"
- },
- "instructions": {
- "$ref": "#/components/schemas/DistanceInstructions"
+ "viewport": {
+ "$ref": "#/components/schemas/Bounds"
}
},
"example": {
- "distance": "46 m",
- "duration": "1 min",
- "polyline": "iu~kHsziXJBJAHGFIDMBSAS",
- "start_location": {
- "lat": 49.314292,
- "lng": 4.151623
- },
- "end_location": {
- "lat": 49.314041,
- "lng": 4.151976
- },
- "travel_mode": "DRIVING"
+ "location": {
+ "lat": 48.829405,
+ "lng": 2.367944
+ },
+ "location_type": "GEOMETRIC_CENTER"
}
},
- "DistanceLeg": {
- "title": "DistanceLeg",
+ "AddressDetailsResponse": {
+ "title": "AddressDetailsResponse",
"type": "object",
- "description": "Leg in a route",
+ "description": "Address Details Response",
"properties": {
- "distance": {
- "$ref": "#/components/schemas/DistanceValue"
- },
- "duration": {
- "$ref": "#/components/schemas/DurationValue"
- },
- "start_location": {
- "$ref": "#/components/schemas/LatLngLiteral"
- },
- "end_location": {
- "$ref": "#/components/schemas/LatLngLiteral"
- },
- "start_waypoint": {
- "type": "integer",
- "description": "The start waypoint order number",
- "example": 1
- },
- "end_waypoint": {
- "type": "integer",
- "description": "The end waypoint order number",
- "example": 2
- },
- "start_address": {
- "type": "string",
- "description": "the starting address of the leg",
- "example": "Chemin de la Tuilerie"
- },
- "end_address": {
- "type": "string",
- "description": "the ending address of the leg",
- "example": "D 8043, E 44"
+ "status": {
+ "$ref": "#/components/schemas/AddressStatus"
},
- "steps": {
- "description": "List of steps constituting the leg. Steps are returned when `details=full` parameter is specified. 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.",
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/DistanceStep"
+ "result": {
+ "description": "the root node of address details",
+ "type": "object",
+ "properties": {
+ "formatted_address": {
+ "$ref": "#/components/schemas/FormattedAddress"
+ },
+ "types": {
+ "description": "The types of result.",
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AddressTypes"
+ }
+ },
+ "public_id": {
+ "description": "Contains a unique ID for each suggestion. Please use this ID to give feedbacks on results.",
+ "type": "string",
+ "example": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0"
+ },
+ "address_components": {
+ "$ref": "#/components/schemas/AddressComponents"
+ },
+ "geometry": {
+ "$ref": "#/components/schemas/AddressGeometry"
+ }
}
}
},
"example": {
- "distance": {
- "text": "1 km",
- "value": 1038
- },
- "duration": {
- "text": "1 min",
- "value": 75
- },
- "start_location": {
- "lat": 49.31067,
- "lng": 4.14525
- },
- "end_location": {
- "lat": 49.31344,
- "lng": 4.15293
+ "result": {
+ "formatted_address": "London, England, United Kingdom",
+ "types": [
+ "locality"
+ ],
+ "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0",
+ "address_components": [
+ {
+ "types": [
+ "country"
+ ],
+ "long_name": "United Kingdom",
+ "short_name": "GBR"
+ },
+ {
+ "types": [
+ "state"
+ ],
+ "long_name": "England",
+ "short_name": "England"
+ },
+ {
+ "types": [
+ "county"
+ ],
+ "long_name": "London",
+ "short_name": "LDN"
+ },
+ {
+ "long_name": "London",
+ "short_name": "London",
+ "types": [
+ "locality"
+ ]
+ },
+ {
+ "long_name": "SW1A 2",
+ "short_name": "SW1A 2",
+ "types": [
+ "postal_code"
+ ]
+ }
+ ],
+ "geometry": {
+ "location_type": "GEOMETRIC_CENTER",
+ "location": {
+ "lat": 51.50643,
+ "lng": -0.12719
+ },
+ "viewport": {
+ "northeast": {
+ "lat": 51.68629,
+ "lng": 0.28206
+ },
+ "southwest": {
+ "lat": 51.28043,
+ "lng": -0.56316
+ }
+ }
+ }
},
- "start_waypoint": 0,
- "end_waypoint": 1,
- "end_address": "D 30",
- "start_address": "D 151"
+ "status": "OK"
}
},
- "DistanceRouteElementsResponse": {
- "title": "DistanceRouteElementsResponse",
+ "AddressGeocodeTypes": {
+ "title": "AddressGeocodeTypes",
+ "type": "string",
+ "description": "Contains the type of result.",
+ "enum": [
+ "address",
+ "house_number",
+ "route",
+ "address_block",
+ "locality",
+ "admin_level",
+ "country",
+ "place"
+ ]
+ },
+ "AddressGeocodeResponse": {
+ "title": "AddressGeocodeResponse",
"type": "object",
- "description": "Attributes describing routes from an origin to a destination returned in distance route response.",
- "required": [
- "overview_polyline",
- "bounds",
- "notice",
- "legs"
- ],
+ "description": "Address Geocode Response",
"properties": {
- "overview_polyline": {
- "$ref": "#/components/schemas/EncodedPolyline"
- },
- "bounds": {
- "$ref": "#/components/schemas/Bounds"
- },
- "notice": {
- "type": "string",
- "description": "Some noticeable information about the route",
- "example": "Has toll segments"
+ "formatted_address": {
+ "$ref": "#/components/schemas/FormattedAddress"
},
- "legs": {
+ "types": {
+ "description": "The types of result. If result type is a `place`, additional types may be returned (`eat_and_drink`, `going_out_entertainment`, `sights_and_museums`, `natural_and_geographical`, `transport`, `accommodations`, `leisure_and_outdoor`, `shopping`, `business_and_services`, `facilities`, `areas_and_buildings`)",
"type": "array",
- "description": "Legs part of the route response",
"items": {
- "$ref": "#/components/schemas/DistanceLeg"
+ "$ref": "#/components/schemas/AddressGeocodeTypes"
}
},
- "main_route_name": {
- "type": "string",
- "description": "The main route name based on the longest step length to differentiate routes when alternates are returned.",
- "example": "Fillmore Street"
+ "address_components": {
+ "$ref": "#/components/schemas/AddressComponents"
},
- "recommended": {
- "type": "boolean",
- "description": "Optional field. Only present and set to true when the route is the recommended route.",
- "example": true
+ "geometry": {
+ "$ref": "#/components/schemas/AddressGeometry"
}
}
},
- "DistanceRouteResponse": {
- "title": "DistanceRouteResponse",
+ "AddressGeocodeCollectionResponse": {
+ "title": "AddressGeocodeCollectionResponse",
"type": "object",
- "description": "Attributes describing a distance route response.",
+ "description": "Address Geocode Collection Response. Contains one or more Addresses with coordinates (default to one result for reverse geocoding)",
"properties": {
- "status": {
- "$ref": "#/components/schemas/DistanceStatus"
- },
- "routes": {
- "description": "Contains an array of routes from origin to destination (only one if alternatives is not specified)",
+ "results": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/DistanceRouteElementsResponse"
+ "$ref": "#/components/schemas/AddressGeocodeResponse"
}
+ },
+ "status": {
+ "$ref": "#/components/schemas/AddressStatus"
}
},
"example": {
- "status": "OK",
- "routes": [
+ "results": [
{
- "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@eAHO"
- },
- "bounds": {
- "northeast": {
- "lat": 49.315678,
- "lng": 4.152915
+ "formatted_address": "Place de la Résistance, 75007 Paris, France",
+ "types": [
+ "address",
+ "route"
+ ],
+ "address_components": [
+ {
+ "types": [
+ "country"
+ ],
+ "long_name": "France",
+ "short_name": "FRA"
},
- "southwest": {
- "lat": 49.31073,
- "lng": 4.145162
- }
- },
- "notice": "",
- "legs": [
{
- "distance": {
- "text": "1 km",
- "value": 1038
- },
- "duration": {
- "text": "1 min",
- "value": 75
- },
- "start_location": {
- "lat": 49.31067,
- "lng": 4.14525
- },
- "end_location": {
- "lat": 49.31344,
- "lng": 4.15293
- },
- "start_waypoint": 0,
- "end_waypoint": 1,
- "end_address": "D 30",
- "start_address": "D 151",
- "steps": [
- {
- "distance": "676 m",
- "duration": "1 min",
- "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
- },
- "end_location": {
- "lat": 49.315679,
- "lng": 4.149621
- },
- "travel_mode": "DRIVING",
- "instructions": {
- "action": 2,
- "summary": "Drive northeast on D 151.",
- "verbal_succint": "Drive northeast. Then Enter the roundabout and take the 2nd exit onto D 30.",
- "verbal_before": "Drive northeast on D 151. Then Enter the roundabout and take the 2nd exit onto D 30.",
- "verbal_after": "Continue for 700 meters."
- }
- },
- {
- "distance": "22 m",
- "duration": "1 min",
- "polyline": "}}~kHcniXBIBU?W",
- "start_location": {
- "lat": 49.315679,
- "lng": 4.149621
- },
- "end_location": {
- "lat": 49.31563,
- "lng": 4.149905
- },
- "travel_mode": "DRIVING",
- "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_succint": "Enter the roundabout and take the 2nd exit.",
- "verbal_before": "Enter the roundabout and take the 2nd exit onto D 30."
- }
- },
- {
- "distance": "198 m",
- "duration": "1 min",
- "polyline": "u}~kH{oiXFWDOLUP[P]j@y@^g@`@i@NUNONMJKJIFELC",
- "start_location": {
- "lat": 49.31563,
- "lng": 4.149905
- },
- "end_location": {
- "lat": 49.314292,
- "lng": 4.151623
- },
- "travel_mode": "DRIVING",
- "instructions": {
- "action": 27,
- "summary": "Exit the roundabout onto D 30.",
- "verbal_succint": "Exit the roundabout.",
- "verbal_before": "Exit the roundabout onto D 30.",
- "verbal_after": "Continue for 200 meters."
- }
- },
- {
- "distance": "46 m",
- "duration": "1 min",
- "polyline": "iu~kHsziXJBJAHGFIDMBSAS",
- "start_location": {
- "lat": 49.314292,
- "lng": 4.151623
- },
- "end_location": {
- "lat": 49.314041,
- "lng": 4.151976
- },
- "travel_mode": "DRIVING",
- "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_succint": "Enter the roundabout and take the 2nd exit.",
- "verbal_before": "Enter the roundabout and take the 2nd exit onto D 30."
- }
- },
- {
- "distance": "96 m",
- "duration": "1 min",
- "polyline": "ws~kHy|iXBKDILURa@LWt@eAHO",
- "start_location": {
- "lat": 49.314041,
- "lng": 4.151976
- },
- "end_location": {
- "lat": 49.313431,
- "lng": 4.152916
- },
- "travel_mode": "DRIVING",
- "instructions": {
- "action": 27,
- "summary": "Exit the roundabout onto D 30.",
- "verbal_succint": "Exit the roundabout. Then, in 100 meters, You will arrive at your destination.",
- "verbal_before": "Exit the roundabout onto D 30. Then, in 100 meters, You will arrive at your destination.",
- "verbal_after": "Continue for 100 meters."
- }
- },
- {
- "distance": "1 m",
- "duration": "1 min",
- "polyline": "}o~kHubjX",
- "start_location": {
- "lat": 49.313431,
- "lng": 4.152916
- },
- "end_location": {
- "lat": 49.313431,
- "lng": 4.152916
- },
- "travel_mode": "DRIVING",
- "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."
- }
- }
+ "types": [
+ "state"
+ ],
+ "long_name": "Ile-de-France",
+ "short_name": "IDF"
+ },
+ {
+ "types": [
+ "county"
+ ],
+ "long_name": "Paris",
+ "short_name": "Paris"
+ },
+ {
+ "long_name": "Paris",
+ "short_name": "Paris",
+ "types": [
+ "locality"
+ ]
+ },
+ {
+ "long_name": "7th Arrondissement",
+ "short_name": "7th Arrondissement",
+ "types": [
+ "district"
+ ]
+ },
+ {
+ "long_name": "Place de la Résistance",
+ "short_name": "Place de la Résistance",
+ "types": [
+ "route"
+ ]
+ },
+ {
+ "long_name": "75007",
+ "short_name": "75007",
+ "types": [
+ "postal_code"
]
}
],
- "main_route_name": "D 151",
- "recommended": true
+ "geometry": {
+ "location_type": "GEOMETRIC_CENTER",
+ "location": {
+ "lat": 48.86213,
+ "lng": 2.30152
+ },
+ "viewport": {
+ "northeast": {
+ "lat": 48.86231,
+ "lng": 2.30541
+ },
+ "southwest": {
+ "lat": 48.86191,
+ "lng": 2.30147
+ }
+ }
+ }
}
- ]
- }
- },
- "DistanceTollsStep": {
- "title": "DistanceTollsStep",
- "type": "object",
- "properties": {
- "countryCode": {
- "type": "string",
- "description": "Country Code"
- }
- },
- "additionalProperties": true,
- "description": "Detail of tolls to be paid for traversing the specified section. Directly come from Here API",
- "example": {
- "tolls": "some_value"
- }
- },
- "DistanceTollsSystemStep": {
- "title": "DistanceTollsSystemStep",
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "description": "Tolls System Id"
- },
- "name": {
- "type": "string",
- "description": "Tolls System Name"
- }
- },
- "description": "An array of toll authorities that collect payments for the use of (part of) the specified section of the route. Directly come from Here API",
- "example": {
- "id": 12,
- "name": "ASF"
+ ],
+ "status": "OK"
}
},
- "DistanceTollsLeg": {
- "title": "DistanceTollsLeg",
+ "Zone": {
+ "title": "Zone",
"type": "object",
- "description": "Leg in a route",
+ "description": "Attributes describing a Zone.",
+ "required": [
+ "store_id",
+ "zone_id",
+ "polygon"
+ ],
"properties": {
- "distance": {
- "$ref": "#/components/schemas/DistanceValue"
+ "zone_id": {
+ "description": "A textual identifier that uniquely identifies a Zone.",
+ "type": "string",
+ "example": "ZoneA"
},
- "duration": {
- "$ref": "#/components/schemas/DurationValue"
+ "description": {
+ "type": "string",
+ "description": "Textual description of your Zone",
+ "example": "Delivery Zone for Store A"
},
- "start_location": {
- "$ref": "#/components/schemas/LatLngLiteral"
+ "store_id": {
+ "$ref": "#/components/schemas/AssetId"
},
- "end_location": {
- "$ref": "#/components/schemas/LatLngLiteral"
+ "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))"
},
- "tolls": {
+ "types": {
+ "description": "Contains an array of types describing the Zone.",
"type": "array",
"items": {
- "$ref": "#/components/schemas/DistanceTollsStep"
- }
+ "type": "string"
+ },
+ "example": [
+ "delivery",
+ "san_francisco_west"
+ ]
},
- "tollSystems": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/DistanceTollsSystemStep"
- }
+ "status": {
+ "type": "string",
+ "description": "the status as string",
+ "example": "ok"
}
},
"example": {
- "distance": {
- "text": "1 km",
- "value": 1038
- },
- "duration": {
- "text": "1 min",
- "value": 75
- },
- "start_location": {
- "lat": 49.31067,
- "lng": 4.14525
- },
- "end_location": {
- "lat": 49.31344,
- "lng": 4.15293
- }
+ "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"
}
},
- "DistanceTollsElementsResponse": {
- "title": "DistanceTollsElementsResponse",
+ "ZonesCollectionResponse": {
+ "title": "ZonesCollectionResponse",
"type": "object",
- "description": "Attributes describing routes from an origin to a destination returned in distance tolls response.",
- "required": [
- "overview_polyline",
- "bounds",
- "legs"
- ],
+ "description": "A Collection of Woosmap Zones retrieved in response to a get zones list.",
"properties": {
- "overview_polyline": {
- "$ref": "#/components/schemas/EncodedPolyline"
- },
- "bounds": {
- "$ref": "#/components/schemas/Bounds"
- },
- "legs": {
+ "zones": {
+ "description": "The Zones collection",
"type": "array",
- "description": "Legs part of the route response",
"items": {
- "$ref": "#/components/schemas/DistanceTollsLeg"
+ "$ref": "#/components/schemas/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"
}
},
- "DistanceTollsResponse": {
- "title": "DistanceTollsResponse",
+ "ZonesCollectionRequest": {
+ "title": "ZonesCollectionRequest",
"type": "object",
- "description": "Attributes describing a distance tolls response.",
+ "description": "A Collection of Woosmap Zones as expected for Data Management Data API.",
+ "required": [
+ "zones"
+ ],
"properties": {
- "status": {
- "$ref": "#/components/schemas/DistanceStatus"
- },
- "routes": {
- "description": "Contains an array of routes with tolls informations from origin to destination",
+ "zones": {
+ "description": "The Zones collection",
"type": "array",
"items": {
- "$ref": "#/components/schemas/DistanceTollsElementsResponse"
+ "$ref": "#/components/schemas/Zone"
}
}
},
"example": {
- "status": "OK",
- "routes": [
+ "zones": [
{
- "legs": [
- {
- "distance": {
- "value": 272304,
- "text": "272 km"
- },
- "duration": {
- "value": 8834,
- "text": "2 hours 27 mins"
- },
- "start_location": {
- "lat": 43.7037562,
- "lng": 4.1217688
- },
- "end_location": {
- "lat": 45.7196995,
- "lng": 4.848819
- },
- "tolls": [
- {
- "countryCode": "FRA",
- "tollSystemRef": 0,
- "tollSystem": "ASF",
- "tollSystems": [
- 0
- ],
- "fares": [
- {
- "id": "e4626716-1e29-4f9a-905a-19f0376cfb38",
- "name": "ASF",
- "price": {
- "type": "value",
- "currency": "EUR",
- "value": 28.9
- },
- "reason": "toll",
- "paymentMethods": [
- "cash",
- "bankCard",
- "creditCard",
- "transponder",
- "travelCard"
- ],
- "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": [
- {
- "name": "MONTPELLIER (M.EST)",
- "location": {
- "lat": 43.70291,
- "lng": 4.11982
- }
- },
- {
- "name": "VIENNE",
- "location": {
- "lat": 45.4761,
- "lng": 4.83378
- }
- }
- ]
- }
- ],
- "tollSystems": [
- {
- "id": 7607,
- "name": "ASF"
- }
- ]
- }
- ],
- "bounds": {
- "northeast": {
- "lat": 45.7197,
- "lng": 4.89669
- },
- "southwest": {
- "lat": 43.7022,
- "lng": 4.11696
- }
- },
- "overview_polyline": {
- "points": "m{viG_`dXDGLUDU@a@C]GUGMOOOEQCQDMFMPGPGf@@\\H\\HPJHNF\\@N?RFTNNTVh@Rh@Nl@^zBXlAb@|A\\~@\\t@Rx@RhADl@?VCd@EZGTKRUZUL]FM?MCQISOcAaA]WwF{HcDoEgA}AkBoCeCyDuE_IqEkIoEiI_@s@gBiDmCkFkC_FmRw^sB_Ea@w@c@y@sDcHuH{NyDwH}AeD{AoDy@uBmBuFiAuDeA{DiAcFOq@w@eEk@cDs@iFo@}Fo@iI[oGSaHGmFCyEGaXGmHG}DKkEKmDWqG_@qHa@wGi@aHMsAMsAk@mGK}@i@yEKu@_@uCAKWgBU}ASoAUwAWaBgAkGm@iDWoAy@cDaAkDiAeDcAgCeAaCoAcCmAuBaCqDsAcB}@eA_BaBq@m@aCoBgBoAgBeAaAg@iBy@w@[}Bu@sM}D_Cy@gEiBmCuAaBaAwDcCs@i@sBcByAsAiBeBwB_CiBwBqCwDoAiBoCsEgAqBoBgEqAyCmA_DiAcDgAeDc@{Aq@aCu@}CQw@_AwEc@gCy@oFi@{EUgCUyCWsEOkDO{GAkHBsEB_BFoBLiDNsCf@{Hx@qLTsCdI{iAj@}INeEFcGAkDGyCUiFSqCk@cFQqA]uBw@}Dq@mCoAoEa@mAi@wAyAkDm@qAWe@}AmCw@iAgBcCoA{A_C_CwKyJaEkDiL_KsHwGwC_CsE_D_DkBmBcAmEcCeBkAwBcByAqAq@o@}AgB}AoBuAsBk@_AyAmCaAqBuAiDq@sB{@{CeDmL{@sCmB{FuBwF{BaFuAqC{@_BuBmDaBeCqBqCw@cAwAeBgAmA{CyCgD_D_BsAoC_CyG{FyByBuB_CmCaDcByBgCuDoBcDcIsNk@_A_BgCu@eAcByBmB{BaEmE_GiG_DcDwD}DmBmBsAuAcB}AoCcCcA}@s@k@}CcCgDeC{FcEuAeAmAiAmAiAuAyAiAsAe@o@sAoB}@{Au@uAw@_Bq@}AoAgDa@oAiAeEm@sCa@wB]yBUiBi@wEYuCg@{EEe@K_AGk@y@uHYeCGe@}AcMi@qDOaAeBoK{AcIwDiQwC}LqD}NkAaF}@_EuAmGo@sC_ByIWaBq@oD]oB[yBw@cFo@oDi@uDcBiKkB_LSqAw@yEc@_CcAyFo@iDiA{Fm@aDmA_GsDuPGYoCeL_CcJqAwEw@sC_DuKoC}ImCmIgAcDmAiDyDmKaDqIeDiI_@{@Ui@eAkCeEwJuSoe@iFyLmCsGkDwI}FsOSk@kE_MoHoTgDsJSi@]}@gBgEyA_Ds@uA_BsCq@gAaCkD{BqCe@k@cDeDaB{AgA_AyBcBoAy@mBgAsBiAiEyBm@YsB{@aD}As@[eFaC_Bw@gCuA{B{AqCuBwBgByLsKmC_C_EoDgB_B_Ay@qO_NyFkFoAiAyE_E{I_IOMkSsQyDoDi@g@s@s@qCuCyBgCaDcEcCkDuBeDqBmDeC{EsAuCkBsEWq@{@}BgA{CmAqDcLg^wDuLiBaGe@wAuAmEwAsEwAwEgAyDgBgHw@uDq@wDqA{JW_CUaC_@iFc@}JQiH_@}RMeEWuGI}AWuD}@mK[_DeA{Im@qEeAmH}@sFs@cEeAsFkCaM_@cB{B_J_AmDiC_JcAcDuCuIwCcImAcDmCmG}BgFcCiFyCcGwCmFiB_DcDiFsEcHuHgLwC}EwAkCiBwDuBeF{AmEe@yAoAmE_BwG_AsEy@wEc@qCIk@w@iG{@_Ji@kHa@gG}@uOm@qJ_@cH]eGGoAi@qJGaAg@kIqAyUIuAEs@e@wHiAuO_@sEUyBi@_Fk@iEgAcHy@uEs@sDEQwAiGkAsEiA_Eu@cCwDaL{AaEuCmHeEwIkCkFiCuEcBuCkAmBsFoIgNyRiCqDeD_F_A}AkGaLuAcCy@{AcEsH}AsC[k@_Tc`@{@yAyFiKkDiGmCqE}A_CcDsEuBkCuBcC{BcCaAeA}BcCa@c@c@e@s@w@yAaBsD}EgBkC}AgC}C_GgA{BqBiE}AoD}BcF}BaFiA}B{Pg[aD}Fu@oAmIcOmB{CoAcByAeBuCwC_Aw@uAcAeBeAqDsBgFmCoCyAeC{AkCgBy@o@q@g@}AqA_EuDsCuC}CeDmEcF_D{D}CaEuEsGsCkEwDiGwD{G_@o@u@yAmA}BuAgCgBoDcAmBuAqCqBuDy@}A_BuC{CaFoBcDuFqIgK}NuB_DeA_BwBkDaAeBmCeF{AaDaCqF{ByFwBwFyBgGoAcD_C{FyAcD_AqByA_DcDyGaDaHwCaH{BaGsB{FiBuFmA_E}GmUqC{IaD_JoBcFqCuGaAyBmEiJoCmF_ByCcEmHyC_FcEqGkBuC_AsAsAoBm@y@eEwFeBcCqC_EiAeBkCiEm@eAm@gAuBgEkAyB_BiDmAuCyGuPeBiEm@yA]w@aCaFg@eA}AqCgB}CgCaEwCgEeEoFkByBqFcGwHkIsCkDmBgCcCiDeBoCw@mAcDmFyCqFsB}D}AcD_AuBy@wB}@mCq@_C_AcEe@gC[oB_@kCeAiIy@kFkAyFi@qBc@sAkBaFe@eAsAmCmAuBoBwCu@cAwCyDoFmHiBgCgAaBgDmFqBeDgB_DmCeFoB}D}B}E}AoDaA_CeEyKkAcDqBeGoBsGkBsG_E_OiBsGiBuFoAiDk@sAuAyC}AsCeBiCmCqDoAwAqBqBaA{@kCoBkBmAcCqAcAe@cAa@cA[gA[gAWkCe@kAOkCOmAEeA?oCHmAHkCViCZgFh@qBLaBFkBD}@CaAEeAK{@KiASmAYy@Y{Bw@aAc@c@QiCqAmE{BeEiBo@SqCm@cAO{AMw@Iu@C{A?yBD_AF}BVaCh@gAZeCx@cAb@uDzAgC`AeA\\eCp@cARyC`@w@FmADmC@}@CmCQqAQ{@OcAUiCs@oDsA{@]cBq@o@WsAm@iGgC_IcDi@S{@a@kQsH_FcCuBeA_CsAqD_CeCeB}BgB_CmB{BuBMMoBiBe@c@mAyAaBiB_AgAyEgG}KgO{BwCaCwC_@e@qCcDwBaCwA{A_DoCiCqBiBoAyA_A}BoAiAi@aBw@wCiAgCy@QGy@SwCs@}Cm@sB[iH}@cAIkBQ{D[}He@sCMo@?uE?aCDkF^u@HqBXkDn@iAViCn@mAb@y@PqBd@cDr@gC^cBR}ADmBB}BAeBKo@E}@MyAUuA[oBk@yAi@qCkA}DmBgG{CmB_AoBy@q@WgE}AqBm@sCs@{Be@mASiDa@oAIwAE_A?eBFuARiBd@k@RiB~@]Pu@j@]Tk@f@e@f@gAvAgA~Aa@p@wCxFcEbJkCnFq@rAcAjBs@hA{CzE}@fAgAnAyAxAYXo@j@_BrA}BbB}@l@cBbAsHjEkEbCoKjGoBbA}BbAq@XwChAoCjAm@VgHnCgBp@a@NcBf@c@TiGfCqDpAsLtEuJpDuDxAmAh@aBv@q@^yFlDmAz@eAt@qBnAmBpAmBlAmBpAkD|B{HdF{E~CaLpHeDtBmMxI{DhC[TmGdEuc@xYiAv@{FtDeGlEyBdBwD`DgE|DsDpDiBnBqElFqE|FmBlCiCxDqEjHcBvCaCnEIN{ChGaDhHuElLqBjFk@zAgCxGkBrEqArC}BtEq@nAiCbEkBdCmAvAeAfAkAdAgCpBqBjAmAn@gAf@{Bz@kBh@oB`@gAPiCVyCL_B@kC?yIMkCFyADwBNkAL_ANuB`@q@N{@RmA\\aAZoAf@kBx@{BlAsAx@wCrBwAhAmAfAeC`CmAnAaAbAiBrB}AfBcJzKuCfDsD|DuDnD{@r@uAhAwDrCiBnAiBhAoAr@}Ax@}HrDmJdEiDvA}Ap@kDrAyC`AgAXsCj@sATeBNsCPyDFqBEkCMqBOiSuBiBSiHu@mDg@uAYeBa@wBm@sBs@{CsAkBcAmAu@gMgIkTwN_SoMwDgC_C}Aa_@mVez@mj@yIgGsFcEcG_F{FiFyBuBsIqIwNeOm@m@}@_AkHqH{GaHqFqFwBoB{BeBw@k@aC}AeCuA_CgAaDoAaA[gAYkEaAeAOuBYgBOaFUiAEaGOgACw@Ac@Ac@?iEM_Sa@iCCmC@eBFoBHqALwAPeBZwAVwA^iA\\wAf@eBp@aBt@sDfBwJhF{FtCoFjCmD|AmBt@iBp@mDfAsA^cEdAiB\\mEt@{C`@kBR}@JoDZaDPmQnAaEV_OdAyG^oI`@_FRoDJgGRwGLoDDeJHiC@wX?iGCkMBoAByBFuCDiCFsBFa@BiADiHb@mBLsBN{Iz@iD`@mDd@iGbAcF|@qLbC{M|CgKxBoEv@uDl@uEn@gIz@sE`@gk@vEcCPmDXmD\\i`@`DcCT{Jv@oFd@gIl@gHf@_CNqJf@qELgB@yDD_HEaBCwDKwBKsBGsAKcEYkBQmBQgCYaH_AiEs@kAUk@Ki@Ke@I]ImCi@mEiAaHmBaEoAyHsC_DqAuDaBkAk@{F{CcHeEm@[oBoAyAeAsB{AyHoG}AuA_CuBeIcIiHeIkC{CcBuBk@q@yBiCmBuBqBsBsBsBgD}CgDoCyAiAaBkAgAw@mD{BoBiAeEwB}As@cCcAeE{AiCy@yC{@mCo@mE{@y@UcF_A_F_AkN{CuD{@oGgBcAY_AYUGqDiAwE_BeA]aBk@eEcBeBs@sEoBsDaBkFmCk@[gIkE{SuLqDmByCyAqCoAyEgBuFiB}Bk@mBe@{E_AuB[iEi@aCSaDSqEQwAEwCC}CCoIIeHIsJMoDGaLI{FIuDGaCEkX[mACuHW_Fa@iBSaEk@kASiDq@kAW_EkAiCy@aC{@w@YyAm@yCsAqBcAeFsCwDeC{AeAiFgE}AsAyAuAqCqC}@_Ao@u@oAwAsD{Ek@s@_@k@_AsAyBgDwC_Fs@kAwFiKaIsOgBeDmD_HwB{D}CqFaBmCiCaEyAyBcGeIaCyC{AgBeCqC_DgDeCeC{GiGwFsEqDkCmCkB_DqB_JiFo@]gFeCcCeA_CaAq@YqAg@_C_AsB{@cRyGkPqFu@UoImCQGoBm@uHyBkA]cMiDgHeBqEw@iCc@aEe@cDW{AIgEM_DGeD?wEFmCDgGTeFVwE\\sALwLlAuG|@_BVcKhByE`AsFrAyCt@eGdB{IpCe[rKgQhGWHq@VcLzDuE`B]Jg@PuAh@kAb@mHtC_Ab@aEbBiKvEsAp@sCtAeItDcEfB{DzAiDnAuBr@yDjA{Bl@{EhAeCn@aCd@qIxAsBZqBVsDb@aGj@oDXqDVmGZeFPwDHcEDmIBcHAoNCa@?uMCgQLaNRkJTsJZ_Md@yOx@mIXiCH_@?c@@oGBaCAkEIcFQsE[kHs@_@CwB[iC]{E{@oFiASESC{Bi@iEgAcJsBmGsAkFeAkDm@kEq@yGy@uCYsFc@uCWaJg@s@AsG[iE]q@EYA{@?wC?mCM_S{@s@CcGO}BMcBIkDMgEKmBC}B?yCDgAD_EVeBPkBVqB\\uDv@iCr@_Cv@mBr@gBt@mAj@yAt@cAj@{CfBsSdN}D~BiGfDsEtBwB|@}Aj@wFjBu@VeCr@}Bh@gCj@yDv@oEv@aJxAqHpA_MtBy@LkC\\uGx@kFh@cAHwF\\oDPqHLuDB{GGeEIgGWw@GwCOoSwA{Jw@yDa@gDi@y@MkCm@{Aa@qA[aCu@cEoAeF}AuAc@qFsAmEy@{B]aAKeCUyAKcEOoDC}B?aCFy@D_Kl@gBNmIf@sCJcEFcA?mFIoDQsAKcCWeC]sB[kBa@_B_@{Cw@sBo@qBq@}B_AsF_C_Bo@aGoCw@]qFeCkAg@yBaAeAc@u@[cNkGqAm@eCiAy@[kGqC_DuAm@[gJmEkDgB{CaBq@_@kBeAUMwBsAgFiDoA}@wDuCqF{EoBoBgAiA{@aAmCaD{CeEeBiCgEkH_B_Dy@gBwCeHuAyDQg@cAaDgBiGkB_IyAuHmAgH_Fc\\sA}HcAiF}@{DgA_E]kAaBiFa@kA_AcCu@iBs@_BaAwBkA_CeB_DoAwBoAmBmBmC_CwCY]]a@yB_C_B}AmFwEsD{CiUwQoQ{NuMmKcNsKaGiEoFmDcF{CuDqBqCuAkAi@o@[_EeBsAi@iE}A_IiC}MgE{FcBsEoAwBi@cBc@eDs@gEy@cCe@uQuCoFw@_m@iJs]gFkC]oWqDwFw@qC_@gd@gGgGw@yGw@uEc@iCSeDQeBGaCG{CEkA?{FFkDJwDRYBkE\\eBPg@FcH|@_QfCuDd@cEb@g@BsCRcDL}BB}E?yDKaCK}@G_CScCWuCa@qF_AsCm@YKUGiF{Ae@OsFiBgIuCg@Q{h@aRoE}AmG{ByCcA_A[s@Ww@Y_Cw@cA]mC_AiDaAyAc@oKoCsDo@mB]{AUkDe@qB[aBWmC[oB[wAU{B]oIoAeC]gBUwAQcAK}@KyCWuEUgCKgEEmBBcGHwDL{G^}CLoCHsA?aCCgAE}C[oASwB_@iAWkA[gC{@uAi@u@[yBkAcBeAeCaByBcBiCsBiByAi@_@iG}E]YcIkGcBoAo@i@mDgDs@y@wE_Gm@o@cB}Aw@o@w@k@yEiCeBq@iA]cAWaAQuC[cI]gFUaFYuBWgASwFoAsBa@}@MaAIgACy@?aBHsAL}@Lc@LeBf@aA`@]RcDjBsAn@cBl@wBj@q@LuAP{O~AcAH_BRmBPaBViB\\}LrCkBd@mBh@s@RyAh@aA`@oB|@eBz@wBlAi@TmAd@gAZuAXgAL{AHqB@oCQ_AIiAUkDu@sEaAuA[oAU_B[s@MkB]y@KeAImACu@Ci@?g@@yADeBNaC^qBd@YHoAf@q@Tu@\\yB|@qIlD_DlAsBr@QD[H}@XeB^uB`@aBT_CX_BN_AFuAFaCDeIFqGLaBL_CZoAPyBd@k@LiAZcBf@uBx@mB|@{PlJwDjBuD`Bs@VcA`@}Ah@yEvAyDz@iB\\w@LkDh@eAPsCV{CTqBJo@BaGJyDAmR]iJQoEIsIMgC?uA@kELcBJg@BaY~AyAFmFXmCL}BFsCFmEBuC?o@A{CCiAEoHWkIo@{Eg@yEk@mGeAuN}CuGyAwDs@wB]iAOyEg@uF[mEKuCAiA@mFL{CLoBJeDTkY|AsWzAa@BiBL{BR_D`@uDp@wCn@sDbA{DrAqDzA_ErB}@d@iAn@aCzAyAbAsAbAcDrC}ApAsDhD{@z@{@t@[RiAx@mAr@o@Z]Pq@^y@X{@XiDr@cCV_DLuEM_Dc@iBc@qA_@_A_@]O{Aw@m@]w@g@wB_ByAuAuA{AcBuBqGwI}@oAgD{Dk@m@gDyCoAeAkBsAkAs@{@i@kAo@mAm@{B_AqBq@cBk@yAa@wA[{AWgBUeEa@cCOeCIcCBeBJkD^oARcK`C_BPmANyALyABsBAgBG}AKsDg@qDcAoDuAiDkBwEgDqB{AeL}IgHuFwJsHsJuHyAsAiBgBiAmAqCcDiC_DuCuDiDgEgBuBiAmAsAoAgCyBoCkBeC}AQKSKiDwA{B{@{Cw@wB]_Ca@yE[kBE_DBsEZeFr@sq@rOaOhDyDdA}Af@yAh@_C`AaBv@wEdC_HzDkB|@{B|@kBl@_AVmAXyB`@aCZkAJcBHiCDsB?sCCo@C_BAcDIgLYiHMk@AiGO{BGmBCk@CoFMO?Y?a^s@iJWaEG}BAeE@}AD{BLiBPgCZwAToAVyCv@}Br@yBx@oBx@mB~@{@f@yAz@uDfCiBzA[XUR}ArA}ApAmAbA_BhAsBpAu@^cBv@uAd@mAZsCd@wAPwCd@qAV_AViA^}An@}Av@cAl@sBxAuAjAyEjEgF|EuBdBeAv@y@h@w@d@}Ar@eA^]Lo@Rm@PwAZ{@LsBPoBHwA@yBK_AGu@MgB[mBe@wBs@y@[}Ae@uBi@}AYkBUeCKgBBu@@aBJqBVkAT_Bb@y@Xm@RyBbAiAn@aAn@sAbA{BtBy@~@q@z@qAhBe@r@W`@qAdCm@tAaAbCs@xBaAjDi@dCiA~Es@lC]tAg@xA_BzDe@`As@tAo@dA}AxBk@r@iBnBw@r@w@p@mBrA}BpAgAd@aA^w@VkBh@_Cp@yN~D}CdA_C|@uBz@aDxAgCrAqDtBoAv@eBjAa@VqCrBeCtBmAlA_BfBqA`BwBtCsDbFwAhBgAjAcAdAyArA_Av@kBvAo@b@yCdB}BhAsCnA}VjKeBv@uAr@g@ZQH}AbA_Ar@u@l@u@r@aBjBmA|A_AtAw@pAmA~B_AnBsCnFsAxBcAzA{@fAmCtCkBbBkA`ASLyAdAe@XuCzAoBx@eCx@sCp@}@RiCZeBLkCDwCEqBKcBMcZiCcIs@cCQkCMuAEiCCiA@oDL}DXyDj@qCj@qBh@sC|@wChAk@ViB~@gBbAaB`AgAr@eBrAk@^oB|AwE`EuBjBqAhA{BnBqC~BoNzLwEdEkGjF{F`FiA~@eAr@_@VeAn@q@\\mBx@qBn@iBb@s@LiBRy@FsBF{BEgCSmBYaCi@oBc@kPiEoE_A}@MwAK}@Cs@Cg@?cCFmBNgBVwBd@gBh@iBt@i@VmAp@{AbAmA~@{AxAyA|Aq@x@iA|AsB`D_FlHoBxCmCxD{AjBiApAmDfDy@r@qCpBmAv@sAt@ULsB`AqAd@}Ah@eAZ{A^aBZ_CZ_DXsAFc@?oB?eCE_IYeACoLe@oO]oACyB@qD?aFFcJH}@B_IZS@iCNkEVwJx@{Db@wKtAuHlA_[tFyB^iJdBmJbBk`@bHmB`@]Hk@JgFbA{J|AcCZkAJeAJcEN{C@kBCkCKqAIcCSoBWmRwBqDe@_Eo@qFkAaB]oMsCcGkAaBQkACgBDg@FsARuA\\aBl@}Az@kA|@g@f@oErEsAjAc@ZgAp@cBv@{@V_APaALmAHaA?aAGyAKy@McC]oBW_Fs@sAOwG{@qBQiBIgBIqAAsAAmA@aBDsFXqABgCAcDMoBO_AKyB[aBYyA[aBe@_EkA}@[yB_A}@a@qCwAwBsAqA{@cBmA{AmAo@i@yBuBwZgYuDiDyBqBiG{F_EwDwCoCkEaEaA{@gAgA_A}@sCmCg@e@_FsEaQ_PSQmAcA{CsBk@c@qAo@kAi@cAc@{@[s@UyBm@wBa@{AS_CSiAGoC?kA@u@BuBLiBToB\\aCj@mA`@kBt@mAh@_A`@c@Tk@V_@PmAh@oLfFq@VaDdAkCn@wB`@{C`@wBL}@BiBDgA?iAGqDY_BQoASqEy@eEaAeIcBwIkBgLeCqQsDgCm@_B[oGsA{D}@aCe@aDs@mLcCgDs@kNyCcHwA{GyAiE_AcEy@qCe@qFw@_Ee@}AOuKu@w@EiGU{BIoDA{BAq@@iCB{@BmCH{BF_@@_@@qDKeCMcAKo@KkBa@aAMs@Ko@Ai@Ck@BmALwCf@_AL}APc@@W?oFE_BIaAIs@MyA]iA[qFeBi@QsA]uAYmAMk@Ck@?iADe@DgAPc@JkA`@oAl@mGbDeBx@wAj@g@Pg@He@FkAHkA@qAIgAQeAYe@QcAe@iAs@a@[iAcAiAoAkAyAeFiHq@_AqC{Du@cAy@}@u@s@s@i@k@[eAa@cA[]Im@K[EmAMeAC}ABkBFgERwDHq@BoBDu@AoBKiB]_CeASKm@a@m@e@k@k@oA}Ae@q@]m@c@}@q@}ASi@[_AcAuCg@qAs@}Ak@eAw@oAg@o@}@cAkAkAgAaA_D_DqDcDwAwAu@cA]i@g@_Ac@}@{@wBqAaEoB}G]uA_EaN}@cCy@kBg@_Ai@{@kA{Ak@m@o@q@e@a@_BgA{@c@s@]s@Uy@W}AYuAKgHYoBQeAO_@KyAa@q@UaNkFyBu@eBc@m@M}AY}AOm@EeCCyA@_AF}ANaC`@}A`@qAd@aCdAeBbA{B~AuBbBoBdBuC|BoBnAeB`AaC`AuG|BoC`A{HhCaEvAc@TUJi@Xk@^a@Zu@r@w@`Ak@|@mAbCi@|Aa@~AQx@WfBIz@K|AIbC@tBPpFRjFBrA?fBE|AGdAMrAc@bDc@`Cg@~BqAfFs@hC{@lCu@rBy@zBoA~CKXKR}AtDa@x@qB`E}@bBGHeAjBiBzCiDdF{FzHcEfFoEdFyB`CkClCkDjDsElEuEfEyKtJa@Z{AlA{AlAoDrCyFhEyEfDqCfBqBjAuBdAkE`BkCfAeDdBgBhAm@b@wBbBo@j@yCxCuA|Ao@v@_@d@yAtBm@`Am@bAkAxBaApB{ApDi@tAiA`DeAtCu@fBiAxB_A|Ak@z@}BzCuBrBiA~@kAz@iAr@cAh@qAn@sDjBeHjDsHbDoDxAsEhBa@Rq@Tw@Ze@RwFnBgA`@sDnA}EzAwCr@cFpAqE`AoB^g@JgBVkEp@iEj@{AP_Ed@mAJoCPmCPkCLeC@cBIyBS{@Qy@Q}@WaBo@e@UoAs@_@WkByAwAsA_CcCmC_D{AoB{AuBiHmKyEgGqDiEwCaDcCcCeE{D{DcDeCiBsDeCkBiA_FuCsGmDwGcDeEqBuCoAyFyB}JuD_UmIiEeB_Aa@kIuDgB{@mHuDiBcAs@_@qAw@cEcCkAs@kFqD}CyB{DaDi@c@s@m@WUaCqB}AuAq@o@iBgBmDmDyPaR_EeEw@w@qCwCoJcJiC}BkJgIyGsFiF{DgDaCoCgBaBaAaFgCgEkBeCeAgGuBwHuBsF}AiIiCyK{DeHsCgVmKkBs@mA_@eAWyBi@{Bc@gDi@_AKo@CWEkESi@AmBC{ABu@@}AFcEVs@FwKt@kHf@{BPuE\\c@FmAJy@Js@HqBV_Fr@o@J{PfCcBXu@LQBwAHo@J_AZ_A^g@RoAd@oAZoB`@eANcAHmADkAAsAMq@Mm@Qa@MqE{AcA]q@MuB[eAIqBIyA?_CJuBVmAT[DcAVcAZkG|BeCp@}AVcAH_@DsAFeK`@aHXiCHu@DwDToAHi@DaGRsCDiABoA?WAqAAe@?]KQGQKQOQUUk@I_@MiAKeBIsBKmEOmDE_AKwBUsFEs@MuCMoCSuD@W@sA?cAB]PaAKuBS]OYSQ[MOUc@c@]@_@Fa@V}@L}@HkBLS?gAFFxFLnL@rAB`C@n@BhA?RAl@yA`@QD"
- }
+ "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"
+ ]
}
]
}
},
- "DistanceIsochroneResponse": {
- "title": "DistanceIsochroneResponse",
+ "SuccessZones": {
+ "title": "SuccessZones",
"type": "object",
- "description": "Attributes describing a distance isochrone response.",
+ "description": "Message returned to a success Zones request",
"properties": {
"status": {
- "$ref": "#/components/schemas/DistanceStatus"
+ "type": "string",
+ "description": "the status of the 2OO Zones response",
+ "example": "success"
},
- "isoline": {
- "description": "Contains the properties of isoline",
- "type": "object",
- "properties": {
- "origin": {
- "$ref": "#/components/schemas/LatLngLiteral"
- },
- "time": {
- "description": "The time of the isochrone (returned as default or when specifying `method=time` in parameters)",
- "type": "object",
- "properties": {
- "value": {
- "description": "The time in minutes",
- "type": "number",
- "example": 30
- },
- "text": {
- "description": "The readable time in minutes",
- "type": "string",
- "example": "30 minutes"
- }
- }
- },
- "distance": {
- "description": "The distance of the isochrone (returned only if `method=distance` in parameters)",
- "type": "object",
- "properties": {
- "value": {
- "description": "The distance in kilometers",
- "type": "number",
- "example": 10
- },
- "text": {
- "description": "The readable distance in kilometers",
- "type": "string",
- "example": "10 km"
- }
- }
- },
- "geometry": {
- "type": "string",
- "description": "The polyline of the isoline (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm)).",
- "example": "a_jyHfol@aAfEzGlIfER~JqV_KqLu@pDiHv@bAfEeCfE"
- }
- }
- }
- },
- "example": {
- "status": "OK",
- "isoline": {
- "origin": {
- "lat": 48.709,
- "lng": 2.403
- },
- "distance": {
- "value": 1,
- "text": "1 km"
- },
- "geometry": "s|ihHouuMZ`GdClCsA~QhCnQmBhEpCfF|HxGpBtFfEnBnHqJpH}ADaEcCaB@sBnEiEYiGmVyFaG{G[eFoCw@gAiIkDYg@_DwA@"
+ "message": {
+ "description": "message returned with the 2OO Zones request",
+ "example": "Zones successfully updated.",
+ "type": "string"
}
}
+ },
+ "Destinations": {
+ "title": "Destinations",
+ "example": "48.709,2.403|48.768,2.338",
+ "type": "string",
+ "description": "One or more locations to use as the finishing point for calculating travel distance. The options for the destinations parameter are the same as for the origins parameter, described above. In order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc:encoded-polyline:`\n"
+ },
+ "Origins": {
+ "title": "Origins",
+ "example": "48.709,2.403",
+ "type": "string",
+ "description": "The starting point for calculating travel distance. You can supply one or more locations separated by the pipe character, in the form of latitude/longitude coordinates. They are used unchanged to calculate distance. Ensure that no space exists between the latitude and longitude values. In order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc:encoded-polyline:`\n"
+ },
+ "Units": {
+ "title": "Units",
+ "example": "metric",
+ "type": "string",
+ "enum": [
+ "imperial",
+ "metric"
+ ],
+ "description": "Specifies the unit system to use when expressing distance as text. Two different units supported:\n * `metric` (default) returns distances in kilometers and meters\n * `imperial` returns distances in miles and feet\n"
}
},
"securitySchemes": {
diff --git a/dist/woosmap-openapi3.yml b/dist/woosmap-openapi3.yml
index 725a2c24..cc751d30 100755
--- a/dist/woosmap-openapi3.yml
+++ b/dist/woosmap-openapi3.yml
@@ -50,11 +50,6 @@ tags:
>**⚠️ This API has been deprecated in favour of Localities API**
externalDocs:
url: https://developers.woosmap.com/products/address-api/get-started/
- - name: Distance API
- description: |
- Woosmap Distance API is a service providing road travel distance and duration calculations, on a Worldwide scale. Request is done over HTTPS using GET or POST. 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/distance-api/get-started/
- name: Zones API
description: |
Woosmap Zones API is a web service that uses an HTTP request to manage, create or edit your Zones (polygons) attached to your assets.
@@ -4607,860 +4602,57 @@ paths:
.catch(function (error) {
console.log(error);
});
- /distance/distancematrix/json:
- get:
- summary: Distance Matrix
- operationId: getDistanceMatrix
- servers:
- - url: https://api.woosmap.com
- tags:
- - Distance API
+components:
+ parameters:
+ ip_address:
+ name: ip_address
description: |
- Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode.
- security:
- - PublicApiKeyAuth: []
- RefererHeader: []
- - PrivateApiKeyAuth: []
- - PrivateApiKeyHeaderAuth: []
- parameters:
- - $ref: '#/components/parameters/origins'
- - $ref: '#/components/parameters/destinations'
- - $ref: '#/components/parameters/mode'
- - $ref: '#/components/parameters/language-4'
- - $ref: '#/components/parameters/units'
- - $ref: '#/components/parameters/elements'
- - $ref: '#/components/parameters/method'
- - $ref: '#/components/parameters/avoid'
- - $ref: '#/components/parameters/departure_time'
- responses:
- '200':
- description: Distance Matrix successfully retrieved
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/DistanceMatrixResponse'
- examples:
- default:
- summary: Distance Matrix Result for driving from origins `48.709,2.403` to destinations `48.709,2.303|48.768,2.338`,
- value:
- status: OK
- rows:
- - elements:
- - status: OK
- duration:
- value: 978
- text: 16 mins
- distance:
- value: 10796
- text: 10.8 km
- - status: OK
- duration:
- value: 942
- text: 16 mins
- distance:
- value: 10322
- text: 10.3 km
- '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/distance/distancematrix/json?origins=48.709%2C2.403&destinations=48.709%2C2.303%7C48.768%2C2.338&mode=driving&language=en&elements=duration_distance&method=distance&key=YOUR_PUBLIC_API_KEY' \
- -H 'Referer: http://localhost'
- - lang: javascript
- label: JavaScript
- source: |-
- const requestOptions = {
- method: "GET",
- redirect: "follow"
- };
+ 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.
+ in: query
+ schema:
+ type: string
+ example: 75.134.29.90
+ limit:
+ name: limit
+ description: |
+ To limit number of assets retrieved from an IP location.
+ schema:
+ type: integer
+ minimum: 1
+ maximum: 300
+ example: 10
+ 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"`
+ ### Vocabulary
- fetch("https://api.woosmap.com/distance/distancematrix/json?origins=48.709%2C2.403&destinations=48.709%2C2.303%7C48.768%2C2.338&mode=driving&language=en&elements=duration_distance&method=distance&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
+ - **Field**: attribute of the Store that is searched, e.g. the attribute `name` of the store.
- url = "https://api.woosmap.com/distance/distancematrix/json?origins=48.709%2C2.403&destinations=48.709%2C2.303%7C48.768%2C2.338&mode=driving&language=en&elements=duration_distance&method=distance&key=YOUR_PUBLIC_API_KEY"
+ - **Operator**: test that is performed on the data to provide a match, e.g. `=`.
+ Each field has a default operator. If none operator follow the `:`, the default one is used.
- payload = {}
- headers = {
- 'Referer': 'http://localhost'
- }
+ - **Value**: the content of the attribute that is tested, e.g. the name of the store `"My cool store"`.
- response = requests.request("GET", url, headers=headers, data=payload)
+ Combine clauses with the conjunctions `AND` or `OR`, and negate the query with `NOT`.
+ ### Fields
- print(response.text)
- post:
- summary: Distance Matrix using POST
- operationId: postDistanceMatrix
- servers:
- - url: https://api.woosmap.com
- tags:
- - Distance API
- description: |
- Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode. If the URL size is too short for your origins and destinations, you should request the server using this POST method and passing arguments as json.
- security:
- - PublicApiKeyAuth: []
- RefererHeader: []
- - PrivateApiKeyAuth: []
- - PrivateApiKeyHeaderAuth: []
- requestBody:
- description: The request body of Distance Matrix must be formatted as JSON.
- required: true
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/DistanceMatrixRequest'
- examples:
- default:
- summary: Request as a JSON for a distance matrix call
- value:
- origins: 48.73534,2.368308|48.73534,2.368308
- destinations: 48.83534,2.368308
- units: imperial
- elements: duration_distance
- method: distance
- departure_time: now
- responses:
- '200':
- description: Distance Matrix with POST successfully retrieved
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/DistanceMatrixResponse'
- examples:
- default:
- summary: Distance Matrix Result for driving from origins `48.73534,2.368308|48.73534,2.368308` to destinations `48.83534,2.368308`,
- value:
- status: OK
- rows:
- - elements:
- - status: OK
- duration:
- value: 978
- text: 16 mins
- distance:
- value: 10796
- text: 10.8 km
- - status: OK
- duration:
- value: 942
- text: 16 mins
- distance:
- value: 10322
- text: 10.3 km
- '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.
- '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/distance/distancematrix/json?private_key=YOUR_PRIVATE_API_KEY' \
- -H 'content-type: application/json' \
- -d '{
- "origins": "48.73534,2.368308|48.73534,2.368308",
- "destinations": "48.83534,2.368308",
- "units": "imperial",
- "elements": "duration_distance",
- "method": "distance",
- "departure_time": "now"
- }'
- - lang: python
- label: Python
- source: |
- import requests
- import json
+ - `type`: An element is contained within `type` collection. e.g. `type:"myType"`
- url = "https://api.woosmap.com/distance/distancematrix/json?private_key=YOUR_PRIVATE_API_KEY"
+ - `tag`: An element is contained within `tag` collection. e.g. `tag:"myTag"`
- payload = json.dumps({
- "origins": "48.73534,2.368308|48.73534,2.368308",
- "destinations": "48.83534,2.368308",
- "units": "imperial",
- "elements": "duration_distance",
- "method": "distance",
- "departure_time": "now"
- })
- headers = {
- 'content-type': 'application/json'
- }
+ - `city`: text matching: the value match the `city` field. e.g. `city:="Paris"`
- response = requests.request("POST", url, headers=headers, data=payload)
+ - `country`: text matching: the value match the `countryCode` field. e.g. `country:="FR"`
- print(response.text)
- - lang: nodejs
- label: NodeJS
- source: |
- const axios = require('axios');
- let data = JSON.stringify({
- "origins": "48.73534,2.368308|48.73534,2.368308",
- "destinations": "48.83534,2.368308",
- "units": "imperial",
- "elements": "duration_distance",
- "method": "distance",
- "departure_time": "now"
- });
+ - `name`: text matching: the value match the `name` field. e.g. `name:="myName"`
- let config = {
- method: 'post',
- maxBodyLength: Infinity,
- url: 'https://api.woosmap.com/distance/distancematrix/json?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);
- });
- /distance/route/json:
- get:
- summary: Route
- operationId: getRoute
- servers:
- - url: https://api.woosmap.com
- tags:
- - Distance API
- description: |
- Get distance, duration and path (as a polyline) for a pair of origin and destination, based on the recommended route between those two points for a specified travel mode.
- security:
- - PublicApiKeyAuth: []
- RefererHeader: []
- - PrivateApiKeyAuth: []
- - PrivateApiKeyHeaderAuth: []
- parameters:
- - $ref: '#/components/parameters/origin'
- - $ref: '#/components/parameters/destination'
- - $ref: '#/components/parameters/mode'
- - $ref: '#/components/parameters/language-4'
- - $ref: '#/components/parameters/units'
- - $ref: '#/components/parameters/alternatives'
- - $ref: '#/components/parameters/waypoints'
- - $ref: '#/components/parameters/method'
- - $ref: '#/components/parameters/details'
- - $ref: '#/components/parameters/avoid'
- - $ref: '#/components/parameters/departure_time'
- - $ref: '#/components/parameters/arrival_time'
- responses:
- '200':
- description: Route successfully retrieved
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/DistanceRouteResponse'
- examples:
- default:
- summary: Distance Route Result for driving from origin `49.31067,4.14525` to destination `49.31344,4.15293` and retrieving alternatives routes.
- value:
- status: OK
- routes:
- - 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@eAHO
- bounds:
- northeast:
- lat: 49.315678
- lng: 4.152915
- southwest:
- lat: 49.31073
- lng: 4.145162
- notice: ''
- legs:
- - distance:
- text: 1 km
- value: 1038
- duration:
- text: 1 min
- value: 75
- start_location:
- lat: 49.31067
- lng: 4.14525
- end_location:
- lat: 49.31344
- lng: 4.15293
- start_waypoint: 0
- end_waypoint: 1
- end_address: D 30
- start_address: D 151
- steps:
- - distance: 676 m
- duration: 1 min
- 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
- end_location:
- lat: 49.315679
- lng: 4.149621
- travel_mode: DRIVING
- instructions:
- action: 2
- summary: Drive northeast on D 151.
- verbal_succint: Drive northeast. Then Enter the roundabout and take the 2nd exit onto D 30.
- verbal_before: Drive northeast on D 151. Then Enter the roundabout and take the 2nd exit onto D 30.
- verbal_after: Continue for 700 meters.
- - distance: 22 m
- duration: 1 min
- polyline: '}}~kHcniXBIBU?W'
- start_location:
- lat: 49.315679
- lng: 4.149621
- end_location:
- lat: 49.31563
- lng: 4.149905
- travel_mode: DRIVING
- 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_succint: Enter the roundabout and take the 2nd exit.
- verbal_before: Enter the roundabout and take the 2nd exit onto D 30.
- - distance: 198 m
- duration: 1 min
- polyline: u}~kH{oiXFWDOLUP[P]j@y@^g@`@i@NUNONMJKJIFELC
- start_location:
- lat: 49.31563
- lng: 4.149905
- end_location:
- lat: 49.314292
- lng: 4.151623
- travel_mode: DRIVING
- instructions:
- action: 27
- summary: Exit the roundabout onto D 30.
- verbal_succint: Exit the roundabout.
- verbal_before: Exit the roundabout onto D 30.
- verbal_after: Continue for 200 meters.
- - distance: 46 m
- duration: 1 min
- polyline: iu~kHsziXJBJAHGFIDMBSAS
- start_location:
- lat: 49.314292
- lng: 4.151623
- end_location:
- lat: 49.314041
- lng: 4.151976
- travel_mode: DRIVING
- 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_succint: Enter the roundabout and take the 2nd exit.
- verbal_before: Enter the roundabout and take the 2nd exit onto D 30.
- - distance: 96 m
- duration: 1 min
- polyline: ws~kHy|iXBKDILURa@LWt@eAHO
- start_location:
- lat: 49.314041
- lng: 4.151976
- end_location:
- lat: 49.313431
- lng: 4.152916
- travel_mode: DRIVING
- instructions:
- action: 27
- summary: Exit the roundabout onto D 30.
- verbal_succint: Exit the roundabout. Then, in 100 meters, You will arrive at your destination.
- verbal_before: Exit the roundabout onto D 30. Then, in 100 meters, You will arrive at your destination.
- verbal_after: Continue for 100 meters.
- - distance: 1 m
- duration: 1 min
- polyline: '}o~kHubjX'
- start_location:
- lat: 49.313431
- lng: 4.152916
- end_location:
- lat: 49.313431
- lng: 4.152916
- travel_mode: DRIVING
- 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.
- main_route_name: D 151
- recommended: true
- '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/distance/route/json?origin=49.31067%2C4.14525&destination=49.31344%2C4.15293&mode=driving&language=en&alternatives=true&method=distance&details=full&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/distance/route/json?origin=49.31067%2C4.14525&destination=49.31344%2C4.15293&mode=driving&language=en&alternatives=true&method=distance&details=full&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/distance/route/json?origin=49.31067%2C4.14525&destination=49.31344%2C4.15293&mode=driving&language=en&alternatives=true&method=distance&details=full&key=YOUR_PUBLIC_API_KEY"
-
- payload = {}
- headers = {
- 'Referer': 'http://localhost'
- }
-
- response = requests.request("GET", url, headers=headers, data=payload)
-
- print(response.text)
- /distance/tolls/json:
- get:
- summary: Tolls
- operationId: getTolls
- servers:
- - url: https://api.woosmap.com
- tags:
- - Distance API
- description: |
- Get Tolls
- security:
- - PublicApiKeyAuth: []
- RefererHeader: []
- - PrivateApiKeyAuth: []
- - PrivateApiKeyHeaderAuth: []
- parameters:
- - $ref: '#/components/parameters/origin'
- - $ref: '#/components/parameters/destination'
- - $ref: '#/components/parameters/mode'
- - $ref: '#/components/parameters/language-4'
- - $ref: '#/components/parameters/units'
- - $ref: '#/components/parameters/alternatives'
- - $ref: '#/components/parameters/waypoints'
- - $ref: '#/components/parameters/method'
- - $ref: '#/components/parameters/departure_time'
- - $ref: '#/components/parameters/arrival_time'
- responses:
- '200':
- description: Tolls successfully retrieved
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/DistanceTollsResponse'
- examples:
- default:
- summary: Distance Tolls Result for driving by car from origin `Lunel, France` to `Lyon, France`
- value:
- status: OK
- routes:
- - legs:
- - distance:
- value: 272304
- text: 272 km
- duration:
- value: 8834
- text: 2 hours 27 mins
- start_location:
- lat: 43.7037562
- lng: 4.1217688
- end_location:
- lat: 45.7196995
- lng: 4.848819
- tolls:
- - countryCode: FRA
- tollSystemRef: 0
- tollSystem: ASF
- tollSystems:
- - 0
- fares:
- - id: e4626716-1e29-4f9a-905a-19f0376cfb38
- name: ASF
- price:
- type: value
- currency: EUR
- value: 28.9
- reason: toll
- paymentMethods:
- - cash
- - bankCard
- - creditCard
- - transponder
- - travelCard
- 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:
- - name: MONTPELLIER (M.EST)
- location:
- lat: 43.70291
- lng: 4.11982
- - name: VIENNE
- location:
- lat: 45.4761
- lng: 4.83378
- tollSystems:
- - id: 7607
- name: ASF
- bounds:
- northeast:
- lat: 45.7197
- lng: 4.89669
- southwest:
- lat: 43.7022
- lng: 4.11696
- overview_polyline:
- points: m{viG_`dXDGLUDU@a@C]GUGMOOOEQCQDMFMPGPGf@@\H\HPJHNF\@N?RFTNNTVh@Rh@Nl@^zBXlAb@|A\~@\t@Rx@RhADl@?VCd@EZGTKRUZUL]FM?MCQISOcAaA]WwF{HcDoEgA}AkBoCeCyDuE_IqEkIoEiI_@s@gBiDmCkFkC_FmRw^sB_Ea@w@c@y@sDcHuH{NyDwH}AeD{AoDy@uBmBuFiAuDeA{DiAcFOq@w@eEk@cDs@iFo@}Fo@iI[oGSaHGmFCyEGaXGmHG}DKkEKmDWqG_@qHa@wGi@aHMsAMsAk@mGK}@i@yEKu@_@uCAKWgBU}ASoAUwAWaBgAkGm@iDWoAy@cDaAkDiAeDcAgCeAaCoAcCmAuBaCqDsAcB}@eA_BaBq@m@aCoBgBoAgBeAaAg@iBy@w@[}Bu@sM}D_Cy@gEiBmCuAaBaAwDcCs@i@sBcByAsAiBeBwB_CiBwBqCwDoAiBoCsEgAqBoBgEqAyCmA_DiAcDgAeDc@{Aq@aCu@}CQw@_AwEc@gCy@oFi@{EUgCUyCWsEOkDO{GAkHBsEB_BFoBLiDNsCf@{Hx@qLTsCdI{iAj@}INeEFcGAkDGyCUiFSqCk@cFQqA]uBw@}Dq@mCoAoEa@mAi@wAyAkDm@qAWe@}AmCw@iAgBcCoA{A_C_CwKyJaEkDiL_KsHwGwC_CsE_D_DkBmBcAmEcCeBkAwBcByAqAq@o@}AgB}AoBuAsBk@_AyAmCaAqBuAiDq@sB{@{CeDmL{@sCmB{FuBwF{BaFuAqC{@_BuBmDaBeCqBqCw@cAwAeBgAmA{CyCgD_D_BsAoC_CyG{FyByBuB_CmCaDcByBgCuDoBcDcIsNk@_A_BgCu@eAcByBmB{BaEmE_GiG_DcDwD}DmBmBsAuAcB}AoCcCcA}@s@k@}CcCgDeC{FcEuAeAmAiAmAiAuAyAiAsAe@o@sAoB}@{Au@uAw@_Bq@}AoAgDa@oAiAeEm@sCa@wB]yBUiBi@wEYuCg@{EEe@K_AGk@y@uHYeCGe@}AcMi@qDOaAeBoK{AcIwDiQwC}LqD}NkAaF}@_EuAmGo@sC_ByIWaBq@oD]oB[yBw@cFo@oDi@uDcBiKkB_LSqAw@yEc@_CcAyFo@iDiA{Fm@aDmA_GsDuPGYoCeL_CcJqAwEw@sC_DuKoC}ImCmIgAcDmAiDyDmKaDqIeDiI_@{@Ui@eAkCeEwJuSoe@iFyLmCsGkDwI}FsOSk@kE_MoHoTgDsJSi@]}@gBgEyA_Ds@uA_BsCq@gAaCkD{BqCe@k@cDeDaB{AgA_AyBcBoAy@mBgAsBiAiEyBm@YsB{@aD}As@[eFaC_Bw@gCuA{B{AqCuBwBgByLsKmC_C_EoDgB_B_Ay@qO_NyFkFoAiAyE_E{I_IOMkSsQyDoDi@g@s@s@qCuCyBgCaDcEcCkDuBeDqBmDeC{EsAuCkBsEWq@{@}BgA{CmAqDcLg^wDuLiBaGe@wAuAmEwAsEwAwEgAyDgBgHw@uDq@wDqA{JW_CUaC_@iFc@}JQiH_@}RMeEWuGI}AWuD}@mK[_DeA{Im@qEeAmH}@sFs@cEeAsFkCaM_@cB{B_J_AmDiC_JcAcDuCuIwCcImAcDmCmG}BgFcCiFyCcGwCmFiB_DcDiFsEcHuHgLwC}EwAkCiBwDuBeF{AmEe@yAoAmE_BwG_AsEy@wEc@qCIk@w@iG{@_Ji@kHa@gG}@uOm@qJ_@cH]eGGoAi@qJGaAg@kIqAyUIuAEs@e@wHiAuO_@sEUyBi@_Fk@iEgAcHy@uEs@sDEQwAiGkAsEiA_Eu@cCwDaL{AaEuCmHeEwIkCkFiCuEcBuCkAmBsFoIgNyRiCqDeD_F_A}AkGaLuAcCy@{AcEsH}AsC[k@_Tc`@{@yAyFiKkDiGmCqE}A_CcDsEuBkCuBcC{BcCaAeA}BcCa@c@c@e@s@w@yAaBsD}EgBkC}AgC}C_GgA{BqBiE}AoD}BcF}BaFiA}B{Pg[aD}Fu@oAmIcOmB{CoAcByAeBuCwC_Aw@uAcAeBeAqDsBgFmCoCyAeC{AkCgBy@o@q@g@}AqA_EuDsCuC}CeDmEcF_D{D}CaEuEsGsCkEwDiGwD{G_@o@u@yAmA}BuAgCgBoDcAmBuAqCqBuDy@}A_BuC{CaFoBcDuFqIgK}NuB_DeA_BwBkDaAeBmCeF{AaDaCqF{ByFwBwFyBgGoAcD_C{FyAcD_AqByA_DcDyGaDaHwCaH{BaGsB{FiBuFmA_E}GmUqC{IaD_JoBcFqCuGaAyBmEiJoCmF_ByCcEmHyC_FcEqGkBuC_AsAsAoBm@y@eEwFeBcCqC_EiAeBkCiEm@eAm@gAuBgEkAyB_BiDmAuCyGuPeBiEm@yA]w@aCaFg@eA}AqCgB}CgCaEwCgEeEoFkByBqFcGwHkIsCkDmBgCcCiDeBoCw@mAcDmFyCqFsB}D}AcD_AuBy@wB}@mCq@_C_AcEe@gC[oB_@kCeAiIy@kFkAyFi@qBc@sAkBaFe@eAsAmCmAuBoBwCu@cAwCyDoFmHiBgCgAaBgDmFqBeDgB_DmCeFoB}D}B}E}AoDaA_CeEyKkAcDqBeGoBsGkBsG_E_OiBsGiBuFoAiDk@sAuAyC}AsCeBiCmCqDoAwAqBqBaA{@kCoBkBmAcCqAcAe@cAa@cA[gA[gAWkCe@kAOkCOmAEeA?oCHmAHkCViCZgFh@qBLaBFkBD}@CaAEeAK{@KiASmAYy@Y{Bw@aAc@c@QiCqAmE{BeEiBo@SqCm@cAO{AMw@Iu@C{A?yBD_AF}BVaCh@gAZeCx@cAb@uDzAgC`AeA\eCp@cARyC`@w@FmADmC@}@CmCQqAQ{@OcAUiCs@oDsA{@]cBq@o@WsAm@iGgC_IcDi@S{@a@kQsH_FcCuBeA_CsAqD_CeCeB}BgB_CmB{BuBMMoBiBe@c@mAyAaBiB_AgAyEgG}KgO{BwCaCwC_@e@qCcDwBaCwA{A_DoCiCqBiBoAyA_A}BoAiAi@aBw@wCiAgCy@QGy@SwCs@}Cm@sB[iH}@cAIkBQ{D[}He@sCMo@?uE?aCDkF^u@HqBXkDn@iAViCn@mAb@y@PqBd@cDr@gC^cBR}ADmBB}BAeBKo@E}@MyAUuA[oBk@yAi@qCkA}DmBgG{CmB_AoBy@q@WgE}AqBm@sCs@{Be@mASiDa@oAIwAE_A?eBFuARiBd@k@RiB~@]Pu@j@]Tk@f@e@f@gAvAgA~Aa@p@wCxFcEbJkCnFq@rAcAjBs@hA{CzE}@fAgAnAyAxAYXo@j@_BrA}BbB}@l@cBbAsHjEkEbCoKjGoBbA}BbAq@XwChAoCjAm@VgHnCgBp@a@NcBf@c@TiGfCqDpAsLtEuJpDuDxAmAh@aBv@q@^yFlDmAz@eAt@qBnAmBpAmBlAmBpAkD|B{HdF{E~CaLpHeDtBmMxI{DhC[TmGdEuc@xYiAv@{FtDeGlEyBdBwD`DgE|DsDpDiBnBqElFqE|FmBlCiCxDqEjHcBvCaCnEIN{ChGaDhHuElLqBjFk@zAgCxGkBrEqArC}BtEq@nAiCbEkBdCmAvAeAfAkAdAgCpBqBjAmAn@gAf@{Bz@kBh@oB`@gAPiCVyCL_B@kC?yIMkCFyADwBNkAL_ANuB`@q@N{@RmA\aAZoAf@kBx@{BlAsAx@wCrBwAhAmAfAeC`CmAnAaAbAiBrB}AfBcJzKuCfDsD|DuDnD{@r@uAhAwDrCiBnAiBhAoAr@}Ax@}HrDmJdEiDvA}Ap@kDrAyC`AgAXsCj@sATeBNsCPyDFqBEkCMqBOiSuBiBSiHu@mDg@uAYeBa@wBm@sBs@{CsAkBcAmAu@gMgIkTwN_SoMwDgC_C}Aa_@mVez@mj@yIgGsFcEcG_F{FiFyBuBsIqIwNeOm@m@}@_AkHqH{GaHqFqFwBoB{BeBw@k@aC}AeCuA_CgAaDoAaA[gAYkEaAeAOuBYgBOaFUiAEaGOgACw@Ac@Ac@?iEM_Sa@iCCmC@eBFoBHqALwAPeBZwAVwA^iA\wAf@eBp@aBt@sDfBwJhF{FtCoFjCmD|AmBt@iBp@mDfAsA^cEdAiB\mEt@{C`@kBR}@JoDZaDPmQnAaEV_OdAyG^oI`@_FRoDJgGRwGLoDDeJHiC@wX?iGCkMBoAByBFuCDiCFsBFa@BiADiHb@mBLsBN{Iz@iD`@mDd@iGbAcF|@qLbC{M|CgKxBoEv@uDl@uEn@gIz@sE`@gk@vEcCPmDXmD\i`@`DcCT{Jv@oFd@gIl@gHf@_CNqJf@qELgB@yDD_HEaBCwDKwBKsBGsAKcEYkBQmBQgCYaH_AiEs@kAUk@Ki@Ke@I]ImCi@mEiAaHmBaEoAyHsC_DqAuDaBkAk@{F{CcHeEm@[oBoAyAeAsB{AyHoG}AuA_CuBeIcIiHeIkC{CcBuBk@q@yBiCmBuBqBsBsBsBgD}CgDoCyAiAaBkAgAw@mD{BoBiAeEwB}As@cCcAeE{AiCy@yC{@mCo@mE{@y@UcF_A_F_AkN{CuD{@oGgBcAY_AYUGqDiAwE_BeA]aBk@eEcBeBs@sEoBsDaBkFmCk@[gIkE{SuLqDmByCyAqCoAyEgBuFiB}Bk@mBe@{E_AuB[iEi@aCSaDSqEQwAEwCC}CCoIIeHIsJMoDGaLI{FIuDGaCEkX[mACuHW_Fa@iBSaEk@kASiDq@kAW_EkAiCy@aC{@w@YyAm@yCsAqBcAeFsCwDeC{AeAiFgE}AsAyAuAqCqC}@_Ao@u@oAwAsD{Ek@s@_@k@_AsAyBgDwC_Fs@kAwFiKaIsOgBeDmD_HwB{D}CqFaBmCiCaEyAyBcGeIaCyC{AgBeCqC_DgDeCeC{GiGwFsEqDkCmCkB_DqB_JiFo@]gFeCcCeA_CaAq@YqAg@_C_AsB{@cRyGkPqFu@UoImCQGoBm@uHyBkA]cMiDgHeBqEw@iCc@aEe@cDW{AIgEM_DGeD?wEFmCDgGTeFVwE\sALwLlAuG|@_BVcKhByE`AsFrAyCt@eGdB{IpCe[rKgQhGWHq@VcLzDuE`B]Jg@PuAh@kAb@mHtC_Ab@aEbBiKvEsAp@sCtAeItDcEfB{DzAiDnAuBr@yDjA{Bl@{EhAeCn@aCd@qIxAsBZqBVsDb@aGj@oDXqDVmGZeFPwDHcEDmIBcHAoNCa@?uMCgQLaNRkJTsJZ_Md@yOx@mIXiCH_@?c@@oGBaCAkEIcFQsE[kHs@_@CwB[iC]{E{@oFiASESC{Bi@iEgAcJsBmGsAkFeAkDm@kEq@yGy@uCYsFc@uCWaJg@s@AsG[iE]q@EYA{@?wC?mCM_S{@s@CcGO}BMcBIkDMgEKmBC}B?yCDgAD_EVeBPkBVqB\uDv@iCr@_Cv@mBr@gBt@mAj@yAt@cAj@{CfBsSdN}D~BiGfDsEtBwB|@}Aj@wFjBu@VeCr@}Bh@gCj@yDv@oEv@aJxAqHpA_MtBy@LkC\uGx@kFh@cAHwF\oDPqHLuDB{GGeEIgGWw@GwCOoSwA{Jw@yDa@gDi@y@MkCm@{Aa@qA[aCu@cEoAeF}AuAc@qFsAmEy@{B]aAKeCUyAKcEOoDC}B?aCFy@D_Kl@gBNmIf@sCJcEFcA?mFIoDQsAKcCWeC]sB[kBa@_B_@{Cw@sBo@qBq@}B_AsF_C_Bo@aGoCw@]qFeCkAg@yBaAeAc@u@[cNkGqAm@eCiAy@[kGqC_DuAm@[gJmEkDgB{CaBq@_@kBeAUMwBsAgFiDoA}@wDuCqF{EoBoBgAiA{@aAmCaD{CeEeBiCgEkH_B_Dy@gBwCeHuAyDQg@cAaDgBiGkB_IyAuHmAgH_Fc\sA}HcAiF}@{DgA_E]kAaBiFa@kA_AcCu@iBs@_BaAwBkA_CeB_DoAwBoAmBmBmC_CwCY]]a@yB_C_B}AmFwEsD{CiUwQoQ{NuMmKcNsKaGiEoFmDcF{CuDqBqCuAkAi@o@[_EeBsAi@iE}A_IiC}MgE{FcBsEoAwBi@cBc@eDs@gEy@cCe@uQuCoFw@_m@iJs]gFkC]oWqDwFw@qC_@gd@gGgGw@yGw@uEc@iCSeDQeBGaCG{CEkA?{FFkDJwDRYBkE\eBPg@FcH|@_QfCuDd@cEb@g@BsCRcDL}BB}E?yDKaCK}@G_CScCWuCa@qF_AsCm@YKUGiF{Ae@OsFiBgIuCg@Q{h@aRoE}AmG{ByCcA_A[s@Ww@Y_Cw@cA]mC_AiDaAyAc@oKoCsDo@mB]{AUkDe@qB[aBWmC[oB[wAU{B]oIoAeC]gBUwAQcAK}@KyCWuEUgCKgEEmBBcGHwDL{G^}CLoCHsA?aCCgAE}C[oASwB_@iAWkA[gC{@uAi@u@[yBkAcBeAeCaByBcBiCsBiByAi@_@iG}E]YcIkGcBoAo@i@mDgDs@y@wE_Gm@o@cB}Aw@o@w@k@yEiCeBq@iA]cAWaAQuC[cI]gFUaFYuBWgASwFoAsBa@}@MaAIgACy@?aBHsAL}@Lc@LeBf@aA`@]RcDjBsAn@cBl@wBj@q@LuAP{O~AcAH_BRmBPaBViB\}LrCkBd@mBh@s@RyAh@aA`@oB|@eBz@wBlAi@TmAd@gAZuAXgAL{AHqB@oCQ_AIiAUkDu@sEaAuA[oAU_B[s@MkB]y@KeAImACu@Ci@?g@@yADeBNaC^qBd@YHoAf@q@Tu@\yB|@qIlD_DlAsBr@QD[H}@XeB^uB`@aBT_CX_BN_AFuAFaCDeIFqGLaBL_CZoAPyBd@k@LiAZcBf@uBx@mB|@{PlJwDjBuD`Bs@VcA`@}Ah@yEvAyDz@iB\w@LkDh@eAPsCV{CTqBJo@BaGJyDAmR]iJQoEIsIMgC?uA@kELcBJg@BaY~AyAFmFXmCL}BFsCFmEBuC?o@A{CCiAEoHWkIo@{Eg@yEk@mGeAuN}CuGyAwDs@wB]iAOyEg@uF[mEKuCAiA@mFL{CLoBJeDTkY|AsWzAa@BiBL{BR_D`@uDp@wCn@sDbA{DrAqDzA_ErB}@d@iAn@aCzAyAbAsAbAcDrC}ApAsDhD{@z@{@t@[RiAx@mAr@o@Z]Pq@^y@X{@XiDr@cCV_DLuEM_Dc@iBc@qA_@_A_@]O{Aw@m@]w@g@wB_ByAuAuA{AcBuBqGwI}@oAgD{Dk@m@gDyCoAeAkBsAkAs@{@i@kAo@mAm@{B_AqBq@cBk@yAa@wA[{AWgBUeEa@cCOeCIcCBeBJkD^oARcK`C_BPmANyALyABsBAgBG}AKsDg@qDcAoDuAiDkBwEgDqB{AeL}IgHuFwJsHsJuHyAsAiBgBiAmAqCcDiC_DuCuDiDgEgBuBiAmAsAoAgCyBoCkBeC}AQKSKiDwA{B{@{Cw@wB]_Ca@yE[kBE_DBsEZeFr@sq@rOaOhDyDdA}Af@yAh@_C`AaBv@wEdC_HzDkB|@{B|@kBl@_AVmAXyB`@aCZkAJcBHiCDsB?sCCo@C_BAcDIgLYiHMk@AiGO{BGmBCk@CoFMO?Y?a^s@iJWaEG}BAeE@}AD{BLiBPgCZwAToAVyCv@}Br@yBx@oBx@mB~@{@f@yAz@uDfCiBzA[XUR}ArA}ApAmAbA_BhAsBpAu@^cBv@uAd@mAZsCd@wAPwCd@qAV_AViA^}An@}Av@cAl@sBxAuAjAyEjEgF|EuBdBeAv@y@h@w@d@}Ar@eA^]Lo@Rm@PwAZ{@LsBPoBHwA@yBK_AGu@MgB[mBe@wBs@y@[}Ae@uBi@}AYkBUeCKgBBu@@aBJqBVkAT_Bb@y@Xm@RyBbAiAn@aAn@sAbA{BtBy@~@q@z@qAhBe@r@W`@qAdCm@tAaAbCs@xBaAjDi@dCiA~Es@lC]tAg@xA_BzDe@`As@tAo@dA}AxBk@r@iBnBw@r@w@p@mBrA}BpAgAd@aA^w@VkBh@_Cp@yN~D}CdA_C|@uBz@aDxAgCrAqDtBoAv@eBjAa@VqCrBeCtBmAlA_BfBqA`BwBtCsDbFwAhBgAjAcAdAyArA_Av@kBvAo@b@yCdB}BhAsCnA}VjKeBv@uAr@g@ZQH}AbA_Ar@u@l@u@r@aBjBmA|A_AtAw@pAmA~B_AnBsCnFsAxBcAzA{@fAmCtCkBbBkA`ASLyAdAe@XuCzAoBx@eCx@sCp@}@RiCZeBLkCDwCEqBKcBMcZiCcIs@cCQkCMuAEiCCiA@oDL}DXyDj@qCj@qBh@sC|@wChAk@ViB~@gBbAaB`AgAr@eBrAk@^oB|AwE`EuBjBqAhA{BnBqC~BoNzLwEdEkGjF{F`FiA~@eAr@_@VeAn@q@\mBx@qBn@iBb@s@LiBRy@FsBF{BEgCSmBYaCi@oBc@kPiEoE_A}@MwAK}@Cs@Cg@?cCFmBNgBVwBd@gBh@iBt@i@VmAp@{AbAmA~@{AxAyA|Aq@x@iA|AsB`D_FlHoBxCmCxD{AjBiApAmDfDy@r@qCpBmAv@sAt@ULsB`AqAd@}Ah@eAZ{A^aBZ_CZ_DXsAFc@?oB?eCE_IYeACoLe@oO]oACyB@qD?aFFcJH}@B_IZS@iCNkEVwJx@{Db@wKtAuHlA_[tFyB^iJdBmJbBk`@bHmB`@]Hk@JgFbA{J|AcCZkAJeAJcEN{C@kBCkCKqAIcCSoBWmRwBqDe@_Eo@qFkAaB]oMsCcGkAaBQkACgBDg@FsARuA\aBl@}Az@kA|@g@f@oErEsAjAc@ZgAp@cBv@{@V_APaALmAHaA?aAGyAKy@McC]oBW_Fs@sAOwG{@qBQiBIgBIqAAsAAmA@aBDsFXqABgCAcDMoBO_AKyB[aBYyA[aBe@_EkA}@[yB_A}@a@qCwAwBsAqA{@cBmA{AmAo@i@yBuBwZgYuDiDyBqBiG{F_EwDwCoCkEaEaA{@gAgA_A}@sCmCg@e@_FsEaQ_PSQmAcA{CsBk@c@qAo@kAi@cAc@{@[s@UyBm@wBa@{AS_CSiAGoC?kA@u@BuBLiBToB\aCj@mA`@kBt@mAh@_A`@c@Tk@V_@PmAh@oLfFq@VaDdAkCn@wB`@{C`@wBL}@BiBDgA?iAGqDY_BQoASqEy@eEaAeIcBwIkBgLeCqQsDgCm@_B[oGsA{D}@aCe@aDs@mLcCgDs@kNyCcHwA{GyAiE_AcEy@qCe@qFw@_Ee@}AOuKu@w@EiGU{BIoDA{BAq@@iCB{@BmCH{BF_@@_@@qDKeCMcAKo@KkBa@aAMs@Ko@Ai@Ck@BmALwCf@_AL}APc@@W?oFE_BIaAIs@MyA]iA[qFeBi@QsA]uAYmAMk@Ck@?iADe@DgAPc@JkA`@oAl@mGbDeBx@wAj@g@Pg@He@FkAHkA@qAIgAQeAYe@QcAe@iAs@a@[iAcAiAoAkAyAeFiHq@_AqC{Du@cAy@}@u@s@s@i@k@[eAa@cA[]Im@K[EmAMeAC}ABkBFgERwDHq@BoBDu@AoBKiB]_CeASKm@a@m@e@k@k@oA}Ae@q@]m@c@}@q@}ASi@[_AcAuCg@qAs@}Ak@eAw@oAg@o@}@cAkAkAgAaA_D_DqDcDwAwAu@cA]i@g@_Ac@}@{@wBqAaEoB}G]uA_EaN}@cCy@kBg@_Ai@{@kA{Ak@m@o@q@e@a@_BgA{@c@s@]s@Uy@W}AYuAKgHYoBQeAO_@KyAa@q@UaNkFyBu@eBc@m@M}AY}AOm@EeCCyA@_AF}ANaC`@}A`@qAd@aCdAeBbA{B~AuBbBoBdBuC|BoBnAeB`AaC`AuG|BoC`A{HhCaEvAc@TUJi@Xk@^a@Zu@r@w@`Ak@|@mAbCi@|Aa@~AQx@WfBIz@K|AIbC@tBPpFRjFBrA?fBE|AGdAMrAc@bDc@`Cg@~BqAfFs@hC{@lCu@rBy@zBoA~CKXKR}AtDa@x@qB`E}@bBGHeAjBiBzCiDdF{FzHcEfFoEdFyB`CkClCkDjDsElEuEfEyKtJa@Z{AlA{AlAoDrCyFhEyEfDqCfBqBjAuBdAkE`BkCfAeDdBgBhAm@b@wBbBo@j@yCxCuA|Ao@v@_@d@yAtBm@`Am@bAkAxBaApB{ApDi@tAiA`DeAtCu@fBiAxB_A|Ak@z@}BzCuBrBiA~@kAz@iAr@cAh@qAn@sDjBeHjDsHbDoDxAsEhBa@Rq@Tw@Ze@RwFnBgA`@sDnA}EzAwCr@cFpAqE`AoB^g@JgBVkEp@iEj@{AP_Ed@mAJoCPmCPkCLeC@cBIyBS{@Qy@Q}@WaBo@e@UoAs@_@WkByAwAsA_CcCmC_D{AoB{AuBiHmKyEgGqDiEwCaDcCcCeE{D{DcDeCiBsDeCkBiA_FuCsGmDwGcDeEqBuCoAyFyB}JuD_UmIiEeB_Aa@kIuDgB{@mHuDiBcAs@_@qAw@cEcCkAs@kFqD}CyB{DaDi@c@s@m@WUaCqB}AuAq@o@iBgBmDmDyPaR_EeEw@w@qCwCoJcJiC}BkJgIyGsFiF{DgDaCoCgBaBaAaFgCgEkBeCeAgGuBwHuBsF}AiIiCyK{DeHsCgVmKkBs@mA_@eAWyBi@{Bc@gDi@_AKo@CWEkESi@AmBC{ABu@@}AFcEVs@FwKt@kHf@{BPuE\c@FmAJy@Js@HqBV_Fr@o@J{PfCcBXu@LQBwAHo@J_AZ_A^g@RoAd@oAZoB`@eANcAHmADkAAsAMq@Mm@Qa@MqE{AcA]q@MuB[eAIqBIyA?_CJuBVmAT[DcAVcAZkG|BeCp@}AVcAH_@DsAFeK`@aHXiCHu@DwDToAHi@DaGRsCDiABoA?WAqAAe@?]KQGQKQOQUUk@I_@MiAKeBIsBKmEOmDE_AKwBUsFEs@MuCMoCSuD@W@sA?cAB]PaAKuBS]OYSQ[MOUc@c@]@_@Fa@V}@L}@HkBLS?gAFFxFLnL@rAB`C@n@BhA?RAl@yA`@QD
- '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/distance/tolls/json?origin=43.70386%2C%204.12200&destination=45.71971%2C%204.84891&mode=driving&private_key=YOUR_PRIVATE_API_KEY'
- - lang: javascript
- label: JavaScript
- source: |-
- const requestOptions = {
- method: "GET",
- redirect: "follow"
- };
-
- fetch("https://api.woosmap.com/distance/tolls/json?origin=43.70386%2C%204.12200&destination=45.71971%2C%204.84891&mode=driving&private_key=YOUR_PRIVATE_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/distance/tolls/json?origin=43.70386%2C%204.12200&destination=45.71971%2C%204.84891&mode=driving&private_key=YOUR_PRIVATE_API_KEY"
-
- payload = {}
- headers = {}
-
- response = requests.request("GET", url, headers=headers, data=payload)
-
- print(response.text)
- /distance/isochrone/json:
- get:
- summary: Isochrone (Early Access)
- operationId: getIsochrone
- servers:
- - url: https://api.woosmap.com
- tags:
- - Distance API
- description: |
- Find all destinations that can be reached in a specific amount of time or a maximum travel distance
- security:
- - PublicApiKeyAuth: []
- RefererHeader: []
- - PrivateApiKeyAuth: []
- - PrivateApiKeyHeaderAuth: []
- parameters:
- - $ref: '#/components/parameters/origin'
- - $ref: '#/components/parameters/value'
- - $ref: '#/components/parameters/mode'
- - $ref: '#/components/parameters/language-4'
- - $ref: '#/components/parameters/units'
- - $ref: '#/components/parameters/method'
- - $ref: '#/components/parameters/avoid'
- responses:
- '200':
- description: Isochrone successfully retrieved
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/DistanceIsochroneResponse'
- examples:
- default:
- summary: Distance Isochrone Result for driving 1km by car from origin `48.709,2.403`
- value:
- status: OK
- isoline:
- origin:
- lat: 48.709
- lng: 2.403
- distance:
- value: 1
- text: 1 km
- geometry: s|ihHouuMZ`GdClCsA~QhCnQmBhEpCfF|HxGpBtFfEnBnHqJpH}ADaEcCaB@sBnEiEYiGmVyFaG{G[eFoCw@gAiIkDYg@_DwA@
- '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/distance/isochrone/json?origin=48.709%2C2.403&value=1&mode=driving&language=en&method=distance&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/distance/isochrone/json?origin=48.709%2C2.403&value=1&mode=driving&language=en&method=distance&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/distance/isochrone/json?origin=48.709%2C2.403&value=1&mode=driving&language=en&method=distance&key=YOUR_PUBLIC_API_KEY"
-
- payload = {}
- headers = {
- 'Referer': 'http://localhost'
- }
-
- response = requests.request("GET", url, headers=headers, data=payload)
-
- print(response.text)
-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.
- in: query
- schema:
- type: string
- example: 75.134.29.90
- limit:
- name: limit
- description: |
- To limit number of assets retrieved from an IP location.
- schema:
- type: integer
- minimum: 1
- maximum: 300
- example: 10
- 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"`
- ### Vocabulary
-
- - **Field**: attribute of the Store that is searched, e.g. the attribute `name` of the store.
-
- - **Operator**: test that is performed on the data to provide a match, e.g. `=`.
- Each field has a default operator. If none operator follow the `:`, the default one is used.
-
- - **Value**: the content of the attribute that is tested, e.g. the name of the store `"My cool store"`.
-
- Combine clauses with the conjunctions `AND` or `OR`, and negate the query with `NOT`.
- ### Fields
-
- - `type`: An element is contained within `type` collection. e.g. `type:"myType"`
-
- - `tag`: An element is contained within `tag` collection. e.g. `tag:"myTag"`
-
- - `city`: text matching: the value match the `city` field. e.g. `city:="Paris"`
-
- - `country`: text matching: the value match the `countryCode` field. e.g. `country:="FR"`
-
- - `name`: text matching: the value match the `name` field. e.g. `name:="myName"`
-
- - `idstore`: text matching: the value match the `idstore` field. e.g. `idstore:="myIdStore"`
+ - `idstore`: text matching: the value match the `idstore` field. e.g. `idstore:="myIdStore"`
- `user`: concerns all fields inside `user_properties`. text matching or numerical comparison. e.g. `user.myAttribute:="myValue"`
@@ -5808,238 +5000,78 @@ components:
in: query
language-3:
name: language
- description: |
- The language code, using ISO 639-1 country codes, indicating in which language the results should be returned, if possible. If language is not supplied, the Localities service will use the default language of each country.
- schema:
- type: string
- example: en
- in: query
- public_id-2:
- name: public_id
- description: |
- A textual identifier that uniquely identifies a locality, returned from an [Address Autocomplete](https://developers.woosmap.com/products/address-api/autocomplete/).
- schema:
- type: string
- example: aGVyZTpjbTpuYW1lZHBsYWNlOjIwMDA1MTI2
- required: true
- in: query
- fields-2:
- name: fields
- description: |
- Used to limit the returning fields (by default, all fields are return). Available fields are (geometry) (fields should be separated by a `,`). By using this parameter you will limit content of responses to the geometry part. No address component will be returned.
- schema:
- type: string
- enum:
- - geometry
- example: geometry
- in: query
- address-2:
- name: address
- description: |
- The address of which to find the coordinates for. A partial address is less likely to return the proper coordinates than the complete address.
- schema:
- type: string
- example: 224%20Rue%20de%20Rivoli%2C%20Paris
- required: false
- in: query
- latlng-2:
- name: latlng
- description: |
- Geographic coordinates. Should be pass in `lat`,`lng` format.
- schema:
- type: string
- example: 5.2,-2.3
- required: false
- in: query
- limit-3:
- name: limit
- description: |
- Maximum number of results to be returned (value from 1 to 100, default values for geocode request [20] and for reverse geocode request [1])
- schema:
- type: integer
- minimum: 1
- maximum: 100
- example: 10
- in: query
- limit-4:
- name: limit
- description: |
- To limit number of zones retrieved (max 50).
- schema:
- type: integer
- minimum: 1
- maximum: 50
- example: 10
- in: query
- offset:
- name: offset
- description: |
- To retrieve zones starting from an offset value.
- schema:
- type: integer
- minimum: 1
- example: 20
- in: query
- origins:
- name: origins
- in: query
- required: true
- schema:
- type: string
- example: 48.709,2.403
- description: |
- The starting point for calculating travel distance. You can supply one or more locations separated by the pipe character (|), in the form of latitude/longitude coordinates. They are used unchanged to calculate distance. Ensure that no space exists between the latitude and longitude values. In order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc:encoded-polyline:`
- destinations:
- name: destinations
- in: query
- required: true
- schema:
- type: string
- example: 48.709,2.403|48.768,2.338
- description: |
- One or more locations to use as the finishing point for calculating travel distance. The options for the destinations parameter are the same as for the origins parameter, described above. In order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc:encoded-polyline:`
- mode:
- name: mode
- in: query
- schema:
- type: string
- enum:
- - driving
- - cycling
- - walking
- example: driving
- description: |
- Specifies the mode of transport to use when calculating distance
- language-4:
- name: language
- in: query
+ description: |
+ The language code, using ISO 639-1 country codes, indicating in which language the results should be returned, if possible. If language is not supplied, the Localities service will use the default language of each country.
schema:
type: string
example: en
- description: |
- The language code, indicating in which language the results should be returned, if possible. If language is not supplied, the Distance API service will use the navigator language or “en”.
- units:
- name: units
in: query
- schema:
- type: string
- enum:
- - imperial
- - metric
- example: metric
+ public_id-2:
+ name: public_id
description: |
- Specifies the unit system parameter to use when expressing distance as text. Two different units supported:
- * `metric` (default) returns distances in kilometers and meters
- * `imperial` returns distances in miles and feet
- elements:
- name: elements
- in: query
+ A textual identifier that uniquely identifies a locality, returned from an [Address Autocomplete](https://developers.woosmap.com/products/address-api/autocomplete/).
schema:
type: string
- enum:
- - distance
- - duration
- - duration_distance
- example: duration_distance
- description: |
- Specifies element values that will be part of the API response (distance and/or duration). if not specified default is `distance`
- method:
- name: method
+ example: aGVyZTpjbTpuYW1lZHBsYWNlOjIwMDA1MTI2
+ required: true
in: query
+ fields-2:
+ name: fields
+ description: |
+ Used to limit the returning fields (by default, all fields are return). Available fields are (geometry) (fields should be separated by a `,`). By using this parameter you will limit content of responses to the geometry part. No address component will be returned.
schema:
type: string
enum:
- - time
- - distance
- example: distance
- description: |
- Specifies the method to compute the route between the start point and the end point:
- - `time`: fastest route (default) - `distance`: shortest route
- avoid:
- name: avoid
+ - geometry
+ example: geometry
in: query
- schema:
- type: string
- example: tolls|highways|43.3,3.4;42.1,3.5;41.4,3.6
+ address-2:
+ name: address
description: |
- The 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. To add multiple polygons, separate them with the `|` character.
- departure_time:
- name: departure_time
- in: query
+ The address of which to find the coordinates for. A partial address is less likely to return the proper coordinates than the complete address.
schema:
type: string
- example: '1600799173'
- description: |
- By using this parameter, Distance will calculate the duration with traffic Specifies the date/time at which to base the calculations on for traffic purposes. Valid values are a timestamp (e.g. `1600799173` for the date:`22/09/2020 20:26:13`) or `now`.
- Use either `arrival_time` or `departure_time`, not both.
- origin:
- name: origin
+ example: 224%20Rue%20de%20Rivoli%2C%20Paris
+ required: false
in: query
- required: true
- schema:
- type: string
- example: 48.709,2.403
+ latlng-2:
+ name: latlng
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.
- destination:
- name: destination
- in: query
- required: true
+ Geographic coordinates. Should be pass in `lat`,`lng` format.
schema:
type: string
- example: 48.768,2.338
- description: |
- The ending point for the route. It should be supplied in the form of latitude/longitude coordinates. Ensure that no space exists between the latitude and longitude values.
- alternatives:
- name: alternatives
+ example: 5.2,-2.3
+ required: false
in: query
- schema:
- type: boolean
- example: true
+ limit-3:
+ name: limit
description: |
- Specifies if alternative routes should be returned. default is `false`. Depending on the calculated route, alternatives may not be provided.
- `alternatives` and `waypoints` can not be used at the same time.
- waypoints:
- name: waypoints
- in: query
+ Maximum number of results to be returned (value from 1 to 100, default values for geocode request [20] and for reverse geocode request [1])
schema:
- type: string
- example: optimize:true|48.850077,3.311124|48.850077,3.411124
- description: |
- A list of points by which the route should pass (route response is divided into legs, one leg corresponding to a route between two waypoints). Waypoints should be separated by | character.
- Optionally, you may pass `optimize:true` as the first argument within the waypoints parameter. This way the provided route is optimized by rearranging the waypoints in a more efficient order based on distance or time according to the method parameter. The route start point and end point order is not changed, their position is considered fixed.
- `alternatives` and `waypoints` can not be used at the same time.
- details:
- name: details
+ type: integer
+ minimum: 1
+ maximum: 100
+ example: 10
in: query
- schema:
- type: string
- enum:
- - full
- - none
- example: full
+ limit-4:
+ name: limit
description: |
- Specifies if maneuver instructions should be returned (roadbook). Valid values are `none` and `full` (default is `none`)
- arrival_time:
- name: arrival_time
- in: query
+ To limit number of zones retrieved (max 50).
schema:
- type: string
- example: '1600799173'
- description: |
- By using this parameter, Distance will calculate the duration with traffic Specifies the arrival date/time as a timestamp to base the calculation on (e.g. `1600799173` for the date:`22/09/2020 20:26:13`).
- Use either `arrival_time` or `departure_time`, not both.
- value:
- name: value
+ type: integer
+ minimum: 1
+ maximum: 50
+ example: 10
in: query
- required: true
+ offset:
+ name: offset
+ description: |
+ To retrieve zones starting from an offset value.
schema:
type: integer
minimum: 1
- maximum: 120
- example: 120
- description: |
- The value to use for isochrone contour. You can specify time in minutes or distance in kilometers (cf. method parameter). The maximum value that can be specified is 120 (120 minutes : 2 hours or 120 km).
+ example: 20
+ in: query
address_address_components:
$ref: '#/components/parameters/address_components'
address_address:
@@ -6060,38 +5092,6 @@ components:
$ref: '#/components/parameters/location-2'
address_public_id:
$ref: '#/components/parameters/public_id-2'
- distance_alternatives:
- $ref: '#/components/parameters/alternatives'
- distance_arrival_time:
- $ref: '#/components/parameters/arrival_time'
- distance_avoid:
- $ref: '#/components/parameters/avoid'
- distance_departure_time:
- $ref: '#/components/parameters/departure_time'
- distance_destination:
- $ref: '#/components/parameters/destination'
- distance_destinations:
- $ref: '#/components/parameters/destinations'
- distance_details:
- $ref: '#/components/parameters/details'
- distance_elements:
- $ref: '#/components/parameters/elements'
- distance_language:
- $ref: '#/components/parameters/language-4'
- distance_method:
- $ref: '#/components/parameters/method'
- distance_mode:
- $ref: '#/components/parameters/mode'
- distance_origin:
- $ref: '#/components/parameters/origin'
- distance_origins:
- $ref: '#/components/parameters/origins'
- distance_units:
- $ref: '#/components/parameters/units'
- distance_value:
- $ref: '#/components/parameters/value'
- distance_waypoints:
- $ref: '#/components/parameters/waypoints'
geolocation_ip_address:
$ref: '#/components/parameters/ip_address'
geolocation_limit:
@@ -8821,146 +7821,18 @@ components:
description: message returned with the 2OO Zones request
example: Zones successfully updated.
type: string
- DistanceStatus:
- title: DistanceStatus
+ Destinations:
+ title: Destinations
+ example: 48.709,2.403|48.768,2.338
type: string
description: |
- Returns more info on if the request was successful or not.
- * `OK` indicates the response contains a valid result.
- * `INVALID_REQUEST` indicates that the provided request was invalid (e.g. wrong URL syntax).
- * `MAX_ELEMENTS_EXCEEDED` indicates that the product of origins and destinations exceeds the per-query limit (fixed at 200 elts/q).
- * `MAX_ROUTE_LENGTH_EXCEEDED` indicates that at least one of requested route is too long and the matrix cannot be processed (>500km).
- * `REQUEST_DENIED` indicates that the service denied use of the Distance API service (e.g. wrong API Key, wrong/no referer, …).
- * `BACKEND_ERROR` indicates a Distance API request could not be processed due to a server error. This may indicate that the origin and/or destination of this pairing could not be matched to the network. The request may or may not succeed if you try again.
- * `OVER_QUERY_LIMIT` (associated to a 429 status code) indicates that the number of queries per second (QPS) or the number of elements per second (EPS) exceed the [usage limits](https://developers.woosmap.com/products/distance-api/distance-matrix-endpoint/#usage-limits)
- enum:
- - OK
- - INVALID_REQUEST
- - MAX_ELEMENTS_EXCEEDED
- - MAX_ROUTE_LENGTH_EXCEEDED
- - REQUEST_DENIED
- - BACKEND_ERROR
- - OVER_QUERY_LIMIT
- DurationValue:
- title: DurationValue
- description: The total duration to travel this route/leg, expressed in seconds (value) and as text. The textual value gives a structured string for duration in the specified language (if available).
- type: object
- properties:
- value:
- description: The duration in seconds
- type: number
- example: 272.5
- text:
- type: string
- description: The readable duration value
- example: 5 mins
- example:
- value: 272.5
- text: 5 mins
- DistanceValue:
- title: DistanceValue
- description: The total distance expressed in meters (value) and as text. The textual value uses the unit system specified with the units parameter of the original request.
- type: object
- properties:
- value:
- description: The distance in meters.
- type: number
- example: 2775.1
- text:
- description: The readable distance using the unit system specified.
- type: string
- example: 2.8 km
- example:
- value: 2775.1
- text: 2.8 km
- DistanceMatrixElementResponse:
- title: DistanceMatrixElementResponse
- type: object
- description: Attributes describing an element of origin and destination returned in distance Matrix response.
- properties:
- status:
- type: string
- description: |
- Status returned for Distance Matrix Element Response.
- - `OK` indicates the response contains a valid result.
- - `NOT_FOUND` indicates that the origin and/or destination of this pairing could not be matched to the network.
- - `ZERO_RESULTS` indicates no route could be found between the origin and destination.
- enum:
- - OK
- - NOT_FOUND
- - ZERO_RESULTS
- duration:
- $ref: '#/components/schemas/DurationValue'
- distance:
- $ref: '#/components/schemas/DistanceValue'
- DistanceMatrixElementsResponse:
- title: DistanceMatrixElementsResponse
- type: object
- description: Attributes describing elements of origin and destination returned in distance Matrix response.
- properties:
- elements:
- type: array
- description: the route element
- items:
- $ref: '#/components/schemas/DistanceMatrixElementResponse'
- example:
- elements:
- - status: OK
- duration:
- value: 866
- text: 14 mins
- distance:
- value: 10613
- text: 10.6 km
- - status: OK
- duration:
- value: 935
- text: 16 mins
- distance:
- value: 10287
- text: 10.3 km
- DistanceMatrixResponse:
- title: DistanceMatrixResponse
- type: object
- description: Attributes describing an distance Matrix response.
- properties:
- status:
- $ref: '#/components/schemas/DistanceStatus'
- rows:
- description: Contains an array of elements for each pair of origin and destination
- type: array
- items:
- $ref: '#/components/schemas/DistanceMatrixElementsResponse'
- example:
- status: OK
- rows:
- - elements:
- - status: OK
- duration:
- value: 978
- text: 16 mins
- distance:
- value: 10796
- text: 10.8 km
- - status: OK
- duration:
- value: 942
- text: 16 mins
- distance:
- value: 10322
- text: 10.3 km
+ One or more locations to use as the finishing point for calculating travel distance. The options for the destinations parameter are the same as for the origins parameter, described above. In order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc:encoded-polyline:`
Origins:
title: Origins
example: 48.709,2.403
type: string
description: |
The starting point for calculating travel distance. You can supply one or more locations separated by the pipe character, in the form of latitude/longitude coordinates. They are used unchanged to calculate distance. Ensure that no space exists between the latitude and longitude values. In order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc:encoded-polyline:`
- Destinations:
- title: Destinations
- example: 48.709,2.403|48.768,2.338
- type: string
- description: |
- One or more locations to use as the finishing point for calculating travel distance. The options for the destinations parameter are the same as for the origins parameter, described above. In order to reduce URL size, [encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm) are also supported using `enc:encoded-polyline:`
Units:
title: Units
example: metric
@@ -8972,584 +7844,6 @@ components:
Specifies the unit system to use when expressing distance as text. Two different units supported:
* `metric` (default) returns distances in kilometers and meters
* `imperial` returns distances in miles and feet
- DistanceMatrixRequest:
- title: DistanceMatrixRequest
- type: object
- description: Attributes describing a distance Matrix request
- required:
- - origins
- - destinations
- properties:
- origins:
- $ref: '#/components/schemas/Origins'
- destinations:
- $ref: '#/components/schemas/Destinations'
- mode:
- example: driving
- type: string
- enum:
- - driving
- - cycling
- - walking
- description: |
- Specifies the mode of transport to use when calculating distance
- language:
- example: en
- type: string
- description: |
- The language code, indicating in which language the results should be returned, if possible. If language is not supplied, the Distance API service will use the navigator language or “en”.
- units:
- $ref: '#/components/schemas/Units'
- elements:
- example: duration_distance
- type: string
- enum:
- - distance
- - duration
- - duration_distance
- description: |
- Specifies element values that will be part of the API response (distance and/or duration). if not specified default is `distance`
- method:
- example: distance
- type: string
- enum:
- - time
- - distance
- description: |
- Specifies the method to compute the route between the start point and the end point:
- - `time`: fastest route (default)
- - `distance`: shortest route
- departure_time:
- example: now
- type: string
- description: |
- Specifies the date/time at which to base the calculations on for traffic purposes. Valid values are a timestamp (e.g. `1600799173` for the date:`22/09/2020 20:26:13`) or `now`.
- example:
- origins: 48.73534,2.368308|48.73534,2.368308
- destinations: 48.83534,2.368308
- units: imperial
- elements: duration_distance
- method: distance
- departure_time: now
- EncodedPolyline:
- title: EncodedPolyline
- type: object
- description: The polyline of the route (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm)).
- properties:
- points:
- type: string
- description: The encoded string value for points of the polyline
- example: a_jyHfol@aAfEzGlIfER~JqV_KqLu@pDiHv@bAfEeCfE
- example:
- points: a_jyHfol@aAfEzGlIfER~JqV_KqLu@pDiHv@bAfEeCfE
- DistanceInstructions:
- title: DistanceInstructions
- type: object
- description: Formatted instructions for this leg
- properties:
- action:
- type: integer
- 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).
- example: 2
- summary:
- type: string
- description: Written maneuver instruction.
- example: Drive northeast on D 151.
- verbal_alert:
- type: string
- description: The transition alert instruction will prepare the user for the forthcoming transition.
- example: Enter the roundabout and take the 2nd exit onto D 30.
- verbal_succint:
- type: string
- description: Text suitable for use as a verbal alert in a navigation application
- example: Drive northeast. Then Enter the roundabout and take the 2nd exit onto D 30.
- verbal_before:
- type: string
- description: Text suitable for use as a verbal message immediately prior to the maneuver transition
- example: Drive northeast on D 151. Then Enter the roundabout and take the 2nd exit onto D 30.
- verbal_after:
- type: string
- description: Text suitable for use as a verbal message immediately after the maneuver transition
- example: Continue for 700 meters.
- example:
- action: 2
- summary: Drive northeast on D 151.
- verbal_alert: Enter the roundabout and take the 2nd exit onto D 30.
- verbal_before: Drive northeast on D 151. Then Enter the roundabout and take the 2nd exit onto D 30.
- DistanceStep:
- title: DistanceStep
- type: object
- description: step in a leg
- properties:
- distance:
- description: the distance as text covered by this step until the next step.
- type: string
- example: 2.8 km
- duration:
- description: the typical time as text required to perform the step, until the next step
- type: string
- example: 5 minutes
- polyline:
- type: string
- description: the polyline representation of the step (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm)
- example: _igoHa~hYgApBMHOEKO
- start_location:
- $ref: '#/components/schemas/LatLngLiteral'
- end_location:
- $ref: '#/components/schemas/LatLngLiteral'
- travel_mode:
- type: string
- description: the type of travel mode used
- example: driving
- instructions:
- $ref: '#/components/schemas/DistanceInstructions'
- example:
- distance: 46 m
- duration: 1 min
- polyline: iu~kHsziXJBJAHGFIDMBSAS
- start_location:
- lat: 49.314292
- lng: 4.151623
- end_location:
- lat: 49.314041
- lng: 4.151976
- travel_mode: DRIVING
- DistanceLeg:
- title: DistanceLeg
- type: object
- description: Leg in a route
- properties:
- distance:
- $ref: '#/components/schemas/DistanceValue'
- duration:
- $ref: '#/components/schemas/DurationValue'
- start_location:
- $ref: '#/components/schemas/LatLngLiteral'
- end_location:
- $ref: '#/components/schemas/LatLngLiteral'
- start_waypoint:
- type: integer
- description: The start waypoint order number
- example: 1
- end_waypoint:
- type: integer
- description: The end waypoint order number
- example: 2
- start_address:
- type: string
- description: the starting address of the leg
- example: Chemin de la Tuilerie
- end_address:
- type: string
- description: the ending address of the leg
- example: D 8043, E 44
- steps:
- description: List of steps constituting the leg. Steps are returned when `details=full` parameter is specified. 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.
- type: array
- items:
- $ref: '#/components/schemas/DistanceStep'
- example:
- distance:
- text: 1 km
- value: 1038
- duration:
- text: 1 min
- value: 75
- start_location:
- lat: 49.31067
- lng: 4.14525
- end_location:
- lat: 49.31344
- lng: 4.15293
- start_waypoint: 0
- end_waypoint: 1
- end_address: D 30
- start_address: D 151
- DistanceRouteElementsResponse:
- title: DistanceRouteElementsResponse
- type: object
- description: Attributes describing routes from an origin to a destination returned in distance route response.
- required:
- - overview_polyline
- - bounds
- - notice
- - legs
- properties:
- overview_polyline:
- $ref: '#/components/schemas/EncodedPolyline'
- bounds:
- $ref: '#/components/schemas/Bounds'
- notice:
- type: string
- description: Some noticeable information about the route
- example: Has toll segments
- legs:
- type: array
- description: Legs part of the route response
- items:
- $ref: '#/components/schemas/DistanceLeg'
- main_route_name:
- type: string
- description: The main route name based on the longest step length to differentiate routes when alternates are returned.
- example: Fillmore Street
- recommended:
- type: boolean
- description: Optional field. Only present and set to true when the route is the recommended route.
- example: true
- DistanceRouteResponse:
- title: DistanceRouteResponse
- type: object
- description: Attributes describing a distance route response.
- properties:
- status:
- $ref: '#/components/schemas/DistanceStatus'
- routes:
- description: Contains an array of routes from origin to destination (only one if alternatives is not specified)
- type: array
- items:
- $ref: '#/components/schemas/DistanceRouteElementsResponse'
- example:
- status: OK
- routes:
- - 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@eAHO
- bounds:
- northeast:
- lat: 49.315678
- lng: 4.152915
- southwest:
- lat: 49.31073
- lng: 4.145162
- notice: ''
- legs:
- - distance:
- text: 1 km
- value: 1038
- duration:
- text: 1 min
- value: 75
- start_location:
- lat: 49.31067
- lng: 4.14525
- end_location:
- lat: 49.31344
- lng: 4.15293
- start_waypoint: 0
- end_waypoint: 1
- end_address: D 30
- start_address: D 151
- steps:
- - distance: 676 m
- duration: 1 min
- 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
- end_location:
- lat: 49.315679
- lng: 4.149621
- travel_mode: DRIVING
- instructions:
- action: 2
- summary: Drive northeast on D 151.
- verbal_succint: Drive northeast. Then Enter the roundabout and take the 2nd exit onto D 30.
- verbal_before: Drive northeast on D 151. Then Enter the roundabout and take the 2nd exit onto D 30.
- verbal_after: Continue for 700 meters.
- - distance: 22 m
- duration: 1 min
- polyline: '}}~kHcniXBIBU?W'
- start_location:
- lat: 49.315679
- lng: 4.149621
- end_location:
- lat: 49.31563
- lng: 4.149905
- travel_mode: DRIVING
- 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_succint: Enter the roundabout and take the 2nd exit.
- verbal_before: Enter the roundabout and take the 2nd exit onto D 30.
- - distance: 198 m
- duration: 1 min
- polyline: u}~kH{oiXFWDOLUP[P]j@y@^g@`@i@NUNONMJKJIFELC
- start_location:
- lat: 49.31563
- lng: 4.149905
- end_location:
- lat: 49.314292
- lng: 4.151623
- travel_mode: DRIVING
- instructions:
- action: 27
- summary: Exit the roundabout onto D 30.
- verbal_succint: Exit the roundabout.
- verbal_before: Exit the roundabout onto D 30.
- verbal_after: Continue for 200 meters.
- - distance: 46 m
- duration: 1 min
- polyline: iu~kHsziXJBJAHGFIDMBSAS
- start_location:
- lat: 49.314292
- lng: 4.151623
- end_location:
- lat: 49.314041
- lng: 4.151976
- travel_mode: DRIVING
- 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_succint: Enter the roundabout and take the 2nd exit.
- verbal_before: Enter the roundabout and take the 2nd exit onto D 30.
- - distance: 96 m
- duration: 1 min
- polyline: ws~kHy|iXBKDILURa@LWt@eAHO
- start_location:
- lat: 49.314041
- lng: 4.151976
- end_location:
- lat: 49.313431
- lng: 4.152916
- travel_mode: DRIVING
- instructions:
- action: 27
- summary: Exit the roundabout onto D 30.
- verbal_succint: Exit the roundabout. Then, in 100 meters, You will arrive at your destination.
- verbal_before: Exit the roundabout onto D 30. Then, in 100 meters, You will arrive at your destination.
- verbal_after: Continue for 100 meters.
- - distance: 1 m
- duration: 1 min
- polyline: '}o~kHubjX'
- start_location:
- lat: 49.313431
- lng: 4.152916
- end_location:
- lat: 49.313431
- lng: 4.152916
- travel_mode: DRIVING
- 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.
- main_route_name: D 151
- recommended: true
- DistanceTollsStep:
- title: DistanceTollsStep
- type: object
- properties:
- countryCode:
- type: string
- description: Country Code
- additionalProperties: true
- description: Detail of tolls to be paid for traversing the specified section. Directly come from Here API
- example:
- tolls: some_value
- DistanceTollsSystemStep:
- title: DistanceTollsSystemStep
- type: object
- properties:
- id:
- type: integer
- description: Tolls System Id
- name:
- type: string
- description: Tolls System Name
- description: An array of toll authorities that collect payments for the use of (part of) the specified section of the route. Directly come from Here API
- example:
- id: 12
- name: ASF
- DistanceTollsLeg:
- title: DistanceTollsLeg
- type: object
- description: Leg in a route
- properties:
- distance:
- $ref: '#/components/schemas/DistanceValue'
- duration:
- $ref: '#/components/schemas/DurationValue'
- start_location:
- $ref: '#/components/schemas/LatLngLiteral'
- end_location:
- $ref: '#/components/schemas/LatLngLiteral'
- tolls:
- type: array
- items:
- $ref: '#/components/schemas/DistanceTollsStep'
- tollSystems:
- type: array
- items:
- $ref: '#/components/schemas/DistanceTollsSystemStep'
- example:
- distance:
- text: 1 km
- value: 1038
- duration:
- text: 1 min
- value: 75
- start_location:
- lat: 49.31067
- lng: 4.14525
- end_location:
- lat: 49.31344
- lng: 4.15293
- DistanceTollsElementsResponse:
- title: DistanceTollsElementsResponse
- type: object
- description: Attributes describing routes from an origin to a destination returned in distance tolls response.
- required:
- - overview_polyline
- - bounds
- - legs
- properties:
- overview_polyline:
- $ref: '#/components/schemas/EncodedPolyline'
- bounds:
- $ref: '#/components/schemas/Bounds'
- legs:
- type: array
- description: Legs part of the route response
- items:
- $ref: '#/components/schemas/DistanceTollsLeg'
- DistanceTollsResponse:
- title: DistanceTollsResponse
- type: object
- description: Attributes describing a distance tolls response.
- properties:
- status:
- $ref: '#/components/schemas/DistanceStatus'
- routes:
- description: Contains an array of routes with tolls informations from origin to destination
- type: array
- items:
- $ref: '#/components/schemas/DistanceTollsElementsResponse'
- example:
- status: OK
- routes:
- - legs:
- - distance:
- value: 272304
- text: 272 km
- duration:
- value: 8834
- text: 2 hours 27 mins
- start_location:
- lat: 43.7037562
- lng: 4.1217688
- end_location:
- lat: 45.7196995
- lng: 4.848819
- tolls:
- - countryCode: FRA
- tollSystemRef: 0
- tollSystem: ASF
- tollSystems:
- - 0
- fares:
- - id: e4626716-1e29-4f9a-905a-19f0376cfb38
- name: ASF
- price:
- type: value
- currency: EUR
- value: 28.9
- reason: toll
- paymentMethods:
- - cash
- - bankCard
- - creditCard
- - transponder
- - travelCard
- 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:
- - name: MONTPELLIER (M.EST)
- location:
- lat: 43.70291
- lng: 4.11982
- - name: VIENNE
- location:
- lat: 45.4761
- lng: 4.83378
- tollSystems:
- - id: 7607
- name: ASF
- bounds:
- northeast:
- lat: 45.7197
- lng: 4.89669
- southwest:
- lat: 43.7022
- lng: 4.11696
- overview_polyline:
- points: m{viG_`dXDGLUDU@a@C]GUGMOOOEQCQDMFMPGPGf@@\H\HPJHNF\@N?RFTNNTVh@Rh@Nl@^zBXlAb@|A\~@\t@Rx@RhADl@?VCd@EZGTKRUZUL]FM?MCQISOcAaA]WwF{HcDoEgA}AkBoCeCyDuE_IqEkIoEiI_@s@gBiDmCkFkC_FmRw^sB_Ea@w@c@y@sDcHuH{NyDwH}AeD{AoDy@uBmBuFiAuDeA{DiAcFOq@w@eEk@cDs@iFo@}Fo@iI[oGSaHGmFCyEGaXGmHG}DKkEKmDWqG_@qHa@wGi@aHMsAMsAk@mGK}@i@yEKu@_@uCAKWgBU}ASoAUwAWaBgAkGm@iDWoAy@cDaAkDiAeDcAgCeAaCoAcCmAuBaCqDsAcB}@eA_BaBq@m@aCoBgBoAgBeAaAg@iBy@w@[}Bu@sM}D_Cy@gEiBmCuAaBaAwDcCs@i@sBcByAsAiBeBwB_CiBwBqCwDoAiBoCsEgAqBoBgEqAyCmA_DiAcDgAeDc@{Aq@aCu@}CQw@_AwEc@gCy@oFi@{EUgCUyCWsEOkDO{GAkHBsEB_BFoBLiDNsCf@{Hx@qLTsCdI{iAj@}INeEFcGAkDGyCUiFSqCk@cFQqA]uBw@}Dq@mCoAoEa@mAi@wAyAkDm@qAWe@}AmCw@iAgBcCoA{A_C_CwKyJaEkDiL_KsHwGwC_CsE_D_DkBmBcAmEcCeBkAwBcByAqAq@o@}AgB}AoBuAsBk@_AyAmCaAqBuAiDq@sB{@{CeDmL{@sCmB{FuBwF{BaFuAqC{@_BuBmDaBeCqBqCw@cAwAeBgAmA{CyCgD_D_BsAoC_CyG{FyByBuB_CmCaDcByBgCuDoBcDcIsNk@_A_BgCu@eAcByBmB{BaEmE_GiG_DcDwD}DmBmBsAuAcB}AoCcCcA}@s@k@}CcCgDeC{FcEuAeAmAiAmAiAuAyAiAsAe@o@sAoB}@{Au@uAw@_Bq@}AoAgDa@oAiAeEm@sCa@wB]yBUiBi@wEYuCg@{EEe@K_AGk@y@uHYeCGe@}AcMi@qDOaAeBoK{AcIwDiQwC}LqD}NkAaF}@_EuAmGo@sC_ByIWaBq@oD]oB[yBw@cFo@oDi@uDcBiKkB_LSqAw@yEc@_CcAyFo@iDiA{Fm@aDmA_GsDuPGYoCeL_CcJqAwEw@sC_DuKoC}ImCmIgAcDmAiDyDmKaDqIeDiI_@{@Ui@eAkCeEwJuSoe@iFyLmCsGkDwI}FsOSk@kE_MoHoTgDsJSi@]}@gBgEyA_Ds@uA_BsCq@gAaCkD{BqCe@k@cDeDaB{AgA_AyBcBoAy@mBgAsBiAiEyBm@YsB{@aD}As@[eFaC_Bw@gCuA{B{AqCuBwBgByLsKmC_C_EoDgB_B_Ay@qO_NyFkFoAiAyE_E{I_IOMkSsQyDoDi@g@s@s@qCuCyBgCaDcEcCkDuBeDqBmDeC{EsAuCkBsEWq@{@}BgA{CmAqDcLg^wDuLiBaGe@wAuAmEwAsEwAwEgAyDgBgHw@uDq@wDqA{JW_CUaC_@iFc@}JQiH_@}RMeEWuGI}AWuD}@mK[_DeA{Im@qEeAmH}@sFs@cEeAsFkCaM_@cB{B_J_AmDiC_JcAcDuCuIwCcImAcDmCmG}BgFcCiFyCcGwCmFiB_DcDiFsEcHuHgLwC}EwAkCiBwDuBeF{AmEe@yAoAmE_BwG_AsEy@wEc@qCIk@w@iG{@_Ji@kHa@gG}@uOm@qJ_@cH]eGGoAi@qJGaAg@kIqAyUIuAEs@e@wHiAuO_@sEUyBi@_Fk@iEgAcHy@uEs@sDEQwAiGkAsEiA_Eu@cCwDaL{AaEuCmHeEwIkCkFiCuEcBuCkAmBsFoIgNyRiCqDeD_F_A}AkGaLuAcCy@{AcEsH}AsC[k@_Tc`@{@yAyFiKkDiGmCqE}A_CcDsEuBkCuBcC{BcCaAeA}BcCa@c@c@e@s@w@yAaBsD}EgBkC}AgC}C_GgA{BqBiE}AoD}BcF}BaFiA}B{Pg[aD}Fu@oAmIcOmB{CoAcByAeBuCwC_Aw@uAcAeBeAqDsBgFmCoCyAeC{AkCgBy@o@q@g@}AqA_EuDsCuC}CeDmEcF_D{D}CaEuEsGsCkEwDiGwD{G_@o@u@yAmA}BuAgCgBoDcAmBuAqCqBuDy@}A_BuC{CaFoBcDuFqIgK}NuB_DeA_BwBkDaAeBmCeF{AaDaCqF{ByFwBwFyBgGoAcD_C{FyAcD_AqByA_DcDyGaDaHwCaH{BaGsB{FiBuFmA_E}GmUqC{IaD_JoBcFqCuGaAyBmEiJoCmF_ByCcEmHyC_FcEqGkBuC_AsAsAoBm@y@eEwFeBcCqC_EiAeBkCiEm@eAm@gAuBgEkAyB_BiDmAuCyGuPeBiEm@yA]w@aCaFg@eA}AqCgB}CgCaEwCgEeEoFkByBqFcGwHkIsCkDmBgCcCiDeBoCw@mAcDmFyCqFsB}D}AcD_AuBy@wB}@mCq@_C_AcEe@gC[oB_@kCeAiIy@kFkAyFi@qBc@sAkBaFe@eAsAmCmAuBoBwCu@cAwCyDoFmHiBgCgAaBgDmFqBeDgB_DmCeFoB}D}B}E}AoDaA_CeEyKkAcDqBeGoBsGkBsG_E_OiBsGiBuFoAiDk@sAuAyC}AsCeBiCmCqDoAwAqBqBaA{@kCoBkBmAcCqAcAe@cAa@cA[gA[gAWkCe@kAOkCOmAEeA?oCHmAHkCViCZgFh@qBLaBFkBD}@CaAEeAK{@KiASmAYy@Y{Bw@aAc@c@QiCqAmE{BeEiBo@SqCm@cAO{AMw@Iu@C{A?yBD_AF}BVaCh@gAZeCx@cAb@uDzAgC`AeA\eCp@cARyC`@w@FmADmC@}@CmCQqAQ{@OcAUiCs@oDsA{@]cBq@o@WsAm@iGgC_IcDi@S{@a@kQsH_FcCuBeA_CsAqD_CeCeB}BgB_CmB{BuBMMoBiBe@c@mAyAaBiB_AgAyEgG}KgO{BwCaCwC_@e@qCcDwBaCwA{A_DoCiCqBiBoAyA_A}BoAiAi@aBw@wCiAgCy@QGy@SwCs@}Cm@sB[iH}@cAIkBQ{D[}He@sCMo@?uE?aCDkF^u@HqBXkDn@iAViCn@mAb@y@PqBd@cDr@gC^cBR}ADmBB}BAeBKo@E}@MyAUuA[oBk@yAi@qCkA}DmBgG{CmB_AoBy@q@WgE}AqBm@sCs@{Be@mASiDa@oAIwAE_A?eBFuARiBd@k@RiB~@]Pu@j@]Tk@f@e@f@gAvAgA~Aa@p@wCxFcEbJkCnFq@rAcAjBs@hA{CzE}@fAgAnAyAxAYXo@j@_BrA}BbB}@l@cBbAsHjEkEbCoKjGoBbA}BbAq@XwChAoCjAm@VgHnCgBp@a@NcBf@c@TiGfCqDpAsLtEuJpDuDxAmAh@aBv@q@^yFlDmAz@eAt@qBnAmBpAmBlAmBpAkD|B{HdF{E~CaLpHeDtBmMxI{DhC[TmGdEuc@xYiAv@{FtDeGlEyBdBwD`DgE|DsDpDiBnBqElFqE|FmBlCiCxDqEjHcBvCaCnEIN{ChGaDhHuElLqBjFk@zAgCxGkBrEqArC}BtEq@nAiCbEkBdCmAvAeAfAkAdAgCpBqBjAmAn@gAf@{Bz@kBh@oB`@gAPiCVyCL_B@kC?yIMkCFyADwBNkAL_ANuB`@q@N{@RmA\aAZoAf@kBx@{BlAsAx@wCrBwAhAmAfAeC`CmAnAaAbAiBrB}AfBcJzKuCfDsD|DuDnD{@r@uAhAwDrCiBnAiBhAoAr@}Ax@}HrDmJdEiDvA}Ap@kDrAyC`AgAXsCj@sATeBNsCPyDFqBEkCMqBOiSuBiBSiHu@mDg@uAYeBa@wBm@sBs@{CsAkBcAmAu@gMgIkTwN_SoMwDgC_C}Aa_@mVez@mj@yIgGsFcEcG_F{FiFyBuBsIqIwNeOm@m@}@_AkHqH{GaHqFqFwBoB{BeBw@k@aC}AeCuA_CgAaDoAaA[gAYkEaAeAOuBYgBOaFUiAEaGOgACw@Ac@Ac@?iEM_Sa@iCCmC@eBFoBHqALwAPeBZwAVwA^iA\wAf@eBp@aBt@sDfBwJhF{FtCoFjCmD|AmBt@iBp@mDfAsA^cEdAiB\mEt@{C`@kBR}@JoDZaDPmQnAaEV_OdAyG^oI`@_FRoDJgGRwGLoDDeJHiC@wX?iGCkMBoAByBFuCDiCFsBFa@BiADiHb@mBLsBN{Iz@iD`@mDd@iGbAcF|@qLbC{M|CgKxBoEv@uDl@uEn@gIz@sE`@gk@vEcCPmDXmD\i`@`DcCT{Jv@oFd@gIl@gHf@_CNqJf@qELgB@yDD_HEaBCwDKwBKsBGsAKcEYkBQmBQgCYaH_AiEs@kAUk@Ki@Ke@I]ImCi@mEiAaHmBaEoAyHsC_DqAuDaBkAk@{F{CcHeEm@[oBoAyAeAsB{AyHoG}AuA_CuBeIcIiHeIkC{CcBuBk@q@yBiCmBuBqBsBsBsBgD}CgDoCyAiAaBkAgAw@mD{BoBiAeEwB}As@cCcAeE{AiCy@yC{@mCo@mE{@y@UcF_A_F_AkN{CuD{@oGgBcAY_AYUGqDiAwE_BeA]aBk@eEcBeBs@sEoBsDaBkFmCk@[gIkE{SuLqDmByCyAqCoAyEgBuFiB}Bk@mBe@{E_AuB[iEi@aCSaDSqEQwAEwCC}CCoIIeHIsJMoDGaLI{FIuDGaCEkX[mACuHW_Fa@iBSaEk@kASiDq@kAW_EkAiCy@aC{@w@YyAm@yCsAqBcAeFsCwDeC{AeAiFgE}AsAyAuAqCqC}@_Ao@u@oAwAsD{Ek@s@_@k@_AsAyBgDwC_Fs@kAwFiKaIsOgBeDmD_HwB{D}CqFaBmCiCaEyAyBcGeIaCyC{AgBeCqC_DgDeCeC{GiGwFsEqDkCmCkB_DqB_JiFo@]gFeCcCeA_CaAq@YqAg@_C_AsB{@cRyGkPqFu@UoImCQGoBm@uHyBkA]cMiDgHeBqEw@iCc@aEe@cDW{AIgEM_DGeD?wEFmCDgGTeFVwE\sALwLlAuG|@_BVcKhByE`AsFrAyCt@eGdB{IpCe[rKgQhGWHq@VcLzDuE`B]Jg@PuAh@kAb@mHtC_Ab@aEbBiKvEsAp@sCtAeItDcEfB{DzAiDnAuBr@yDjA{Bl@{EhAeCn@aCd@qIxAsBZqBVsDb@aGj@oDXqDVmGZeFPwDHcEDmIBcHAoNCa@?uMCgQLaNRkJTsJZ_Md@yOx@mIXiCH_@?c@@oGBaCAkEIcFQsE[kHs@_@CwB[iC]{E{@oFiASESC{Bi@iEgAcJsBmGsAkFeAkDm@kEq@yGy@uCYsFc@uCWaJg@s@AsG[iE]q@EYA{@?wC?mCM_S{@s@CcGO}BMcBIkDMgEKmBC}B?yCDgAD_EVeBPkBVqB\uDv@iCr@_Cv@mBr@gBt@mAj@yAt@cAj@{CfBsSdN}D~BiGfDsEtBwB|@}Aj@wFjBu@VeCr@}Bh@gCj@yDv@oEv@aJxAqHpA_MtBy@LkC\uGx@kFh@cAHwF\oDPqHLuDB{GGeEIgGWw@GwCOoSwA{Jw@yDa@gDi@y@MkCm@{Aa@qA[aCu@cEoAeF}AuAc@qFsAmEy@{B]aAKeCUyAKcEOoDC}B?aCFy@D_Kl@gBNmIf@sCJcEFcA?mFIoDQsAKcCWeC]sB[kBa@_B_@{Cw@sBo@qBq@}B_AsF_C_Bo@aGoCw@]qFeCkAg@yBaAeAc@u@[cNkGqAm@eCiAy@[kGqC_DuAm@[gJmEkDgB{CaBq@_@kBeAUMwBsAgFiDoA}@wDuCqF{EoBoBgAiA{@aAmCaD{CeEeBiCgEkH_B_Dy@gBwCeHuAyDQg@cAaDgBiGkB_IyAuHmAgH_Fc\sA}HcAiF}@{DgA_E]kAaBiFa@kA_AcCu@iBs@_BaAwBkA_CeB_DoAwBoAmBmBmC_CwCY]]a@yB_C_B}AmFwEsD{CiUwQoQ{NuMmKcNsKaGiEoFmDcF{CuDqBqCuAkAi@o@[_EeBsAi@iE}A_IiC}MgE{FcBsEoAwBi@cBc@eDs@gEy@cCe@uQuCoFw@_m@iJs]gFkC]oWqDwFw@qC_@gd@gGgGw@yGw@uEc@iCSeDQeBGaCG{CEkA?{FFkDJwDRYBkE\eBPg@FcH|@_QfCuDd@cEb@g@BsCRcDL}BB}E?yDKaCK}@G_CScCWuCa@qF_AsCm@YKUGiF{Ae@OsFiBgIuCg@Q{h@aRoE}AmG{ByCcA_A[s@Ww@Y_Cw@cA]mC_AiDaAyAc@oKoCsDo@mB]{AUkDe@qB[aBWmC[oB[wAU{B]oIoAeC]gBUwAQcAK}@KyCWuEUgCKgEEmBBcGHwDL{G^}CLoCHsA?aCCgAE}C[oASwB_@iAWkA[gC{@uAi@u@[yBkAcBeAeCaByBcBiCsBiByAi@_@iG}E]YcIkGcBoAo@i@mDgDs@y@wE_Gm@o@cB}Aw@o@w@k@yEiCeBq@iA]cAWaAQuC[cI]gFUaFYuBWgASwFoAsBa@}@MaAIgACy@?aBHsAL}@Lc@LeBf@aA`@]RcDjBsAn@cBl@wBj@q@LuAP{O~AcAH_BRmBPaBViB\}LrCkBd@mBh@s@RyAh@aA`@oB|@eBz@wBlAi@TmAd@gAZuAXgAL{AHqB@oCQ_AIiAUkDu@sEaAuA[oAU_B[s@MkB]y@KeAImACu@Ci@?g@@yADeBNaC^qBd@YHoAf@q@Tu@\yB|@qIlD_DlAsBr@QD[H}@XeB^uB`@aBT_CX_BN_AFuAFaCDeIFqGLaBL_CZoAPyBd@k@LiAZcBf@uBx@mB|@{PlJwDjBuD`Bs@VcA`@}Ah@yEvAyDz@iB\w@LkDh@eAPsCV{CTqBJo@BaGJyDAmR]iJQoEIsIMgC?uA@kELcBJg@BaY~AyAFmFXmCL}BFsCFmEBuC?o@A{CCiAEoHWkIo@{Eg@yEk@mGeAuN}CuGyAwDs@wB]iAOyEg@uF[mEKuCAiA@mFL{CLoBJeDTkY|AsWzAa@BiBL{BR_D`@uDp@wCn@sDbA{DrAqDzA_ErB}@d@iAn@aCzAyAbAsAbAcDrC}ApAsDhD{@z@{@t@[RiAx@mAr@o@Z]Pq@^y@X{@XiDr@cCV_DLuEM_Dc@iBc@qA_@_A_@]O{Aw@m@]w@g@wB_ByAuAuA{AcBuBqGwI}@oAgD{Dk@m@gDyCoAeAkBsAkAs@{@i@kAo@mAm@{B_AqBq@cBk@yAa@wA[{AWgBUeEa@cCOeCIcCBeBJkD^oARcK`C_BPmANyALyABsBAgBG}AKsDg@qDcAoDuAiDkBwEgDqB{AeL}IgHuFwJsHsJuHyAsAiBgBiAmAqCcDiC_DuCuDiDgEgBuBiAmAsAoAgCyBoCkBeC}AQKSKiDwA{B{@{Cw@wB]_Ca@yE[kBE_DBsEZeFr@sq@rOaOhDyDdA}Af@yAh@_C`AaBv@wEdC_HzDkB|@{B|@kBl@_AVmAXyB`@aCZkAJcBHiCDsB?sCCo@C_BAcDIgLYiHMk@AiGO{BGmBCk@CoFMO?Y?a^s@iJWaEG}BAeE@}AD{BLiBPgCZwAToAVyCv@}Br@yBx@oBx@mB~@{@f@yAz@uDfCiBzA[XUR}ArA}ApAmAbA_BhAsBpAu@^cBv@uAd@mAZsCd@wAPwCd@qAV_AViA^}An@}Av@cAl@sBxAuAjAyEjEgF|EuBdBeAv@y@h@w@d@}Ar@eA^]Lo@Rm@PwAZ{@LsBPoBHwA@yBK_AGu@MgB[mBe@wBs@y@[}Ae@uBi@}AYkBUeCKgBBu@@aBJqBVkAT_Bb@y@Xm@RyBbAiAn@aAn@sAbA{BtBy@~@q@z@qAhBe@r@W`@qAdCm@tAaAbCs@xBaAjDi@dCiA~Es@lC]tAg@xA_BzDe@`As@tAo@dA}AxBk@r@iBnBw@r@w@p@mBrA}BpAgAd@aA^w@VkBh@_Cp@yN~D}CdA_C|@uBz@aDxAgCrAqDtBoAv@eBjAa@VqCrBeCtBmAlA_BfBqA`BwBtCsDbFwAhBgAjAcAdAyArA_Av@kBvAo@b@yCdB}BhAsCnA}VjKeBv@uAr@g@ZQH}AbA_Ar@u@l@u@r@aBjBmA|A_AtAw@pAmA~B_AnBsCnFsAxBcAzA{@fAmCtCkBbBkA`ASLyAdAe@XuCzAoBx@eCx@sCp@}@RiCZeBLkCDwCEqBKcBMcZiCcIs@cCQkCMuAEiCCiA@oDL}DXyDj@qCj@qBh@sC|@wChAk@ViB~@gBbAaB`AgAr@eBrAk@^oB|AwE`EuBjBqAhA{BnBqC~BoNzLwEdEkGjF{F`FiA~@eAr@_@VeAn@q@\mBx@qBn@iBb@s@LiBRy@FsBF{BEgCSmBYaCi@oBc@kPiEoE_A}@MwAK}@Cs@Cg@?cCFmBNgBVwBd@gBh@iBt@i@VmAp@{AbAmA~@{AxAyA|Aq@x@iA|AsB`D_FlHoBxCmCxD{AjBiApAmDfDy@r@qCpBmAv@sAt@ULsB`AqAd@}Ah@eAZ{A^aBZ_CZ_DXsAFc@?oB?eCE_IYeACoLe@oO]oACyB@qD?aFFcJH}@B_IZS@iCNkEVwJx@{Db@wKtAuHlA_[tFyB^iJdBmJbBk`@bHmB`@]Hk@JgFbA{J|AcCZkAJeAJcEN{C@kBCkCKqAIcCSoBWmRwBqDe@_Eo@qFkAaB]oMsCcGkAaBQkACgBDg@FsARuA\aBl@}Az@kA|@g@f@oErEsAjAc@ZgAp@cBv@{@V_APaALmAHaA?aAGyAKy@McC]oBW_Fs@sAOwG{@qBQiBIgBIqAAsAAmA@aBDsFXqABgCAcDMoBO_AKyB[aBYyA[aBe@_EkA}@[yB_A}@a@qCwAwBsAqA{@cBmA{AmAo@i@yBuBwZgYuDiDyBqBiG{F_EwDwCoCkEaEaA{@gAgA_A}@sCmCg@e@_FsEaQ_PSQmAcA{CsBk@c@qAo@kAi@cAc@{@[s@UyBm@wBa@{AS_CSiAGoC?kA@u@BuBLiBToB\aCj@mA`@kBt@mAh@_A`@c@Tk@V_@PmAh@oLfFq@VaDdAkCn@wB`@{C`@wBL}@BiBDgA?iAGqDY_BQoASqEy@eEaAeIcBwIkBgLeCqQsDgCm@_B[oGsA{D}@aCe@aDs@mLcCgDs@kNyCcHwA{GyAiE_AcEy@qCe@qFw@_Ee@}AOuKu@w@EiGU{BIoDA{BAq@@iCB{@BmCH{BF_@@_@@qDKeCMcAKo@KkBa@aAMs@Ko@Ai@Ck@BmALwCf@_AL}APc@@W?oFE_BIaAIs@MyA]iA[qFeBi@QsA]uAYmAMk@Ck@?iADe@DgAPc@JkA`@oAl@mGbDeBx@wAj@g@Pg@He@FkAHkA@qAIgAQeAYe@QcAe@iAs@a@[iAcAiAoAkAyAeFiHq@_AqC{Du@cAy@}@u@s@s@i@k@[eAa@cA[]Im@K[EmAMeAC}ABkBFgERwDHq@BoBDu@AoBKiB]_CeASKm@a@m@e@k@k@oA}Ae@q@]m@c@}@q@}ASi@[_AcAuCg@qAs@}Ak@eAw@oAg@o@}@cAkAkAgAaA_D_DqDcDwAwAu@cA]i@g@_Ac@}@{@wBqAaEoB}G]uA_EaN}@cCy@kBg@_Ai@{@kA{Ak@m@o@q@e@a@_BgA{@c@s@]s@Uy@W}AYuAKgHYoBQeAO_@KyAa@q@UaNkFyBu@eBc@m@M}AY}AOm@EeCCyA@_AF}ANaC`@}A`@qAd@aCdAeBbA{B~AuBbBoBdBuC|BoBnAeB`AaC`AuG|BoC`A{HhCaEvAc@TUJi@Xk@^a@Zu@r@w@`Ak@|@mAbCi@|Aa@~AQx@WfBIz@K|AIbC@tBPpFRjFBrA?fBE|AGdAMrAc@bDc@`Cg@~BqAfFs@hC{@lCu@rBy@zBoA~CKXKR}AtDa@x@qB`E}@bBGHeAjBiBzCiDdF{FzHcEfFoEdFyB`CkClCkDjDsElEuEfEyKtJa@Z{AlA{AlAoDrCyFhEyEfDqCfBqBjAuBdAkE`BkCfAeDdBgBhAm@b@wBbBo@j@yCxCuA|Ao@v@_@d@yAtBm@`Am@bAkAxBaApB{ApDi@tAiA`DeAtCu@fBiAxB_A|Ak@z@}BzCuBrBiA~@kAz@iAr@cAh@qAn@sDjBeHjDsHbDoDxAsEhBa@Rq@Tw@Ze@RwFnBgA`@sDnA}EzAwCr@cFpAqE`AoB^g@JgBVkEp@iEj@{AP_Ed@mAJoCPmCPkCLeC@cBIyBS{@Qy@Q}@WaBo@e@UoAs@_@WkByAwAsA_CcCmC_D{AoB{AuBiHmKyEgGqDiEwCaDcCcCeE{D{DcDeCiBsDeCkBiA_FuCsGmDwGcDeEqBuCoAyFyB}JuD_UmIiEeB_Aa@kIuDgB{@mHuDiBcAs@_@qAw@cEcCkAs@kFqD}CyB{DaDi@c@s@m@WUaCqB}AuAq@o@iBgBmDmDyPaR_EeEw@w@qCwCoJcJiC}BkJgIyGsFiF{DgDaCoCgBaBaAaFgCgEkBeCeAgGuBwHuBsF}AiIiCyK{DeHsCgVmKkBs@mA_@eAWyBi@{Bc@gDi@_AKo@CWEkESi@AmBC{ABu@@}AFcEVs@FwKt@kHf@{BPuE\c@FmAJy@Js@HqBV_Fr@o@J{PfCcBXu@LQBwAHo@J_AZ_A^g@RoAd@oAZoB`@eANcAHmADkAAsAMq@Mm@Qa@MqE{AcA]q@MuB[eAIqBIyA?_CJuBVmAT[DcAVcAZkG|BeCp@}AVcAH_@DsAFeK`@aHXiCHu@DwDToAHi@DaGRsCDiABoA?WAqAAe@?]KQGQKQOQUUk@I_@MiAKeBIsBKmEOmDE_AKwBUsFEs@MuCMoCSuD@W@sA?cAB]PaAKuBS]OYSQ[MOUc@c@]@_@Fa@V}@L}@HkBLS?gAFFxFLnL@rAB`C@n@BhA?RAl@yA`@QD
- DistanceIsochroneResponse:
- title: DistanceIsochroneResponse
- type: object
- description: Attributes describing a distance isochrone response.
- properties:
- status:
- $ref: '#/components/schemas/DistanceStatus'
- isoline:
- description: Contains the properties of isoline
- type: object
- properties:
- origin:
- $ref: '#/components/schemas/LatLngLiteral'
- time:
- description: The time of the isochrone (returned as default or when specifying `method=time` in parameters)
- type: object
- properties:
- value:
- description: The time in minutes
- type: number
- example: 30
- text:
- description: The readable time in minutes
- type: string
- example: 30 minutes
- distance:
- description: The distance of the isochrone (returned only if `method=distance` in parameters)
- type: object
- properties:
- value:
- description: The distance in kilometers
- type: number
- example: 10
- text:
- description: The readable distance in kilometers
- type: string
- example: 10 km
- geometry:
- type: string
- description: The polyline of the isoline (encoded with the [poyline algorithm](https://developers.google.com/maps/documentation/utilities/polylinealgorithm)).
- example: a_jyHfol@aAfEzGlIfER~JqV_KqLu@pDiHv@bAfEeCfE
- example:
- status: OK
- isoline:
- origin:
- lat: 48.709
- lng: 2.403
- distance:
- value: 1
- text: 1 km
- geometry: s|ihHouuMZ`GdClCsA~QhCnQmBhEpCfF|HxGpBtFfEnBnHqJpH}ADaEcCaB@sBnEiEYiGmVyFaG{G[eFoCw@gAiIkDYg@_DwA@
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).
diff --git a/dist/woosmap-postman.json b/dist/woosmap-postman.json
index f879c711..e5f159db 100755
--- a/dist/woosmap-postman.json
+++ b/dist/woosmap-postman.json
@@ -5,7 +5,7 @@
"description": "Stores Search API 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",
"item": [
{
- "id": "5c31b698-5e0d-4d50-b70d-70f3c7baa704",
+ "id": "eb0542d7-949d-4312-9e8b-397c03fcb1c6",
"name": "Search for assets",
"request": {
"name": "Search for assets",
@@ -128,7 +128,7 @@
},
"response": [
{
- "id": "75ee865d-313f-4127-b914-3ecb38b0ee5e",
+ "id": "0b679fd2-14ff-457f-9065-41a629584f62",
"name": "Assets successfully retrieved",
"originalRequest": {
"url": {
@@ -243,12 +243,12 @@
"value": "application/json"
}
],
- "body": "{\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"properties\": {\n \"name\": \"\",\n \"store_id\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"country_code\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"open\": {\n \"current_slice\": {\n \"start\": \"\",\n \"end\": \"\"\n },\n \"open_hours\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"open_now\": \"\",\n \"next_opening\": {\n \"end\": \"\",\n \"start\": \"\",\n \"day\": \"\"\n },\n \"week_day\": \"\"\n },\n \"weekly_opening\": {\n \"1\": {\n \"hours\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"isSpecial\": \"\"\n },\n \"2\": {\n \"hours\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"isSpecial\": \"\"\n },\n \"3\": {\n \"hours\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"isSpecial\": \"\"\n },\n \"4\": {\n \"hours\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"isSpecial\": \"\"\n },\n \"5\": {\n \"hours\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"isSpecial\": \"\"\n },\n \"6\": {\n \"hours\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"isSpecial\": \"\"\n },\n \"7\": {\n \"hours\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"isSpecial\": \"\"\n },\n \"timezone\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"last_updated\": \"\",\n \"user_properties\": {\n \"aliquaab\": false\n },\n \"opening_hours\": {\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 \"distance\": \"\"\n },\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n \"\",\n \"\"\n ]\n }\n },\n {\n \"type\": \"Feature\",\n \"properties\": {\n \"name\": \"\",\n \"store_id\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"country_code\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"open\": {\n \"current_slice\": {\n \"start\": \"\",\n \"end\": \"\"\n },\n \"open_hours\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"open_now\": \"\",\n \"next_opening\": {\n \"end\": \"\",\n \"start\": \"\",\n \"day\": \"\"\n },\n \"week_day\": \"\"\n },\n \"weekly_opening\": {\n \"1\": {\n \"hours\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"isSpecial\": \"\"\n },\n \"2\": {\n \"hours\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"isSpecial\": \"\"\n },\n \"3\": {\n \"hours\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"isSpecial\": \"\"\n },\n \"4\": {\n \"hours\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"isSpecial\": \"\"\n },\n \"5\": {\n \"hours\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"isSpecial\": \"\"\n },\n \"6\": {\n \"hours\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"isSpecial\": \"\"\n },\n \"7\": {\n \"hours\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"isSpecial\": \"\"\n },\n \"timezone\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"last_updated\": \"\",\n \"user_properties\": {\n \"exercitation6_3\": -68860699,\n \"incididunt_1\": true,\n \"nisi_a13\": true\n },\n \"opening_hours\": {\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 \"distance\": \"\"\n },\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"pagination\": {\n \"page\": \"\",\n \"pageCount\": \"\"\n }\n}",
+ "body": "{\n \"type\": \"FeatureCollection\",\n \"features\": [\n {\n \"type\": \"Feature\",\n \"properties\": {\n \"name\": \"\",\n \"store_id\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"country_code\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"open\": {\n \"current_slice\": {\n \"start\": \"\",\n \"end\": \"\"\n },\n \"open_hours\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"open_now\": \"\",\n \"next_opening\": {\n \"end\": \"\",\n \"start\": \"\",\n \"day\": \"\"\n },\n \"week_day\": \"\"\n },\n \"weekly_opening\": {\n \"1\": {\n \"hours\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"isSpecial\": \"