From 9d6de323ec411128d9705fae93eecbe7c2ef8987 Mon Sep 17 00:00:00 2001 From: cmillett <65162811+cmillett@users.noreply.github.com> Date: Thu, 9 Apr 2026 11:09:05 +0200 Subject: [PATCH] feat: Remove deprecated Address API from OpenAPI specification The Address API was deprecated in Nov 2023 in favor of Localities API. Remove all Address API endpoints, parameters, schemas, responses, snippets, and generated docs. Shared schema AddressComponents is preserved as it is referenced by Localities API. Co-Authored-By: Claude Opus 4.6 (1M context) --- README.md | 1 - ...p_http_parameters_addressautocomplete.html | 69 - ...map_http_parameters_addressautocomplete.md | 29 - ...oosmap_http_parameters_addressdetails.html | 64 - .../woosmap_http_parameters_addressdetails.md | 25 - ...oosmap_http_parameters_addressgeocode.html | 90 - .../woosmap_http_parameters_addressgeocode.md | 41 - ...map_http_parameters_localitiesdetails.html | 5 +- ...osmap_http_parameters_localitiesdetails.md | 2 +- ...addressautocompletecollectionresponse.html | 154 - ...a_addressautocompletecollectionresponse.md | 77 - ...hema_addressautocompletematchedfields.html | 74 - ...schema_addressautocompletematchedfields.md | 16 - ...tp_schema_addressautocompleteresponse.html | 164 - ...http_schema_addressautocompleteresponse.md | 36 - ...ap_http_schema_addressdetailsresponse.html | 148 - ...smap_http_schema_addressdetailsresponse.md | 84 - ...hema_addressgeocodecollectionresponse.html | 175 - ...schema_addressgeocodecollectionresponse.md | 100 - ...ap_http_schema_addressgeocoderesponse.html | 145 - ...smap_http_schema_addressgeocoderesponse.md | 19 - ...osmap_http_schema_addressgeocodetypes.html | 32 - ...woosmap_http_schema_addressgeocodetypes.md | 12 - .../woosmap_http_schema_addressgeometry.html | 134 - .../woosmap_http_schema_addressgeometry.md | 28 - .../woosmap_http_schema_addressstatus.html | 49 - .../woosmap_http_schema_addressstatus.md | 17 - .../woosmap_http_schema_addresstypes.html | 32 - .../woosmap_http_schema_addresstypes.md | 12 - dist/merged-woosmap-openapi3.json | 4910 +++++++---------- ...ap_http_address_autocomplete_collection.go | 39 - ..._http_address_autocomplete_collection.java | 12 - ...ap_http_address_autocomplete_collection.js | 11 - ...tp_address_autocomplete_collection.node.js | 21 - ...ap_http_address_autocomplete_collection.py | 15 - ...ap_http_address_autocomplete_collection.rb | 16 - ...ap_http_address_autocomplete_collection.sh | 4 - ...p_http_address_autocomplete_collection.txt | 6 - .../woosmap_http_address_details.go | 39 - .../woosmap_http_address_details.java | 12 - .../woosmap_http_address_details.js | 11 - .../woosmap_http_address_details.node.js | 21 - .../woosmap_http_address_details.py | 15 - .../woosmap_http_address_details.rb | 16 - .../woosmap_http_address_details.sh | 4 - .../woosmap_http_address_details.txt | 5 - ...woosmap_http_address_geocode_collection.go | 39 - ...osmap_http_address_geocode_collection.java | 12 - ...woosmap_http_address_geocode_collection.js | 11 - ...ap_http_address_geocode_collection.node.js | 21 - ...woosmap_http_address_geocode_collection.py | 15 - ...woosmap_http_address_geocode_collection.rb | 16 - ...woosmap_http_address_geocode_collection.sh | 4 - ...oosmap_http_address_geocode_collection.txt | 7 - dist/woosmap-openapi3.json | 2627 +++------ dist/woosmap-openapi3.yml | 847 +-- dist/woosmap-postman.json | 2392 ++------ generator/requests/requests.ts | 63 - redocly/redocly-merged-config.yaml | 1 - redocly/redocly-validate-config.yaml | 1 - specification/index.yml | 10 - specification/parameters/_index.yml | 20 - specification/parameters/address/address.yml | 9 - .../parameters/address/address_components.yml | 8 - .../parameters/address/cc_format.yml | 10 - specification/parameters/address/fields.yml | 11 - specification/parameters/address/input.yml | 9 - specification/parameters/address/language.yml | 9 - specification/parameters/address/latlng.yml | 9 - specification/parameters/address/limit.yml | 9 - specification/parameters/address/location.yml | 7 - .../parameters/address/public_id.yml | 9 - specification/paths/_index.yml | 18 - .../paths/address/addressAutocomplete.yml | 66 - .../paths/address/addressDetails.yml | 65 - .../paths/address/addressGeocode.yml | 69 - .../paths/localities/localitiesDetails.yml | 2 +- ...dress_autocomplete_collection_response.yml | 32 - ...map_http_address_autocomplete_response.yml | 15 - .../woosmap_http_address_details_response.yml | 45 - ...tp_address_geocode_collection_response.yml | 60 - .../AddressAutocompleteCollectionResponse.yml | 12 - .../AddressAutocompleteMatchedFields.yml | 9 - .../schemas/AddressAutocompleteResponse.yml | 20 - .../schemas/AddressDetailsResponse.yml | 27 - .../AddressGeocodeCollectionResponse.yml | 12 - .../schemas/AddressGeocodeResponse.yml | 15 - specification/schemas/AddressGeocodeTypes.yml | 12 - specification/schemas/AddressGeometry.yml | 26 - specification/schemas/AddressStatus.yml | 14 - specification/schemas/AddressTypes.yml | 10 - specification/schemas/_index.yml | 22 - ...p_address_autocomplete_collection.curl.yml | 5 - ...ess_autocomplete_collection.javascript.yml | 5 - ...address_autocomplete_collection.nodejs.yml | 5 - ...address_autocomplete_collection.python.yml | 5 - .../woosmap_http_address_details.curl.yml | 5 - ...oosmap_http_address_details.javascript.yml | 5 - .../woosmap_http_address_details.nodejs.yml | 5 - .../woosmap_http_address_details.python.yml | 5 - ...p_http_address_geocode_collection.curl.yml | 5 - ..._address_geocode_collection.javascript.yml | 5 - ...http_address_geocode_collection.nodejs.yml | 5 - ...http_address_geocode_collection.python.yml | 5 - 104 files changed, 3150 insertions(+), 10628 deletions(-) delete mode 100644 dist/documentation/parameters/woosmap_http_parameters_addressautocomplete.html delete mode 100644 dist/documentation/parameters/woosmap_http_parameters_addressautocomplete.md delete mode 100644 dist/documentation/parameters/woosmap_http_parameters_addressdetails.html delete mode 100644 dist/documentation/parameters/woosmap_http_parameters_addressdetails.md delete mode 100644 dist/documentation/parameters/woosmap_http_parameters_addressgeocode.html delete mode 100644 dist/documentation/parameters/woosmap_http_parameters_addressgeocode.md delete mode 100644 dist/documentation/schemas/woosmap_http_schema_addressautocompletecollectionresponse.html delete mode 100644 dist/documentation/schemas/woosmap_http_schema_addressautocompletecollectionresponse.md delete mode 100644 dist/documentation/schemas/woosmap_http_schema_addressautocompletematchedfields.html delete mode 100644 dist/documentation/schemas/woosmap_http_schema_addressautocompletematchedfields.md delete mode 100644 dist/documentation/schemas/woosmap_http_schema_addressautocompleteresponse.html delete mode 100644 dist/documentation/schemas/woosmap_http_schema_addressautocompleteresponse.md delete mode 100644 dist/documentation/schemas/woosmap_http_schema_addressdetailsresponse.html delete mode 100644 dist/documentation/schemas/woosmap_http_schema_addressdetailsresponse.md delete mode 100644 dist/documentation/schemas/woosmap_http_schema_addressgeocodecollectionresponse.html delete mode 100644 dist/documentation/schemas/woosmap_http_schema_addressgeocodecollectionresponse.md delete mode 100644 dist/documentation/schemas/woosmap_http_schema_addressgeocoderesponse.html delete mode 100644 dist/documentation/schemas/woosmap_http_schema_addressgeocoderesponse.md delete mode 100644 dist/documentation/schemas/woosmap_http_schema_addressgeocodetypes.html delete mode 100644 dist/documentation/schemas/woosmap_http_schema_addressgeocodetypes.md delete mode 100644 dist/documentation/schemas/woosmap_http_schema_addressgeometry.html delete mode 100644 dist/documentation/schemas/woosmap_http_schema_addressgeometry.md delete mode 100644 dist/documentation/schemas/woosmap_http_schema_addressstatus.html delete mode 100644 dist/documentation/schemas/woosmap_http_schema_addressstatus.md delete mode 100644 dist/documentation/schemas/woosmap_http_schema_addresstypes.html delete mode 100644 dist/documentation/schemas/woosmap_http_schema_addresstypes.md delete mode 100644 dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.go delete mode 100644 dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.java delete mode 100644 dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.js delete mode 100644 dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.node.js delete mode 100644 dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.py delete mode 100644 dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.rb delete mode 100644 dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.sh delete mode 100644 dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.txt delete mode 100644 dist/snippets/woosmap_http_address_details/woosmap_http_address_details.go delete mode 100644 dist/snippets/woosmap_http_address_details/woosmap_http_address_details.java delete mode 100644 dist/snippets/woosmap_http_address_details/woosmap_http_address_details.js delete mode 100644 dist/snippets/woosmap_http_address_details/woosmap_http_address_details.node.js delete mode 100644 dist/snippets/woosmap_http_address_details/woosmap_http_address_details.py delete mode 100644 dist/snippets/woosmap_http_address_details/woosmap_http_address_details.rb delete mode 100644 dist/snippets/woosmap_http_address_details/woosmap_http_address_details.sh delete mode 100644 dist/snippets/woosmap_http_address_details/woosmap_http_address_details.txt delete mode 100644 dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.go delete mode 100644 dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.java delete mode 100644 dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.js delete mode 100644 dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.node.js delete mode 100644 dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.py delete mode 100644 dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.rb delete mode 100644 dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.sh delete mode 100644 dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.txt delete mode 100644 specification/parameters/address/address.yml delete mode 100644 specification/parameters/address/address_components.yml delete mode 100644 specification/parameters/address/cc_format.yml delete mode 100644 specification/parameters/address/fields.yml delete mode 100644 specification/parameters/address/input.yml delete mode 100644 specification/parameters/address/language.yml delete mode 100644 specification/parameters/address/latlng.yml delete mode 100644 specification/parameters/address/limit.yml delete mode 100644 specification/parameters/address/location.yml delete mode 100644 specification/parameters/address/public_id.yml delete mode 100644 specification/paths/address/addressAutocomplete.yml delete mode 100644 specification/paths/address/addressDetails.yml delete mode 100644 specification/paths/address/addressGeocode.yml delete mode 100644 specification/responses/woosmap_http_address_autocomplete_collection_response.yml delete mode 100644 specification/responses/woosmap_http_address_autocomplete_response.yml delete mode 100644 specification/responses/woosmap_http_address_details_response.yml delete mode 100644 specification/responses/woosmap_http_address_geocode_collection_response.yml delete mode 100644 specification/schemas/AddressAutocompleteCollectionResponse.yml delete mode 100644 specification/schemas/AddressAutocompleteMatchedFields.yml delete mode 100644 specification/schemas/AddressAutocompleteResponse.yml delete mode 100644 specification/schemas/AddressDetailsResponse.yml delete mode 100644 specification/schemas/AddressGeocodeCollectionResponse.yml delete mode 100644 specification/schemas/AddressGeocodeResponse.yml delete mode 100644 specification/schemas/AddressGeocodeTypes.yml delete mode 100644 specification/schemas/AddressGeometry.yml delete mode 100644 specification/schemas/AddressStatus.yml delete mode 100644 specification/schemas/AddressTypes.yml delete mode 100644 specification/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.curl.yml delete mode 100644 specification/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.javascript.yml delete mode 100644 specification/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.nodejs.yml delete mode 100644 specification/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.python.yml delete mode 100644 specification/snippets/woosmap_http_address_details/woosmap_http_address_details.curl.yml delete mode 100644 specification/snippets/woosmap_http_address_details/woosmap_http_address_details.javascript.yml delete mode 100644 specification/snippets/woosmap_http_address_details/woosmap_http_address_details.nodejs.yml delete mode 100644 specification/snippets/woosmap_http_address_details/woosmap_http_address_details.python.yml delete mode 100644 specification/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.curl.yml delete mode 100644 specification/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.javascript.yml delete mode 100644 specification/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.nodejs.yml delete mode 100644 specification/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.python.yml diff --git a/README.md b/README.md index f38cb89b..a2340eef 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,6 @@ An OpenAPI specification for Woosmap Platform. | [Geolocation](https://developers.woosmap.com/products/geolocation-api/location/) | Complete | | [Stores](https://developers.woosmap.com/products/stores-api/overview/) | Complete | | [Localities](https://developers.woosmap.com/products/localities/get-started/) | Complete | -| [Address](https://developers.woosmap.com/products/address-api/get-started/) | Complete | | [Distance](https://developers.woosmap.com/products/distance-api/get-started/) | Complete | | [Transit](https://developers.woosmap.com/products/transit-api/route-endpoint/) | Complete | | [Indoor](https://developers.woosmap.com/products/indoor-api/get-started/) | Complete | diff --git a/dist/documentation/parameters/woosmap_http_parameters_addressautocomplete.html b/dist/documentation/parameters/woosmap_http_parameters_addressautocomplete.html deleted file mode 100644 index 729f0f40..00000000 --- a/dist/documentation/parameters/woosmap_http_parameters_addressautocomplete.html +++ /dev/null @@ -1,69 +0,0 @@ - - -

Required parameters

- -

Optional parameters

- -

- Generated from the - OpenAPI specification. - ✎ Edit - bug_report Report bug -

- - diff --git a/dist/documentation/parameters/woosmap_http_parameters_addressautocomplete.md b/dist/documentation/parameters/woosmap_http_parameters_addressautocomplete.md deleted file mode 100644 index 6213c941..00000000 --- a/dist/documentation/parameters/woosmap_http_parameters_addressautocomplete.md +++ /dev/null @@ -1,29 +0,0 @@ - - -

Required parameters

- --

input

- - 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. - -

Optional parameters

- --

components

- - 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 `|`. - --

language

- - 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. - --

location

- - Bias for the results. Should be pass in `lat`,`lng` format. - - -

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_addressdetails.html b/dist/documentation/parameters/woosmap_http_parameters_addressdetails.html deleted file mode 100644 index 29952af6..00000000 --- a/dist/documentation/parameters/woosmap_http_parameters_addressdetails.html +++ /dev/null @@ -1,64 +0,0 @@ - - -

Required parameters

- -

Optional parameters

- -

- Generated from the - OpenAPI specification. - ✎ Edit - bug_report Report bug -

- - diff --git a/dist/documentation/parameters/woosmap_http_parameters_addressdetails.md b/dist/documentation/parameters/woosmap_http_parameters_addressdetails.md deleted file mode 100644 index 47b230cd..00000000 --- a/dist/documentation/parameters/woosmap_http_parameters_addressdetails.md +++ /dev/null @@ -1,25 +0,0 @@ - - -

Required parameters

- --

public_id

- - A textual identifier that uniquely identifies a locality, returned from an [Address Autocomplete](https://developers.woosmap.com/products/address-api/autocomplete/). - -

Optional parameters

- --

cc_format

- - 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`). - --

fields

- - 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. - - -

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_addressgeocode.html b/dist/documentation/parameters/woosmap_http_parameters_addressgeocode.html deleted file mode 100644 index 3b258a09..00000000 --- a/dist/documentation/parameters/woosmap_http_parameters_addressgeocode.html +++ /dev/null @@ -1,90 +0,0 @@ - - -

Optional parameters

- -

- Generated from the - OpenAPI specification. - ✎ Edit - bug_report Report bug -

- - diff --git a/dist/documentation/parameters/woosmap_http_parameters_addressgeocode.md b/dist/documentation/parameters/woosmap_http_parameters_addressgeocode.md deleted file mode 100644 index b6abeb46..00000000 --- a/dist/documentation/parameters/woosmap_http_parameters_addressgeocode.md +++ /dev/null @@ -1,41 +0,0 @@ - - - - -

Optional parameters

- --

address

- - The address of which to find the coordinates for. A partial address is less likely to return the proper coordinates than the complete address. - --

cc_format

- - 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`). - --

components

- - 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 `|`. - --

language

- - 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. - --

latlng

- - Geographic coordinates. Should be pass in `lat`,`lng` format. - --

limit

- - Maximum number of results to be returned (value from 1 to 100, default values for geocode request \[20] and for reverse geocode request \[1]) - --

location

- - Bias for the results. Should be pass in `lat`,`lng` format. - - -

Generated from the OpenAPI specification. -✎ Edit -bug_report Report bug -

- - \ No newline at end of file diff --git a/dist/documentation/parameters/woosmap_http_parameters_localitiesdetails.html b/dist/documentation/parameters/woosmap_http_parameters_localitiesdetails.html index c3becbed..49ea7cd3 100644 --- a/dist/documentation/parameters/woosmap_http_parameters_localitiesdetails.html +++ b/dist/documentation/parameters/woosmap_http_parameters_localitiesdetails.html @@ -39,8 +39,9 @@

cc_format

To specify the format for the short country code - expected to be returned in the address_components field (default is - alpha3). + expected to be returned in the address_components field. Default is the + format used to specify components or alpha2 if + no components are specified.

  • diff --git a/dist/documentation/parameters/woosmap_http_parameters_localitiesdetails.md b/dist/documentation/parameters/woosmap_http_parameters_localitiesdetails.md index 8b4ab6b4..f8b9c609 100644 --- a/dist/documentation/parameters/woosmap_http_parameters_localitiesdetails.md +++ b/dist/documentation/parameters/woosmap_http_parameters_localitiesdetails.md @@ -16,7 +16,7 @@ -

    cc_format

    - 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`). + To specify the format for the short [country code](https://en.wikipedia.org/wiki/ISO\_3166-1) expected to be returned in the address_components field. Default is the format used to specify `components` or `alpha2` if no components are specified. -

    fields

    diff --git a/dist/documentation/schemas/woosmap_http_schema_addressautocompletecollectionresponse.html b/dist/documentation/schemas/woosmap_http_schema_addressautocompletecollectionresponse.html deleted file mode 100644 index 70863b6e..00000000 --- a/dist/documentation/schemas/woosmap_http_schema_addressautocompletecollectionresponse.html +++ /dev/null @@ -1,154 +0,0 @@ - - -

    - AddressAutocompleteCollectionResponse -

    -

    Address Collection Response containing Localities

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldRequiredTypeDescription
    - - optional - Array<AddressAutocompleteResponse> - - See - AddressAutocompleteResponse - for more information. -
    - - optionalAddressStatus - See AddressStatus for - more information. -
    -

    - Example -

    -
    -{
    -  "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"
    -}
    -

    - Generated from the - OpenAPI specification. - ✎ Edit - bug_report Report bug -

    - - diff --git a/dist/documentation/schemas/woosmap_http_schema_addressautocompletecollectionresponse.md b/dist/documentation/schemas/woosmap_http_schema_addressautocompletecollectionresponse.md deleted file mode 100644 index 021d1203..00000000 --- a/dist/documentation/schemas/woosmap_http_schema_addressautocompletecollectionresponse.md +++ /dev/null @@ -1,77 +0,0 @@ - - -

    AddressAutocompleteCollectionResponse

    - -Address Collection Response containing Localities - -| Field | Required | Type | Description | -| :----------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------- | -| | optional | Array<[AddressAutocompleteResponse](#AddressAutocompleteResponse "AddressAutocompleteResponse")> | See [AddressAutocompleteResponse](#AddressAutocompleteResponse "AddressAutocompleteResponse") for more information. | -| | optional | [AddressStatus](#AddressStatus "AddressStatus") | See [AddressStatus](#AddressStatus "AddressStatus") for more information. | - -

    Example

    - -
    {
    -  "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"
    -}
    - -

    Generated from the OpenAPI specification. -✎ Edit -bug_report Report bug -

    - - diff --git a/dist/documentation/schemas/woosmap_http_schema_addressautocompletematchedfields.html b/dist/documentation/schemas/woosmap_http_schema_addressautocompletematchedfields.html deleted file mode 100644 index 02d885df..00000000 --- a/dist/documentation/schemas/woosmap_http_schema_addressautocompletematchedfields.html +++ /dev/null @@ -1,74 +0,0 @@ - - -

    - AddressAutocompleteMatchedFields -

    -

    - Contains a set of substrings for description. Each substring is identified by - an offset and a length.` -

    - - - - - - - - - - - - - - - - - -
    FieldRequiredTypeDescription
    - - optional - Array<MatchedSubstring> - -
    -

    match substrings for address description

    -

    - See MatchedSubstring for more - information. -

    -
    -
    -

    - Generated from the - OpenAPI specification. - ✎ Edit - bug_report Report bug -

    - - diff --git a/dist/documentation/schemas/woosmap_http_schema_addressautocompletematchedfields.md b/dist/documentation/schemas/woosmap_http_schema_addressautocompletematchedfields.md deleted file mode 100644 index f6ea2bd3..00000000 --- a/dist/documentation/schemas/woosmap_http_schema_addressautocompletematchedfields.md +++ /dev/null @@ -1,16 +0,0 @@ - - -

    AddressAutocompleteMatchedFields

    - -Contains a set of substrings for description. Each substring is identified by an `offset` and a `length`.\` - -| Field | Required | Type | Description | -| :------------------------------------------------------------------------------------------------------------------------------ | -------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| | optional | Array<[MatchedSubstring](#MatchedSubstring "MatchedSubstring")> |

    match substrings for address description

    See MatchedSubstring for more information.

    | - -

    Generated from the OpenAPI specification. -✎ Edit -bug_report Report bug -

    - - diff --git a/dist/documentation/schemas/woosmap_http_schema_addressautocompleteresponse.html b/dist/documentation/schemas/woosmap_http_schema_addressautocompleteresponse.html deleted file mode 100644 index 44801ff3..00000000 --- a/dist/documentation/schemas/woosmap_http_schema_addressautocompleteresponse.html +++ /dev/null @@ -1,164 +0,0 @@ - - -

    - AddressAutocompleteResponse -

    -

    Attributes describing an Address.

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldRequiredTypeDescription
    - - optionalstring -
    -

    - Address description to be used as suggestion in drop down list if - needed. -

    -
    -
    - - optional - AddressAutocompleteMatchedFields - - See - AddressAutocompleteMatchedFields - for more information. -
    - - optionalstring -
    -

    - 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. -

    -
    -
    - - optionalAddressStatus - See AddressStatus for - more information. -
    - - optionalAddressTypes - See AddressTypes for - more information. -
    -

    - Example -

    -
    -{
    -  "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0",
    -  "description": "London, England, United Kingdom",
    -  "matched_substring": {
    -    "description": [
    -      {
    -        "offset": 0,
    -        "length": 4
    -      }
    -    ]
    -  },
    -  "type": "locality"
    -}
    -

    - Generated from the - OpenAPI specification. - ✎ Edit - bug_report Report bug -

    - - diff --git a/dist/documentation/schemas/woosmap_http_schema_addressautocompleteresponse.md b/dist/documentation/schemas/woosmap_http_schema_addressautocompleteresponse.md deleted file mode 100644 index 4e283acf..00000000 --- a/dist/documentation/schemas/woosmap_http_schema_addressautocompleteresponse.md +++ /dev/null @@ -1,36 +0,0 @@ - - -

    AddressAutocompleteResponse

    - -Attributes describing an Address. - -| Field | Required | Type | Description | -| :------------------------------------------------------------------------------------------------------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| | optional | string |

    Address description to be used as suggestion in drop down list if needed.

    | -| | optional | [AddressAutocompleteMatchedFields](#AddressAutocompleteMatchedFields "AddressAutocompleteMatchedFields") | See [AddressAutocompleteMatchedFields](#AddressAutocompleteMatchedFields "AddressAutocompleteMatchedFields") for more information. | -| | optional | string |

    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.

    | -| | optional | [AddressStatus](#AddressStatus "AddressStatus") | See [AddressStatus](#AddressStatus "AddressStatus") for more information. | -| | optional | [AddressTypes](#AddressTypes "AddressTypes") | See [AddressTypes](#AddressTypes "AddressTypes") for more information. | - -

    Example

    - -
    {
    -  "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0",
    -  "description": "London, England, United Kingdom",
    -  "matched_substring": {
    -    "description": [
    -      {
    -        "offset": 0,
    -        "length": 4
    -      }
    -    ]
    -  },
    -  "type": "locality"
    -}
    - -

    Generated from the OpenAPI specification. -✎ Edit -bug_report Report bug -

    - - diff --git a/dist/documentation/schemas/woosmap_http_schema_addressdetailsresponse.html b/dist/documentation/schemas/woosmap_http_schema_addressdetailsresponse.html deleted file mode 100644 index 519b71e3..00000000 --- a/dist/documentation/schemas/woosmap_http_schema_addressdetailsresponse.html +++ /dev/null @@ -1,148 +0,0 @@ - - -

    - AddressDetailsResponse -

    -

    Address Details Response

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldRequiredTypeDescription
    - - optionalobject -
    -

    the root node of address details

    -
    -
    - - optionalAddressStatus - See AddressStatus for - more information. -
    -

    - 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
    -        },
    -        "southwest": {
    -          "lat": 51.28043,
    -          "lng": -0.56316
    -        }
    -      }
    -    }
    -  },
    -  "status": "OK"
    -}
    -

    - Generated from the - OpenAPI specification. - ✎ Edit - bug_report Report bug -

    - - diff --git a/dist/documentation/schemas/woosmap_http_schema_addressdetailsresponse.md b/dist/documentation/schemas/woosmap_http_schema_addressdetailsresponse.md deleted file mode 100644 index fe19e42e..00000000 --- a/dist/documentation/schemas/woosmap_http_schema_addressdetailsresponse.md +++ /dev/null @@ -1,84 +0,0 @@ - - -

    AddressDetailsResponse

    - -Address Details Response - -| Field | Required | Type | Description | -| :---------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------- | -------------------------------------------------------------------------------------- | -| | optional | object |

    the root node of address details

    | -| | optional | [AddressStatus](#AddressStatus "AddressStatus") | See [AddressStatus](#AddressStatus "AddressStatus") for more information. | - -

    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
    -        },
    -        "southwest": {
    -          "lat": 51.28043,
    -          "lng": -0.56316
    -        }
    -      }
    -    }
    -  },
    -  "status": "OK"
    -}
    - -

    Generated from the OpenAPI specification. -✎ Edit -bug_report Report bug -

    - - diff --git a/dist/documentation/schemas/woosmap_http_schema_addressgeocodecollectionresponse.html b/dist/documentation/schemas/woosmap_http_schema_addressgeocodecollectionresponse.html deleted file mode 100644 index 72cfe00c..00000000 --- a/dist/documentation/schemas/woosmap_http_schema_addressgeocodecollectionresponse.html +++ /dev/null @@ -1,175 +0,0 @@ - - -

    - AddressGeocodeCollectionResponse -

    -

    - Address Geocode Collection Response. Contains one or more Addresses with - coordinates (default to one result for reverse geocoding) -

    - - - - - - - - - - - - - - - - - - - - - - - -
    FieldRequiredTypeDescription
    - - optional - Array<AddressGeocodeResponse> - - See - AddressGeocodeResponse - for more information. -
    - - optionalAddressStatus - See AddressStatus for - more information. -
    -

    - Example -

    -
    -{
    -  "results": [
    -    {
    -      "formatted_address": "Place de la Résistance, 75007 Paris, France",
    -      "types": [
    -        "address",
    -        "route"
    -      ],
    -      "address_components": [
    -        {
    -          "types": [
    -            "country"
    -          ],
    -          "long_name": "France",
    -          "short_name": "FRA"
    -        },
    -        {
    -          "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"
    -          ]
    -        }
    -      ],
    -      "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
    -          }
    -        }
    -      }
    -    }
    -  ],
    -  "status": "OK"
    -}
    -

    - Generated from the - OpenAPI specification. - ✎ Edit - bug_report Report bug -

    - - diff --git a/dist/documentation/schemas/woosmap_http_schema_addressgeocodecollectionresponse.md b/dist/documentation/schemas/woosmap_http_schema_addressgeocodecollectionresponse.md deleted file mode 100644 index 250d020a..00000000 --- a/dist/documentation/schemas/woosmap_http_schema_addressgeocodecollectionresponse.md +++ /dev/null @@ -1,100 +0,0 @@ - - -

    AddressGeocodeCollectionResponse

    - -Address Geocode Collection Response. Contains one or more Addresses with coordinates (default to one result for reverse geocoding) - -| Field | Required | Type | Description | -| :---------------------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -| | optional | Array<[AddressGeocodeResponse](#AddressGeocodeResponse "AddressGeocodeResponse")> | See [AddressGeocodeResponse](#AddressGeocodeResponse "AddressGeocodeResponse") for more information. | -| | optional | [AddressStatus](#AddressStatus "AddressStatus") | See [AddressStatus](#AddressStatus "AddressStatus") for more information. | - -

    Example

    - -
    {
    -  "results": [
    -    {
    -      "formatted_address": "Place de la Résistance, 75007 Paris, France",
    -      "types": [
    -        "address",
    -        "route"
    -      ],
    -      "address_components": [
    -        {
    -          "types": [
    -            "country"
    -          ],
    -          "long_name": "France",
    -          "short_name": "FRA"
    -        },
    -        {
    -          "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"
    -          ]
    -        }
    -      ],
    -      "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
    -          }
    -        }
    -      }
    -    }
    -  ],
    -  "status": "OK"
    -}
    - -

    Generated from the OpenAPI specification. -✎ Edit -bug_report Report bug -

    - - diff --git a/dist/documentation/schemas/woosmap_http_schema_addressgeocoderesponse.html b/dist/documentation/schemas/woosmap_http_schema_addressgeocoderesponse.html deleted file mode 100644 index d9e97b36..00000000 --- a/dist/documentation/schemas/woosmap_http_schema_addressgeocoderesponse.html +++ /dev/null @@ -1,145 +0,0 @@ - - -

    - AddressGeocodeResponse -

    -

    Address Geocode Response

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldRequiredTypeDescription
    - - optional - AddressComponents - - See - AddressComponents - for more information. -
    - - optional - FormattedAddress - - See - FormattedAddress - for more information. -
    - - optional - AddressGeometry - - See - AddressGeometry - for more information. -
    - - optional - Array<AddressGeocodeTypes> - -
    -

    - 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) -

    -

    - See AddressGeocodeTypes for more - information. -

    -
    -
    -

    - Generated from the - OpenAPI specification. - ✎ Edit - bug_report Report bug -

    - - diff --git a/dist/documentation/schemas/woosmap_http_schema_addressgeocoderesponse.md b/dist/documentation/schemas/woosmap_http_schema_addressgeocoderesponse.md deleted file mode 100644 index 62ac5eb5..00000000 --- a/dist/documentation/schemas/woosmap_http_schema_addressgeocoderesponse.md +++ /dev/null @@ -1,19 +0,0 @@ - - -

    AddressGeocodeResponse

    - -Address Geocode Response - -| Field | Required | Type | Description | -| :---------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| | optional | [AddressComponents](#AddressComponents "AddressComponents") | See [AddressComponents](#AddressComponents "AddressComponents") for more information. | -| | optional | [FormattedAddress](#FormattedAddress "FormattedAddress") | See [FormattedAddress](#FormattedAddress "FormattedAddress") for more information. | -| | optional | [AddressGeometry](#AddressGeometry "AddressGeometry") | See [AddressGeometry](#AddressGeometry "AddressGeometry") for more information. | -| | optional | Array<[AddressGeocodeTypes](#AddressGeocodeTypes "AddressGeocodeTypes")> |

    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)

    See AddressGeocodeTypes for more information.

    | - -

    Generated from the OpenAPI specification. -✎ Edit -bug_report Report bug -

    - - diff --git a/dist/documentation/schemas/woosmap_http_schema_addressgeocodetypes.html b/dist/documentation/schemas/woosmap_http_schema_addressgeocodetypes.html deleted file mode 100644 index 66021fc0..00000000 --- a/dist/documentation/schemas/woosmap_http_schema_addressgeocodetypes.html +++ /dev/null @@ -1,32 +0,0 @@ - - -

    AddressGeocodeTypes

    -

    Contains the type of result.

    -

    - Generated from the - OpenAPI specification. - ✎ Edit - bug_report Report bug -

    - - diff --git a/dist/documentation/schemas/woosmap_http_schema_addressgeocodetypes.md b/dist/documentation/schemas/woosmap_http_schema_addressgeocodetypes.md deleted file mode 100644 index e23b5878..00000000 --- a/dist/documentation/schemas/woosmap_http_schema_addressgeocodetypes.md +++ /dev/null @@ -1,12 +0,0 @@ - - -

    AddressGeocodeTypes

    - -Contains the type of result. - -

    Generated from the OpenAPI specification. -✎ Edit -bug_report Report bug -

    - - diff --git a/dist/documentation/schemas/woosmap_http_schema_addressgeometry.html b/dist/documentation/schemas/woosmap_http_schema_addressgeometry.html deleted file mode 100644 index 013783ea..00000000 --- a/dist/documentation/schemas/woosmap_http_schema_addressgeometry.html +++ /dev/null @@ -1,134 +0,0 @@ - - -

    AddressGeometry

    -

    - The location of the result, in latitude and longitude. Accuracy is also - provided. -

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    FieldRequiredTypeDescription
    - - optionalLatLngLiteral - See LatLngLiteral for - more information. -
    - - optionalstring -
    -

    - Specifies additional data about the geocoded location. The following - values are currently supported: -

    -
      -
    • - ROOFTOP result is a precise geocode for which we have - location information accurate down to street address precision. -
    • -
    • - RANGE_INTERPOLATED result reflects an approximation - (usually on a road) interpolated between two precise points (such - as intersections). Interpolated results are generally returned - when rooftop geocodes are unavailable for a street address. -
    • -
    • - GEOMETRIC_CENTER result is the geometric center of a - result such as a polyline (for example, a street) or polygon - (city, region, …). -
    • -
    • - APPROXIMATE result is approximate (usually when no - other above value applies) -
    • -
    -
    - The allowed values include: ROOFTOP, - RANGE_INTERPOLATED, GEOMETRIC_CENTER, and - APPROXIMATE -
    -
    -
    - - optionalBounds - See Bounds for more information. -
    -

    Example

    -
    -{
    -  "location": {
    -    "lat": 48.829405,
    -    "lng": 2.367944
    -  },
    -  "location_type": "GEOMETRIC_CENTER"
    -}
    -

    - Generated from the - OpenAPI specification. - ✎ Edit - bug_report Report bug -

    - - diff --git a/dist/documentation/schemas/woosmap_http_schema_addressgeometry.md b/dist/documentation/schemas/woosmap_http_schema_addressgeometry.md deleted file mode 100644 index c0f54e9c..00000000 --- a/dist/documentation/schemas/woosmap_http_schema_addressgeometry.md +++ /dev/null @@ -1,28 +0,0 @@ - - -

    AddressGeometry

    - -The location of the result, in latitude and longitude. Accuracy is also provided. - -| Field | Required | Type | Description | -| :----------------------------------------------------------------------------------------------------------------- | -------- | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| | optional | [LatLngLiteral](#LatLngLiteral "LatLngLiteral") | See [LatLngLiteral](#LatLngLiteral "LatLngLiteral") for more information. | -| | optional | string |

    Specifies additional data about the geocoded location. The following values are currently supported:

    • ROOFTOP result is a precise geocode for which we have location information accurate down to street address precision.
    • RANGE_INTERPOLATED result reflects an approximation (usually on a road) interpolated between two precise points (such as intersections). Interpolated results are generally returned when rooftop geocodes are unavailable for a street address.
    • GEOMETRIC_CENTER result is the geometric center of a result such as a polyline (for example, a street) or polygon (city, region, …).
    • APPROXIMATE result is approximate (usually when no other above value applies)
    The allowed values include: `ROOFTOP`, `RANGE_INTERPOLATED`, `GEOMETRIC_CENTER`, and `APPROXIMATE`
    | -| | optional | [Bounds](#Bounds "Bounds") | See [Bounds](#Bounds "Bounds") for more information. | - -

    Example

    - -
    {
    -  "location": {
    -    "lat": 48.829405,
    -    "lng": 2.367944
    -  },
    -  "location_type": "GEOMETRIC_CENTER"
    -}
    - -

    Generated from the OpenAPI specification. -✎ Edit -bug_report Report bug -

    - - diff --git a/dist/documentation/schemas/woosmap_http_schema_addressstatus.html b/dist/documentation/schemas/woosmap_http_schema_addressstatus.html deleted file mode 100644 index ab48f8ab..00000000 --- a/dist/documentation/schemas/woosmap_http_schema_addressstatus.html +++ /dev/null @@ -1,49 +0,0 @@ - - -

    AddressStatus

    -

    - Returns more info on if the request was successful or not, valid responses. -

    - -

    - Generated from the - OpenAPI specification. - ✎ Edit - bug_report Report bug -

    - - diff --git a/dist/documentation/schemas/woosmap_http_schema_addressstatus.md b/dist/documentation/schemas/woosmap_http_schema_addressstatus.md deleted file mode 100644 index 88fad7cd..00000000 --- a/dist/documentation/schemas/woosmap_http_schema_addressstatus.md +++ /dev/null @@ -1,17 +0,0 @@ - - -

    AddressStatus

    - -Returns more info on if the request was successful or not, valid responses. - -- `OK` indicates the response contains a valid result. -- `INVALID_REQUEST` indicates that the provided request was invalid (e.g. wrong URL syntax). -- `REQUEST_DENIED` indicates that the service denied use of the Address API (e.g. wrong API Key, wrong/no referer, …). -- `UNKNOWN_ERROR` indicates an Address API request could not be processed due to a server error. The request may succeed if you try again. - -

    Generated from the OpenAPI specification. -✎ Edit -bug_report Report bug -

    - - diff --git a/dist/documentation/schemas/woosmap_http_schema_addresstypes.html b/dist/documentation/schemas/woosmap_http_schema_addresstypes.html deleted file mode 100644 index cc75dcde..00000000 --- a/dist/documentation/schemas/woosmap_http_schema_addresstypes.html +++ /dev/null @@ -1,32 +0,0 @@ - - -

    AddressTypes

    -

    Contains the type of result.

    -

    - Generated from the - OpenAPI specification. - ✎ Edit - bug_report Report bug -

    - - diff --git a/dist/documentation/schemas/woosmap_http_schema_addresstypes.md b/dist/documentation/schemas/woosmap_http_schema_addresstypes.md deleted file mode 100644 index 6450c58b..00000000 --- a/dist/documentation/schemas/woosmap_http_schema_addresstypes.md +++ /dev/null @@ -1,12 +0,0 @@ - - -

    AddressTypes

    - -Contains the type of result. - -

    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 1a8dce38..fc319110 100755 --- a/dist/merged-woosmap-openapi3.json +++ b/dist/merged-woosmap-openapi3.json @@ -53,13 +53,6 @@ "url": "https://developers.woosmap.com/products/localities/get-started/" } }, - { - "name": "Address API", - "description": "Woosmap Address API is a web service that returns addresses and other geographical places in response to an HTTP request. Request is done over HTTPS using GET. Response is formatted as JSON. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/support/api-keys/).\n>**⚠️ This API has been deprecated in favour of Localities API**\n", - "externalDocs": { - "url": "https://developers.woosmap.com/products/address-api/get-started/" - } - }, { "name": "Store Search" }, @@ -114,167 +107,209 @@ } ], "paths": { - "/address/autocomplete/json": { - "get": { - "deprecated": true, - "summary": "Autocomplete for Addresses", - "operationId": "addressAutocomplete", + "/stores": { + "post": { + "summary": "Create your Assets", + "operationId": "createStores", "servers": [ { "url": "https://api.woosmap.com" } ], "tags": [ - "Address API" + "Data Management" ], - "description": "Autocomplete on worldwide suggestions for a for text-based geographic searches. It can match on full words as well as substrings.\n", + "description": "Used to batch create Assets to a specific project identified with the `private_key` parameter.\n", "security": [ - { - "Woosmap_Platform_API_Reference_PublicApiKeyAuth": [], - "Woosmap_Platform_API_Reference_RefererHeader": [] - }, { "Woosmap_Platform_API_Reference_PrivateApiKeyAuth": [] - }, - { - "Woosmap_Platform_API_Reference_PrivateApiKeyHeaderAuth": [] - } - ], - "parameters": [ - { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_input-2" - }, - { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_address_components" - }, - { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_location-2" - }, - { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_language-3" } ], - "responses": { - "200": { - "description": "Autocompletion Address successfully retrieved", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AddressAutocompleteCollectionResponse" - }, - "examples": { - "default": { - "summary": "Autocomplete address results for input `Lond` and components `country:gb`", - "value": { - "predictions": [ - { - "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0", - "description": "London, England, United Kingdom", - "matched_substring": { - "description": [ - { - "offset": 0, - "length": 4 - } - ] - }, - "type": "locality" + "requestBody": { + "description": "The request body must of Stores Creation be formatted as JSON.", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AssetsCollectionRequest" + }, + "examples": { + "default": { + "summary": "Stores data to create as JSON", + "value": { + "stores": [ + { + "types": [ + "drive", + "click_and_collect" + ], + "tags": [ + "wifi", + "covered_parking" + ], + "location": { + "lat": 38.719, + "lng": -77.1067 }, - { - "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwNDE5Nzgz", - "description": "Londonderry, Northern Ireland, United Kingdom", - "matched_substring": { - "description": [ + "storeId": "STORE_ID_123456", + "name": "My Cool Store", + "address": { + "lines": [ + "Building Centre", + "26 Store Street" + ], + "countryCode": "UK", + "city": "London", + "zipcode": "WC1E 7BT" + }, + "contact": { + "website": "https://www.woosmap.com", + "phone": "+44 20 7693 4000", + "email": "contact@woosmap.com" + }, + "userProperties": { + "some_user_properties": "associated user value" + }, + "openingHours": { + "timezone": "Europe/London", + "usual": { + "1": [], + "default": [ { - "offset": 0, - "length": 4 + "start": "08:30", + "end": "22:00" } ] }, - "type": "locality" - }, - { - "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NjEw", - "description": "London Heathrow Airport, Hounslow, England, United Kingdom", - "matched_substring": { - "description": [ + "special": { + "2015-02-07": [ { - "offset": 0, - "length": 4 + "start": "08:00", + "end": "23:00" } ] - }, - "type": "locality" + } + } + }, + { + "types": [ + "drive" + ], + "tags": [ + "covered_parking" + ], + "location": { + "lat": 38.5239, + "lng": -77.0157 }, - { - "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM0NDEy", - "description": "London Luton Airport, Luton, England, United Kingdom", - "matched_substring": { - "description": [ + "storeId": "STORE_ID_45678", + "name": "My Cool Store 2", + "address": { + "lines": [ + "1805-1899", + "Orchard St" + ], + "countryCode": "US", + "city": "Alexandria", + "zipcode": "22309" + }, + "contact": { + "website": "https://www.woosmap.com", + "phone": "+44 20 7693 4000", + "email": "contact@woosmap.com" + }, + "userProperties": { + "some_user_properties": "associated user value" + }, + "openingHours": { + "timezone": "America/New_York", + "usual": { + "1": [], + "default": [ { - "offset": 0, - "length": 4 + "start": "08:30", + "end": "22:00" } ] - }, - "type": "locality" + } } - ], - "status": "OK" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Assets successfully created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Success" + }, + "examples": { + "default": { + "summary": "Success response for Stores Created", + "value": { + "status": "success", + "value": "2 stores" } } } } } }, - "401": { - "description": "Unauthorized. Incorrect authentication credentials.", + "400": { + "description": "Invalid. The data is not a valid JSON.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Error401" + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Error400" }, "examples": { - "Unauthorized": { - "summary": "Error 401", + "Invalid": { + "summary": "Error 400", "value": { - "detail": "Incorrect authentication credentials. Please check or use a valid API Key" + "status": "error", + "value": "The request is invalid, the data is not a valid JSON." } } } } } }, - "403": { - "description": "Forbidden. This Woosmap API is not enabled for this project.", + "401": { + "description": "Unauthorized. Incorrect authentication credentials.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Error403" + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Error401" }, "examples": { - "Forbidden": { - "summary": "Error 403", + "Unauthorized": { + "summary": "Error 401", "value": { - "detail": "This Woosmap API is not enabled for this project." + "detail": "Incorrect authentication credentials. Please check or use a valid API Key" } } } } } }, - "429": { - "description": "Too Many Requests. The rate limit for this endpoint has been exceeded.", + "403": { + "description": "Forbidden. This Woosmap API is not enabled for this project.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Error429" + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Error403" }, "examples": { "Forbidden": { - "summary": "Error 429", + "summary": "Error 403", "value": { - "detail": "The rate limit for this endpoint has been exceeded" + "detail": "This Woosmap API is not enabled for this project." } } } @@ -286,132 +321,143 @@ { "lang": "curl", "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/address/autocomplete/json?input=Lond&components=country%3Agb&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/address/autocomplete/json?input=Lond&components=country%3Agb&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));" + "source": "curl -L 'https://api.woosmap.com/stores?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n--data-raw '{\n \"stores\": [\n {\n \"types\": [\n \"drive\",\n \"click_and_collect\"\n ],\n \"tags\": [\n \"wifi\",\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.719,\n \"lng\": -77.1067\n },\n \"storeId\": \"STORE_ID_123456\",\n \"name\": \"My Cool Store\",\n \"address\": {\n \"lines\": [\n \"Building Centre\",\n \"26 Store Street\"\n ],\n \"countryCode\": \"UK\",\n \"city\": \"London\",\n \"zipcode\": \"WC1E 7BT\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"Europe/London\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"08:00\",\n \"end\": \"23:00\"\n }\n ]\n }\n }\n },\n {\n \"types\": [\n \"drive\"\n ],\n \"tags\": [\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.5239,\n \"lng\": -77.0157\n },\n \"storeId\": \"STORE_ID_45678\",\n \"name\": \"My Cool Store 2\",\n \"address\": {\n \"lines\": [\n \"1805-1899\",\n \"Orchard St\"\n ],\n \"countryCode\": \"US\",\n \"city\": \"Alexandria\",\n \"zipcode\": \"22309\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"America/New_York\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n }\n }\n }\n ]\n}'" }, { "lang": "python", "label": "Python", - "source": "import requests\n\nurl = \"https://api.woosmap.com/address/autocomplete/json?input=Lond&components=country%3Agb&key=YOUR_PUBLIC_API_KEY\"\n\npayload = {}\nheaders = {\n 'Referer': 'http://localhost'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + "source": "import requests\nimport json\n\nurl = \"https://api.woosmap.com/stores?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"stores\": [\n {\n \"types\": [\n \"drive\",\n \"click_and_collect\"\n ],\n \"tags\": [\n \"wifi\",\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.719,\n \"lng\": -77.1067\n },\n \"storeId\": \"STORE_ID_123456\",\n \"name\": \"My Cool Store\",\n \"address\": {\n \"lines\": [\n \"Building Centre\",\n \"26 Store Street\"\n ],\n \"countryCode\": \"UK\",\n \"city\": \"London\",\n \"zipcode\": \"WC1E 7BT\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"Europe/London\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"08:00\",\n \"end\": \"23:00\"\n }\n ]\n }\n }\n },\n {\n \"types\": [\n \"drive\"\n ],\n \"tags\": [\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.5239,\n \"lng\": -77.0157\n },\n \"storeId\": \"STORE_ID_45678\",\n \"name\": \"My Cool Store 2\",\n \"address\": {\n \"lines\": [\n \"1805-1899\",\n \"Orchard St\"\n ],\n \"countryCode\": \"US\",\n \"city\": \"Alexandria\",\n \"zipcode\": \"22309\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"America/New_York\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n }\n }\n }\n ]\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + }, + { + "lang": "nodejs", + "label": "NodeJS", + "source": "const axios = require('axios');\nlet data = JSON.stringify({\n \"stores\": [\n {\n \"types\": [\n \"drive\",\n \"click_and_collect\"\n ],\n \"tags\": [\n \"wifi\",\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.719,\n \"lng\": -77.1067\n },\n \"storeId\": \"STORE_ID_123456\",\n \"name\": \"My Cool Store\",\n \"address\": {\n \"lines\": [\n \"Building Centre\",\n \"26 Store Street\"\n ],\n \"countryCode\": \"UK\",\n \"city\": \"London\",\n \"zipcode\": \"WC1E 7BT\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"Europe/London\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"08:00\",\n \"end\": \"23:00\"\n }\n ]\n }\n }\n },\n {\n \"types\": [\n \"drive\"\n ],\n \"tags\": [\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.5239,\n \"lng\": -77.0157\n },\n \"storeId\": \"STORE_ID_45678\",\n \"name\": \"My Cool Store 2\",\n \"address\": {\n \"lines\": [\n \"1805-1899\",\n \"Orchard St\"\n ],\n \"countryCode\": \"US\",\n \"city\": \"Alexandria\",\n \"zipcode\": \"22309\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"America/New_York\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n }\n }\n }\n ]\n});\n\nlet config = {\n method: 'post',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/stores?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" } ] - } - }, - "/address/details/json": { - "get": { - "deprecated": true, - "summary": "Details of an Address", - "operationId": "addressDetails", + }, + "put": { + "summary": "Update the Assets", + "operationId": "updateStores", "servers": [ { "url": "https://api.woosmap.com" } ], "tags": [ - "Address API" + "Data Management" ], - "description": "Provides details of an address autocomplete suggestion (using the suggestion’s `public_id`).\n", + "description": "Used to update assets in batch. `storeId` must exists when using `PUT` method, if one asset does not exists, the batch will be refused.", "security": [ - { - "Woosmap_Platform_API_Reference_PublicApiKeyAuth": [], - "Woosmap_Platform_API_Reference_RefererHeader": [] - }, { "Woosmap_Platform_API_Reference_PrivateApiKeyAuth": [] - }, - { - "Woosmap_Platform_API_Reference_PrivateApiKeyHeaderAuth": [] - } - ], - "parameters": [ - { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_public_id-2" - }, - { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_fields-2" - }, - { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_cc_format" } ], - "responses": { - "200": { - "description": "Details Address successfully retrieved", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AddressDetailsResponse" - }, - "examples": { - "default": { - "summary": "Address Details for `London, England, United Kingdom`", - "value": { - "result": { - "formatted_address": "London, England, United Kingdom", + "requestBody": { + "description": "The request body of Stores Update must be formatted as JSON.", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AssetsCollectionRequest" + }, + "examples": { + "default": { + "summary": "Stores data to update as JSON", + "value": { + "stores": [ + { "types": [ - "locality" + "drive", + "click_and_collect" ], - "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" + "tags": [ + "wifi", + "covered_parking" + ], + "location": { + "lat": 38.719, + "lng": -77.1067 + }, + "storeId": "STORE_ID_123456", + "name": "My Cool Store", + "address": { + "lines": [ + "698-500", + " Lloyds Ln" + ], + "countryCode": "US", + "city": "Alexandria", + "zipcode": "VA 22302" + }, + "contact": { + "website": "https://www.woosmap.com", + "phone": "+44 20 7693 4000", + "email": "contact@woosmap.com" + }, + "userProperties": { + "some_user_properties": "associated user value" + }, + "openingHours": { + "timezone": "Europe/London", + "usual": { + "1": [], + "default": [ + { + "start": "08:30", + "end": "22:00" + } ] }, - { - "long_name": "SW1A 2", - "short_name": "SW1A 2", - "types": [ - "postal_code" + "special": { + "2015-02-07": [ + { + "start": "08:00", + "end": "23:00" + } ] } - ], - "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 - } - } } - }, - "status": "OK" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Assets successfully updated", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Success" + }, + "examples": { + "default": { + "summary": "Success response for Stores updated", + "value": { + "status": "success", + "value": "1 stores" + } + } + } + } + } + }, + "400": { + "description": "Invalid. The data is not a valid JSON.", + "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." } } } @@ -453,19 +499,104 @@ } } } + } + }, + "x-codeSamples": [ + { + "lang": "curl", + "label": "cURL", + "source": "curl -L -X PUT 'https://api.woosmap.com/stores?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n--data-raw '{\n \"stores\": [\n {\n \"types\": [\n \"drive\",\n \"click_and_collect\"\n ],\n \"tags\": [\n \"wifi\",\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.719,\n \"lng\": -77.1067\n },\n \"storeId\": \"STORE_ID_123456\",\n \"name\": \"My Cool Store\",\n \"address\": {\n \"lines\": [\n \"698-500\",\n \" Lloyds Ln\"\n ],\n \"countryCode\": \"US\",\n \"city\": \"Alexandria\",\n \"zipcode\": \"VA 22302\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"Europe/London\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"08:00\",\n \"end\": \"23:00\"\n }\n ]\n }\n }\n }\n ]\n}'" }, - "429": { - "description": "Too Many Requests. The rate limit for this endpoint has been exceeded.", + { + "lang": "python", + "label": "Python", + "source": "import requests\nimport json\n\nurl = \"https://api.woosmap.com/stores?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"stores\": [\n {\n \"types\": [\n \"drive\",\n \"click_and_collect\"\n ],\n \"tags\": [\n \"wifi\",\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.719,\n \"lng\": -77.1067\n },\n \"storeId\": \"STORE_ID_123456\",\n \"name\": \"My Cool Store\",\n \"address\": {\n \"lines\": [\n \"698-500\",\n \" Lloyds Ln\"\n ],\n \"countryCode\": \"US\",\n \"city\": \"Alexandria\",\n \"zipcode\": \"VA 22302\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"Europe/London\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"08:00\",\n \"end\": \"23:00\"\n }\n ]\n }\n }\n }\n ]\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + }, + { + "lang": "nodejs", + "label": "NodeJS", + "source": "const axios = require('axios');\nlet data = JSON.stringify({\n \"stores\": [\n {\n \"types\": [\n \"drive\",\n \"click_and_collect\"\n ],\n \"tags\": [\n \"wifi\",\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.719,\n \"lng\": -77.1067\n },\n \"storeId\": \"STORE_ID_123456\",\n \"name\": \"My Cool Store\",\n \"address\": {\n \"lines\": [\n \"698-500\",\n \" Lloyds Ln\"\n ],\n \"countryCode\": \"US\",\n \"city\": \"Alexandria\",\n \"zipcode\": \"VA 22302\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"Europe/London\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"08:00\",\n \"end\": \"23:00\"\n }\n ]\n }\n }\n }\n ]\n});\n\nlet config = {\n method: 'put',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/stores?private_key=YOUR_PRIVATE_API_KEY',\n headers: { \n 'content-type': 'application/json'\n },\n data : data\n};\n\naxios.request(config)\n.then((response) => {\n console.log(JSON.stringify(response.data));\n})\n.catch((error) => {\n console.log(error);\n});\n" + } + ] + }, + "delete": { + "summary": "Delete the Assets", + "operationId": "deleteStores", + "servers": [ + { + "url": "https://api.woosmap.com" + } + ], + "tags": [ + "Data Management" + ], + "description": "Used to delete one or more assets. The `storeId` specified in `query` parameter is the id of the asset to delete. To delete several assets, use the comma as a separator. To delete all project assets, omit the `query` parameter.\n", + "security": [ + { + "Woosmap_Platform_API_Reference_PrivateApiKeyAuth": [] + } + ], + "parameters": [ + { + "name": "query", + "description": "The query to target assets ID to delete", + "in": "query", + "example": "idstore:[{storeId1},{storeId2}]", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Assets successfully deleted", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Error429" + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Success" + }, + "examples": { + "default": { + "summary": "Success response for Stores deleted", + "value": { + "status": "success", + "value": 2 + } + } + } + } + } + }, + "401": { + "description": "Unauthorized. Incorrect authentication 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" + } + } + } + } + } + }, + "403": { + "description": "Forbidden. This Woosmap API is not enabled for this project.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Error403" }, "examples": { "Forbidden": { - "summary": "Error 429", + "summary": "Error 403", "value": { - "detail": "The rate limit for this endpoint has been exceeded" + "detail": "This Woosmap API is not enabled for this project." } } } @@ -477,35 +608,34 @@ { "lang": "curl", "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/address/details/json?public_id=aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0&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/address/details/json?public_id=aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));" + "source": "curl -L -X DELETE 'https://api.woosmap.com/stores/?private_key=YOUR_PRIVATE_API_KEY'" }, { "lang": "python", "label": "Python", - "source": "import requests\n\nurl = \"https://api.woosmap.com/address/details/json?public_id=aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0&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/stores/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"DELETE\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + }, + { + "lang": "nodejs", + "label": "NodeJS", + "source": "const axios = require('axios');\n\nlet config = {\n method: 'delete',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/stores/?private_key=YOUR_PRIVATE_API_KEY',\n headers: { }\n};\n\naxios.request(config)\n.then((response) => {\n console.log(JSON.stringify(response.data));\n})\n.catch((error) => {\n console.log(error);\n});\n" } ] } }, - "/address/geocode/json": { + "/stores/{storeId}": { "get": { - "deprecated": true, - "summary": "Geocode an Address or Reverse Geocode a latlng", - "operationId": "addressGeocode", + "summary": "Get Asset from ID", + "operationId": "getStore", "servers": [ { "url": "https://api.woosmap.com" } ], "tags": [ - "Address API" + "Data Management" ], - "description": "Provides details for an address or a geographic position. Either parameter `address` **or** `latlng` is required. Maximum of 25 queries per second (QPS)\n", + "description": "Used to retrieve an asset from his `storeId`\n", "security": [ { "Woosmap_Platform_API_Reference_PublicApiKeyAuth": [], @@ -520,117 +650,202 @@ ], "parameters": [ { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_address-2" - }, - { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_latlng-2" - }, - { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_address_components" - }, - { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_language-3" - }, - { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_location-2" - }, - { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_cc_format" - }, - { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_limit-3" + "in": "path", + "name": "storeId", + "schema": { + "type": "string" + }, + "required": true, + "example": "STORE_ID_123456", + "description": "ID of the asset to get" } ], "responses": { "200": { - "description": "Request Address Geocode successful", + "description": "Asset successfully retrieved", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AddressGeocodeCollectionResponse" + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AssetFeatureResponse" }, "examples": { "default": { - "summary": "Geocode Results for address `Place de la Resistance` with components `country:FR`", + "summary": "Get a store from its store_id", "value": { - "results": [ - { - "formatted_address": "Place de la Résistance, 75007 Paris, France", - "types": [ - "address", - "route" + "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" ], - "address_components": [ - { - "types": [ - "country" - ], - "long_name": "France", - "short_name": "FRA" - }, - { - "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" - ] - }, + "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": [ { - "long_name": "75007", - "short_name": "75007", - "types": [ - "postal_code" - ] + "end": "20:00", + "start": "05:00" } ], - "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 - } - } + "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" } - ], - "status": "OK" + }, + "geometry": { + "type": "Point", + "coordinates": [ + -122.712924, + 38.41244 + ] + } } } } @@ -673,48 +888,33 @@ } } }, - "429": { - "description": "Too Many Requests. The rate limit for this endpoint has been exceeded.", - "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" - } - } - } - } - } + "404": { + "description": "Not Found - `storeId` do not exist." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/address/geocode/json?address=Place%20de%20la%20Resistance%20Paris&components=country%3AFR&limit=5&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'" + "source": "curl -L 'https://api.woosmap.com/stores/10031/?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/address/geocode/json?address=Place%20de%20la%20Resistance%20Paris&components=country%3AFR&limit=5&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));" + "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/stores/10031/?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/address/geocode/json?address=Place%20de%20la%20Resistance%20Paris&components=country%3AFR&limit=5&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/stores/10031/?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" } ] } }, - "/stores": { + "/stores/replace": { "post": { - "summary": "Create your Assets", - "operationId": "createStores", + "summary": "Replace all assets", + "operationId": "replaceStores", "servers": [ { "url": "https://api.woosmap.com" @@ -723,14 +923,14 @@ "tags": [ "Data Management" ], - "description": "Used to batch create Assets to a specific project identified with the `private_key` parameter.\n", + "description": "To replace all your Assets. This endpoint will delete all previous assets and import assets in request body. During the operation previous assets could always be displayed on map. If the import failed previous assets are not deleted.", "security": [ { "Woosmap_Platform_API_Reference_PrivateApiKeyAuth": [] } ], "requestBody": { - "description": "The request body must of Stores Creation be formatted as JSON.", + "description": "The request body of Stores Replace must be formatted as JSON.", "required": true, "content": { "application/json": { @@ -739,7 +939,7 @@ }, "examples": { "default": { - "summary": "Stores data to create as JSON", + "summary": "Stores Data to replace as JSON", "value": { "stores": [ { @@ -847,7 +1047,7 @@ }, "responses": { "200": { - "description": "Assets successfully created", + "description": "Assets successfully replaced", "content": { "application/json": { "schema": { @@ -855,10 +1055,10 @@ }, "examples": { "default": { - "summary": "Success response for Stores Created", + "summary": "Success response for Stores replaced", "value": { "status": "success", - "value": "2 stores" + "value": "2 stores deleted, 2 stores created" } } } @@ -925,833 +1125,540 @@ { "lang": "curl", "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/stores?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n--data-raw '{\n \"stores\": [\n {\n \"types\": [\n \"drive\",\n \"click_and_collect\"\n ],\n \"tags\": [\n \"wifi\",\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.719,\n \"lng\": -77.1067\n },\n \"storeId\": \"STORE_ID_123456\",\n \"name\": \"My Cool Store\",\n \"address\": {\n \"lines\": [\n \"Building Centre\",\n \"26 Store Street\"\n ],\n \"countryCode\": \"UK\",\n \"city\": \"London\",\n \"zipcode\": \"WC1E 7BT\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"Europe/London\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"08:00\",\n \"end\": \"23:00\"\n }\n ]\n }\n }\n },\n {\n \"types\": [\n \"drive\"\n ],\n \"tags\": [\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.5239,\n \"lng\": -77.0157\n },\n \"storeId\": \"STORE_ID_45678\",\n \"name\": \"My Cool Store 2\",\n \"address\": {\n \"lines\": [\n \"1805-1899\",\n \"Orchard St\"\n ],\n \"countryCode\": \"US\",\n \"city\": \"Alexandria\",\n \"zipcode\": \"22309\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"America/New_York\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n }\n }\n }\n ]\n}'" + "source": "curl -L 'https://api.woosmap.com/stores/replace?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n--data-raw '{\n \"stores\": [\n {\n \"types\": [\n \"drive\",\n \"click_and_collect\"\n ],\n \"tags\": [\n \"wifi\",\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.719,\n \"lng\": -77.1067\n },\n \"storeId\": \"STORE_ID_123456\",\n \"name\": \"My Cool Store\",\n \"address\": {\n \"lines\": [\n \"Building Centre\",\n \"26 Store Street\"\n ],\n \"countryCode\": \"UK\",\n \"city\": \"London\",\n \"zipcode\": \"WC1E 7BT\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"Europe/London\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"08:00\",\n \"end\": \"23:00\"\n }\n ]\n }\n }\n },\n {\n \"types\": [\n \"drive\"\n ],\n \"tags\": [\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.5239,\n \"lng\": -77.0157\n },\n \"storeId\": \"STORE_ID_45678\",\n \"name\": \"My Cool Store 2\",\n \"address\": {\n \"lines\": [\n \"1805-1899\",\n \"Orchard St\"\n ],\n \"countryCode\": \"US\",\n \"city\": \"Alexandria\",\n \"zipcode\": \"22309\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"America/New_York\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n }\n }\n }\n ]\n}'" }, { "lang": "python", "label": "Python", - "source": "import requests\nimport json\n\nurl = \"https://api.woosmap.com/stores?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"stores\": [\n {\n \"types\": [\n \"drive\",\n \"click_and_collect\"\n ],\n \"tags\": [\n \"wifi\",\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.719,\n \"lng\": -77.1067\n },\n \"storeId\": \"STORE_ID_123456\",\n \"name\": \"My Cool Store\",\n \"address\": {\n \"lines\": [\n \"Building Centre\",\n \"26 Store Street\"\n ],\n \"countryCode\": \"UK\",\n \"city\": \"London\",\n \"zipcode\": \"WC1E 7BT\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"Europe/London\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"08:00\",\n \"end\": \"23:00\"\n }\n ]\n }\n }\n },\n {\n \"types\": [\n \"drive\"\n ],\n \"tags\": [\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.5239,\n \"lng\": -77.0157\n },\n \"storeId\": \"STORE_ID_45678\",\n \"name\": \"My Cool Store 2\",\n \"address\": {\n \"lines\": [\n \"1805-1899\",\n \"Orchard St\"\n ],\n \"countryCode\": \"US\",\n \"city\": \"Alexandria\",\n \"zipcode\": \"22309\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"America/New_York\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n }\n }\n }\n ]\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + "source": "import requests\nimport json\n\nurl = \"https://api.woosmap.com/stores/replace?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"stores\": [\n {\n \"types\": [\n \"drive\",\n \"click_and_collect\"\n ],\n \"tags\": [\n \"wifi\",\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.719,\n \"lng\": -77.1067\n },\n \"storeId\": \"STORE_ID_123456\",\n \"name\": \"My Cool Store\",\n \"address\": {\n \"lines\": [\n \"Building Centre\",\n \"26 Store Street\"\n ],\n \"countryCode\": \"UK\",\n \"city\": \"London\",\n \"zipcode\": \"WC1E 7BT\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"Europe/London\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"08:00\",\n \"end\": \"23:00\"\n }\n ]\n }\n }\n },\n {\n \"types\": [\n \"drive\"\n ],\n \"tags\": [\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.5239,\n \"lng\": -77.0157\n },\n \"storeId\": \"STORE_ID_45678\",\n \"name\": \"My Cool Store 2\",\n \"address\": {\n \"lines\": [\n \"1805-1899\",\n \"Orchard St\"\n ],\n \"countryCode\": \"US\",\n \"city\": \"Alexandria\",\n \"zipcode\": \"22309\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"America/New_York\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n }\n }\n }\n ]\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" }, { "lang": "nodejs", "label": "NodeJS", - "source": "const axios = require('axios');\nlet data = JSON.stringify({\n \"stores\": [\n {\n \"types\": [\n \"drive\",\n \"click_and_collect\"\n ],\n \"tags\": [\n \"wifi\",\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.719,\n \"lng\": -77.1067\n },\n \"storeId\": \"STORE_ID_123456\",\n \"name\": \"My Cool Store\",\n \"address\": {\n \"lines\": [\n \"Building Centre\",\n \"26 Store Street\"\n ],\n \"countryCode\": \"UK\",\n \"city\": \"London\",\n \"zipcode\": \"WC1E 7BT\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"Europe/London\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"08:00\",\n \"end\": \"23:00\"\n }\n ]\n }\n }\n },\n {\n \"types\": [\n \"drive\"\n ],\n \"tags\": [\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.5239,\n \"lng\": -77.0157\n },\n \"storeId\": \"STORE_ID_45678\",\n \"name\": \"My Cool Store 2\",\n \"address\": {\n \"lines\": [\n \"1805-1899\",\n \"Orchard St\"\n ],\n \"countryCode\": \"US\",\n \"city\": \"Alexandria\",\n \"zipcode\": \"22309\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"America/New_York\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n }\n }\n }\n ]\n});\n\nlet config = {\n method: 'post',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/stores?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" + "source": "const axios = require('axios');\nlet data = JSON.stringify({\n \"stores\": [\n {\n \"types\": [\n \"drive\",\n \"click_and_collect\"\n ],\n \"tags\": [\n \"wifi\",\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.719,\n \"lng\": -77.1067\n },\n \"storeId\": \"STORE_ID_123456\",\n \"name\": \"My Cool Store\",\n \"address\": {\n \"lines\": [\n \"Building Centre\",\n \"26 Store Street\"\n ],\n \"countryCode\": \"UK\",\n \"city\": \"London\",\n \"zipcode\": \"WC1E 7BT\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"Europe/London\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"08:00\",\n \"end\": \"23:00\"\n }\n ]\n }\n }\n },\n {\n \"types\": [\n \"drive\"\n ],\n \"tags\": [\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.5239,\n \"lng\": -77.0157\n },\n \"storeId\": \"STORE_ID_45678\",\n \"name\": \"My Cool Store 2\",\n \"address\": {\n \"lines\": [\n \"1805-1899\",\n \"Orchard St\"\n ],\n \"countryCode\": \"US\",\n \"city\": \"Alexandria\",\n \"zipcode\": \"22309\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"America/New_York\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n }\n }\n }\n ]\n});\n\nlet config = {\n method: 'post',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/stores/replace?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" } ] - }, - "put": { - "summary": "Update the Assets", - "operationId": "updateStores", - "servers": [ - { - "url": "https://api.woosmap.com" - } - ], + } + }, + "/datasets/{dataset_id}": { + "get": { "tags": [ - "Data Management" + "Datasets API" ], - "description": "Used to update assets in batch. `storeId` must exists when using `PUT` method, if one asset does not exists, the batch will be refused.", + "summary": "Get Dataset", + "description": "Gets dataset details.\n\n**Rate limit**: `1/1s`\n\n**Ratelimit:** 1/1s", + "operationId": "get_dataset_datasets__dataset_id__get", "security": [ { - "Woosmap_Platform_API_Reference_PrivateApiKeyAuth": [] + "Datasets_PrivateKeyWithWrite": [] + }, + { + "Datasets_PrivateKeyWithWriteHeader": [] } ], - "requestBody": { - "description": "The request body of Stores Update must be formatted as JSON.", - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AssetsCollectionRequest" - }, - "examples": { - "default": { - "summary": "Stores data to update as JSON", - "value": { - "stores": [ - { - "types": [ - "drive", - "click_and_collect" - ], - "tags": [ - "wifi", - "covered_parking" - ], - "location": { - "lat": 38.719, - "lng": -77.1067 - }, - "storeId": "STORE_ID_123456", - "name": "My Cool Store", - "address": { - "lines": [ - "698-500", - " Lloyds Ln" - ], - "countryCode": "US", - "city": "Alexandria", - "zipcode": "VA 22302" - }, - "contact": { - "website": "https://www.woosmap.com", - "phone": "+44 20 7693 4000", - "email": "contact@woosmap.com" - }, - "userProperties": { - "some_user_properties": "associated user value" - }, - "openingHours": { - "timezone": "Europe/London", - "usual": { - "1": [], - "default": [ - { - "start": "08:30", - "end": "22:00" - } - ] - }, - "special": { - "2015-02-07": [ - { - "start": "08:00", - "end": "23:00" - } - ] - } - } - } - ] - } - } - } + "parameters": [ + { + "name": "dataset_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Dataset Id" } } - }, + ], "responses": { "200": { - "description": "Assets successfully updated", + "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Success" - }, - "examples": { - "default": { - "summary": "Success response for Stores updated", - "value": { - "status": "success", - "value": "1 stores" - } - } + "$ref": "#/components/schemas/Datasets_DatasetResponse" } } } }, - "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/Datasets_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/Datasets_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/Datasets_AuthenticationErrorResponse" + } + } + } + }, + "404": { + "description": "Dataset was not found", + "content": { + "application/json": { + "schema": { + "$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" } } } } }, + "x-ratelimit-limit": 1, + "x-ratelimit-window-seconds": 1, "x-codeSamples": [ { "lang": "curl", "label": "cURL", - "source": "curl -L -X PUT 'https://api.woosmap.com/stores?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n--data-raw '{\n \"stores\": [\n {\n \"types\": [\n \"drive\",\n \"click_and_collect\"\n ],\n \"tags\": [\n \"wifi\",\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.719,\n \"lng\": -77.1067\n },\n \"storeId\": \"STORE_ID_123456\",\n \"name\": \"My Cool Store\",\n \"address\": {\n \"lines\": [\n \"698-500\",\n \" Lloyds Ln\"\n ],\n \"countryCode\": \"US\",\n \"city\": \"Alexandria\",\n \"zipcode\": \"VA 22302\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"Europe/London\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"08:00\",\n \"end\": \"23:00\"\n }\n ]\n }\n }\n }\n ]\n}'" + "source": "curl -L 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0?private_key=YOUR_PRIVATE_API_KEY'" }, { - "lang": "python", - "label": "Python", - "source": "import requests\nimport json\n\nurl = \"https://api.woosmap.com/stores?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"stores\": [\n {\n \"types\": [\n \"drive\",\n \"click_and_collect\"\n ],\n \"tags\": [\n \"wifi\",\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.719,\n \"lng\": -77.1067\n },\n \"storeId\": \"STORE_ID_123456\",\n \"name\": \"My Cool Store\",\n \"address\": {\n \"lines\": [\n \"698-500\",\n \" Lloyds Ln\"\n ],\n \"countryCode\": \"US\",\n \"city\": \"Alexandria\",\n \"zipcode\": \"VA 22302\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"Europe/London\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"08:00\",\n \"end\": \"23:00\"\n }\n ]\n }\n }\n }\n ]\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + "lang": "javascript", + "label": "JavaScript", + "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0?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": "nodejs", - "label": "NodeJS", - "source": "const axios = require('axios');\nlet data = JSON.stringify({\n \"stores\": [\n {\n \"types\": [\n \"drive\",\n \"click_and_collect\"\n ],\n \"tags\": [\n \"wifi\",\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.719,\n \"lng\": -77.1067\n },\n \"storeId\": \"STORE_ID_123456\",\n \"name\": \"My Cool Store\",\n \"address\": {\n \"lines\": [\n \"698-500\",\n \" Lloyds Ln\"\n ],\n \"countryCode\": \"US\",\n \"city\": \"Alexandria\",\n \"zipcode\": \"VA 22302\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"Europe/London\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"08:00\",\n \"end\": \"23:00\"\n }\n ]\n }\n }\n }\n ]\n});\n\nlet config = {\n method: 'put',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/stores?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": "python", + "label": "Python", + "source": "import requests\n\nurl = \"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } - ] + ], + "x-original-tag": "dataset" }, "delete": { - "summary": "Delete the Assets", - "operationId": "deleteStores", - "servers": [ - { - "url": "https://api.woosmap.com" - } - ], "tags": [ - "Data Management" + "Datasets API" ], - "description": "Used to delete one or more assets. The `storeId` specified in `query` parameter is the id of the asset to delete. To delete several assets, use the comma as a separator. To delete all project assets, omit the `query` parameter.\n", + "summary": "Delete Dataset", + "description": "Schedule a dataset for deletion, deletion will happen in 7 days.\n\n\n**Rate limit**: `1/1s`\n\n**Ratelimit:** 1/1s", + "operationId": "delete_dataset_datasets__dataset_id__delete", "security": [ { - "Woosmap_Platform_API_Reference_PrivateApiKeyAuth": [] + "Datasets_PrivateKeyWithWrite": [] + }, + { + "Datasets_PrivateKeyWithWriteHeader": [] } ], "parameters": [ { - "name": "query", - "description": "The query to target assets ID to delete", - "in": "query", - "example": "idstore:[{storeId1},{storeId2}]", + "name": "dataset_id", + "in": "path", + "required": true, "schema": { - "type": "string" + "type": "string", + "format": "uuid", + "title": "Dataset Id" } } ], "responses": { "200": { - "description": "Assets successfully deleted", + "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Success" - }, - "examples": { - "default": { - "summary": "Success response for Stores deleted", - "value": { - "status": "success", - "value": 2 - } - } + "type": "object", + "additionalProperties": true, + "title": "Response Delete Dataset Datasets Dataset Id Delete" } } } }, "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/Datasets_AuthenticationErrorResponse" + } + } + } + }, + "402": { + "description": "Out of free quota.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Datasets_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/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": "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" } } } } }, + "x-ratelimit-limit": 1, + "x-ratelimit-window-seconds": 1, "x-codeSamples": [ { "lang": "curl", "label": "cURL", - "source": "curl -L -X DELETE 'https://api.woosmap.com/stores/?private_key=YOUR_PRIVATE_API_KEY'" + "source": "curl -L -X DELETE 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0?private_key=YOUR_PRIVATE_API_KEY'" }, { - "lang": "python", - "label": "Python", - "source": "import requests\n\nurl = \"https://api.woosmap.com/stores/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"DELETE\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + "lang": "javascript", + "label": "JavaScript", + "source": "const requestOptions = {\n method: \"DELETE\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0?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": "nodejs", - "label": "NodeJS", - "source": "const axios = require('axios');\n\nlet config = {\n method: 'delete',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/stores/?private_key=YOUR_PRIVATE_API_KEY',\n headers: { }\n};\n\naxios.request(config)\n.then((response) => {\n console.log(JSON.stringify(response.data));\n})\n.catch((error) => {\n console.log(error);\n});\n" - } - ] - } - }, - "/stores/{storeId}": { - "get": { - "summary": "Get Asset from ID", - "operationId": "getStore", - "servers": [ - { - "url": "https://api.woosmap.com" + "lang": "python", + "label": "Python", + "source": "import requests\n\nurl = \"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"DELETE\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], + "x-original-tag": "dataset" + }, + "put": { "tags": [ - "Data Management" + "Datasets API" ], - "description": "Used to retrieve an asset from his `storeId`\n", + "summary": "Update Dataset", + "description": "Updates a dataset url or name.\n\n**Rate limit**: `1/1s`\n\n**Ratelimit:** 1/1s", + "operationId": "update_dataset_datasets__dataset_id__put", "security": [ { - "Woosmap_Platform_API_Reference_PublicApiKeyAuth": [], - "Woosmap_Platform_API_Reference_RefererHeader": [] - }, - { - "Woosmap_Platform_API_Reference_PrivateApiKeyAuth": [] + "Datasets_PrivateKeyWithWrite": [] }, { - "Woosmap_Platform_API_Reference_PrivateApiKeyHeaderAuth": [] + "Datasets_PrivateKeyWithWriteHeader": [] } ], "parameters": [ { + "name": "dataset_id", "in": "path", - "name": "storeId", - "schema": { - "type": "string" - }, "required": true, - "example": "STORE_ID_123456", - "description": "ID of the asset to get" + "schema": { + "type": "string", + "format": "uuid", + "title": "Dataset Id" + } } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Datasets_DatasetUpdate" + } + } + } + }, "responses": { "200": { - "description": "Asset successfully retrieved", + "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AssetFeatureResponse" - }, - "examples": { - "default": { - "summary": "Get a store from its store_id", - "value": { - "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 - ] - } - } - } + "$ref": "#/components/schemas/Datasets_DatasetResponse" } } } }, "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/Datasets_AuthenticationErrorResponse" + } + } + } + }, + "402": { + "description": "Out of free quota.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Datasets_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/Datasets_AuthenticationErrorResponse" } } } }, "404": { - "description": "Not Found - `storeId` do not exist." + "description": "Dataset was not found", + "content": { + "application/json": { + "schema": { + "$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" + } + } + } } }, + "x-ratelimit-limit": 1, + "x-ratelimit-window-seconds": 1, "x-codeSamples": [ { "lang": "curl", "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/stores/10031/?key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'" + "source": "curl -L -X PUT 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"name\": \"string\",\n \"url\": \"http://example.com\"\n}'" }, { "lang": "javascript", "label": "JavaScript", - "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/stores/10031/?key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));" + "source": "const myHeaders = new Headers();\nmyHeaders.append(\"content-type\", \"application/json\");\n\nconst raw = JSON.stringify({\n \"name\": \"string\",\n \"url\": \"http://example.com\"\n});\n\nconst requestOptions = {\n method: \"PUT\",\n headers: myHeaders,\n body: raw,\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0?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/stores/10031/?key=YOUR_PUBLIC_API_KEY\"\n\npayload = {}\nheaders = {\n 'Referer': 'http://localhost'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + "source": "import requests\nimport json\n\nurl = \"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"name\": \"string\",\n \"url\": \"http://example.com\"\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } - ] + ], + "x-original-tag": "dataset" } }, - "/stores/replace": { - "post": { - "summary": "Replace all assets", - "operationId": "replaceStores", - "servers": [ - { - "url": "https://api.woosmap.com" - } - ], + "/datasets/": { + "get": { "tags": [ - "Data Management" + "Datasets API" ], - "description": "To replace all your Assets. This endpoint will delete all previous assets and import assets in request body. During the operation previous assets could always be displayed on map. If the import failed previous assets are not deleted.", + "summary": "List Datasets", + "description": "Lists datasets.\n\n**Rate limit**: `1/1s`\n\n**Ratelimit:** 1/1s", + "operationId": "list_datasets_datasets__get", "security": [ { - "Woosmap_Platform_API_Reference_PrivateApiKeyAuth": [] + "Datasets_PrivateKeyWithWrite": [] + }, + { + "Datasets_PrivateKeyWithWriteHeader": [] } ], - "requestBody": { - "description": "The request body of Stores Replace must be formatted as JSON.", - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AssetsCollectionRequest" - }, - "examples": { - "default": { - "summary": "Stores Data to replace as JSON", - "value": { - "stores": [ - { - "types": [ - "drive", - "click_and_collect" - ], - "tags": [ - "wifi", - "covered_parking" - ], - "location": { - "lat": 38.719, - "lng": -77.1067 - }, - "storeId": "STORE_ID_123456", - "name": "My Cool Store", - "address": { - "lines": [ - "Building Centre", - "26 Store Street" - ], - "countryCode": "UK", - "city": "London", - "zipcode": "WC1E 7BT" - }, - "contact": { - "website": "https://www.woosmap.com", - "phone": "+44 20 7693 4000", - "email": "contact@woosmap.com" - }, - "userProperties": { - "some_user_properties": "associated user value" - }, - "openingHours": { - "timezone": "Europe/London", - "usual": { - "1": [], - "default": [ - { - "start": "08:30", - "end": "22:00" - } - ] - }, - "special": { - "2015-02-07": [ - { - "start": "08:00", - "end": "23:00" - } - ] - } - } - }, - { - "types": [ - "drive" - ], - "tags": [ - "covered_parking" - ], - "location": { - "lat": 38.5239, - "lng": -77.0157 - }, - "storeId": "STORE_ID_45678", - "name": "My Cool Store 2", - "address": { - "lines": [ - "1805-1899", - "Orchard St" - ], - "countryCode": "US", - "city": "Alexandria", - "zipcode": "22309" - }, - "contact": { - "website": "https://www.woosmap.com", - "phone": "+44 20 7693 4000", - "email": "contact@woosmap.com" - }, - "userProperties": { - "some_user_properties": "associated user value" - }, - "openingHours": { - "timezone": "America/New_York", - "usual": { - "1": [], - "default": [ - { - "start": "08:30", - "end": "22:00" - } - ] - } - } - } - ] - } - } - } - } + "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, + "schema": { + "type": "integer", + "minimum": 1, + "description": "The result page to fetch.", + "default": 1, + "title": "Page" + }, + "description": "The result page to fetch." } - }, + ], "responses": { "200": { - "description": "Assets successfully replaced", + "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Success" - }, - "examples": { - "default": { - "summary": "Success response for Stores replaced", - "value": { - "status": "success", - "value": "2 stores deleted, 2 stores created" - } - } + "$ref": "#/components/schemas/Datasets_DatasetListResponse" } } } }, - "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/Datasets_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/Datasets_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/Datasets_AuthenticationErrorResponse" + } + } + } + }, + "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" } } } } }, + "x-ratelimit-limit": 1, + "x-ratelimit-window-seconds": 1, "x-codeSamples": [ { "lang": "curl", "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/stores/replace?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n--data-raw '{\n \"stores\": [\n {\n \"types\": [\n \"drive\",\n \"click_and_collect\"\n ],\n \"tags\": [\n \"wifi\",\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.719,\n \"lng\": -77.1067\n },\n \"storeId\": \"STORE_ID_123456\",\n \"name\": \"My Cool Store\",\n \"address\": {\n \"lines\": [\n \"Building Centre\",\n \"26 Store Street\"\n ],\n \"countryCode\": \"UK\",\n \"city\": \"London\",\n \"zipcode\": \"WC1E 7BT\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"Europe/London\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"08:00\",\n \"end\": \"23:00\"\n }\n ]\n }\n }\n },\n {\n \"types\": [\n \"drive\"\n ],\n \"tags\": [\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.5239,\n \"lng\": -77.0157\n },\n \"storeId\": \"STORE_ID_45678\",\n \"name\": \"My Cool Store 2\",\n \"address\": {\n \"lines\": [\n \"1805-1899\",\n \"Orchard St\"\n ],\n \"countryCode\": \"US\",\n \"city\": \"Alexandria\",\n \"zipcode\": \"22309\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"America/New_York\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n }\n }\n }\n ]\n}'" + "source": "curl -L 'https://api.woosmap.com/datasets/?private_key=YOUR_PRIVATE_API_KEY'" }, { - "lang": "python", - "label": "Python", - "source": "import requests\nimport json\n\nurl = \"https://api.woosmap.com/stores/replace?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"stores\": [\n {\n \"types\": [\n \"drive\",\n \"click_and_collect\"\n ],\n \"tags\": [\n \"wifi\",\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.719,\n \"lng\": -77.1067\n },\n \"storeId\": \"STORE_ID_123456\",\n \"name\": \"My Cool Store\",\n \"address\": {\n \"lines\": [\n \"Building Centre\",\n \"26 Store Street\"\n ],\n \"countryCode\": \"UK\",\n \"city\": \"London\",\n \"zipcode\": \"WC1E 7BT\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"Europe/London\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"08:00\",\n \"end\": \"23:00\"\n }\n ]\n }\n }\n },\n {\n \"types\": [\n \"drive\"\n ],\n \"tags\": [\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.5239,\n \"lng\": -77.0157\n },\n \"storeId\": \"STORE_ID_45678\",\n \"name\": \"My Cool Store 2\",\n \"address\": {\n \"lines\": [\n \"1805-1899\",\n \"Orchard St\"\n ],\n \"countryCode\": \"US\",\n \"city\": \"Alexandria\",\n \"zipcode\": \"22309\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"America/New_York\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n }\n }\n }\n ]\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + "lang": "javascript", + "label": "JavaScript", + "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/?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": "nodejs", - "label": "NodeJS", - "source": "const axios = require('axios');\nlet data = JSON.stringify({\n \"stores\": [\n {\n \"types\": [\n \"drive\",\n \"click_and_collect\"\n ],\n \"tags\": [\n \"wifi\",\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.719,\n \"lng\": -77.1067\n },\n \"storeId\": \"STORE_ID_123456\",\n \"name\": \"My Cool Store\",\n \"address\": {\n \"lines\": [\n \"Building Centre\",\n \"26 Store Street\"\n ],\n \"countryCode\": \"UK\",\n \"city\": \"London\",\n \"zipcode\": \"WC1E 7BT\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"Europe/London\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"08:00\",\n \"end\": \"23:00\"\n }\n ]\n }\n }\n },\n {\n \"types\": [\n \"drive\"\n ],\n \"tags\": [\n \"covered_parking\"\n ],\n \"location\": {\n \"lat\": 38.5239,\n \"lng\": -77.0157\n },\n \"storeId\": \"STORE_ID_45678\",\n \"name\": \"My Cool Store 2\",\n \"address\": {\n \"lines\": [\n \"1805-1899\",\n \"Orchard St\"\n ],\n \"countryCode\": \"US\",\n \"city\": \"Alexandria\",\n \"zipcode\": \"22309\"\n },\n \"contact\": {\n \"website\": \"https://www.woosmap.com\",\n \"phone\": \"+44 20 7693 4000\",\n \"email\": \"contact@woosmap.com\"\n },\n \"userProperties\": {\n \"some_user_properties\": \"associated user value\"\n },\n \"openingHours\": {\n \"timezone\": \"America/New_York\",\n \"usual\": {\n \"1\": [],\n \"default\": [\n {\n \"start\": \"08:30\",\n \"end\": \"22:00\"\n }\n ]\n }\n }\n }\n ]\n});\n\nlet config = {\n method: 'post',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/stores/replace?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": "python", + "label": "Python", + "source": "import requests\n\nurl = \"https://api.woosmap.com/datasets/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } - ] - } - }, - "/datasets/{dataset_id}": { - "get": { + ], + "x-original-tag": "dataset" + }, + "post": { "tags": [ "Datasets API" ], - "summary": "Get Dataset", - "description": "Gets dataset details.\n\n**Rate limit**: `1/1s`", - "operationId": "get_dataset_datasets__dataset_id__get", + "summary": "Create Dataset", + "description": "Creates a dataset.\n\n**Rate limit**: `1/1s`\n\n**Ratelimit:** 1/1s", + "operationId": "create_dataset_datasets__post", "security": [ { "Datasets_PrivateKeyWithWrite": [] @@ -1760,18 +1667,16 @@ "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", @@ -1813,16 +1718,6 @@ } } }, - "404": { - "description": "Dataset was not found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel" - } - } - } - }, "422": { "description": "Validation Error", "content": { @@ -1844,32 +1739,36 @@ } } }, + "x-ratelimit-limit": 1, + "x-ratelimit-window-seconds": 1, "x-codeSamples": [ { "lang": "curl", "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0?private_key=YOUR_PRIVATE_API_KEY'" + "source": "curl -L 'https://api.woosmap.com/datasets/?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"name\": \"string\",\n \"url\": \"http://example.com\",\n \"schema_mapping\": [\n {\n \"schema_key\": \"title\",\n \"data_key\": \"string\"\n }\n ]\n}'" }, { "lang": "javascript", "label": "JavaScript", - "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0?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": "const myHeaders = new Headers();\nmyHeaders.append(\"content-type\", \"application/json\");\n\nconst raw = JSON.stringify({\n \"name\": \"string\",\n \"url\": \"http://example.com\",\n \"schema_mapping\": [\n {\n \"schema_key\": \"title\",\n \"data_key\": \"string\"\n }\n ]\n});\n\nconst requestOptions = {\n method: \"POST\",\n headers: myHeaders,\n body: raw,\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/?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/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0?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\nimport json\n\nurl = \"https://api.woosmap.com/datasets/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"name\": \"string\",\n \"url\": \"http://example.com\",\n \"schema_mapping\": [\n {\n \"schema_key\": \"title\",\n \"data_key\": \"string\"\n }\n ]\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "x-original-tag": "dataset" - }, - "delete": { + } + }, + "/datasets/{dataset_id}/status": { + "get": { "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": "Get Dataset Status", + "description": "Returns the dataset import status.\n\n**Rate limit**: `1/5s`\n\n**Ratelimit:** 1/5s", + "operationId": "get_dataset_status_datasets__dataset_id__status_get", "security": [ { "Datasets_PrivateKeyWithWrite": [] @@ -1896,9 +1795,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "additionalProperties": true, - "title": "Response Delete Dataset Datasets Dataset Id Delete" + "$ref": "#/components/schemas/Datasets_DatasetStatusResponse" } } } @@ -1943,16 +1840,6 @@ } } }, - "409": { - "description": "The Dataset was already scheduled for deletion.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel" - } - } - } - }, "422": { "description": "Validation Error", "content": { @@ -1974,32 +1861,36 @@ } } }, + "x-ratelimit-limit": 1, + "x-ratelimit-window-seconds": 5, "x-codeSamples": [ { "lang": "curl", "label": "cURL", - "source": "curl -L -X DELETE 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0?private_key=YOUR_PRIVATE_API_KEY'" + "source": "curl -L 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/status?private_key=YOUR_PRIVATE_API_KEY'" }, { "lang": "javascript", "label": "JavaScript", - "source": "const requestOptions = {\n method: \"DELETE\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0?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": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/status?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/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"DELETE\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + "source": "import requests\n\nurl = \"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/status?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "x-original-tag": "dataset" - }, - "put": { + } + }, + "/datasets/{dataset_id}/import": { + "post": { "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": "Trigger Import", + "description": "Trigger the dataset import.\n\n**Rate limit**: `1/90s`\n\n**Ratelimit:** 1/90s", + "operationId": "trigger_import_datasets__dataset_id__import_post", "security": [ { "Datasets_PrivateKeyWithWrite": [] @@ -2020,23 +1911,13 @@ } } ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Datasets_DatasetUpdate" - } - } - } - }, "responses": { - "200": { + "202": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Datasets_DatasetResponse" + "$ref": "#/components/schemas/Datasets_ImportResponse" } } } @@ -2102,108 +1983,74 @@ } } }, + "x-ratelimit-limit": 1, + "x-ratelimit-window-seconds": 90, "x-codeSamples": [ { "lang": "curl", "label": "cURL", - "source": "curl -L -X PUT 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"name\": \"string\",\n \"url\": \"http://example.com\"\n}'" + "source": "curl -L 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/import?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{}'" }, { "lang": "javascript", "label": "JavaScript", - "source": "const myHeaders = new Headers();\nmyHeaders.append(\"content-type\", \"application/json\");\n\nconst raw = JSON.stringify({\n \"name\": \"string\",\n \"url\": \"http://example.com\"\n});\n\nconst requestOptions = {\n method: \"PUT\",\n headers: myHeaders,\n body: raw,\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0?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": "const myHeaders = new Headers();\nmyHeaders.append(\"content-type\", \"application/json\");\n\nconst raw = JSON.stringify({});\n\nconst requestOptions = {\n method: \"POST\",\n headers: myHeaders,\n body: raw,\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/import?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\nimport json\n\nurl = \"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"name\": \"string\",\n \"url\": \"http://example.com\"\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + "source": "import requests\nimport json\n\nurl = \"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/import?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "x-original-tag": "dataset" } }, - "/datasets/": { - "get": { + "/datasets/hooks/reimport/{reimport_key}": { + "post": { "tags": [ "Datasets API" ], - "summary": "List Datasets", - "description": "Lists datasets.\n\n**Rate limit**: `1/1s`", - "operationId": "list_datasets_datasets__get", - "security": [ - { - "Datasets_PrivateKeyWithWrite": [] - }, - { - "Datasets_PrivateKeyWithWriteHeader": [] - } - ], + "summary": "Reimport Dataset Webhook", + "description": "Triggers the reimport of the dataset linked to the dataset.\n\n**Rate limit**: `1/90s`\n\n**Ratelimit:** 1/90s", + "operationId": "reimport_dataset_webhook_datasets_hooks_reimport__reimport_key__post", "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": "reimport_key", + "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": "Reimport Key" + } } ], "responses": { - "200": { + "202": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Datasets_DatasetListResponse" + "$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" } } } @@ -2229,38 +2076,99 @@ } } }, + "x-ratelimit-limit": 1, + "x-ratelimit-window-seconds": 90, "x-codeSamples": [ { "lang": "curl", "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/datasets/?private_key=YOUR_PRIVATE_API_KEY'" + "source": "curl -L 'https://api.woosmap.com/datasets/hooks/reimport/my_reimport_key?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{}'" }, { "lang": "javascript", "label": "JavaScript", - "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/?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": "const myHeaders = new Headers();\nmyHeaders.append(\"content-type\", \"application/json\");\n\nconst raw = JSON.stringify({});\n\nconst requestOptions = {\n method: \"POST\",\n headers: myHeaders,\n body: raw,\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/hooks/reimport/my_reimport_key?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/datasets/?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\nimport json\n\nurl = \"https://api.woosmap.com/datasets/hooks/reimport/my_reimport_key?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], + "security": [], "x-original-tag": "dataset" - }, + } + }, + "/datasets/{dataset_id}/features/search/": { "post": { "tags": [ "Datasets API" ], - "summary": "Create Dataset", - "description": "Creates a dataset.\n\n**Rate limit**: `1/1s`", - "operationId": "create_dataset_datasets__post", + "summary": "Search Features", + "description": "Search for features.\n\n**Rate limit**: `20/1s`\n\n**Ratelimit:** 20/1s", + "operationId": "search_features_datasets__dataset_id__features_search__post", "security": [ { - "Datasets_PrivateKeyWithWrite": [] + "Datasets_PublicAPIKey": [] }, { - "Datasets_PrivateKeyWithWriteHeader": [] + "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": "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": { @@ -2268,7 +2176,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Datasets_DatasetCreateRequest" + "$ref": "#/components/schemas/Datasets_SearchRequest" } } } @@ -2279,7 +2187,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Datasets_DatasetResponse" + "$ref": "#/components/schemas/Datasets_SearchResultResponse" } } } @@ -2314,6 +2222,16 @@ } } }, + "404": { + "description": "Dataset was not found", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Datasets_features__internal__responses__HTTPErrorModel" + } + } + } + }, "422": { "description": "Validation Error", "content": { @@ -2335,40 +2253,45 @@ } } }, + "x-ratelimit-limit": 20, + "x-ratelimit-window-seconds": 1, "x-codeSamples": [ { "lang": "curl", "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/datasets/?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"name\": \"string\",\n \"url\": \"http://example.com\",\n \"schema_mapping\": [\n {\n \"schema_key\": \"title\",\n \"data_key\": \"string\"\n }\n ]\n}'" + "source": "curl -L 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/search/?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"where\": \"cost_col:>32.3\"\n}'" }, { "lang": "javascript", "label": "JavaScript", - "source": "const myHeaders = new Headers();\nmyHeaders.append(\"content-type\", \"application/json\");\n\nconst raw = JSON.stringify({\n \"name\": \"string\",\n \"url\": \"http://example.com\",\n \"schema_mapping\": [\n {\n \"schema_key\": \"title\",\n \"data_key\": \"string\"\n }\n ]\n});\n\nconst requestOptions = {\n method: \"POST\",\n headers: myHeaders,\n body: raw,\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/?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": "const myHeaders = new Headers();\nmyHeaders.append(\"content-type\", \"application/json\");\n\nconst raw = JSON.stringify({\n \"where\": \"cost_col:>32.3\"\n});\n\nconst requestOptions = {\n method: \"POST\",\n headers: myHeaders,\n body: raw,\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/search/?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\nimport json\n\nurl = \"https://api.woosmap.com/datasets/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"name\": \"string\",\n \"url\": \"http://example.com\",\n \"schema_mapping\": [\n {\n \"schema_key\": \"title\",\n \"data_key\": \"string\"\n }\n ]\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + "source": "import requests\nimport json\n\nurl = \"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/search/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"where\": \"cost_col:>32.3\"\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], - "x-original-tag": "dataset" + "x-original-tag": "search" } }, - "/datasets/{dataset_id}/status": { - "get": { + "/datasets/{dataset_id}/features/nearby/": { + "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": "Nearby Features", + "description": "Search for features nearby geometry.\n\n**Rate limit**: `20/1s`\n\n**Ratelimit:** 20/1s", + "operationId": "nearby_features_datasets__dataset_id__features_nearby__post", "security": [ { - "Datasets_PrivateKeyWithWrite": [] + "Datasets_PublicAPIKey": [] }, { - "Datasets_PrivateKeyWithWriteHeader": [] + "Datasets_PrivateApiKey": [] + }, + { + "Datasets_PrivateApiKeyHeader": [] } ], "parameters": [ @@ -2381,135 +2304,152 @@ "format": "uuid", "title": "Dataset Id" } - } - ], - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Datasets_DatasetStatusResponse" - } - } - } }, - "401": { - "description": "Unable to locate credentials.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Datasets_AuthenticationErrorResponse" - } - } + { + "name": "format", + "in": "query", + "required": false, + "schema": { + "enum": [ + "geojson", + "wkb" + ], + "type": "string", + "default": "geojson", + "title": "Format" } }, - "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_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" - } - } - } - } - }, - "x-codeSamples": [ - { - "lang": "curl", - "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/status?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/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/status?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/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/status?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" - } - ], - "x-original-tag": "dataset" - } - }, - "/datasets/{dataset_id}/import": { - "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", - "security": [ - { - "Datasets_PrivateKeyWithWrite": [] + { + "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." }, { - "Datasets_PrivateKeyWithWriteHeader": [] + "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." } ], - "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_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" + } + } + } } } - ], + }, "responses": { - "202": { + "200": { "description": "Successful Response", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Datasets_ImportResponse" + "$ref": "#/components/schemas/Datasets_SearchResultResponse" } } } @@ -2575,160 +2515,70 @@ } } }, + "x-ratelimit-limit": 20, + "x-ratelimit-window-seconds": 1, "x-codeSamples": [ { "lang": "curl", "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/import?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{}'" + "source": "curl -L 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/nearby/?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 3.883,\n 43.6\n ]\n },\n \"buffer\": 5000\n}'" }, { "lang": "javascript", "label": "JavaScript", - "source": "const myHeaders = new Headers();\nmyHeaders.append(\"content-type\", \"application/json\");\n\nconst raw = JSON.stringify({});\n\nconst requestOptions = {\n method: \"POST\",\n headers: myHeaders,\n body: raw,\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/import?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": "const myHeaders = new Headers();\nmyHeaders.append(\"content-type\", \"application/json\");\n\nconst raw = JSON.stringify({\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 3.883,\n 43.6\n ]\n },\n \"buffer\": 5000\n});\n\nconst requestOptions = {\n method: \"POST\",\n headers: myHeaders,\n body: raw,\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/nearby/?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\nimport json\n\nurl = \"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/import?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({})\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\nimport json\n\nurl = \"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/nearby/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 3.883,\n 43.6\n ]\n },\n \"buffer\": 5000\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], - "x-original-tag": "dataset" + "x-original-tag": "search" } }, - "/datasets/hooks/reimport/{reimport_key}": { + "/datasets/{dataset_id}/features/intersects/": { "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", + "summary": "Intersect Features", + "description": "Returns the features that are intersecting with geometry.\n\n**Rate limit**: `20/1s`\n\n![Intersection](https://postgis.net/workshops/postgis-intro/_images/st_intersects.png)\n\n**Ratelimit:** 20/1s", + "operationId": "intersect_features_datasets__dataset_id__features_intersects__post", + "security": [ + { + "Datasets_PublicAPIKey": [] + }, + { + "Datasets_PrivateApiKey": [] + }, + { + "Datasets_PrivateApiKeyHeader": [] + } + ], "parameters": [ { - "name": "reimport_key", + "name": "dataset_id", "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" - } - } + "title": "Dataset Id" } }, - "401": { - "description": "Unauthorized" - }, - "402": { - "description": "Payment Required" - }, - "403": { - "description": "Forbidden" - }, - "404": { - "description": "Dataset was not found", - "content": { - "application/json": { - "schema": { - "$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" - } - } - } - } - }, - "x-codeSamples": [ - { - "lang": "curl", - "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/datasets/hooks/reimport/my_reimport_key?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{}'" - }, - { - "lang": "javascript", - "label": "JavaScript", - "source": "const myHeaders = new Headers();\nmyHeaders.append(\"content-type\", \"application/json\");\n\nconst raw = JSON.stringify({});\n\nconst requestOptions = {\n method: \"POST\",\n headers: myHeaders,\n body: raw,\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/hooks/reimport/my_reimport_key?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\nimport json\n\nurl = \"https://api.woosmap.com/datasets/hooks/reimport/my_reimport_key?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" - } - ], - "security": [], - "x-original-tag": "dataset" - } - }, - "/datasets/{dataset_id}/features/search/": { - "post": { - "tags": [ - "Datasets API" - ], - "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" } }, { @@ -2764,7 +2614,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" + } + } } } } @@ -2841,34 +2777,36 @@ } } }, + "x-ratelimit-limit": 20, + "x-ratelimit-window-seconds": 1, "x-codeSamples": [ { "lang": "curl", "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/search/?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"where\": \"cost_col:>32.3\"\n}'" + "source": "curl -L 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/intersects/?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n 2.3522,\n 48.8566\n ],\n [\n 2.3622,\n 48.8566\n ],\n [\n 2.3622,\n 48.8666\n ],\n [\n 2.3522,\n 48.8666\n ],\n [\n 2.3522,\n 48.8566\n ]\n ]\n ]\n }\n}'" }, { "lang": "javascript", "label": "JavaScript", - "source": "const myHeaders = new Headers();\nmyHeaders.append(\"content-type\", \"application/json\");\n\nconst raw = JSON.stringify({\n \"where\": \"cost_col:>32.3\"\n});\n\nconst requestOptions = {\n method: \"POST\",\n headers: myHeaders,\n body: raw,\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/search/?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": "const myHeaders = new Headers();\nmyHeaders.append(\"content-type\", \"application/json\");\n\nconst raw = JSON.stringify({\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n 2.3522,\n 48.8566\n ],\n [\n 2.3622,\n 48.8566\n ],\n [\n 2.3622,\n 48.8666\n ],\n [\n 2.3522,\n 48.8666\n ],\n [\n 2.3522,\n 48.8566\n ]\n ]\n ]\n }\n});\n\nconst requestOptions = {\n method: \"POST\",\n headers: myHeaders,\n body: raw,\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/intersects/?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\nimport json\n\nurl = \"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/search/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"where\": \"cost_col:>32.3\"\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\nimport json\n\nurl = \"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/intersects/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n 2.3522,\n 48.8566\n ],\n [\n 2.3622,\n 48.8566\n ],\n [\n 2.3622,\n 48.8666\n ],\n [\n 2.3522,\n 48.8666\n ],\n [\n 2.3522,\n 48.8566\n ]\n ]\n ]\n }\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "x-original-tag": "search" } }, - "/datasets/{dataset_id}/features/nearby/": { + "/datasets/{dataset_id}/features/contains/": { "post": { "tags": [ "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": "Contains Features", + "description": "Search for features containing geometry.\n\n**Rate limit**: `20/1s`\n\n![Within](https://postgis.net/workshops/postgis-intro/_images/st_within.png)\n\n**Ratelimit:** 20/1s", + "operationId": "contains_features_datasets__dataset_id__features_contains__post", "security": [ { "Datasets_PublicAPIKey": [] @@ -3101,34 +3039,36 @@ } } }, + "x-ratelimit-limit": 20, + "x-ratelimit-window-seconds": 1, "x-codeSamples": [ { "lang": "curl", "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/nearby/?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 3.883,\n 43.6\n ]\n },\n \"buffer\": 5000\n}'" + "source": "curl -L 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/contains/?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 3.883,\n 43.6\n ]\n }\n}'" }, { "lang": "javascript", "label": "JavaScript", - "source": "const myHeaders = new Headers();\nmyHeaders.append(\"content-type\", \"application/json\");\n\nconst raw = JSON.stringify({\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 3.883,\n 43.6\n ]\n },\n \"buffer\": 5000\n});\n\nconst requestOptions = {\n method: \"POST\",\n headers: myHeaders,\n body: raw,\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/nearby/?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": "const myHeaders = new Headers();\nmyHeaders.append(\"content-type\", \"application/json\");\n\nconst raw = JSON.stringify({\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 3.883,\n 43.6\n ]\n }\n});\n\nconst requestOptions = {\n method: \"POST\",\n headers: myHeaders,\n body: raw,\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/contains/?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\nimport json\n\nurl = \"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/nearby/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 3.883,\n 43.6\n ]\n },\n \"buffer\": 5000\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\nimport json\n\nurl = \"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/contains/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 3.883,\n 43.6\n ]\n }\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "x-original-tag": "search" } }, - "/datasets/{dataset_id}/features/intersects/": { + "/datasets/{dataset_id}/features/within/": { "post": { "tags": [ "Datasets API" ], - "summary": "Intersect Features", - "description": "Returns the features that are intersecting with geometry.\n\n**Rate limit**: `20/1s`\n\n![Intersection](https://postgis.net/workshops/postgis-intro/_images/st_intersects.png)", - "operationId": "intersect_features_datasets__dataset_id__features_intersects__post", + "summary": "Within Features", + "description": "Search for features within geometry.\n\n**Rate limit**: `20/1s`\n\n![Within](https://postgis.net/workshops/postgis-intro/_images/st_within.png)\n\n**Ratelimit:** 20/1s", + "operationId": "within_features_datasets__dataset_id__features_within__post", "security": [ { "Datasets_PublicAPIKey": [] @@ -3198,61 +3138,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", @@ -3361,34 +3251,36 @@ } } }, - "x-codeSamples": [ + "x-ratelimit-limit": 20, + "x-ratelimit-window-seconds": 1, + "x-codeSamples": [ { "lang": "curl", "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/intersects/?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n 2.3522,\n 48.8566\n ],\n [\n 2.3622,\n 48.8566\n ],\n [\n 2.3622,\n 48.8666\n ],\n [\n 2.3522,\n 48.8666\n ],\n [\n 2.3522,\n 48.8566\n ]\n ]\n ]\n }\n}'" + "source": "curl -L 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/within/?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n 2.3522,\n 48.8566\n ],\n [\n 2.3622,\n 48.8566\n ],\n [\n 2.3622,\n 48.8666\n ],\n [\n 2.3522,\n 48.8666\n ],\n [\n 2.3522,\n 48.8566\n ]\n ]\n ]\n }\n}'" }, { "lang": "javascript", "label": "JavaScript", - "source": "const myHeaders = new Headers();\nmyHeaders.append(\"content-type\", \"application/json\");\n\nconst raw = JSON.stringify({\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n 2.3522,\n 48.8566\n ],\n [\n 2.3622,\n 48.8566\n ],\n [\n 2.3622,\n 48.8666\n ],\n [\n 2.3522,\n 48.8666\n ],\n [\n 2.3522,\n 48.8566\n ]\n ]\n ]\n }\n});\n\nconst requestOptions = {\n method: \"POST\",\n headers: myHeaders,\n body: raw,\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/intersects/?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": "const myHeaders = new Headers();\nmyHeaders.append(\"content-type\", \"application/json\");\n\nconst raw = JSON.stringify({\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n 2.3522,\n 48.8566\n ],\n [\n 2.3622,\n 48.8566\n ],\n [\n 2.3622,\n 48.8666\n ],\n [\n 2.3522,\n 48.8666\n ],\n [\n 2.3522,\n 48.8566\n ]\n ]\n ]\n }\n});\n\nconst requestOptions = {\n method: \"POST\",\n headers: myHeaders,\n body: raw,\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/within/?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\nimport json\n\nurl = \"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/intersects/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n 2.3522,\n 48.8566\n ],\n [\n 2.3622,\n 48.8566\n ],\n [\n 2.3622,\n 48.8666\n ],\n [\n 2.3522,\n 48.8666\n ],\n [\n 2.3522,\n 48.8566\n ]\n ]\n ]\n }\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + "source": "import requests\nimport json\n\nurl = \"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/within/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n 2.3522,\n 48.8566\n ],\n [\n 2.3622,\n 48.8566\n ],\n [\n 2.3622,\n 48.8666\n ],\n [\n 2.3522,\n 48.8666\n ],\n [\n 2.3522,\n 48.8566\n ]\n ]\n ]\n }\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "x-original-tag": "search" } }, - "/datasets/{dataset_id}/features/contains/": { - "post": { + "/datasets/{dataset_id}/features/{feature_id}": { + "get": { "tags": [ "Datasets API" ], - "summary": "Contains Features", - "description": "Search for features containing geometry.\n\n**Rate limit**: `20/1s`\n\n![Within](https://postgis.net/workshops/postgis-intro/_images/st_within.png)", - "operationId": "contains_features_datasets__dataset_id__features_contains__post", + "summary": "Get Feature", + "description": "Gets a feature from its ID.\n\n**Rate limit**: `20/1s`\n\n**Ratelimit:** 20/1s", + "operationId": "get_feature_datasets__dataset_id__features__feature_id__get", "security": [ { "Datasets_PublicAPIKey": [] @@ -3411,6 +3303,16 @@ "title": "Dataset Id" } }, + { + "name": "feature_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Feature Id" + } + }, { "name": "format", "in": "query", @@ -3426,136 +3328,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_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 - ] - ] - } - } + "anyOf": [ + { + "type": "string" }, - "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" - } + { + "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" } } } @@ -3591,7 +3386,7 @@ } }, "404": { - "description": "Dataset was not found", + "description": "Feature or Dataset were not found", "content": { "application/json": { "schema": { @@ -3621,476 +3416,105 @@ } } }, + "x-ratelimit-limit": 20, + "x-ratelimit-window-seconds": 1, "x-codeSamples": [ { "lang": "curl", "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/contains/?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 3.883,\n 43.6\n ]\n }\n}'" + "source": "curl -L 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/497f6eca-6276-4993-bfeb-53cbbbba6f08?private_key=YOUR_PRIVATE_API_KEY'" }, { "lang": "javascript", "label": "JavaScript", - "source": "const myHeaders = new Headers();\nmyHeaders.append(\"content-type\", \"application/json\");\n\nconst raw = JSON.stringify({\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 3.883,\n 43.6\n ]\n }\n});\n\nconst requestOptions = {\n method: \"POST\",\n headers: myHeaders,\n body: raw,\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/contains/?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": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/497f6eca-6276-4993-bfeb-53cbbbba6f08?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\nimport json\n\nurl = \"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/contains/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n 3.883,\n 43.6\n ]\n }\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + "source": "import requests\n\nurl = \"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/497f6eca-6276-4993-bfeb-53cbbbba6f08?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], - "x-original-tag": "search" + "x-original-tag": "features" } }, - "/datasets/{dataset_id}/features/within/": { - "post": { + "/distance/route/json/": { + "get": { "tags": [ - "Datasets API" + "Distance API" ], - "summary": "Within Features", - "description": "Search for features within geometry.\n\n**Rate limit**: `20/1s`\n\n![Within](https://postgis.net/workshops/postgis-intro/_images/st_within.png)", - "operationId": "within_features_datasets__dataset_id__features_within__post", + "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": [ { - "Datasets_PublicAPIKey": [] + "Distance_PublicAPIKey": [] }, { - "Datasets_PrivateApiKey": [] + "Distance_PrivateApiKey": [] }, { - "Datasets_PrivateApiKeyHeader": [] + "Distance_PrivateApiKeyHeader": [] } ], "parameters": [ { - "name": "dataset_id", - "in": "path", - "required": true, + "name": "waypoints", + "in": "query", + "required": false, "schema": { - "type": "string", - "format": "uuid", - "title": "Dataset Id" - } + "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": "format", + "name": "mode", "in": "query", "required": false, "schema": { "enum": [ - "geojson", - "wkb" + "driving", + "walking", + "cycling" ], "type": "string", - "default": "geojson", - "title": "Format" - } + "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": "per_page", + "name": "method", "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" + "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": "The maximum number of elements to return in a result page." + "description": "Specifies how to compute the route between the start point and the end point:\n* `time`: fastest route \n* `distance`: shortest route" }, { - "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_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" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Successful Response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Datasets_SearchResultResponse" - } - } - } - }, - "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_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" - } - } - } - } - }, - "x-codeSamples": [ - { - "lang": "curl", - "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/within/?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n 2.3522,\n 48.8566\n ],\n [\n 2.3622,\n 48.8566\n ],\n [\n 2.3622,\n 48.8666\n ],\n [\n 2.3522,\n 48.8666\n ],\n [\n 2.3522,\n 48.8566\n ]\n ]\n ]\n }\n}'" - }, - { - "lang": "javascript", - "label": "JavaScript", - "source": "const myHeaders = new Headers();\nmyHeaders.append(\"content-type\", \"application/json\");\n\nconst raw = JSON.stringify({\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n 2.3522,\n 48.8566\n ],\n [\n 2.3622,\n 48.8566\n ],\n [\n 2.3622,\n 48.8666\n ],\n [\n 2.3522,\n 48.8666\n ],\n [\n 2.3522,\n 48.8566\n ]\n ]\n ]\n }\n});\n\nconst requestOptions = {\n method: \"POST\",\n headers: myHeaders,\n body: raw,\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/within/?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\nimport json\n\nurl = \"https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/within/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"geometry\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n 2.3522,\n 48.8566\n ],\n [\n 2.3622,\n 48.8566\n ],\n [\n 2.3622,\n 48.8666\n ],\n [\n 2.3522,\n 48.8666\n ],\n [\n 2.3522,\n 48.8566\n ]\n ]\n ]\n }\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" - } - ], - "x-original-tag": "search" - } - }, - "/datasets/{dataset_id}/features/{feature_id}": { - "get": { - "tags": [ - "Datasets 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", - "security": [ - { - "Datasets_PublicAPIKey": [] - }, - { - "Datasets_PrivateApiKey": [] - }, - { - "Datasets_PrivateApiKeyHeader": [] - } - ], - "parameters": [ - { - "name": "dataset_id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Dataset Id" - } - }, - { - "name": "feature_id", - "in": "path", - "required": true, - "schema": { - "type": "string", - "format": "uuid", - "title": "Feature Id" - } - }, - { - "name": "format", - "in": "query", - "required": false, - "schema": { - "enum": [ - "geojson", - "wkb" - ], - "type": "string", - "default": "geojson", - "title": "Format" - } - }, - { - "name": "X-Field-Mask", - "in": "header", - "required": false, - "schema": { - "anyOf": [ - { - "type": "string" - }, - { - "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" - } - } - } - }, - "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": "Feature or Dataset were not found", - "content": { - "application/json": { - "schema": { - "$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" - } - } - } - } - }, - "x-codeSamples": [ - { - "lang": "curl", - "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/497f6eca-6276-4993-bfeb-53cbbbba6f08?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/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/497f6eca-6276-4993-bfeb-53cbbbba6f08?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/datasets/8c4c51f1-f6f3-43bc-b65d-7415e8ef22c0/features/497f6eca-6276-4993-bfeb-53cbbbba6f08?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" - } - ], - "x-original-tag": "features" - } - }, - "/distance/route/json/": { - "get": { - "tags": [ - "Distance 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", + "name": "units", "in": "query", "required": false, "schema": { @@ -4117,6 +3541,7 @@ "da", "de", "es", + "et", "fi", "he", "it", @@ -4619,6 +4044,7 @@ "da", "de", "es", + "et", "fi", "he", "it", @@ -5144,6 +4570,7 @@ "da", "de", "es", + "et", "fi", "he", "it", @@ -5624,6 +5051,7 @@ "da", "de", "es", + "et", "fi", "he", "it", @@ -9193,7 +8621,7 @@ "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_data" }, { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_cc_format-2" + "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_cc_format" } ], "responses": { @@ -11760,7 +11188,7 @@ ], "parameters": [ { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_limit-4" + "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_limit-3" }, { "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_offset" @@ -12748,200 +12176,97 @@ "in": "query" }, "Woosmap_Platform_API_Reference_cc_format": { - "name": "cc_format", - "description": "To specify the format for the short [country code](https://en.wikipedia.org/wiki/ISO_3166-1) expected to be returned in the address_components field (default is `alpha3`).\n", - "schema": { - "type": "string", - "enum": [ - "alpha2", - "alpha3" - ], - "example": "alpha2" - }, - "in": "query" - }, - "Woosmap_Platform_API_Reference_page-2": { - "name": "page", - "description": "In a few cases, a postal code details may contain addresses (UK postal codes). The address list is paginated. In that case, you can navigate in the address list thanks to the `addresses_per_page` and `page` parameters. Notice: as all the addresses are now automatically returned in the response, the `page` parameter is deprecated and has been turned off on December 31, 2021.\n", - "schema": { - "type": "integer", - "example": 1 - }, - "in": "query", - "deprecated": true - }, - "Woosmap_Platform_API_Reference_addresses_per_page": { - "name": "addresses_per_page", - "description": "In a few cases, a postal code details may contain addresses (UK postal codes). The address list is paginated. In that case, you can navigate in the address list thanks to the `addresses_per_page` and `page` parameters. Notice: as all the addresses are now automatically returned in the response, the `addresses_per_page` parameter is deprecated and has been turned off on December 31, 2021.\n", - "schema": { - "type": "integer", - "example": 10 - }, - "in": "query", - "deprecated": true - }, - "Woosmap_Platform_API_Reference_address": { - "name": "address", - "description": "The input string to geocode. Can represent an address, a street, a locality or a postal code. The `address` parameter must be URL encoded.\nTo protect against illegitimate requests, only the 20 first tokens found in the first 150 characters will be used.\n", - "schema": { - "type": "string", - "maxLength": 150, - "example": "224%20Rue%20de%20Rivoli%2C%20Paris" - }, - "required": false, - "in": "query" - }, - "Woosmap_Platform_API_Reference_latlng": { - "name": "latlng", - "description": "The latlng parameter is used for reverse geocoding, it’s required if the `address` parameter is missing.\n", - "schema": { - "type": "string", - "example": "5.2,-2.3" - }, - "required": false, - "in": "query" - }, - "Woosmap_Platform_API_Reference_geocode_types": { - "name": "types", - "description": "When executing a geocode request with the `address` parameter, it specifies the types of suggestions to return in the query. Multiple types can be combined using the pipe character (`|`) as a separator. This parameter supports a wide range of locality classifications, including:\n - Standard locality types (e.g., cities, administrative areas, postal codes)\n - Points of Interest (POI) categories\n - POI aliases\n\nThese classifications enable flexible geographic data representation and querying.\nThis parameter is ignored when used with the `latlng` parameter. \n", - "schema": { - "default": "locality|postal_code|address", - "example": "locality|admin_level", - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesAll" - }, - "in": "query" - }, - "Woosmap_Platform_API_Reference_list_sub_buildings": { - "name": "list_sub_buildings", - "description": "When latlng parameter is used for reverse geocoding, setting `list_sub_building=true` allows to retrieve all addresses at the same location for a common street number or building. Results may contain an additional key \"sub_buildings\" with \"public_id\" and \"description\" values for every addresses at the same location sharing the same address components.\n", - "schema": { - "type": "boolean", - "example": true - }, - "required": false, - "in": "query" - }, - "Woosmap_Platform_API_Reference_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" - }, - "Woosmap_Platform_API_Reference_nearby_types": { - "name": "types", - "description": "The types of points of interest to return. Multiple types can be passed using the pipe character (`|`) as a separator. For example: `types=business.shop|medical.pharmacy|business.finance.bank`.\n", - "schema": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesPoi" - }, - "required": true, - "in": "query" - }, - "Woosmap_Platform_API_Reference_nearby_excluded_types": { - "name": "excluded_types", - "description": "The types of points of interest to exclude from results. results will match the specified `types`, if any, but will not match the specified `excluded_types` Multiple types can be passed using the pipe character (`|`) as a separator. For example: `excluded_types=business.food_and_drinks.fast_food|business.food_and_drinks.pub`.\n", - "schema": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesPoi" - }, - "in": "query" - }, - "Woosmap_Platform_API_Reference_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" + "alpha3" + ], + "example": "alpha2" }, - "required": true, "in": "query" }, - "Woosmap_Platform_API_Reference_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", + "Woosmap_Platform_API_Reference_page-2": { + "name": "page", + "description": "In a few cases, a postal code details may contain addresses (UK postal codes). The address list is paginated. In that case, you can navigate in the address list thanks to the `addresses_per_page` and `page` parameters. Notice: as all the addresses are now automatically returned in the response, the `page` parameter is deprecated and has been turned off on December 31, 2021.\n", "schema": { - "type": "string", - "example": "country:CAN|country:BEL" + "type": "integer", + "example": 1 }, - "in": "query" + "in": "query", + "deprecated": true }, - "Woosmap_Platform_API_Reference_location-2": { - "name": "location", - "description": "Bias for the results. Should be pass in `lat`,`lng` format.\n", + "Woosmap_Platform_API_Reference_addresses_per_page": { + "name": "addresses_per_page", + "description": "In a few cases, a postal code details may contain addresses (UK postal codes). The address list is paginated. In that case, you can navigate in the address list thanks to the `addresses_per_page` and `page` parameters. Notice: as all the addresses are now automatically returned in the response, the `addresses_per_page` parameter is deprecated and has been turned off on December 31, 2021.\n", "schema": { - "type": "string", - "example": "5.2,-2.3" + "type": "integer", + "example": 10 }, - "in": "query" + "in": "query", + "deprecated": true }, - "Woosmap_Platform_API_Reference_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", + "Woosmap_Platform_API_Reference_address": { + "name": "address", + "description": "The input string to geocode. Can represent an address, a street, a locality or a postal code. The `address` parameter must be URL encoded.\nTo protect against illegitimate requests, only the 20 first tokens found in the first 150 characters will be used.\n", "schema": { "type": "string", - "example": "en" + "maxLength": 150, + "example": "224%20Rue%20de%20Rivoli%2C%20Paris" }, + "required": false, "in": "query" }, - "Woosmap_Platform_API_Reference_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", + "Woosmap_Platform_API_Reference_latlng": { + "name": "latlng", + "description": "The latlng parameter is used for reverse geocoding, it’s required if the `address` parameter is missing.\n", "schema": { "type": "string", - "example": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMDA1MTI2" + "example": "5.2,-2.3" }, - "required": true, + "required": false, "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", + "Woosmap_Platform_API_Reference_geocode_types": { + "name": "types", + "description": "When executing a geocode request with the `address` parameter, it specifies the types of suggestions to return in the query. Multiple types can be combined using the pipe character (`|`) as a separator. This parameter supports a wide range of locality classifications, including:\n - Standard locality types (e.g., cities, administrative areas, postal codes)\n - Points of Interest (POI) categories\n - POI aliases\n\nThese classifications enable flexible geographic data representation and querying.\nThis parameter is ignored when used with the `latlng` parameter. \n", "schema": { - "type": "string", - "enum": [ - "geometry" - ], - "example": "geometry" + "default": "locality|postal_code|address", + "example": "locality|admin_level", + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesAll" }, "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", + "Woosmap_Platform_API_Reference_list_sub_buildings": { + "name": "list_sub_buildings", + "description": "When latlng parameter is used for reverse geocoding, setting `list_sub_building=true` allows to retrieve all addresses at the same location for a common street number or building. Results may contain an additional key \"sub_buildings\" with \"public_id\" and \"description\" values for every addresses at the same location sharing the same address components.\n", "schema": { - "type": "string", - "example": "224%20Rue%20de%20Rivoli%2C%20Paris" + "type": "boolean", + "example": true }, "required": false, "in": "query" }, - "Woosmap_Platform_API_Reference_latlng-2": { - "name": "latlng", - "description": "Geographic coordinates. Should be pass in `lat`,`lng` format.\n", + "Woosmap_Platform_API_Reference_nearby_types": { + "name": "types", + "description": "The types of points of interest to return. Multiple types can be passed using the pipe character (`|`) as a separator. For example: `types=business.shop|medical.pharmacy|business.finance.bank`.\n", "schema": { - "type": "string", - "example": "5.2,-2.3" + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesPoi" }, - "required": false, + "required": true, "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", + "Woosmap_Platform_API_Reference_nearby_excluded_types": { + "name": "excluded_types", + "description": "The types of points of interest to exclude from results. results will match the specified `types`, if any, but will not match the specified `excluded_types` Multiple types can be passed using the pipe character (`|`) as a separator. For example: `excluded_types=business.food_and_drinks.fast_food|business.food_and_drinks.pub`.\n", "schema": { - "type": "integer", - "minimum": 1, - "maximum": 100, - "example": 10 + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesPoi" }, "in": "query" }, - "Woosmap_Platform_API_Reference_limit-4": { + "Woosmap_Platform_API_Reference_limit-3": { "name": "limit", "description": "To limit number of zones retrieved (max 50).\n", "schema": { @@ -12962,36 +12287,6 @@ }, "in": "query" }, - "Woosmap_Platform_API_Reference_address_address_components": { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_address_components" - }, - "Woosmap_Platform_API_Reference_address_address": { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_address-2" - }, - "Woosmap_Platform_API_Reference_address_cc_format": { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_cc_format" - }, - "Woosmap_Platform_API_Reference_address_fields": { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_fields-2" - }, - "Woosmap_Platform_API_Reference_address_input": { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_input-2" - }, - "Woosmap_Platform_API_Reference_address_language": { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_language-3" - }, - "Woosmap_Platform_API_Reference_address_latlng": { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_latlng-2" - }, - "Woosmap_Platform_API_Reference_address_limit": { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_limit-3" - }, - "Woosmap_Platform_API_Reference_address_location": { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_location-2" - }, - "Woosmap_Platform_API_Reference_address_public_id": { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_public_id-2" - }, "Woosmap_Platform_API_Reference_geolocation_ip_address": { "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_ip_address" }, @@ -13005,7 +12300,7 @@ "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_addresses_per_page" }, "Woosmap_Platform_API_Reference_localities_cc_format": { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_cc_format-2" + "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_cc_format" }, "Woosmap_Platform_API_Reference_localities_custom_description": { "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_custom_description" @@ -13092,7 +12387,7 @@ "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_zone" }, "Woosmap_Platform_API_Reference_zones_limit": { - "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_limit-4" + "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_limit-3" }, "Woosmap_Platform_API_Reference_zones_offset": { "$ref": "#/components/parameters/Woosmap_Platform_API_Reference_offset" @@ -15681,421 +14976,108 @@ }, "example": { "location": { - "lat": 48.829405, - "lng": 2.367944 - }, - "location_type": "GEOMETRIC_CENTER" - } - }, - "Woosmap_Platform_API_Reference_LocalitiesScoresPerComponents": { - "title": "LocalitiesScoresPerComponents", - "type": "object", - "properties": { - "street_name": { - "description": "Street score", - "type": "number" - }, - "postal_code": { - "description": "Postal code score", - "type": "number" - }, - "locality": { - "description": "Postal code score", - "type": "number" - } - }, - "example": { - "scores_per_components": { - "street_name": 0.6153846153846154, - "postal_code": 0.8, - "locality": 1 - } - } - }, - "Woosmap_Platform_API_Reference_LocalitiesGeocodeResponse": { - "title": "LocalitiesGeocodeResponse", - "type": "object", - "description": "Attributes describing a locality. Not all attributes will be available for all locality types.", - "properties": { - "formatted_address": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_FormattedAddress" - }, - "types": { - "description": "An array containing the types of the result", - "type": "array", - "items": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesAll" - } - }, - "administrative_area_label": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AdministrativeAreaLabel" - }, - "public_id": { - "description": "Contains a unique ID for each suggestion. Please use this ID to give feedbacks on results.", - "type": "string", - "example": "MkvnYy6K6oVGqeqfWJGO/6eCgqo=" - }, - "geometry": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesAddressGeometry" - }, - "status": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesStatus" - }, - "address_components": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_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/Woosmap_Platform_API_Reference_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/Woosmap_Platform_API_Reference_LocalitiesScoresPerComponents" - } - } - }, - "Woosmap_Platform_API_Reference_LocalitiesGeocodeCollectionResponse": { - "title": "LocalitiesGeocodeCollectionResponse", - "type": "object", - "description": "Localities Geocode Collection Response. Contains one or more detailed Localities or Addresses in FR or in the UK, with coordinates (default to one result for reverse geocoding)", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesGeocodeResponse" - } - } - }, - "example": { - "results": [ - { - "public_id": "0+FTYd/1MsiBSxLAKq+/Fiyy+uM=", - "types": [ - "address", - "route" - ], - "formatted_address": "Place Jeanne D'Arc, 75013, Paris", - "address_components": [ - { - "types": [ - "country", - "administrative_area_level_0", - "division_level_0" - ], - "long_name": "France", - "short_name": "FR" - }, - { - "types": [ - "state", - "division_level_1" - ], - "long_name": "Île-de-France", - "short_name": "Île-de-France" - }, - { - "types": [ - "administrative_area_level_1", - "county", - "division_level_2" - ], - "long_name": "Paris", - "short_name": "Paris" - }, - { - "types": [ - "locality" - ], - "long_name": "Paris", - "short_name": "Paris" - }, - { - "types": [ - "postal_codes" - ], - "long_name": "75013", - "short_name": "75013" - }, - { - "types": [ - "route" - ], - "long_name": "Place Jeanne D'Arc", - "short_name": "Place Jeanne D'Arc" - } - ], - "geometry": { - "location": { - "lat": 48.829405, - "lng": 2.367944 - }, - "location_type": "GEOMETRIC_CENTER" - }, - "scores_per_components": { - "street_name": 1 - } - } - ] + "lat": 48.829405, + "lng": 2.367944 + }, + "location_type": "GEOMETRIC_CENTER" } }, - "Woosmap_Platform_API_Reference_LocalitiesNearbyResponse": { - "title": "LocalitiesNearbyResponse", + "Woosmap_Platform_API_Reference_LocalitiesScoresPerComponents": { + "title": "LocalitiesScoresPerComponents", "type": "object", - "description": "Attributes describing a point of interest.", "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 + } + } + }, + "Woosmap_Platform_API_Reference_LocalitiesGeocodeResponse": { + "title": "LocalitiesGeocodeResponse", + "type": "object", + "description": "Attributes describing a locality. Not all attributes will be available for all locality types.", + "properties": { + "formatted_address": { + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_FormattedAddress" + }, "types": { - "description": "An array containing the types of the result.", + "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/Woosmap_Platform_API_Reference_LocalitiesTypesPoi" + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesAll" } }, - "name": { - "description": "The name of the result.", - "type": "string" + "administrative_area_label": { + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AdministrativeAreaLabel" }, "public_id": { - "description": "Contains a unique ID for each result. Please use this ID to give feedbacks on results.", + "description": "Contains a unique ID for each suggestion. Please use this ID to give feedbacks on results.", "type": "string", - "example": "NOAeiQADqqisOuN3NM7oXlhkROI=" + "example": "MkvnYy6K6oVGqeqfWJGO/6eCgqo=" }, "geometry": { - "description": "The location of the result, in latitude and longitude, eventually associated with a Viewport.", - "type": "object", - "properties": { - "location": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LatLngLiteral" - }, - "viewport": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Bounds" - } - }, - "example": { - "location": { - "lat": 51.4998415, - "lng": -0.1246375 - } - } + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesAddressGeometry" + }, + "status": { + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesStatus" }, "address_components": { "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AddressComponents" }, - "categories": { - "description": "An array containing the categories of the result. This information is now available in the `types` field and will be removed.", + "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", - "deprecated": true, "items": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesPoi" + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesAddressSummary" } }, - "formatted_address": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_FormattedAddress" + "scores_per_components": { + "description": "For each component (street_name, postal_code, and locality), it indicates the degree of correspondence with the original query. This value ranges from 0 to 1, with 0 indicating no match with the original query, and enables you to assess the quality of the Geocode’s result.", + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesScoresPerComponents" } } }, - "Woosmap_Platform_API_Reference_LocalitiesNearbyCollectionResponse": { - "title": "LocalitiesNearbyCollectionResponse", + "Woosmap_Platform_API_Reference_LocalitiesGeocodeCollectionResponse": { + "title": "LocalitiesGeocodeCollectionResponse", "type": "object", - "description": "Collection of nearby points of interest.", + "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": { - "description": "The array of nearby points of interest.", "type": "array", - "items": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesNearbyResponse" - } - }, - "pagination": { - "description": "Helps to navigate through paginated results.", - "type": "object", - "properties": { - "next_page": { - "description": "If more results are available, this will contain the value to pass to the `page` parameter to get the next page", - "type": [ - "integer", - "null" - ] - }, - "previous_page": { - "description": "If previous results are available, this will contain the value to pass to the `page` parameter to get the previous page", - "type": [ - "integer", - "null" - ] - } - } - } - }, - "example": { - "results": [ - { - "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6ZTc2ZDA1YzBiM2M0M2NmNmVkNTJjNGQyZDFiZDE3Nzc0OTZkNjlmOA==", - "types": [ - "point_of_interest", - "business.food_and_drinks.fast_food" - ], - "categories": [ - "business.food_and_drinks.fast_food" - ], - "name": "Pret A Manger", - "formatted_address": "Broadway, New York", - "geometry": { - "location": { - "lat": 40.715905992166256, - "lng": -74.00508673226767 - } - }, - "address_components": [ - { - "types": [ - "country", - "administrative_area_level_0", - "division_level_0" - ], - "long_name": "United States", - "short_name": "US" - }, - { - "types": [ - "locality" - ], - "long_name": "New York", - "short_name": "New York" - }, - { - "types": [ - "route" - ], - "long_name": "Broadway", - "short_name": "Broadway" - } - ] - }, - { - "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6MzBlMGYxMzVhNGUzZDQ4MzRiMmNlNDMzMWJiYjZkOTY0MWJhN2E0Zg==", - "types": [ - "point_of_interest", - "business.food_and_drinks.fast_food" - ], - "categories": [ - "business.food_and_drinks.fast_food" - ], - "name": "Dunkin'", - "formatted_address": "Broadway, New York", - "geometry": { - "location": { - "lat": 40.71602115951586, - "lng": -74.00494482664695 - } - }, - "address_components": [ - { - "types": [ - "country", - "administrative_area_level_0", - "division_level_0" - ], - "long_name": "United States", - "short_name": "US" - }, - { - "types": [ - "locality" - ], - "long_name": "New York", - "short_name": "New York" - }, - { - "types": [ - "route" - ], - "long_name": "Broadway", - "short_name": "Broadway" - } - ] - }, - { - "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmJlMWNkMTE2ZDQwM2E0Y2YwNGQ5NWQ2OTlmZWRmM2FhZTExNGU3ZWY=", - "types": [ - "point_of_interest", - "business.food_and_drinks.restaurant" - ], - "categories": [ - "business.food_and_drinks.restaurant" - ], - "name": "Chambers", - "formatted_address": "Chambers Street, New York", - "geometry": { - "location": { - "lat": 40.71461844801976, - "lng": -74.00754036678366 - } - }, - "address_components": [ - { - "types": [ - "country", - "administrative_area_level_0", - "division_level_0" - ], - "long_name": "United States", - "short_name": "US" - }, - { - "types": [ - "locality" - ], - "long_name": "New York", - "short_name": "New York" - }, - { - "types": [ - "route" - ], - "long_name": "Chambers Street", - "short_name": "Chambers Street" - } - ] - }, + "items": { + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesGeocodeResponse" + } + } + }, + "example": { + "results": [ { - "public_id": "cG9pOnVzOmJ1c2luZXNzLnNob3AuZ3JvY2VyeTo1YTczMjYxOTQyYjVlZmUwOGEzZjQ1NGZmMTMwMmJjNjA4ODE3NmRk", + "public_id": "0+FTYd/1MsiBSxLAKq+/Fiyy+uM=", "types": [ - "point_of_interest", - "business.shop.grocery" - ], - "categories": [ - "business.shop.grocery" + "address", + "route" ], - "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 - } - } - }, + "formatted_address": "Place Jeanne D'Arc, 75013, Paris", "address_components": [ { "types": [ @@ -16103,125 +15085,172 @@ "administrative_area_level_0", "division_level_0" ], - "long_name": "United States", - "short_name": "US" - } - ] - }, - { - "public_id": "cG9pOnVzOmJ1c2luZXNzLmZpbmFuY2UuYmFuazpiOGY5MDE4Nzc2ZDZjNmEwZTljOGM4YWM0OTAxZWZlNzNmODZkM2M3", - "types": [ - "point_of_interest", - "business.finance.bank" - ], - "categories": [ - "business.finance.bank" - ], - "name": "Citibank", - "formatted_address": "Broadway, New York", - "geometry": { - "location": { - "lat": 40.7130414767567, - "lng": -74.0074818610995 - } - }, - "address_components": [ + "long_name": "France", + "short_name": "FR" + }, { "types": [ - "country", - "administrative_area_level_0", - "division_level_0" + "state", + "division_level_1" ], - "long_name": "United States", - "short_name": "US" + "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": "New York", - "short_name": "New York" + "long_name": "Paris", + "short_name": "Paris" }, { "types": [ - "route" + "postal_codes" ], - "long_name": "Broadway", - "short_name": "Broadway" - } - ] - }, - { - "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQzMTMzZTJkODdiOGJjMGE3ZjI2YTdiMWVjYTZlZmI1MjQyYWE3MTE=", - "types": [ - "point_of_interest", - "business.food_and_drinks.restaurant" - ], - "categories": [ - "business.food_and_drinks.restaurant" - ], - "name": "Saffron", - "geometry": { - "location": { - "lat": 40.71467049963849, - "lng": -74.00767187884445 - } - }, - "address_components": [ + "long_name": "75013", + "short_name": "75013" + }, { "types": [ - "country", - "administrative_area_level_0", - "division_level_0" + "route" ], - "long_name": "United States", - "short_name": "US" + "long_name": "Place Jeanne D'Arc", + "short_name": "Place Jeanne D'Arc" } - ] - }, - { - "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQ1NjMyN2RiM2EyNWJlYmIwNjJjZjNlYWYwMDE3ZDIyYzEyNWNlMjY=", - "types": [ - "point_of_interest", - "business.food_and_drinks.restaurant" ], - "categories": [ - "business.food_and_drinks.restaurant" - ], - "name": "Gran Morsi", "geometry": { "location": { - "lat": 40.71432885326513, - "lng": -74.00778746528921 - } + "lat": 48.829405, + "lng": 2.367944 + }, + "location_type": "GEOMETRIC_CENTER" }, - "address_components": [ - { - "types": [ - "country", - "administrative_area_level_0", - "division_level_0" - ], - "long_name": "United States", - "short_name": "US" - } - ] + "scores_per_components": { + "street_name": 1 + } + } + ] + } + }, + "Woosmap_Platform_API_Reference_LocalitiesNearbyResponse": { + "title": "LocalitiesNearbyResponse", + "type": "object", + "description": "Attributes describing a point of interest.", + "properties": { + "types": { + "description": "An array containing the types of the result.", + "type": "array", + "example": [ + "point_of_interest", + "transit.station.rail.train", + "train_station" + ], + "items": { + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesPoi" + } + }, + "name": { + "description": "The name of the result.", + "type": "string" + }, + "public_id": { + "description": "Contains a unique ID for each result. Please use this ID to give 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/Woosmap_Platform_API_Reference_LatLngLiteral" + }, + "viewport": { + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Bounds" + } }, + "example": { + "location": { + "lat": 51.4998415, + "lng": -0.1246375 + } + } + }, + "address_components": { + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AddressComponents" + }, + "categories": { + "description": "An array containing the categories of the result. This information is now available in the `types` field and will be removed.", + "type": "array", + "deprecated": true, + "items": { + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesTypesPoi" + } + }, + "formatted_address": { + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_FormattedAddress" + } + } + }, + "Woosmap_Platform_API_Reference_LocalitiesNearbyCollectionResponse": { + "title": "LocalitiesNearbyCollectionResponse", + "type": "object", + "description": "Collection of nearby points of interest.", + "properties": { + "results": { + "description": "The array of nearby points of interest.", + "type": "array", + "items": { + "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LocalitiesNearbyResponse" + } + }, + "pagination": { + "description": "Helps to navigate through paginated results.", + "type": "object", + "properties": { + "next_page": { + "description": "If more results are available, this will contain the value to pass to the `page` parameter to get the next page", + "type": [ + "integer", + "null" + ] + }, + "previous_page": { + "description": "If previous results are available, this will contain the value to pass to the `page` parameter to get the previous page", + "type": [ + "integer", + "null" + ] + } + } + } + }, + "example": { + "results": [ { - "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5iYXI6MDE5ZGUzNTdiZDkyNzAyZDM4ZDUyOWQ0YmJiZjBmODQ5YWEzZmY1NA==", + "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6ZTc2ZDA1YzBiM2M0M2NmNmVkNTJjNGQyZDFiZDE3Nzc0OTZkNjlmOA==", "types": [ "point_of_interest", - "business.food_and_drinks.bar" + "business.food_and_drinks.fast_food" ], "categories": [ - "business.food_and_drinks.bar" + "business.food_and_drinks.fast_food" ], - "name": "Bon Courage", - "formatted_address": "Reade Street, New York", + "name": "Pret A Manger", + "formatted_address": "Broadway, New York", "geometry": { "location": { - "lat": 40.71541472882126, - "lng": -74.00719193106873 + "lat": 40.715905992166256, + "lng": -74.00508673226767 } }, "address_components": [ @@ -16245,13 +15274,13 @@ "types": [ "route" ], - "long_name": "Reade Street", - "short_name": "Reade Street" + "long_name": "Broadway", + "short_name": "Broadway" } ] }, { - "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6OGIyNDY5MDM4M2JhYzE1NmY4OGRiMGQzYmIyYzNjMTVmOTk0NDQwZQ==", + "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6MzBlMGYxMzVhNGUzZDQ4MzRiMmNlNDMzMWJiYjZkOTY0MWJhN2E0Zg==", "types": [ "point_of_interest", "business.food_and_drinks.fast_food" @@ -16259,12 +15288,12 @@ "categories": [ "business.food_and_drinks.fast_food" ], - "name": "Burger King", + "name": "Dunkin'", "formatted_address": "Broadway, New York", "geometry": { "location": { - "lat": 40.71619516782573, - "lng": -74.00480635760651 + "lat": 40.71602115951586, + "lng": -74.00494482664695 } }, "address_components": [ @@ -16294,20 +15323,20 @@ ] }, { - "public_id": "cG9pOnVzOmJ1c2luZXNzLnRoZWF0cmU6MTU1Yjk5YmEwY2FiYzIzZjYxYWYyYTViYzI0ZDViYTVlNmVmZTAwNA==", + "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmJlMWNkMTE2ZDQwM2E0Y2YwNGQ5NWQ2OTlmZWRmM2FhZTExNGU3ZWY=", "types": [ "point_of_interest", - "business.theatre" + "business.food_and_drinks.restaurant" ], "categories": [ - "business.theatre" + "business.food_and_drinks.restaurant" ], - "name": "The Flea", - "formatted_address": "Thomas Street, New York", + "name": "Chambers", + "formatted_address": "Chambers Street, New York", "geometry": { "location": { - "lat": 40.71609349534023, - "lng": -74.00589281989586 + "lat": 40.71461844801976, + "lng": -74.00754036678366 } }, "address_components": [ @@ -16331,432 +15360,282 @@ "types": [ "route" ], - "long_name": "Thomas Street", - "short_name": "Thomas Street" + "long_name": "Chambers Street", + "short_name": "Chambers Street" } ] - } - ], - "pagination": { - "previous_page": 2, - "next_page": 4 - } - } - }, - "Woosmap_Platform_API_Reference_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/Woosmap_Platform_API_Reference_MatchedSubstring" - } - } - } - }, - "Woosmap_Platform_API_Reference_AddressTypes": { - "title": "AddressTypes", - "type": "string", - "description": "Contains the type of result.", - "enum": [ - "house_number", - "route", - "address_block", - "locality", - "admin_level", - "country" - ] - }, - "Woosmap_Platform_API_Reference_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": [ - "OK", - "INVALID_REQUEST", - "REQUEST_DENIED", - "UNKNOWN_ERROR" - ] - }, - "Woosmap_Platform_API_Reference_AddressAutocompleteResponse": { - "title": "AddressAutocompleteResponse", - "type": "object", - "description": "Attributes describing an Address.", - "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/Woosmap_Platform_API_Reference_AddressAutocompleteMatchedFields" - }, - "type": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AddressTypes" - }, - "status": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AddressStatus" - } - }, - "example": { - "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0", - "description": "London, England, United Kingdom", - "matched_substring": { - "description": [ - { - "offset": 0, - "length": 4 - } - ] - }, - "type": "locality" - } - }, - "Woosmap_Platform_API_Reference_AddressAutocompleteCollectionResponse": { - "title": "AddressAutocompleteCollectionResponse", - "type": "object", - "description": "Address Collection Response containing Localities", - "properties": { - "predictions": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AddressAutocompleteResponse" - } - }, - "status": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AddressStatus" - } - }, - "example": { - "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 + "public_id": "cG9pOnVzOmJ1c2luZXNzLnNob3AuZ3JvY2VyeTo1YTczMjYxOTQyYjVlZmUwOGEzZjQ1NGZmMTMwMmJjNjA4ODE3NmRk", + "types": [ + "point_of_interest", + "business.shop.grocery" + ], + "categories": [ + "business.shop.grocery" + ], + "name": "City Hall Oasis", + "geometry": { + "location": { + "lat": 40.71283012706819, + "lng": -74.00727837935057 + }, + "viewport": { + "northeast": { + "lat": 40.71286059528623, + "lng": -74.00724213866874 + }, + "southwest": { + "lat": 40.71279957503111, + "lng": -74.00731464213119 } - ] + } }, - "type": "locality" + "address_components": [ + { + "types": [ + "country", + "administrative_area_level_0", + "division_level_0" + ], + "long_name": "United States", + "short_name": "US" + } + ] }, { - "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM0NDEy", - "description": "London Luton Airport, Luton, England, United Kingdom", - "matched_substring": { - "description": [ - { - "offset": 0, - "length": 4 - } - ] - }, - "type": "locality" - } - ], - "status": "OK" - } - }, - "Woosmap_Platform_API_Reference_AddressGeometry": { - "title": "AddressGeometry", - "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", - "type": "string", - "enum": [ - "ROOFTOP", - "RANGE_INTERPOLATED", - "GEOMETRIC_CENTER", - "APPROXIMATE" - ] - }, - "location": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_LatLngLiteral" - }, - "viewport": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_Bounds" - } - }, - "example": { - "location": { - "lat": 48.829405, - "lng": 2.367944 - }, - "location_type": "GEOMETRIC_CENTER" - } - }, - "Woosmap_Platform_API_Reference_AddressDetailsResponse": { - "title": "AddressDetailsResponse", - "type": "object", - "description": "Address Details Response", - "properties": { - "status": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AddressStatus" - }, - "result": { - "description": "the root node of address details", - "type": "object", - "properties": { - "formatted_address": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_FormattedAddress" - }, - "types": { - "description": "The types of result.", - "type": "array", - "items": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_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/Woosmap_Platform_API_Reference_AddressComponents" - }, - "geometry": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_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 + "public_id": "cG9pOnVzOmJ1c2luZXNzLmZpbmFuY2UuYmFuazpiOGY5MDE4Nzc2ZDZjNmEwZTljOGM4YWM0OTAxZWZlNzNmODZkM2M3", + "types": [ + "point_of_interest", + "business.finance.bank" + ], + "categories": [ + "business.finance.bank" + ], + "name": "Citibank", + "formatted_address": "Broadway, New York", + "geometry": { + "location": { + "lat": 40.7130414767567, + "lng": -74.0074818610995 + } }, - "viewport": { - "northeast": { - "lat": 51.68629, - "lng": 0.28206 + "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" }, - "southwest": { - "lat": 51.28043, - "lng": -0.56316 + { + "types": [ + "route" + ], + "long_name": "Broadway", + "short_name": "Broadway" } - } - } - }, - "status": "OK" - } - }, - "Woosmap_Platform_API_Reference_AddressGeocodeTypes": { - "title": "AddressGeocodeTypes", - "type": "string", - "description": "Contains the type of result.", - "enum": [ - "address", - "house_number", - "route", - "address_block", - "locality", - "admin_level", - "country", - "place" - ] - }, - "Woosmap_Platform_API_Reference_AddressGeocodeResponse": { - "title": "AddressGeocodeResponse", - "type": "object", - "description": "Address Geocode Response", - "properties": { - "formatted_address": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_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`)", - "type": "array", - "items": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AddressGeocodeTypes" - } - }, - "address_components": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AddressComponents" - }, - "geometry": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AddressGeometry" - } - } - }, - "Woosmap_Platform_API_Reference_AddressGeocodeCollectionResponse": { - "title": "AddressGeocodeCollectionResponse", - "type": "object", - "description": "Address Geocode Collection Response. Contains one or more Addresses with coordinates (default to one result for reverse geocoding)", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AddressGeocodeResponse" - } - }, - "status": { - "$ref": "#/components/schemas/Woosmap_Platform_API_Reference_AddressStatus" - } - }, - "example": { - "results": [ + ] + }, { - "formatted_address": "Place de la Résistance, 75007 Paris, France", + "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQzMTMzZTJkODdiOGJjMGE3ZjI2YTdiMWVjYTZlZmI1MjQyYWE3MTE=", "types": [ - "address", - "route" + "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" + "country", + "administrative_area_level_0", + "division_level_0" ], - "long_name": "France", - "short_name": "FRA" - }, + "long_name": "United States", + "short_name": "US" + } + ] + }, + { + "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQ1NjMyN2RiM2EyNWJlYmIwNjJjZjNlYWYwMDE3ZDIyYzEyNWNlMjY=", + "types": [ + "point_of_interest", + "business.food_and_drinks.restaurant" + ], + "categories": [ + "business.food_and_drinks.restaurant" + ], + "name": "Gran Morsi", + "geometry": { + "location": { + "lat": 40.71432885326513, + "lng": -74.00778746528921 + } + }, + "address_components": [ { "types": [ - "state" + "country", + "administrative_area_level_0", + "division_level_0" ], - "long_name": "Ile-de-France", - "short_name": "IDF" - }, + "long_name": "United States", + "short_name": "US" + } + ] + }, + { + "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5iYXI6MDE5ZGUzNTdiZDkyNzAyZDM4ZDUyOWQ0YmJiZjBmODQ5YWEzZmY1NA==", + "types": [ + "point_of_interest", + "business.food_and_drinks.bar" + ], + "categories": [ + "business.food_and_drinks.bar" + ], + "name": "Bon Courage", + "formatted_address": "Reade Street, New York", + "geometry": { + "location": { + "lat": 40.71541472882126, + "lng": -74.00719193106873 + } + }, + "address_components": [ { "types": [ - "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": "New York", + "short_name": "New York" }, { - "long_name": "7th Arrondissement", - "short_name": "7th Arrondissement", "types": [ - "district" - ] + "route" + ], + "long_name": "Reade Street", + "short_name": "Reade Street" + } + ] + }, + { + "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6OGIyNDY5MDM4M2JhYzE1NmY4OGRiMGQzYmIyYzNjMTVmOTk0NDQwZQ==", + "types": [ + "point_of_interest", + "business.food_and_drinks.fast_food" + ], + "categories": [ + "business.food_and_drinks.fast_food" + ], + "name": "Burger King", + "formatted_address": "Broadway, New York", + "geometry": { + "location": { + "lat": 40.71619516782573, + "lng": -74.00480635760651 + } + }, + "address_components": [ + { + "types": [ + "country", + "administrative_area_level_0", + "division_level_0" + ], + "long_name": "United States", + "short_name": "US" }, { - "long_name": "Place de la Résistance", - "short_name": "Place de la Résistance", "types": [ - "route" - ] + "locality" + ], + "long_name": "New York", + "short_name": "New York" }, { - "long_name": "75007", - "short_name": "75007", "types": [ - "postal_code" - ] + "route" + ], + "long_name": "Broadway", + "short_name": "Broadway" } + ] + }, + { + "public_id": "cG9pOnVzOmJ1c2luZXNzLnRoZWF0cmU6MTU1Yjk5YmEwY2FiYzIzZjYxYWYyYTViYzI0ZDViYTVlNmVmZTAwNA==", + "types": [ + "point_of_interest", + "business.theatre" + ], + "categories": [ + "business.theatre" ], + "name": "The Flea", + "formatted_address": "Thomas Street, New York", "geometry": { - "location_type": "GEOMETRIC_CENTER", "location": { - "lat": 48.86213, - "lng": 2.30152 + "lat": 40.71609349534023, + "lng": -74.00589281989586 + } + }, + "address_components": [ + { + "types": [ + "country", + "administrative_area_level_0", + "division_level_0" + ], + "long_name": "United States", + "short_name": "US" }, - "viewport": { - "northeast": { - "lat": 48.86231, - "lng": 2.30541 - }, - "southwest": { - "lat": 48.86191, - "lng": 2.30147 - } + { + "types": [ + "locality" + ], + "long_name": "New York", + "short_name": "New York" + }, + { + "types": [ + "route" + ], + "long_name": "Thomas Street", + "short_name": "Thomas Street" } - } + ] } ], - "status": "OK" + "pagination": { + "previous_page": 2, + "next_page": 4 + } } }, "Woosmap_Platform_API_Reference_Zone": { @@ -21427,6 +20306,7 @@ "da", "de", "es", + "et", "fi", "he", "it", @@ -21682,6 +20562,7 @@ "da", "de", "es", + "et", "fi", "he", "it", @@ -22867,7 +21748,6 @@ "tags": [ "Geolocation API", "Localities API", - "Address API", "Datasets API", "Woosmap for what3words API" ] diff --git a/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.go b/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.go deleted file mode 100644 index e5a17ac8..00000000 --- a/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.go +++ /dev/null @@ -1,39 +0,0 @@ -// [START woosmap_http_address_autocomplete_collection] -package main - -import ( - "fmt" - "net/http" - "io" -) - -func main() { - - url := "https://api.woosmap.com/address/autocomplete/json?input=Lond&components=country%3Agb&key=YOUR_PUBLIC_API_KEY" - method := "GET" - - client := &http.Client { - } - req, err := http.NewRequest(method, url, nil) - - if err != nil { - fmt.Println(err) - return - } - req.Header.Add("Referer", "http://localhost") - - res, err := client.Do(req) - if err != nil { - fmt.Println(err) - return - } - defer res.Body.Close() - - body, err := io.ReadAll(res.Body) - if err != nil { - fmt.Println(err) - return - } - fmt.Println(string(body)) -} -// [END woosmap_http_address_autocomplete_collection] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.java b/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.java deleted file mode 100644 index b56cd92e..00000000 --- a/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.java +++ /dev/null @@ -1,12 +0,0 @@ -// [START woosmap_http_address_autocomplete_collection] -OkHttpClient client = new OkHttpClient().newBuilder() - .build(); -MediaType mediaType = MediaType.parse("text/plain"); -RequestBody body = RequestBody.create(mediaType, ""); -Request request = new Request.Builder() - .url("https://api.woosmap.com/address/autocomplete/json?input=Lond&components=country%3Agb&key=YOUR_PUBLIC_API_KEY") - .method("GET", body) - .addHeader("Referer", "http://localhost") - .build(); -Response response = client.newCall(request).execute(); -// [END woosmap_http_address_autocomplete_collection] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.js b/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.js deleted file mode 100644 index 884e6e25..00000000 --- a/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.js +++ /dev/null @@ -1,11 +0,0 @@ -// [START woosmap_http_address_autocomplete_collection] -const requestOptions = { - method: "GET", - redirect: "follow" -}; - -fetch("https://api.woosmap.com/address/autocomplete/json?input=Lond&components=country%3Agb&key=YOUR_PUBLIC_API_KEY", requestOptions) - .then((response) => response.text()) - .then((result) => console.log(result)) - .catch((error) => console.error(error)); -// [END woosmap_http_address_autocomplete_collection] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.node.js b/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.node.js deleted file mode 100644 index 5ca014d6..00000000 --- a/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.node.js +++ /dev/null @@ -1,21 +0,0 @@ -// [START woosmap_http_address_autocomplete_collection] -const axios = require('axios'); - -let config = { - method: 'get', - maxBodyLength: Infinity, - url: 'https://api.woosmap.com/address/autocomplete/json?input=Lond&components=country%3Agb&key=YOUR_PUBLIC_API_KEY', - headers: { - 'Referer': 'http://localhost' - } -}; - -axios.request(config) -.then((response) => { - console.log(JSON.stringify(response.data)); -}) -.catch((error) => { - console.log(error); -}); - -// [END woosmap_http_address_autocomplete_collection] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.py b/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.py deleted file mode 100644 index e9aa66a6..00000000 --- a/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.py +++ /dev/null @@ -1,15 +0,0 @@ -# [START woosmap_http_address_autocomplete_collection] -import requests - -url = "https://api.woosmap.com/address/autocomplete/json?input=Lond&components=country%3Agb&key=YOUR_PUBLIC_API_KEY" - -payload = {} -headers = { - 'Referer': 'http://localhost' -} - -response = requests.request("GET", url, headers=headers, data=payload) - -print(response.text) - -# [END woosmap_http_address_autocomplete_collection] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.rb b/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.rb deleted file mode 100644 index 6ad7f8ac..00000000 --- a/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.rb +++ /dev/null @@ -1,16 +0,0 @@ -# [START woosmap_http_address_autocomplete_collection] -require "uri" -require "net/http" - -url = URI("https://api.woosmap.com/address/autocomplete/json?input=Lond&components=country%3Agb&key=YOUR_PUBLIC_API_KEY") - -https = Net::HTTP.new(url.host, url.port) -https.use_ssl = true - -request = Net::HTTP::Get.new(url) -request["Referer"] = "http://localhost" - -response = https.request(request) -puts response.read_body - -# [END woosmap_http_address_autocomplete_collection] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.sh b/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.sh deleted file mode 100644 index 131d60de..00000000 --- a/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.sh +++ /dev/null @@ -1,4 +0,0 @@ -# [START woosmap_http_address_autocomplete_collection] -curl -L 'https://api.woosmap.com/address/autocomplete/json?input=Lond&components=country%3Agb&key=YOUR_PUBLIC_API_KEY' \ --H 'Referer: http://localhost' -# [END woosmap_http_address_autocomplete_collection] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.txt b/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.txt deleted file mode 100644 index c84de836..00000000 --- a/dist/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.txt +++ /dev/null @@ -1,6 +0,0 @@ -[START woosmap_http_address_autocomplete_collection] -https://api.woosmap.com/address/autocomplete/json - ?components=country%3Agb - &input=Lond - &key=YOUR_PUBLIC_API_KEY -[END woosmap_http_address_autocomplete_collection] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.go b/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.go deleted file mode 100644 index 8fdcf343..00000000 --- a/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.go +++ /dev/null @@ -1,39 +0,0 @@ -// [START woosmap_http_address_details] -package main - -import ( - "fmt" - "net/http" - "io" -) - -func main() { - - url := "https://api.woosmap.com/address/details/json?public_id=aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0&key=YOUR_PUBLIC_API_KEY" - method := "GET" - - client := &http.Client { - } - req, err := http.NewRequest(method, url, nil) - - if err != nil { - fmt.Println(err) - return - } - req.Header.Add("Referer", "http://localhost") - - res, err := client.Do(req) - if err != nil { - fmt.Println(err) - return - } - defer res.Body.Close() - - body, err := io.ReadAll(res.Body) - if err != nil { - fmt.Println(err) - return - } - fmt.Println(string(body)) -} -// [END woosmap_http_address_details] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.java b/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.java deleted file mode 100644 index 853c5b55..00000000 --- a/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.java +++ /dev/null @@ -1,12 +0,0 @@ -// [START woosmap_http_address_details] -OkHttpClient client = new OkHttpClient().newBuilder() - .build(); -MediaType mediaType = MediaType.parse("text/plain"); -RequestBody body = RequestBody.create(mediaType, ""); -Request request = new Request.Builder() - .url("https://api.woosmap.com/address/details/json?public_id=aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0&key=YOUR_PUBLIC_API_KEY") - .method("GET", body) - .addHeader("Referer", "http://localhost") - .build(); -Response response = client.newCall(request).execute(); -// [END woosmap_http_address_details] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.js b/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.js deleted file mode 100644 index 9912be2d..00000000 --- a/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.js +++ /dev/null @@ -1,11 +0,0 @@ -// [START woosmap_http_address_details] -const requestOptions = { - method: "GET", - redirect: "follow" -}; - -fetch("https://api.woosmap.com/address/details/json?public_id=aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0&key=YOUR_PUBLIC_API_KEY", requestOptions) - .then((response) => response.text()) - .then((result) => console.log(result)) - .catch((error) => console.error(error)); -// [END woosmap_http_address_details] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.node.js b/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.node.js deleted file mode 100644 index 56040713..00000000 --- a/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.node.js +++ /dev/null @@ -1,21 +0,0 @@ -// [START woosmap_http_address_details] -const axios = require('axios'); - -let config = { - method: 'get', - maxBodyLength: Infinity, - url: 'https://api.woosmap.com/address/details/json?public_id=aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0&key=YOUR_PUBLIC_API_KEY', - headers: { - 'Referer': 'http://localhost' - } -}; - -axios.request(config) -.then((response) => { - console.log(JSON.stringify(response.data)); -}) -.catch((error) => { - console.log(error); -}); - -// [END woosmap_http_address_details] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.py b/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.py deleted file mode 100644 index b7d1d084..00000000 --- a/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.py +++ /dev/null @@ -1,15 +0,0 @@ -# [START woosmap_http_address_details] -import requests - -url = "https://api.woosmap.com/address/details/json?public_id=aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0&key=YOUR_PUBLIC_API_KEY" - -payload = {} -headers = { - 'Referer': 'http://localhost' -} - -response = requests.request("GET", url, headers=headers, data=payload) - -print(response.text) - -# [END woosmap_http_address_details] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.rb b/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.rb deleted file mode 100644 index 53f7c276..00000000 --- a/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.rb +++ /dev/null @@ -1,16 +0,0 @@ -# [START woosmap_http_address_details] -require "uri" -require "net/http" - -url = URI("https://api.woosmap.com/address/details/json?public_id=aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0&key=YOUR_PUBLIC_API_KEY") - -https = Net::HTTP.new(url.host, url.port) -https.use_ssl = true - -request = Net::HTTP::Get.new(url) -request["Referer"] = "http://localhost" - -response = https.request(request) -puts response.read_body - -# [END woosmap_http_address_details] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.sh b/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.sh deleted file mode 100644 index c686eda3..00000000 --- a/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.sh +++ /dev/null @@ -1,4 +0,0 @@ -# [START woosmap_http_address_details] -curl -L 'https://api.woosmap.com/address/details/json?public_id=aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0&key=YOUR_PUBLIC_API_KEY' \ --H 'Referer: http://localhost' -# [END woosmap_http_address_details] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.txt b/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.txt deleted file mode 100644 index a17f354e..00000000 --- a/dist/snippets/woosmap_http_address_details/woosmap_http_address_details.txt +++ /dev/null @@ -1,5 +0,0 @@ -[START woosmap_http_address_details] -https://api.woosmap.com/address/details/json - ?public_id=aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0 - &key=YOUR_PUBLIC_API_KEY -[END woosmap_http_address_details] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.go b/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.go deleted file mode 100644 index dfd371fc..00000000 --- a/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.go +++ /dev/null @@ -1,39 +0,0 @@ -// [START woosmap_http_address_geocode_collection] -package main - -import ( - "fmt" - "net/http" - "io" -) - -func main() { - - url := "https://api.woosmap.com/address/geocode/json?address=Place%20de%20la%20Resistance%20Paris&components=country%3AFR&limit=5&key=YOUR_PUBLIC_API_KEY" - method := "GET" - - client := &http.Client { - } - req, err := http.NewRequest(method, url, nil) - - if err != nil { - fmt.Println(err) - return - } - req.Header.Add("Referer", "http://localhost") - - res, err := client.Do(req) - if err != nil { - fmt.Println(err) - return - } - defer res.Body.Close() - - body, err := io.ReadAll(res.Body) - if err != nil { - fmt.Println(err) - return - } - fmt.Println(string(body)) -} -// [END woosmap_http_address_geocode_collection] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.java b/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.java deleted file mode 100644 index 675fd5ce..00000000 --- a/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.java +++ /dev/null @@ -1,12 +0,0 @@ -// [START woosmap_http_address_geocode_collection] -OkHttpClient client = new OkHttpClient().newBuilder() - .build(); -MediaType mediaType = MediaType.parse("text/plain"); -RequestBody body = RequestBody.create(mediaType, ""); -Request request = new Request.Builder() - .url("https://api.woosmap.com/address/geocode/json?address=Place%20de%20la%20Resistance%20Paris&components=country%3AFR&limit=5&key=YOUR_PUBLIC_API_KEY") - .method("GET", body) - .addHeader("Referer", "http://localhost") - .build(); -Response response = client.newCall(request).execute(); -// [END woosmap_http_address_geocode_collection] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.js b/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.js deleted file mode 100644 index ce011102..00000000 --- a/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.js +++ /dev/null @@ -1,11 +0,0 @@ -// [START woosmap_http_address_geocode_collection] -const requestOptions = { - method: "GET", - redirect: "follow" -}; - -fetch("https://api.woosmap.com/address/geocode/json?address=Place%20de%20la%20Resistance%20Paris&components=country%3AFR&limit=5&key=YOUR_PUBLIC_API_KEY", requestOptions) - .then((response) => response.text()) - .then((result) => console.log(result)) - .catch((error) => console.error(error)); -// [END woosmap_http_address_geocode_collection] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.node.js b/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.node.js deleted file mode 100644 index 7e2ba5e7..00000000 --- a/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.node.js +++ /dev/null @@ -1,21 +0,0 @@ -// [START woosmap_http_address_geocode_collection] -const axios = require('axios'); - -let config = { - method: 'get', - maxBodyLength: Infinity, - url: 'https://api.woosmap.com/address/geocode/json?address=Place%20de%20la%20Resistance%20Paris&components=country%3AFR&limit=5&key=YOUR_PUBLIC_API_KEY', - headers: { - 'Referer': 'http://localhost' - } -}; - -axios.request(config) -.then((response) => { - console.log(JSON.stringify(response.data)); -}) -.catch((error) => { - console.log(error); -}); - -// [END woosmap_http_address_geocode_collection] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.py b/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.py deleted file mode 100644 index 1e5a5740..00000000 --- a/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.py +++ /dev/null @@ -1,15 +0,0 @@ -# [START woosmap_http_address_geocode_collection] -import requests - -url = "https://api.woosmap.com/address/geocode/json?address=Place%20de%20la%20Resistance%20Paris&components=country%3AFR&limit=5&key=YOUR_PUBLIC_API_KEY" - -payload = {} -headers = { - 'Referer': 'http://localhost' -} - -response = requests.request("GET", url, headers=headers, data=payload) - -print(response.text) - -# [END woosmap_http_address_geocode_collection] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.rb b/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.rb deleted file mode 100644 index 77cbf63c..00000000 --- a/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.rb +++ /dev/null @@ -1,16 +0,0 @@ -# [START woosmap_http_address_geocode_collection] -require "uri" -require "net/http" - -url = URI("https://api.woosmap.com/address/geocode/json?address=Place%20de%20la%20Resistance%20Paris&components=country%3AFR&limit=5&key=YOUR_PUBLIC_API_KEY") - -https = Net::HTTP.new(url.host, url.port) -https.use_ssl = true - -request = Net::HTTP::Get.new(url) -request["Referer"] = "http://localhost" - -response = https.request(request) -puts response.read_body - -# [END woosmap_http_address_geocode_collection] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.sh b/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.sh deleted file mode 100644 index f10b62a3..00000000 --- a/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.sh +++ /dev/null @@ -1,4 +0,0 @@ -# [START woosmap_http_address_geocode_collection] -curl -L 'https://api.woosmap.com/address/geocode/json?address=Place%20de%20la%20Resistance%20Paris&components=country%3AFR&limit=5&key=YOUR_PUBLIC_API_KEY' \ --H 'Referer: http://localhost' -# [END woosmap_http_address_geocode_collection] \ No newline at end of file diff --git a/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.txt b/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.txt deleted file mode 100644 index 56fe95f1..00000000 --- a/dist/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.txt +++ /dev/null @@ -1,7 +0,0 @@ -[START woosmap_http_address_geocode_collection] -https://api.woosmap.com/address/geocode/json - ?address=Place%20de%20la%20Resistance%20Paris - &components=country%3AFR - &limit=5 - &key=YOUR_PUBLIC_API_KEY -[END woosmap_http_address_geocode_collection] \ No newline at end of file diff --git a/dist/woosmap-openapi3.json b/dist/woosmap-openapi3.json index 391b2854..91e6964f 100755 --- a/dist/woosmap-openapi3.json +++ b/dist/woosmap-openapi3.json @@ -64,13 +64,6 @@ "externalDocs": { "url": "https://developers.woosmap.com/products/localities/get-started/" } - }, - { - "name": "Address API", - "description": "Woosmap Address API is a web service that returns addresses and other geographical places in response to an HTTP request. Request is done over HTTPS using GET. Response is formatted as JSON. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/support/api-keys/).\n>**⚠️ This API has been deprecated in favour of Localities API**\n", - "externalDocs": { - "url": "https://developers.woosmap.com/products/address-api/get-started/" - } } ], "paths": { @@ -2895,7 +2888,7 @@ "$ref": "#/components/parameters/data" }, { - "$ref": "#/components/parameters/cc_format-2" + "$ref": "#/components/parameters/cc_format" } ], "responses": { @@ -3783,113 +3776,65 @@ ] } }, - "/address/autocomplete/json": { + "/zones": { "get": { - "deprecated": true, - "summary": "Autocomplete for Addresses", - "operationId": "addressAutocomplete", + "summary": "List your Zones", + "operationId": "listZones", "servers": [ { "url": "https://api.woosmap.com" } ], "tags": [ - "Address API" + "Zones" ], - "description": "Autocomplete on worldwide suggestions for a for text-based geographic searches. It can match on full words as well as substrings.\n", + "description": "List all zones for the current project, sorted by `zone_id`.\n", "security": [ - { - "PublicApiKeyAuth": [], - "RefererHeader": [] - }, { "PrivateApiKeyAuth": [] - }, - { - "PrivateApiKeyHeaderAuth": [] } ], "parameters": [ { - "$ref": "#/components/parameters/input-2" - }, - { - "$ref": "#/components/parameters/address_components" - }, - { - "$ref": "#/components/parameters/location-2" + "$ref": "#/components/parameters/limit-3" }, { - "$ref": "#/components/parameters/language-3" + "$ref": "#/components/parameters/offset" } ], "responses": { "200": { - "description": "Autocompletion Address successfully retrieved", + "description": "Zones successfully retrieved", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AddressAutocompleteCollectionResponse" + "$ref": "#/components/schemas/ZonesCollectionResponse" }, "examples": { "default": { - "summary": "Autocomplete address results for input `Lond` and components `country:gb`", + "summary": "Zones data", "value": { - "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" - }, + "zones": [ { - "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NjEw", - "description": "London Heathrow Airport, Hounslow, England, United Kingdom", - "matched_substring": { - "description": [ - { - "offset": 0, - "length": 4 - } - ] - }, - "type": "locality" + "store_id": "STORE_ID_123456", + "zone_id": "ZoneB", + "polygon": "POLYGON ((-122.4546384 37.774656, -122.4515485 37.7595934, -122.4354306 37.7602172, -122.4333707 37.7512596, -122.423071 37.7511239, -122.4242726 37.7687665, -122.4259893 37.7691736, -122.4289075 37.7732444, -122.4306241 37.7850483, -122.4472753 37.7830133, -122.445902 37.7759581, -122.4546384 37.774656))", + "types": [ + "delivery" + ], + "description": "Delivery Zone for Store B" }, { - "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM0NDEy", - "description": "London Luton Airport, Luton, England, United Kingdom", - "matched_substring": { - "description": [ - { - "offset": 0, - "length": 4 - } - ] - }, - "type": "locality" + "store_id": "STORE_ID_45678", + "zone_id": "ZoneC", + "polygon": "POLYGON ((-122.4758889 37.7524995, -122.4751594 37.7321718, -122.4688079 37.7299995, -122.4648597 37.7261979, -122.4519851 37.7228035, -122.4483802 37.7215815, -122.4458053 37.726741, -122.4365356 37.7310857, -122.4315574 37.7324433, -122.4246909 37.7312214, -122.4219444 37.731493, -122.423071 37.7511239, -122.4333707 37.7512596, -122.4354306 37.7602172, -122.4515485 37.7595934, -122.4528628 37.7582744, -122.4540375 37.7566755, -122.4565266 37.7513144, -122.4601315 37.7521288, -122.4618481 37.7514501, -122.4635648 37.7530788, -122.4758889 37.7524995))", + "types": [ + "delivery" + ], + "description": "Delivery Zone for Store C" } ], - "status": "OK" + "status": "ok" } } } @@ -3955,186 +3900,153 @@ { "lang": "curl", "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/address/autocomplete/json?input=Lond&components=country%3Agb&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'" + "source": "curl -L 'https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY&limit=2&offset=1'" }, { "lang": "javascript", "label": "JavaScript", - "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/address/autocomplete/json?input=Lond&components=country%3Agb&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));" + "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY&limit=2&offset=1\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));" }, { "lang": "python", "label": "Python", - "source": "import requests\n\nurl = \"https://api.woosmap.com/address/autocomplete/json?input=Lond&components=country%3Agb&key=YOUR_PUBLIC_API_KEY\"\n\npayload = {}\nheaders = {\n 'Referer': 'http://localhost'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + "source": "import requests\n\nurl = \"https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY&limit=2&offset=1\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ] - } - }, - "/address/details/json": { - "get": { - "deprecated": true, - "summary": "Details of an Address", - "operationId": "addressDetails", + }, + "post": { + "summary": "Create your Zones", + "operationId": "createZones", "servers": [ { "url": "https://api.woosmap.com" } ], "tags": [ - "Address API" + "Zones" ], - "description": "Provides details of an address autocomplete suggestion (using the suggestion’s `public_id`).\n", + "description": "Used to batch create Zones to a specific project identified with the `private_key` parameter.\n", "security": [ - { - "PublicApiKeyAuth": [], - "RefererHeader": [] - }, { "PrivateApiKeyAuth": [] - }, - { - "PrivateApiKeyHeaderAuth": [] } ], - "parameters": [ - { - "$ref": "#/components/parameters/public_id-2" - }, - { - "$ref": "#/components/parameters/fields-2" - }, - { - "$ref": "#/components/parameters/cc_format" + "requestBody": { + "description": "The request body of Zones Creation must be formatted as JSON.", + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ZonesCollectionRequest" + }, + "examples": { + "default": { + "summary": "Zones data as JSON", + "value": { + "zones": [ + { + "zone_id": "ZoneA", + "description": "Delivery Zone for Store A", + "store_id": "STORE_ID_123456", + "polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))", + "types": [ + "delivery" + ] + }, + { + "zone_id": "ZoneB", + "description": "Delivery Zone for Store B", + "store_id": "STORE_ID_123456", + "polygon": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))", + "types": [ + "delivery" + ] + }, + { + "zone_id": "ZoneC", + "description": "Delivery Zone for Store C", + "store_id": "STORE_ID_45678", + "polygon": "POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))", + "types": [ + "delivery" + ] + } + ] + } + } + } + } } - ], + }, "responses": { "200": { - "description": "Details Address successfully retrieved", + "description": "Zones successfully created", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AddressDetailsResponse" + "$ref": "#/components/schemas/SuccessZones" }, "examples": { "default": { - "summary": "Address Details for `London, England, United Kingdom`", + "summary": "Success response for Zones Created", "value": { - "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 - } - } - } - }, - "status": "OK" + "status": "ok", + "message": "Zones successfully added." } } } } } }, - "401": { - "description": "Unauthorized. Incorrect authentication credentials.", + "400": { + "description": "Invalid. The data is not a valid JSON.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Error401" + "$ref": "#/components/schemas/Error400" }, "examples": { - "Unauthorized": { - "summary": "Error 401", + "Invalid": { + "summary": "Error 400", "value": { - "detail": "Incorrect authentication credentials. Please check or use a valid API Key" + "status": "error", + "value": "The request is invalid, the data is not a valid JSON." } } } } } }, - "403": { - "description": "Forbidden. This Woosmap API is not enabled for this project.", + "401": { + "description": "Unauthorized. Incorrect authentication credentials.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Error403" + "$ref": "#/components/schemas/Error401" }, "examples": { - "Forbidden": { - "summary": "Error 403", + "Unauthorized": { + "summary": "Error 401", "value": { - "detail": "This Woosmap API is not enabled for this project." + "detail": "Incorrect authentication credentials. Please check or use a valid API Key" } } } } } }, - "429": { - "description": "Too Many Requests. The rate limit for this endpoint has been exceeded.", + "403": { + "description": "Forbidden. This Woosmap API is not enabled for this project.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Error429" + "$ref": "#/components/schemas/Error403" }, "examples": { "Forbidden": { - "summary": "Error 429", + "summary": "Error 403", "value": { - "detail": "The rate limit for this endpoint has been exceeded" + "detail": "This Woosmap API is not enabled for this project." } } } @@ -4146,214 +4058,152 @@ { "lang": "curl", "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/address/details/json?public_id=aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0&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/address/details/json?public_id=aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));" + "source": "curl -L 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneB\",\n \"description\": \"Delivery Zone for Store B\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneC\",\n \"description\": \"Delivery Zone for Store C\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n}'" }, { "lang": "python", "label": "Python", - "source": "import requests\n\nurl = \"https://api.woosmap.com/address/details/json?public_id=aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0&key=YOUR_PUBLIC_API_KEY\"\n\npayload = {}\nheaders = {\n 'Referer': 'http://localhost'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + "source": "import requests\nimport json\n\nurl = \"https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneB\",\n \"description\": \"Delivery Zone for Store B\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneC\",\n \"description\": \"Delivery Zone for Store C\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + }, + { + "lang": "nodejs", + "label": "NodeJS", + "source": "const axios = require('axios');\nlet data = JSON.stringify({\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneB\",\n \"description\": \"Delivery Zone for Store B\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneC\",\n \"description\": \"Delivery Zone for Store C\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n});\n\nlet config = {\n method: 'post',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY',\n headers: { \n 'content-type': 'application/json'\n },\n data : data\n};\n\naxios.request(config)\n.then((response) => {\n console.log(JSON.stringify(response.data));\n})\n.catch((error) => {\n console.log(error);\n});\n" } ] - } - }, - "/address/geocode/json": { - "get": { - "deprecated": true, - "summary": "Geocode an Address or Reverse Geocode a latlng", - "operationId": "addressGeocode", + }, + "put": { + "summary": "Update the Zones", + "operationId": "updateZones", "servers": [ { "url": "https://api.woosmap.com" } ], "tags": [ - "Address API" + "Zones" ], - "description": "Provides details for an address or a geographic position. Either parameter `address` **or** `latlng` is required. Maximum of 25 queries per second (QPS)\n", + "description": "Used to update zones in batch. `zone_id` must exists when using `PUT` method, if one zone does not exists, the batch will be refused.", "security": [ - { - "PublicApiKeyAuth": [], - "RefererHeader": [] - }, { "PrivateApiKeyAuth": [] - }, - { - "PrivateApiKeyHeaderAuth": [] } ], - "parameters": [ - { - "$ref": "#/components/parameters/address-2" - }, - { - "$ref": "#/components/parameters/latlng-2" - }, - { - "$ref": "#/components/parameters/address_components" - }, - { - "$ref": "#/components/parameters/language-3" - }, - { - "$ref": "#/components/parameters/location-2" - }, - { - "$ref": "#/components/parameters/cc_format" - }, - { - "$ref": "#/components/parameters/limit-3" + "requestBody": { + "description": "The request body of Zones Update must be formatted as JSON.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ZonesCollectionRequest" + }, + "examples": { + "default": { + "summary": "Zones data", + "value": { + "zones": [ + { + "zone_id": "ZoneA", + "description": "Delivery Zone for Store A", + "store_id": "STORE_ID_123456", + "polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))", + "types": [ + "delivery" + ] + }, + { + "zone_id": "ZoneB", + "description": "Delivery Zone for Store B", + "store_id": "STORE_ID_123456", + "polygon": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))", + "types": [ + "delivery" + ] + }, + { + "zone_id": "ZoneC", + "description": "Delivery Zone for Store C", + "store_id": "STORE_ID_45678", + "polygon": "POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))", + "types": [ + "delivery" + ] + } + ] + } + } + } + } } - ], + }, "responses": { "200": { - "description": "Request Address Geocode successful", + "description": "Zones successfully updated", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/AddressGeocodeCollectionResponse" + "$ref": "#/components/schemas/SuccessZones" }, "examples": { "default": { - "summary": "Geocode Results for address `Place de la Resistance` with components `country:FR`", + "summary": "Success response for Zones updated", "value": { - "results": [ - { - "formatted_address": "Place de la Résistance, 75007 Paris, France", - "types": [ - "address", - "route" - ], - "address_components": [ - { - "types": [ - "country" - ], - "long_name": "France", - "short_name": "FRA" - }, - { - "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" - ] - } - ], - "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 - } - } - } - } - ], - "status": "OK" + "status": "ok", + "message": "Zones successfully added." } } } } } }, - "401": { - "description": "Unauthorized. Incorrect authentication credentials.", + "400": { + "description": "Invalid. The data is not a valid JSON.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Error401" + "$ref": "#/components/schemas/Error400" }, "examples": { - "Unauthorized": { - "summary": "Error 401", + "Invalid": { + "summary": "Error 400", "value": { - "detail": "Incorrect authentication credentials. Please check or use a valid API Key" + "status": "error", + "value": "The request is invalid, the data is not a valid JSON." } } } } } }, - "403": { - "description": "Forbidden. This Woosmap API is not enabled for this project.", + "401": { + "description": "Unauthorized. Incorrect authentication credentials.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Error403" + "$ref": "#/components/schemas/Error401" }, "examples": { - "Forbidden": { - "summary": "Error 403", + "Unauthorized": { + "summary": "Error 401", "value": { - "detail": "This Woosmap API is not enabled for this project." + "detail": "Incorrect authentication credentials. Please check or use a valid API Key" } } } } } }, - "429": { - "description": "Too Many Requests. The rate limit for this endpoint has been exceeded.", + "403": { + "description": "Forbidden. This Woosmap API is not enabled for this project.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Error429" + "$ref": "#/components/schemas/Error403" }, "examples": { "Forbidden": { - "summary": "Error 429", + "summary": "Error 403", "value": { - "detail": "The rate limit for this endpoint has been exceeded" + "detail": "This Woosmap API is not enabled for this project." } } } @@ -4365,25 +4215,23 @@ { "lang": "curl", "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/address/geocode/json?address=Place%20de%20la%20Resistance%20Paris&components=country%3AFR&limit=5&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/address/geocode/json?address=Place%20de%20la%20Resistance%20Paris&components=country%3AFR&limit=5&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 PUT 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n}'" }, { "lang": "python", "label": "Python", - "source": "import requests\n\nurl = \"https://api.woosmap.com/address/geocode/json?address=Place%20de%20la%20Resistance%20Paris&components=country%3AFR&limit=5&key=YOUR_PUBLIC_API_KEY\"\n\npayload = {}\nheaders = {\n 'Referer': 'http://localhost'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + "source": "import requests\nimport json\n\nurl = \"https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + }, + { + "lang": "nodejs", + "label": "NodeJS", + "source": "const axios = require('axios');\nlet data = JSON.stringify({\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n});\n\nlet config = {\n method: 'put',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY',\n headers: { \n 'content-type': 'application/json'\n },\n data : data\n};\n\naxios.request(config)\n.then((response) => {\n console.log(JSON.stringify(response.data));\n})\n.catch((error) => {\n console.log(error);\n});\n" } ] - } - }, - "/zones": { - "get": { - "summary": "List your Zones", - "operationId": "listZones", + }, + "delete": { + "summary": "Delete the Zones", + "operationId": "deleteZones", "servers": [ { "url": "https://api.woosmap.com" @@ -4392,53 +4240,26 @@ "tags": [ "Zones" ], - "description": "List all zones for the current project, sorted by `zone_id`.\n", + "description": "Used to delete one or more Zones.", "security": [ { "PrivateApiKeyAuth": [] } ], - "parameters": [ - { - "$ref": "#/components/parameters/limit-4" - }, - { - "$ref": "#/components/parameters/offset" - } - ], "responses": { "200": { - "description": "Zones successfully retrieved", + "description": "Zones successfully deleted", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ZonesCollectionResponse" + "$ref": "#/components/schemas/SuccessZones" }, "examples": { "default": { - "summary": "Zones data", + "summary": "Success response for Zones deleted", "value": { - "zones": [ - { - "store_id": "STORE_ID_123456", - "zone_id": "ZoneB", - "polygon": "POLYGON ((-122.4546384 37.774656, -122.4515485 37.7595934, -122.4354306 37.7602172, -122.4333707 37.7512596, -122.423071 37.7511239, -122.4242726 37.7687665, -122.4259893 37.7691736, -122.4289075 37.7732444, -122.4306241 37.7850483, -122.4472753 37.7830133, -122.445902 37.7759581, -122.4546384 37.774656))", - "types": [ - "delivery" - ], - "description": "Delivery Zone for Store B" - }, - { - "store_id": "STORE_ID_45678", - "zone_id": "ZoneC", - "polygon": "POLYGON ((-122.4758889 37.7524995, -122.4751594 37.7321718, -122.4688079 37.7299995, -122.4648597 37.7261979, -122.4519851 37.7228035, -122.4483802 37.7215815, -122.4458053 37.726741, -122.4365356 37.7310857, -122.4315574 37.7324433, -122.4246909 37.7312214, -122.4219444 37.731493, -122.423071 37.7511239, -122.4333707 37.7512596, -122.4354306 37.7602172, -122.4515485 37.7595934, -122.4528628 37.7582744, -122.4540375 37.7566755, -122.4565266 37.7513144, -122.4601315 37.7521288, -122.4618481 37.7514501, -122.4635648 37.7530788, -122.4758889 37.7524995))", - "types": [ - "delivery" - ], - "description": "Delivery Zone for Store C" - } - ], - "status": "ok" + "status": "ok", + "message": "Zones deleted." } } } @@ -4480,47 +4301,31 @@ } } } - }, - "429": { - "description": "Too Many Requests. The rate limit for this endpoint has been exceeded.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error429" - }, - "examples": { - "Forbidden": { - "summary": "Error 429", - "value": { - "detail": "The rate limit for this endpoint has been exceeded" - } - } - } - } - } } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY&limit=2&offset=1'" - }, - { - "lang": "javascript", - "label": "JavaScript", - "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY&limit=2&offset=1\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));" + "source": "curl -L -X DELETE 'https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY'" }, { "lang": "python", "label": "Python", - "source": "import requests\n\nurl = \"https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY&limit=2&offset=1\"\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/zones/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"DELETE\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + }, + { + "lang": "nodejs", + "label": "NodeJS", + "source": "const axios = require('axios');\n\nlet config = {\n method: 'delete',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY',\n headers: { }\n};\n\naxios.request(config)\n.then((response) => {\n console.log(JSON.stringify(response.data));\n})\n.catch((error) => {\n console.log(error);\n});\n" } ] - }, - "post": { - "summary": "Create your Zones", - "operationId": "createZones", + } + }, + "/zones/{zone_id}": { + "get": { + "summary": "Get Zone from ID", + "operationId": "getZone", "servers": [ { "url": "https://api.woosmap.com" @@ -4529,92 +4334,44 @@ "tags": [ "Zones" ], - "description": "Used to batch create Zones to a specific project identified with the `private_key` parameter.\n", + "description": "Used to retrieve a zone from his `zone_id`\n", "security": [ { "PrivateApiKeyAuth": [] } ], - "requestBody": { - "description": "The request body of Zones Creation must be formatted as JSON.", - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ZonesCollectionRequest" - }, - "examples": { - "default": { - "summary": "Zones data as JSON", - "value": { - "zones": [ - { - "zone_id": "ZoneA", - "description": "Delivery Zone for Store A", - "store_id": "STORE_ID_123456", - "polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))", - "types": [ - "delivery" - ] - }, - { - "zone_id": "ZoneB", - "description": "Delivery Zone for Store B", - "store_id": "STORE_ID_123456", - "polygon": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))", - "types": [ - "delivery" - ] - }, - { - "zone_id": "ZoneC", - "description": "Delivery Zone for Store C", - "store_id": "STORE_ID_45678", - "polygon": "POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))", - "types": [ - "delivery" - ] - } - ] - } - } - } - } + "parameters": [ + { + "in": "path", + "name": "zone_id", + "schema": { + "type": "string" + }, + "required": true, + "example": "ZoneA", + "description": "ID of the zone to get" } - }, + ], "responses": { "200": { - "description": "Zones successfully created", + "description": "Zone successfully retrieved", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SuccessZones" + "$ref": "#/components/schemas/Zone" }, "examples": { "default": { - "summary": "Success response for Zones Created", - "value": { - "status": "ok", - "message": "Zones successfully added." - } - } - } - } - } - }, - "400": { - "description": "Invalid. The data is not a valid JSON.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error400" - }, - "examples": { - "Invalid": { - "summary": "Error 400", + "summary": "Get a zone from its zone_id", "value": { - "status": "error", - "value": "The request is invalid, the data is not a valid JSON." + "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" } } } @@ -4656,29 +4413,32 @@ } } } + }, + "404": { + "description": "Not Found - `zone_id` do not exist." } }, "x-codeSamples": [ { "lang": "curl", "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneB\",\n \"description\": \"Delivery Zone for Store B\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneC\",\n \"description\": \"Delivery Zone for Store C\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n}'" + "source": "curl -L 'https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY'" }, { - "lang": "python", - "label": "Python", - "source": "import requests\nimport json\n\nurl = \"https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneB\",\n \"description\": \"Delivery Zone for Store B\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneC\",\n \"description\": \"Delivery Zone for Store C\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + "lang": "javascript", + "label": "JavaScript", + "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));" }, { - "lang": "nodejs", - "label": "NodeJS", - "source": "const axios = require('axios');\nlet data = JSON.stringify({\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneB\",\n \"description\": \"Delivery Zone for Store B\",\n \"store_id\": \"STORE_ID_123456\",\n \"polygon\": \"POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))\",\n \"types\": [\n \"delivery\"\n ]\n },\n {\n \"zone_id\": \"ZoneC\",\n \"description\": \"Delivery Zone for Store C\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n});\n\nlet config = {\n method: 'post',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY',\n headers: { \n 'content-type': 'application/json'\n },\n data : data\n};\n\naxios.request(config)\n.then((response) => {\n console.log(JSON.stringify(response.data));\n})\n.catch((error) => {\n console.log(error);\n});\n" + "lang": "python", + "label": "Python", + "source": "import requests\n\nurl = \"https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ] }, - "put": { - "summary": "Update the Zones", - "operationId": "updateZones", + "delete": { + "summary": "Delete Zone from ID", + "operationId": "deleteZone", "servers": [ { "url": "https://api.woosmap.com" @@ -4687,61 +4447,27 @@ "tags": [ "Zones" ], - "description": "Used to update zones in batch. `zone_id` must exists when using `PUT` method, if one zone does not exists, the batch will be refused.", + "description": "Used to delete one Zone. The `zone_id` is the id of the zone to delete. To delete several zones, use the comma as a separator.", "security": [ { "PrivateApiKeyAuth": [] } ], - "requestBody": { - "description": "The request body of Zones Update must be formatted as JSON.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ZonesCollectionRequest" - }, - "examples": { - "default": { - "summary": "Zones data", - "value": { - "zones": [ - { - "zone_id": "ZoneA", - "description": "Delivery Zone for Store A", - "store_id": "STORE_ID_123456", - "polygon": "POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))", - "types": [ - "delivery" - ] - }, - { - "zone_id": "ZoneB", - "description": "Delivery Zone for Store B", - "store_id": "STORE_ID_123456", - "polygon": "POLYGON ((-122.4546384 37.774656,-122.4515485 37.7595934,-122.4354306 37.7602172,-122.4333707 37.7512596,-122.423071 37.7511239,-122.4242726 37.7687665,-122.4259893 37.7691736,-122.4289075 37.7732444,-122.4306241 37.7850483,-122.4472753 37.7830133,-122.445902 37.7759581,-122.4546384 37.774656))", - "types": [ - "delivery" - ] - }, - { - "zone_id": "ZoneC", - "description": "Delivery Zone for Store C", - "store_id": "STORE_ID_45678", - "polygon": "POLYGON ((-122.4758889 37.7524995,-122.4751594 37.7321718,-122.4688079 37.7299995,-122.4648597 37.7261979,-122.4519851 37.7228035,-122.4483802 37.7215815,-122.4458053 37.726741,-122.4365356 37.7310857,-122.4315574 37.7324433,-122.4246909 37.7312214,-122.4219444 37.731493,-122.423071 37.7511239,-122.4333707 37.7512596,-122.4354306 37.7602172,-122.4515485 37.7595934,-122.4528628 37.7582744,-122.4540375 37.7566755,-122.4565266 37.7513144,-122.4601315 37.7521288,-122.4618481 37.7514501,-122.4635648 37.7530788,-122.4758889 37.7524995))", - "types": [ - "delivery" - ] - } - ] - } - } - } - } + "parameters": [ + { + "in": "path", + "name": "zone_id", + "schema": { + "type": "string" + }, + "required": true, + "example": "ZoneA", + "description": "ID of the zone to delete" } - }, + ], "responses": { "200": { - "description": "Zones successfully updated", + "description": "Zones successfully deleted", "content": { "application/json": { "schema": { @@ -4749,29 +4475,10 @@ }, "examples": { "default": { - "summary": "Success response for Zones updated", + "summary": "Success response for Zones deleted", "value": { "status": "ok", - "message": "Zones successfully added." - } - } - } - } - } - }, - "400": { - "description": "Invalid. The data is not a valid JSON.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error400" - }, - "examples": { - "Invalid": { - "summary": "Error 400", - "value": { - "status": "error", - "value": "The request is invalid, the data is not a valid JSON." + "message": "Zone ZoneA deleted." } } } @@ -4819,343 +4526,32 @@ { "lang": "curl", "label": "cURL", - "source": "curl -L -X PUT 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY' \\\n-H 'content-type: application/json' \\\n-d '{\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n}'" + "source": "curl -L -X DELETE 'https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY'" }, { "lang": "python", "label": "Python", - "source": "import requests\nimport json\n\nurl = \"https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = json.dumps({\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n})\nheaders = {\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n" + "source": "import requests\n\nurl = \"https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload={}\nheaders = {}\n\nresponse = requests.request(\"DELETE\", url, headers=headers, data=payload)\n\nprint(response.text)\n" }, { "lang": "nodejs", "label": "NodeJS", - "source": "const axios = require('axios');\nlet data = JSON.stringify({\n \"zones\": [\n {\n \"zone_id\": \"ZoneA\",\n \"description\": \"Delivery Zone for Store A\",\n \"store_id\": \"STORE_ID_45678\",\n \"polygon\": \"POLYGON ((-122.496116 37.7648181,-122.4954079 37.751518,-122.4635648 37.7530788,-122.4618481 37.7514501,-122.4601315 37.7521288,-122.4565266 37.7513144,-122.4540375 37.7566755,-122.4528359 37.7583041,-122.4515485 37.7595934,-122.4546384 37.774656,-122.4718903 37.7731635,-122.472577 37.772485,-122.4755811 37.7725529,-122.4791001 37.7723493,-122.4793576 37.7713995,-122.4784993 37.769839,-122.4783276 37.7680071,-122.4774693 37.766718,-122.4772118 37.7652931,-122.496116 37.7648181))\",\n \"types\": [\n \"delivery\"\n ]\n }\n ]\n});\n\nlet config = {\n method: 'put',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/zones?private_key=YOUR_PRIVATE_API_KEY',\n headers: { \n 'content-type': 'application/json'\n },\n data : data\n};\n\naxios.request(config)\n.then((response) => {\n console.log(JSON.stringify(response.data));\n})\n.catch((error) => {\n console.log(error);\n});\n" + "source": "var axios = require('axios');\n\nvar config = {\n method: 'delete',\n url: 'https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY',\n headers: { }\n};\n\naxios(config)\n.then(function (response) {\n console.log(JSON.stringify(response.data));\n})\n.catch(function (error) {\n console.log(error);\n});\n" } ] - }, - "delete": { - "summary": "Delete the Zones", - "operationId": "deleteZones", - "servers": [ - { - "url": "https://api.woosmap.com" - } - ], - "tags": [ - "Zones" - ], - "description": "Used to delete one or more Zones.", - "security": [ - { - "PrivateApiKeyAuth": [] - } - ], - "responses": { - "200": { - "description": "Zones successfully deleted", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SuccessZones" - }, - "examples": { - "default": { - "summary": "Success response for Zones deleted", - "value": { - "status": "ok", - "message": "Zones deleted." - } - } - } - } - } - }, - "401": { - "description": "Unauthorized. Incorrect authentication credentials.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error401" - }, - "examples": { - "Unauthorized": { - "summary": "Error 401", - "value": { - "detail": "Incorrect authentication credentials. Please check or use a valid API Key" - } - } - } - } - } - }, - "403": { - "description": "Forbidden. This Woosmap API is not enabled for this project.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error403" - }, - "examples": { - "Forbidden": { - "summary": "Error 403", - "value": { - "detail": "This Woosmap API is not enabled for this project." - } - } - } - } - } - } - }, - "x-codeSamples": [ - { - "lang": "curl", - "label": "cURL", - "source": "curl -L -X DELETE 'https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY'" - }, - { - "lang": "python", - "label": "Python", - "source": "import requests\n\nurl = \"https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"DELETE\", url, headers=headers, data=payload)\n\nprint(response.text)\n" - }, - { - "lang": "nodejs", - "label": "NodeJS", - "source": "const axios = require('axios');\n\nlet config = {\n method: 'delete',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/zones/?private_key=YOUR_PRIVATE_API_KEY',\n headers: { }\n};\n\naxios.request(config)\n.then((response) => {\n console.log(JSON.stringify(response.data));\n})\n.catch((error) => {\n console.log(error);\n});\n" - } - ] - } - }, - "/zones/{zone_id}": { - "get": { - "summary": "Get Zone from ID", - "operationId": "getZone", - "servers": [ - { - "url": "https://api.woosmap.com" - } - ], - "tags": [ - "Zones" - ], - "description": "Used to retrieve a zone from his `zone_id`\n", - "security": [ - { - "PrivateApiKeyAuth": [] - } - ], - "parameters": [ - { - "in": "path", - "name": "zone_id", - "schema": { - "type": "string" - }, - "required": true, - "example": "ZoneA", - "description": "ID of the zone to get" - } - ], - "responses": { - "200": { - "description": "Zone successfully retrieved", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Zone" - }, - "examples": { - "default": { - "summary": "Get a zone from its zone_id", - "value": { - "store_id": "STORE_ID_123456", - "zone_id": "ZoneA", - "polygon": "POLYGON ((-122.496116 37.7648181, -122.4954079 37.751518, -122.4635648 37.7530788, -122.4618481 37.7514501, -122.4601315 37.7521288, -122.4565266 37.7513144, -122.4540375 37.7566755, -122.4528359 37.7583041, -122.4515485 37.7595934, -122.4546384 37.774656, -122.4718903 37.7731635, -122.472577 37.772485, -122.4755811 37.7725529, -122.4791001 37.7723493, -122.4793576 37.7713995, -122.4784993 37.769839, -122.4783276 37.7680071, -122.4774693 37.766718, -122.4772118 37.7652931, -122.496116 37.7648181))", - "types": [ - "delivery" - ], - "description": "Delivery Zone for Store A", - "status": "ok" - } - } - } - } - } - }, - "401": { - "description": "Unauthorized. Incorrect authentication credentials.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error401" - }, - "examples": { - "Unauthorized": { - "summary": "Error 401", - "value": { - "detail": "Incorrect authentication credentials. Please check or use a valid API Key" - } - } - } - } - } - }, - "403": { - "description": "Forbidden. This Woosmap API is not enabled for this project.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error403" - }, - "examples": { - "Forbidden": { - "summary": "Error 403", - "value": { - "detail": "This Woosmap API is not enabled for this project." - } - } - } - } - } - }, - "404": { - "description": "Not Found - `zone_id` do not exist." - } - }, - "x-codeSamples": [ - { - "lang": "curl", - "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY'" - }, - { - "lang": "javascript", - "label": "JavaScript", - "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));" - }, - { - "lang": "python", - "label": "Python", - "source": "import requests\n\nurl = \"https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload = {}\nheaders = {}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" - } - ] - }, - "delete": { - "summary": "Delete Zone from ID", - "operationId": "deleteZone", - "servers": [ - { - "url": "https://api.woosmap.com" - } - ], - "tags": [ - "Zones" - ], - "description": "Used to delete one Zone. The `zone_id` is the id of the zone to delete. To delete several zones, use the comma as a separator.", - "security": [ - { - "PrivateApiKeyAuth": [] - } - ], - "parameters": [ - { - "in": "path", - "name": "zone_id", - "schema": { - "type": "string" - }, - "required": true, - "example": "ZoneA", - "description": "ID of the zone to delete" - } - ], - "responses": { - "200": { - "description": "Zones successfully deleted", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SuccessZones" - }, - "examples": { - "default": { - "summary": "Success response for Zones deleted", - "value": { - "status": "ok", - "message": "Zone ZoneA deleted." - } - } - } - } - } - }, - "401": { - "description": "Unauthorized. Incorrect authentication credentials.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error401" - }, - "examples": { - "Unauthorized": { - "summary": "Error 401", - "value": { - "detail": "Incorrect authentication credentials. Please check or use a valid API Key" - } - } - } - } - } - }, - "403": { - "description": "Forbidden. This Woosmap API is not enabled for this project.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error403" - }, - "examples": { - "Forbidden": { - "summary": "Error 403", - "value": { - "detail": "This Woosmap API is not enabled for this project." - } - } - } - } - } - } - }, - "x-codeSamples": [ - { - "lang": "curl", - "label": "cURL", - "source": "curl -L -X DELETE 'https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY'" - }, - { - "lang": "python", - "label": "Python", - "source": "import requests\n\nurl = \"https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY\"\n\npayload={}\nheaders = {}\n\nresponse = requests.request(\"DELETE\", url, headers=headers, data=payload)\n\nprint(response.text)\n" - }, - { - "lang": "nodejs", - "label": "NodeJS", - "source": "var axios = require('axios');\n\nvar config = {\n method: 'delete',\n url: 'https://api.woosmap.com/zones/ZoneA/?private_key=YOUR_PRIVATE_API_KEY',\n headers: { }\n};\n\naxios(config)\n.then(function (response) {\n console.log(JSON.stringify(response.data));\n})\n.catch(function (error) {\n console.log(error);\n});\n" - } - ] - } - } - }, - "components": { - "parameters": { - "ip_address": { - "name": "ip_address", - "description": "The ip_address you want to geolocate. For **server call with private_key** only. Without this parameter, the API will geolocate the IP Address attached to the raw TCP request.\n", - "in": "query", - "schema": { - "type": "string", - "example": "75.134.29.90" - } + } + } + }, + "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", @@ -5389,7 +4785,7 @@ }, "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", + "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": [ @@ -5461,19 +4857,6 @@ "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", @@ -5491,97 +4874,7 @@ }, "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" - }, - "limit-4": { "name": "limit", "description": "To limit number of zones retrieved (max 50).\n", "schema": { @@ -5602,36 +4895,6 @@ }, "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" - }, - "address_location": { - "$ref": "#/components/parameters/location-2" - }, - "address_public_id": { - "$ref": "#/components/parameters/public_id-2" - }, "geolocation_ip_address": { "$ref": "#/components/parameters/ip_address" }, @@ -5645,7 +4908,7 @@ "$ref": "#/components/parameters/addresses_per_page" }, "localities_cc_format": { - "$ref": "#/components/parameters/cc_format-2" + "$ref": "#/components/parameters/cc_format" }, "localities_custom_description": { "$ref": "#/components/parameters/custom_description" @@ -5732,7 +4995,7 @@ "$ref": "#/components/parameters/zone" }, "zones_limit": { - "$ref": "#/components/parameters/limit-4" + "$ref": "#/components/parameters/limit-3" }, "zones_offset": { "$ref": "#/components/parameters/offset" @@ -8324,418 +7587,105 @@ "lat": 48.829405, "lng": 2.367944 }, - "location_type": "GEOMETRIC_CENTER" - } - }, - "LocalitiesScoresPerComponents": { - "title": "LocalitiesScoresPerComponents", - "type": "object", - "properties": { - "street_name": { - "description": "Street score", - "type": "number" - }, - "postal_code": { - "description": "Postal code score", - "type": "number" - }, - "locality": { - "description": "Postal code score", - "type": "number" - } - }, - "example": { - "scores_per_components": { - "street_name": 0.6153846153846154, - "postal_code": 0.8, - "locality": 1 - } - } - }, - "LocalitiesGeocodeResponse": { - "title": "LocalitiesGeocodeResponse", - "type": "object", - "description": "Attributes describing a locality. Not all attributes will be available for all locality types.", - "properties": { - "formatted_address": { - "$ref": "#/components/schemas/FormattedAddress" - }, - "types": { - "description": "An array containing the types of the result", - "type": "array", - "items": { - "$ref": "#/components/schemas/LocalitiesTypesAll" - } - }, - "administrative_area_label": { - "$ref": "#/components/schemas/AdministrativeAreaLabel" - }, - "public_id": { - "description": "Contains a unique ID for each suggestion. Please use this ID to give 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" - } - } - }, - "LocalitiesGeocodeCollectionResponse": { - "title": "LocalitiesGeocodeCollectionResponse", - "type": "object", - "description": "Localities Geocode Collection Response. Contains one or more detailed Localities or Addresses in FR or in the UK, with coordinates (default to one result for reverse geocoding)", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LocalitiesGeocodeResponse" - } - } - }, - "example": { - "results": [ - { - "public_id": "0+FTYd/1MsiBSxLAKq+/Fiyy+uM=", - "types": [ - "address", - "route" - ], - "formatted_address": "Place Jeanne D'Arc, 75013, Paris", - "address_components": [ - { - "types": [ - "country", - "administrative_area_level_0", - "division_level_0" - ], - "long_name": "France", - "short_name": "FR" - }, - { - "types": [ - "state", - "division_level_1" - ], - "long_name": "Île-de-France", - "short_name": "Île-de-France" - }, - { - "types": [ - "administrative_area_level_1", - "county", - "division_level_2" - ], - "long_name": "Paris", - "short_name": "Paris" - }, - { - "types": [ - "locality" - ], - "long_name": "Paris", - "short_name": "Paris" - }, - { - "types": [ - "postal_codes" - ], - "long_name": "75013", - "short_name": "75013" - }, - { - "types": [ - "route" - ], - "long_name": "Place Jeanne D'Arc", - "short_name": "Place Jeanne D'Arc" - } - ], - "geometry": { - "location": { - "lat": 48.829405, - "lng": 2.367944 - }, - "location_type": "GEOMETRIC_CENTER" - }, - "scores_per_components": { - "street_name": 1 - } - } - ] + "location_type": "GEOMETRIC_CENTER" } }, - "LocalitiesNearbyResponse": { - "title": "LocalitiesNearbyResponse", + "LocalitiesScoresPerComponents": { + "title": "LocalitiesScoresPerComponents", "type": "object", - "description": "Attributes describing a point of interest.", "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.", + "description": "An array containing the types of the result", "type": "array", - "example": [ - "point_of_interest", - "transit.station.rail.train", - "train_station" - ], "items": { - "$ref": "#/components/schemas/LocalitiesTypesPoi" + "$ref": "#/components/schemas/LocalitiesTypesAll" } }, - "name": { - "description": "The name of the result.", - "type": "string" + "administrative_area_label": { + "$ref": "#/components/schemas/AdministrativeAreaLabel" }, "public_id": { - "description": "Contains a unique ID for each result. Please use this ID to give feedbacks on results.", + "description": "Contains a unique ID for each suggestion. Please use this ID to give feedbacks on results.", "type": "string", - "example": "NOAeiQADqqisOuN3NM7oXlhkROI=" + "example": "MkvnYy6K6oVGqeqfWJGO/6eCgqo=" }, "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 - } - } + "$ref": "#/components/schemas/LocalitiesAddressGeometry" + }, + "status": { + "$ref": "#/components/schemas/LocalitiesStatus" }, "address_components": { "$ref": "#/components/schemas/AddressComponents" }, - "categories": { - "description": "An array containing the categories of the result. This information is now available in the `types` field and will be removed.", + "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", - "deprecated": true, "items": { - "$ref": "#/components/schemas/LocalitiesTypesPoi" + "$ref": "#/components/schemas/LocalitiesAddressSummary" } }, - "formatted_address": { - "$ref": "#/components/schemas/FormattedAddress" + "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" } } }, - "LocalitiesNearbyCollectionResponse": { - "title": "LocalitiesNearbyCollectionResponse", + "LocalitiesGeocodeCollectionResponse": { + "title": "LocalitiesGeocodeCollectionResponse", "type": "object", - "description": "Collection of nearby points of interest.", - "properties": { - "results": { - "description": "The array of nearby points of interest.", - "type": "array", - "items": { - "$ref": "#/components/schemas/LocalitiesNearbyResponse" - } - }, - "pagination": { - "description": "Helps to navigate through paginated results.", - "type": "object", - "properties": { - "next_page": { - "description": "If more results are available, this will contain the value to pass to the `page` parameter to get the next page", - "type": [ - "integer", - "null" - ] - }, - "previous_page": { - "description": "If previous results are available, this will contain the value to pass to the `page` parameter to get the previous page", - "type": [ - "integer", - "null" - ] - } - } - } - }, - "example": { - "results": [ - { - "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6ZTc2ZDA1YzBiM2M0M2NmNmVkNTJjNGQyZDFiZDE3Nzc0OTZkNjlmOA==", - "types": [ - "point_of_interest", - "business.food_and_drinks.fast_food" - ], - "categories": [ - "business.food_and_drinks.fast_food" - ], - "name": "Pret A Manger", - "formatted_address": "Broadway, New York", - "geometry": { - "location": { - "lat": 40.715905992166256, - "lng": -74.00508673226767 - } - }, - "address_components": [ - { - "types": [ - "country", - "administrative_area_level_0", - "division_level_0" - ], - "long_name": "United States", - "short_name": "US" - }, - { - "types": [ - "locality" - ], - "long_name": "New York", - "short_name": "New York" - }, - { - "types": [ - "route" - ], - "long_name": "Broadway", - "short_name": "Broadway" - } - ] - }, - { - "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6MzBlMGYxMzVhNGUzZDQ4MzRiMmNlNDMzMWJiYjZkOTY0MWJhN2E0Zg==", - "types": [ - "point_of_interest", - "business.food_and_drinks.fast_food" - ], - "categories": [ - "business.food_and_drinks.fast_food" - ], - "name": "Dunkin'", - "formatted_address": "Broadway, New York", - "geometry": { - "location": { - "lat": 40.71602115951586, - "lng": -74.00494482664695 - } - }, - "address_components": [ - { - "types": [ - "country", - "administrative_area_level_0", - "division_level_0" - ], - "long_name": "United States", - "short_name": "US" - }, - { - "types": [ - "locality" - ], - "long_name": "New York", - "short_name": "New York" - }, - { - "types": [ - "route" - ], - "long_name": "Broadway", - "short_name": "Broadway" - } - ] - }, - { - "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmJlMWNkMTE2ZDQwM2E0Y2YwNGQ5NWQ2OTlmZWRmM2FhZTExNGU3ZWY=", - "types": [ - "point_of_interest", - "business.food_and_drinks.restaurant" - ], - "categories": [ - "business.food_and_drinks.restaurant" - ], - "name": "Chambers", - "formatted_address": "Chambers Street, New York", - "geometry": { - "location": { - "lat": 40.71461844801976, - "lng": -74.00754036678366 - } - }, - "address_components": [ - { - "types": [ - "country", - "administrative_area_level_0", - "division_level_0" - ], - "long_name": "United States", - "short_name": "US" - }, - { - "types": [ - "locality" - ], - "long_name": "New York", - "short_name": "New York" - }, - { - "types": [ - "route" - ], - "long_name": "Chambers Street", - "short_name": "Chambers Street" - } - ] - }, + "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": "cG9pOnVzOmJ1c2luZXNzLnNob3AuZ3JvY2VyeTo1YTczMjYxOTQyYjVlZmUwOGEzZjQ1NGZmMTMwMmJjNjA4ODE3NmRk", + "public_id": "0+FTYd/1MsiBSxLAKq+/Fiyy+uM=", "types": [ - "point_of_interest", - "business.shop.grocery" - ], - "categories": [ - "business.shop.grocery" + "address", + "route" ], - "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 - } - } - }, + "formatted_address": "Place Jeanne D'Arc, 75013, Paris", "address_components": [ { "types": [ @@ -8743,125 +7693,172 @@ "administrative_area_level_0", "division_level_0" ], - "long_name": "United States", - "short_name": "US" - } - ] - }, - { - "public_id": "cG9pOnVzOmJ1c2luZXNzLmZpbmFuY2UuYmFuazpiOGY5MDE4Nzc2ZDZjNmEwZTljOGM4YWM0OTAxZWZlNzNmODZkM2M3", - "types": [ - "point_of_interest", - "business.finance.bank" - ], - "categories": [ - "business.finance.bank" - ], - "name": "Citibank", - "formatted_address": "Broadway, New York", - "geometry": { - "location": { - "lat": 40.7130414767567, - "lng": -74.0074818610995 - } - }, - "address_components": [ + "long_name": "France", + "short_name": "FR" + }, { "types": [ - "country", - "administrative_area_level_0", - "division_level_0" + "state", + "division_level_1" ], - "long_name": "United States", - "short_name": "US" + "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": "New York", - "short_name": "New York" + "long_name": "Paris", + "short_name": "Paris" }, { "types": [ - "route" + "postal_codes" ], - "long_name": "Broadway", - "short_name": "Broadway" - } - ] - }, - { - "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQzMTMzZTJkODdiOGJjMGE3ZjI2YTdiMWVjYTZlZmI1MjQyYWE3MTE=", - "types": [ - "point_of_interest", - "business.food_and_drinks.restaurant" - ], - "categories": [ - "business.food_and_drinks.restaurant" - ], - "name": "Saffron", - "geometry": { - "location": { - "lat": 40.71467049963849, - "lng": -74.00767187884445 - } - }, - "address_components": [ + "long_name": "75013", + "short_name": "75013" + }, { "types": [ - "country", - "administrative_area_level_0", - "division_level_0" + "route" ], - "long_name": "United States", - "short_name": "US" + "long_name": "Place Jeanne D'Arc", + "short_name": "Place Jeanne D'Arc" } - ] - }, - { - "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQ1NjMyN2RiM2EyNWJlYmIwNjJjZjNlYWYwMDE3ZDIyYzEyNWNlMjY=", - "types": [ - "point_of_interest", - "business.food_and_drinks.restaurant" - ], - "categories": [ - "business.food_and_drinks.restaurant" ], - "name": "Gran Morsi", "geometry": { "location": { - "lat": 40.71432885326513, - "lng": -74.00778746528921 - } + "lat": 48.829405, + "lng": 2.367944 + }, + "location_type": "GEOMETRIC_CENTER" }, - "address_components": [ - { - "types": [ - "country", - "administrative_area_level_0", - "division_level_0" - ], - "long_name": "United States", - "short_name": "US" - } - ] + "scores_per_components": { + "street_name": 1 + } + } + ] + } + }, + "LocalitiesNearbyResponse": { + "title": "LocalitiesNearbyResponse", + "type": "object", + "description": "Attributes describing a point of interest.", + "properties": { + "types": { + "description": "An array containing the types of the result.", + "type": "array", + "example": [ + "point_of_interest", + "transit.station.rail.train", + "train_station" + ], + "items": { + "$ref": "#/components/schemas/LocalitiesTypesPoi" + } + }, + "name": { + "description": "The name of the result.", + "type": "string" + }, + "public_id": { + "description": "Contains a unique ID for each result. Please use this ID to give 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" + }, + "categories": { + "description": "An array containing the categories of the result. This information is now available in the `types` field and will be removed.", + "type": "array", + "deprecated": true, + "items": { + "$ref": "#/components/schemas/LocalitiesTypesPoi" + } + }, + "formatted_address": { + "$ref": "#/components/schemas/FormattedAddress" + } + } + }, + "LocalitiesNearbyCollectionResponse": { + "title": "LocalitiesNearbyCollectionResponse", + "type": "object", + "description": "Collection of nearby points of interest.", + "properties": { + "results": { + "description": "The array of nearby points of interest.", + "type": "array", + "items": { + "$ref": "#/components/schemas/LocalitiesNearbyResponse" + } + }, + "pagination": { + "description": "Helps to navigate through paginated results.", + "type": "object", + "properties": { + "next_page": { + "description": "If more results are available, this will contain the value to pass to the `page` parameter to get the next page", + "type": [ + "integer", + "null" + ] + }, + "previous_page": { + "description": "If previous results are available, this will contain the value to pass to the `page` parameter to get the previous page", + "type": [ + "integer", + "null" + ] + } + } + } + }, + "example": { + "results": [ { - "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5iYXI6MDE5ZGUzNTdiZDkyNzAyZDM4ZDUyOWQ0YmJiZjBmODQ5YWEzZmY1NA==", + "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6ZTc2ZDA1YzBiM2M0M2NmNmVkNTJjNGQyZDFiZDE3Nzc0OTZkNjlmOA==", "types": [ "point_of_interest", - "business.food_and_drinks.bar" + "business.food_and_drinks.fast_food" ], "categories": [ - "business.food_and_drinks.bar" + "business.food_and_drinks.fast_food" ], - "name": "Bon Courage", - "formatted_address": "Reade Street, New York", + "name": "Pret A Manger", + "formatted_address": "Broadway, New York", "geometry": { "location": { - "lat": 40.71541472882126, - "lng": -74.00719193106873 + "lat": 40.715905992166256, + "lng": -74.00508673226767 } }, "address_components": [ @@ -8885,13 +7882,13 @@ "types": [ "route" ], - "long_name": "Reade Street", - "short_name": "Reade Street" + "long_name": "Broadway", + "short_name": "Broadway" } ] }, { - "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6OGIyNDY5MDM4M2JhYzE1NmY4OGRiMGQzYmIyYzNjMTVmOTk0NDQwZQ==", + "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6MzBlMGYxMzVhNGUzZDQ4MzRiMmNlNDMzMWJiYjZkOTY0MWJhN2E0Zg==", "types": [ "point_of_interest", "business.food_and_drinks.fast_food" @@ -8899,12 +7896,12 @@ "categories": [ "business.food_and_drinks.fast_food" ], - "name": "Burger King", + "name": "Dunkin'", "formatted_address": "Broadway, New York", "geometry": { "location": { - "lat": 40.71619516782573, - "lng": -74.00480635760651 + "lat": 40.71602115951586, + "lng": -74.00494482664695 } }, "address_components": [ @@ -8934,20 +7931,20 @@ ] }, { - "public_id": "cG9pOnVzOmJ1c2luZXNzLnRoZWF0cmU6MTU1Yjk5YmEwY2FiYzIzZjYxYWYyYTViYzI0ZDViYTVlNmVmZTAwNA==", + "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmJlMWNkMTE2ZDQwM2E0Y2YwNGQ5NWQ2OTlmZWRmM2FhZTExNGU3ZWY=", "types": [ "point_of_interest", - "business.theatre" + "business.food_and_drinks.restaurant" ], "categories": [ - "business.theatre" + "business.food_and_drinks.restaurant" ], - "name": "The Flea", - "formatted_address": "Thomas Street, New York", + "name": "Chambers", + "formatted_address": "Chambers Street, New York", "geometry": { "location": { - "lat": 40.71609349534023, - "lng": -74.00589281989586 + "lat": 40.71461844801976, + "lng": -74.00754036678366 } }, "address_components": [ @@ -8971,432 +7968,282 @@ "types": [ "route" ], - "long_name": "Thomas Street", - "short_name": "Thomas Street" + "long_name": "Chambers Street", + "short_name": "Chambers Street" } ] - } - ], - "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" - } - } - } - }, - "AddressTypes": { - "title": "AddressTypes", - "type": "string", - "description": "Contains the type of result.", - "enum": [ - "house_number", - "route", - "address_block", - "locality", - "admin_level", - "country" - ] - }, - "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": [ - "OK", - "INVALID_REQUEST", - "REQUEST_DENIED", - "UNKNOWN_ERROR" - ] - }, - "AddressAutocompleteResponse": { - "title": "AddressAutocompleteResponse", - "type": "object", - "description": "Attributes describing an Address.", - "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" - }, - "status": { - "$ref": "#/components/schemas/AddressStatus" - } - }, - "example": { - "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0", - "description": "London, England, United Kingdom", - "matched_substring": { - "description": [ - { - "offset": 0, - "length": 4 - } - ] - }, - "type": "locality" - } - }, - "AddressAutocompleteCollectionResponse": { - "title": "AddressAutocompleteCollectionResponse", - "type": "object", - "description": "Address Collection Response containing Localities", - "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 - } - ] - }, - "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 + "public_id": "cG9pOnVzOmJ1c2luZXNzLnNob3AuZ3JvY2VyeTo1YTczMjYxOTQyYjVlZmUwOGEzZjQ1NGZmMTMwMmJjNjA4ODE3NmRk", + "types": [ + "point_of_interest", + "business.shop.grocery" + ], + "categories": [ + "business.shop.grocery" + ], + "name": "City Hall Oasis", + "geometry": { + "location": { + "lat": 40.71283012706819, + "lng": -74.00727837935057 + }, + "viewport": { + "northeast": { + "lat": 40.71286059528623, + "lng": -74.00724213866874 + }, + "southwest": { + "lat": 40.71279957503111, + "lng": -74.00731464213119 } - ] + } }, - "type": "locality" + "address_components": [ + { + "types": [ + "country", + "administrative_area_level_0", + "division_level_0" + ], + "long_name": "United States", + "short_name": "US" + } + ] }, { - "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM0NDEy", - "description": "London Luton Airport, Luton, England, United Kingdom", - "matched_substring": { - "description": [ - { - "offset": 0, - "length": 4 - } - ] - }, - "type": "locality" - } - ], - "status": "OK" - } - }, - "AddressGeometry": { - "title": "AddressGeometry", - "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", - "type": "string", - "enum": [ - "ROOFTOP", - "RANGE_INTERPOLATED", - "GEOMETRIC_CENTER", - "APPROXIMATE" - ] - }, - "location": { - "$ref": "#/components/schemas/LatLngLiteral" - }, - "viewport": { - "$ref": "#/components/schemas/Bounds" - } - }, - "example": { - "location": { - "lat": 48.829405, - "lng": 2.367944 - }, - "location_type": "GEOMETRIC_CENTER" - } - }, - "AddressDetailsResponse": { - "title": "AddressDetailsResponse", - "type": "object", - "description": "Address Details Response", - "properties": { - "status": { - "$ref": "#/components/schemas/AddressStatus" - }, - "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": { - "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 + "public_id": "cG9pOnVzOmJ1c2luZXNzLmZpbmFuY2UuYmFuazpiOGY5MDE4Nzc2ZDZjNmEwZTljOGM4YWM0OTAxZWZlNzNmODZkM2M3", + "types": [ + "point_of_interest", + "business.finance.bank" + ], + "categories": [ + "business.finance.bank" + ], + "name": "Citibank", + "formatted_address": "Broadway, New York", + "geometry": { + "location": { + "lat": 40.7130414767567, + "lng": -74.0074818610995 + } }, - "viewport": { - "northeast": { - "lat": 51.68629, - "lng": 0.28206 + "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" }, - "southwest": { - "lat": 51.28043, - "lng": -0.56316 + { + "types": [ + "route" + ], + "long_name": "Broadway", + "short_name": "Broadway" } - } - } - }, - "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", - "type": "object", - "description": "Address Geocode Response", - "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`)", - "type": "array", - "items": { - "$ref": "#/components/schemas/AddressGeocodeTypes" - } - }, - "address_components": { - "$ref": "#/components/schemas/AddressComponents" - }, - "geometry": { - "$ref": "#/components/schemas/AddressGeometry" - } - } - }, - "AddressGeocodeCollectionResponse": { - "title": "AddressGeocodeCollectionResponse", - "type": "object", - "description": "Address Geocode Collection Response. Contains one or more Addresses with coordinates (default to one result for reverse geocoding)", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AddressGeocodeResponse" - } - }, - "status": { - "$ref": "#/components/schemas/AddressStatus" - } - }, - "example": { - "results": [ + ] + }, { - "formatted_address": "Place de la Résistance, 75007 Paris, France", + "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQzMTMzZTJkODdiOGJjMGE3ZjI2YTdiMWVjYTZlZmI1MjQyYWE3MTE=", "types": [ - "address", - "route" + "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" + "country", + "administrative_area_level_0", + "division_level_0" ], - "long_name": "France", - "short_name": "FRA" - }, + "long_name": "United States", + "short_name": "US" + } + ] + }, + { + "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5yZXN0YXVyYW50OmQ1NjMyN2RiM2EyNWJlYmIwNjJjZjNlYWYwMDE3ZDIyYzEyNWNlMjY=", + "types": [ + "point_of_interest", + "business.food_and_drinks.restaurant" + ], + "categories": [ + "business.food_and_drinks.restaurant" + ], + "name": "Gran Morsi", + "geometry": { + "location": { + "lat": 40.71432885326513, + "lng": -74.00778746528921 + } + }, + "address_components": [ { "types": [ - "state" + "country", + "administrative_area_level_0", + "division_level_0" ], - "long_name": "Ile-de-France", - "short_name": "IDF" - }, + "long_name": "United States", + "short_name": "US" + } + ] + }, + { + "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5iYXI6MDE5ZGUzNTdiZDkyNzAyZDM4ZDUyOWQ0YmJiZjBmODQ5YWEzZmY1NA==", + "types": [ + "point_of_interest", + "business.food_and_drinks.bar" + ], + "categories": [ + "business.food_and_drinks.bar" + ], + "name": "Bon Courage", + "formatted_address": "Reade Street, New York", + "geometry": { + "location": { + "lat": 40.71541472882126, + "lng": -74.00719193106873 + } + }, + "address_components": [ { "types": [ - "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": "New York", + "short_name": "New York" }, { - "long_name": "7th Arrondissement", - "short_name": "7th Arrondissement", "types": [ - "district" - ] + "route" + ], + "long_name": "Reade Street", + "short_name": "Reade Street" + } + ] + }, + { + "public_id": "cG9pOnVzOmJ1c2luZXNzLmZvb2RfYW5kX2RyaW5rcy5mYXN0X2Zvb2Q6OGIyNDY5MDM4M2JhYzE1NmY4OGRiMGQzYmIyYzNjMTVmOTk0NDQwZQ==", + "types": [ + "point_of_interest", + "business.food_and_drinks.fast_food" + ], + "categories": [ + "business.food_and_drinks.fast_food" + ], + "name": "Burger King", + "formatted_address": "Broadway, New York", + "geometry": { + "location": { + "lat": 40.71619516782573, + "lng": -74.00480635760651 + } + }, + "address_components": [ + { + "types": [ + "country", + "administrative_area_level_0", + "division_level_0" + ], + "long_name": "United States", + "short_name": "US" }, { - "long_name": "Place de la Résistance", - "short_name": "Place de la Résistance", "types": [ - "route" - ] + "locality" + ], + "long_name": "New York", + "short_name": "New York" }, { - "long_name": "75007", - "short_name": "75007", "types": [ - "postal_code" - ] + "route" + ], + "long_name": "Broadway", + "short_name": "Broadway" } + ] + }, + { + "public_id": "cG9pOnVzOmJ1c2luZXNzLnRoZWF0cmU6MTU1Yjk5YmEwY2FiYzIzZjYxYWYyYTViYzI0ZDViYTVlNmVmZTAwNA==", + "types": [ + "point_of_interest", + "business.theatre" + ], + "categories": [ + "business.theatre" ], + "name": "The Flea", + "formatted_address": "Thomas Street, New York", "geometry": { - "location_type": "GEOMETRIC_CENTER", "location": { - "lat": 48.86213, - "lng": 2.30152 + "lat": 40.71609349534023, + "lng": -74.00589281989586 + } + }, + "address_components": [ + { + "types": [ + "country", + "administrative_area_level_0", + "division_level_0" + ], + "long_name": "United States", + "short_name": "US" }, - "viewport": { - "northeast": { - "lat": 48.86231, - "lng": 2.30541 - }, - "southwest": { - "lat": 48.86191, - "lng": 2.30147 - } + { + "types": [ + "locality" + ], + "long_name": "New York", + "short_name": "New York" + }, + { + "types": [ + "route" + ], + "long_name": "Thomas Street", + "short_name": "Thomas Street" } - } + ] } ], - "status": "OK" + "pagination": { + "previous_page": 2, + "next_page": 4 + } } }, "Zone": { diff --git a/dist/woosmap-openapi3.yml b/dist/woosmap-openapi3.yml index abdfbe6a..5d7bfb20 100755 --- a/dist/woosmap-openapi3.yml +++ b/dist/woosmap-openapi3.yml @@ -57,12 +57,6 @@ tags: Woosmap Localities API is a web service that returns a great amount of geographical places in response to an HTTP request. Among others are city names, postal codes, suburbs, addresses or airports. Request is done over HTTPS using GET. Response is formatted as JSON. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/support/api-keys/). externalDocs: url: https://developers.woosmap.com/products/localities/get-started/ - - name: Address API - description: | - Woosmap Address API is a web service that returns addresses and other geographical places in response to an HTTP request. Request is done over HTTPS using GET. Response is formatted as JSON. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/support/api-keys/). - >**⚠️ This API has been deprecated in favour of Localities API** - externalDocs: - url: https://developers.woosmap.com/products/address-api/get-started/ paths: /geolocation/position: get: @@ -2849,7 +2843,7 @@ paths: - $ref: '#/components/parameters/language-2' - $ref: '#/components/parameters/fields' - $ref: '#/components/parameters/data' - - $ref: '#/components/parameters/cc_format-2' + - $ref: '#/components/parameters/cc_format' responses: '200': description: Request Localities Geocode successful @@ -3368,427 +3362,15 @@ paths: short_name: US - types: - locality - long_name: New York - short_name: New York - - types: - - route - long_name: Thomas Street - short_name: Thomas Street - pagination: - previous_page: 2 - next_page: 4 - '401': - description: Unauthorized. Incorrect authentication credentials. - content: - application/json: - schema: - $ref: '#/components/schemas/Error401' - examples: - Unauthorized: - summary: Error 401 - value: - detail: Incorrect authentication credentials. Please check or use a valid API Key - '403': - description: Forbidden. This Woosmap API is not enabled for this project. - content: - application/json: - schema: - $ref: '#/components/schemas/Error403' - examples: - Forbidden: - summary: Error 403 - value: - detail: This Woosmap API is not enabled for this project. - '429': - description: Too Many Requests. The rate limit for this endpoint has been exceeded. - content: - application/json: - schema: - $ref: '#/components/schemas/Error429' - examples: - Forbidden: - summary: Error 429 - value: - detail: The rate limit for this endpoint has been exceeded - x-codeSamples: - - lang: curl - label: cURL - source: |- - curl -L 'https://api.woosmap.com/localities/nearby?types=business&location=40.71399%2C-74.00499&page=3&key=YOUR_PUBLIC_API_KEY' \ - -H 'Referer: http://localhost' - - lang: javascript - label: JavaScript - source: |- - const requestOptions = { - method: "GET", - redirect: "follow" - }; - - fetch("https://api.woosmap.com/localities/nearby?types=business&location=40.71399%2C-74.00499&page=3&key=YOUR_PUBLIC_API_KEY", requestOptions) - .then((response) => response.text()) - .then((result) => console.log(result)) - .catch((error) => console.error(error)); - - lang: python - label: Python - source: | - import requests - - url = "https://api.woosmap.com/localities/nearby?types=business&location=40.71399%2C-74.00499&page=3&key=YOUR_PUBLIC_API_KEY" - - payload = {} - headers = { - 'Referer': 'http://localhost' - } - - response = requests.request("GET", url, headers=headers, data=payload) - - print(response.text) - /address/autocomplete/json: - get: - deprecated: true - summary: Autocomplete for Addresses - operationId: addressAutocomplete - servers: - - url: https://api.woosmap.com - tags: - - Address API - description: | - Autocomplete on worldwide suggestions for a for text-based geographic searches. It can match on full words as well as substrings. - security: - - PublicApiKeyAuth: [] - RefererHeader: [] - - PrivateApiKeyAuth: [] - - PrivateApiKeyHeaderAuth: [] - parameters: - - $ref: '#/components/parameters/input-2' - - $ref: '#/components/parameters/address_components' - - $ref: '#/components/parameters/location-2' - - $ref: '#/components/parameters/language-3' - responses: - '200': - description: Autocompletion Address successfully retrieved - content: - application/json: - schema: - $ref: '#/components/schemas/AddressAutocompleteCollectionResponse' - examples: - default: - summary: Autocomplete address results for input `Lond` and components `country:gb` - value: - 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 - '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/address/autocomplete/json?input=Lond&components=country%3Agb&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/address/autocomplete/json?input=Lond&components=country%3Agb&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/address/autocomplete/json?input=Lond&components=country%3Agb&key=YOUR_PUBLIC_API_KEY" - - payload = {} - headers = { - 'Referer': 'http://localhost' - } - - response = requests.request("GET", url, headers=headers, data=payload) - - print(response.text) - /address/details/json: - get: - deprecated: true - summary: Details of an Address - operationId: addressDetails - servers: - - url: https://api.woosmap.com - tags: - - Address API - description: | - Provides details of an address autocomplete suggestion (using the suggestion’s `public_id`). - security: - - PublicApiKeyAuth: [] - RefererHeader: [] - - PrivateApiKeyAuth: [] - - PrivateApiKeyHeaderAuth: [] - parameters: - - $ref: '#/components/parameters/public_id-2' - - $ref: '#/components/parameters/fields-2' - - $ref: '#/components/parameters/cc_format' - responses: - '200': - description: Details Address successfully retrieved - content: - application/json: - schema: - $ref: '#/components/schemas/AddressDetailsResponse' - examples: - default: - summary: Address Details for `London, England, United Kingdom` - value: - 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 - status: OK - '401': - description: Unauthorized. Incorrect authentication credentials. - content: - application/json: - schema: - $ref: '#/components/schemas/Error401' - examples: - Unauthorized: - summary: Error 401 - value: - detail: Incorrect authentication credentials. Please check or use a valid API Key - '403': - description: Forbidden. This Woosmap API is not enabled for this project. - content: - application/json: - schema: - $ref: '#/components/schemas/Error403' - examples: - Forbidden: - summary: Error 403 - value: - detail: This Woosmap API is not enabled for this project. - '429': - description: Too Many Requests. The rate limit for this endpoint has been exceeded. - content: - application/json: - schema: - $ref: '#/components/schemas/Error429' - examples: - Forbidden: - summary: Error 429 - value: - detail: The rate limit for this endpoint has been exceeded - x-codeSamples: - - lang: curl - label: cURL - source: |- - curl -L 'https://api.woosmap.com/address/details/json?public_id=aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0&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/address/details/json?public_id=aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0&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/address/details/json?public_id=aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0&key=YOUR_PUBLIC_API_KEY" - - payload = {} - headers = { - 'Referer': 'http://localhost' - } - - response = requests.request("GET", url, headers=headers, data=payload) - - print(response.text) - /address/geocode/json: - get: - deprecated: true - summary: Geocode an Address or Reverse Geocode a latlng - operationId: addressGeocode - servers: - - url: https://api.woosmap.com - tags: - - Address API - description: | - Provides details for an address or a geographic position. Either parameter `address` **or** `latlng` is required. Maximum of 25 queries per second (QPS) - security: - - PublicApiKeyAuth: [] - RefererHeader: [] - - PrivateApiKeyAuth: [] - - PrivateApiKeyHeaderAuth: [] - parameters: - - $ref: '#/components/parameters/address-2' - - $ref: '#/components/parameters/latlng-2' - - $ref: '#/components/parameters/address_components' - - $ref: '#/components/parameters/language-3' - - $ref: '#/components/parameters/location-2' - - $ref: '#/components/parameters/cc_format' - - $ref: '#/components/parameters/limit-3' - responses: - '200': - description: Request Address Geocode successful - content: - application/json: - schema: - $ref: '#/components/schemas/AddressGeocodeCollectionResponse' - examples: - default: - summary: Geocode Results for address `Place de la Resistance` with components `country:FR` - value: - results: - - formatted_address: Place de la Résistance, 75007 Paris, France - types: - - address - - route - address_components: - - types: - - country - long_name: France - short_name: FRA - - 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: + long_name: New York + short_name: New York + - types: - route - - long_name: '75007' - short_name: '75007' - types: - - postal_code - 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 - status: OK + long_name: Thomas Street + short_name: Thomas Street + pagination: + previous_page: 2 + next_page: 4 '401': description: Unauthorized. Incorrect authentication credentials. content: @@ -3826,7 +3408,7 @@ paths: - lang: curl label: cURL source: |- - curl -L 'https://api.woosmap.com/address/geocode/json?address=Place%20de%20la%20Resistance%20Paris&components=country%3AFR&limit=5&key=YOUR_PUBLIC_API_KEY' \ + curl -L 'https://api.woosmap.com/localities/nearby?types=business&location=40.71399%2C-74.00499&page=3&key=YOUR_PUBLIC_API_KEY' \ -H 'Referer: http://localhost' - lang: javascript label: JavaScript @@ -3836,7 +3418,7 @@ paths: redirect: "follow" }; - fetch("https://api.woosmap.com/address/geocode/json?address=Place%20de%20la%20Resistance%20Paris&components=country%3AFR&limit=5&key=YOUR_PUBLIC_API_KEY", requestOptions) + fetch("https://api.woosmap.com/localities/nearby?types=business&location=40.71399%2C-74.00499&page=3&key=YOUR_PUBLIC_API_KEY", requestOptions) .then((response) => response.text()) .then((result) => console.log(result)) .catch((error) => console.error(error)); @@ -3845,7 +3427,7 @@ paths: source: | import requests - url = "https://api.woosmap.com/address/geocode/json?address=Place%20de%20la%20Resistance%20Paris&components=country%3AFR&limit=5&key=YOUR_PUBLIC_API_KEY" + url = "https://api.woosmap.com/localities/nearby?types=business&location=40.71399%2C-74.00499&page=3&key=YOUR_PUBLIC_API_KEY" payload = {} headers = { @@ -3868,7 +3450,7 @@ paths: security: - PrivateApiKeyAuth: [] parameters: - - $ref: '#/components/parameters/limit-4' + - $ref: '#/components/parameters/limit-3' - $ref: '#/components/parameters/offset' responses: '200': @@ -4884,7 +4466,7 @@ components: 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`). + 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. schema: type: string enum: @@ -4954,17 +4536,6 @@ components: 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. - schema: - type: string - enum: - - alpha2 - - alpha3 - example: alpha2 - in: query nearby_types: name: types description: | @@ -4980,87 +4551,7 @@ components: 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. - 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 `|`. - 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. - 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. - 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). @@ -5079,26 +4570,6 @@ components: 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' - address_location: - $ref: '#/components/parameters/location-2' - address_public_id: - $ref: '#/components/parameters/public_id-2' geolocation_ip_address: $ref: '#/components/parameters/ip_address' geolocation_limit: @@ -5108,7 +4579,7 @@ components: localities_addresses_per_page: $ref: '#/components/parameters/addresses_per_page' localities_cc_format: - $ref: '#/components/parameters/cc_format-2' + $ref: '#/components/parameters/cc_format' localities_custom_description: $ref: '#/components/parameters/custom_description' localities_data: @@ -5166,7 +4637,7 @@ components: search_zone: $ref: '#/components/parameters/zone' zones_limit: - $ref: '#/components/parameters/limit-4' + $ref: '#/components/parameters/limit-3' zones_offset: $ref: '#/components/parameters/offset' schemas: @@ -7425,292 +6896,6 @@ components: 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' - AddressTypes: - title: AddressTypes - type: string - description: Contains the type of result. - enum: - - house_number - - route - - address_block - - locality - - admin_level - - country - AddressStatus: - title: AddressStatus - type: string - example: OK - description: | - Returns more info on if the request was successful or not, valid responses. - * `OK` indicates the response contains a valid result. - * `INVALID_REQUEST` indicates that the provided request was invalid (e.g. wrong URL syntax). - * `REQUEST_DENIED` indicates that the service denied use of the Address API (e.g. wrong API Key, wrong/no referer, …). - * `UNKNOWN_ERROR` indicates an Address API request could not be processed due to a server error. The request may succeed if you try again. - enum: - - OK - - INVALID_REQUEST - - REQUEST_DENIED - - UNKNOWN_ERROR - AddressAutocompleteResponse: - title: AddressAutocompleteResponse - type: object - description: Attributes describing an Address. - 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' - status: - $ref: '#/components/schemas/AddressStatus' - example: - public_id: aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0 - description: London, England, United Kingdom - matched_substring: - description: - - offset: 0 - length: 4 - type: locality - AddressAutocompleteCollectionResponse: - title: AddressAutocompleteCollectionResponse - type: object - description: Address Collection Response containing Localities - 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 - 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 - AddressGeometry: - title: AddressGeometry - type: object - description: The location of the result, in latitude and longitude. Accuracy is also provided. - properties: - location_type: - description: | - Specifies additional data about the geocoded location. The following values are currently supported: - - `ROOFTOP` result is a precise geocode for which we have location information accurate down to street address precision. - - `RANGE_INTERPOLATED` result reflects an approximation (usually on a road) interpolated between two precise points (such as intersections). Interpolated results are generally returned when rooftop geocodes are unavailable for a street address. - - `GEOMETRIC_CENTER` result is the geometric center of a result such as a polyline (for example, a street) or polygon (city, region, …). - - `APPROXIMATE` result is approximate (usually when no other above value applies) - type: string - enum: - - ROOFTOP - - RANGE_INTERPOLATED - - GEOMETRIC_CENTER - - APPROXIMATE - location: - $ref: '#/components/schemas/LatLngLiteral' - viewport: - $ref: '#/components/schemas/Bounds' - example: - location: - lat: 48.829405 - lng: 2.367944 - location_type: GEOMETRIC_CENTER - AddressDetailsResponse: - title: AddressDetailsResponse - type: object - description: Address Details Response - properties: - status: - $ref: '#/components/schemas/AddressStatus' - 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: - 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 - 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 - type: object - description: Address Geocode Response - 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`) - type: array - items: - $ref: '#/components/schemas/AddressGeocodeTypes' - address_components: - $ref: '#/components/schemas/AddressComponents' - geometry: - $ref: '#/components/schemas/AddressGeometry' - AddressGeocodeCollectionResponse: - title: AddressGeocodeCollectionResponse - type: object - description: Address Geocode Collection Response. Contains one or more Addresses with coordinates (default to one result for reverse geocoding) - properties: - results: - type: array - items: - $ref: '#/components/schemas/AddressGeocodeResponse' - status: - $ref: '#/components/schemas/AddressStatus' - example: - results: - - formatted_address: Place de la Résistance, 75007 Paris, France - types: - - address - - route - address_components: - - types: - - country - long_name: France - short_name: FRA - - 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 - 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 - status: OK Zone: title: Zone type: object diff --git a/dist/woosmap-postman.json b/dist/woosmap-postman.json index 647c1a0d..8dce4f72 100755 --- a/dist/woosmap-postman.json +++ b/dist/woosmap-postman.json @@ -10,7 +10,7 @@ "description": "Manage the store and asset data within your Woosmap project. It provides full CRUD (Create, Read, Update, Delete) operations through standard HTTP methods, supporting batch imports up to 15MB, along with an atomic replace operation for swapping entire datasets without downtime.\nThis endpoint handles the complete lifecycle of your location data. You can add new assets in batch using POST, update existing assets with PUT, retrieve assets as GeoJSON with GET, remove individual or all assets with DELETE, and atomically replace your entire dataset using the replace operation. All write operations accept JSON payloads containing an array of store objects, each with a unique storeId, name, and geographic coordinates.\n\n``` POST|GET|PUT|DELETE https://api.woosmap.com/stores ```\n", "item": [ { - "id": "28fa046e-ef15-457a-8cfa-d92ab09a6242", + "id": "2e6ed137-d78b-474c-b7ef-d88f69b75349", "name": "Create your Assets", "request": { "name": "Create your Assets", @@ -44,7 +44,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": 5780\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": null\n }\n ]\n}", + "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": null,\n \"localizedNames\": {},\n \"openingHours\": null\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": 7366,\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -72,7 +72,7 @@ }, "response": [ { - "id": "eb83ff28-e29d-4c56-afe5-1b4cce3fff65", + "id": "a8b5a52c-ff5b-4ba7-a02f-de8fdebd3484", "name": "Assets successfully created", "originalRequest": { "url": { @@ -110,7 +110,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": 5780\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": null\n }\n ]\n}", + "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": null,\n \"localizedNames\": {},\n \"openingHours\": null\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": 7366,\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -132,7 +132,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7f12b2a4-3862-4cf0-a3e6-6fbb7171987a", + "id": "6d721ac8-7b6b-4920-8cf6-eebec148add7", "name": "Invalid. The data is not a valid JSON.", "originalRequest": { "url": { @@ -170,7 +170,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": 5780\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": null\n }\n ]\n}", + "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": null,\n \"localizedNames\": {},\n \"openingHours\": null\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": 7366,\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -192,7 +192,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3fe206f7-9c8a-4bc3-bff2-dd557a0a4ede", + "id": "862b03fc-b874-459e-b26f-ed11391ffe40", "name": "Unauthorized. Incorrect authentication credentials.", "originalRequest": { "url": { @@ -230,7 +230,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": 5780\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": null\n }\n ]\n}", + "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": null,\n \"localizedNames\": {},\n \"openingHours\": null\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": 7366,\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -252,7 +252,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e2ade3c6-8558-4b8a-88b2-f2f865405cb2", + "id": "7d2370d3-7c47-4c7d-aba9-3963ada2a23a", "name": "Forbidden. This Woosmap API is not enabled for this project.", "originalRequest": { "url": { @@ -290,7 +290,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": 5780\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": null\n }\n ]\n}", + "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": null,\n \"localizedNames\": {},\n \"openingHours\": null\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": 7366,\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -318,7 +318,7 @@ } }, { - "id": "cc2f5af9-33f5-4847-987f-1757b26e88c9", + "id": "56f23253-e3d2-455d-a800-665a761d7fbc", "name": "Update the Assets", "request": { "name": "Update the Assets", @@ -352,7 +352,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": 5780\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": null\n }\n ]\n}", + "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": null,\n \"localizedNames\": {},\n \"openingHours\": null\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": 7366,\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -380,7 +380,7 @@ }, "response": [ { - "id": "13369f66-3054-493a-9b8b-145a68e23665", + "id": "29c06d15-2688-44e1-9540-6da2405eecf4", "name": "Assets successfully updated", "originalRequest": { "url": { @@ -418,7 +418,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": 5780\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": null\n }\n ]\n}", + "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": null,\n \"localizedNames\": {},\n \"openingHours\": null\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": 7366,\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -440,7 +440,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8dc08ecc-0fd4-4843-97cb-0de855141790", + "id": "d6326a61-3350-47ad-8e56-272e4d81d747", "name": "Invalid. The data is not a valid JSON.", "originalRequest": { "url": { @@ -478,7 +478,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": 5780\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": null\n }\n ]\n}", + "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": null,\n \"localizedNames\": {},\n \"openingHours\": null\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": 7366,\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -500,7 +500,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ce58ab11-5bc7-4d33-8698-43a95cdba8a1", + "id": "105dd188-4fe2-42cf-aca3-702c381104f8", "name": "Unauthorized. Incorrect authentication credentials.", "originalRequest": { "url": { @@ -538,7 +538,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": 5780\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": null\n }\n ]\n}", + "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": null,\n \"localizedNames\": {},\n \"openingHours\": null\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": 7366,\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -560,7 +560,7 @@ "_postman_previewlanguage": "json" }, { - "id": "225cbda7-efa0-4558-9262-989eddcfb1f6", + "id": "ef47aab7-97b1-4e27-a701-ca58bb370132", "name": "Forbidden. This Woosmap API is not enabled for this project.", "originalRequest": { "url": { @@ -598,7 +598,7 @@ "method": "PUT", "body": { "mode": "raw", - "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": 5780\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": null\n }\n ]\n}", + "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": null,\n \"localizedNames\": {},\n \"openingHours\": null\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": 7366,\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -626,7 +626,7 @@ } }, { - "id": "654964cb-ccc0-4754-8594-a5086032ce75", + "id": "343c9200-1181-4869-bd07-9ea30198ba27", "name": "Delete the Assets", "request": { "name": "Delete the Assets", @@ -685,7 +685,7 @@ }, "response": [ { - "id": "8339117b-2c84-4684-a7d9-e0bbd965dda9", + "id": "cc260441-2f78-451a-9747-afe739dc2e49", "name": "Assets successfully deleted", "originalRequest": { "url": { @@ -741,7 +741,7 @@ "_postman_previewlanguage": "json" }, { - "id": "44633122-6a12-4ff2-85ab-81ef3ae5da98", + "id": "50ada804-b151-41cd-9bc6-92b55b74c19d", "name": "Unauthorized. Incorrect authentication credentials.", "originalRequest": { "url": { @@ -797,7 +797,7 @@ "_postman_previewlanguage": "json" }, { - "id": "be90fe4c-6b4a-4f43-ba3f-e5118d0013bf", + "id": "0f1e881b-aa60-448e-9233-2822647fb531", "name": "Forbidden. This Woosmap API is not enabled for this project.", "originalRequest": { "url": { @@ -859,7 +859,7 @@ } }, { - "id": "0ea2a139-1fc7-4b8b-8f58-34c3c77d7071", + "id": "72ee960d-9afd-4a66-8c33-769cb03fb8b1", "name": "Get Asset from ID", "request": { "name": "Get Asset from ID", @@ -920,7 +920,7 @@ }, "response": [ { - "id": "741e8fe5-8619-4a80-850e-6b1a342893f6", + "id": "a1bf025f-c239-430f-a253-889e2f65c306", "name": "Asset successfully retrieved", "originalRequest": { "url": { @@ -974,12 +974,12 @@ "value": "application/json" } ], - "body": "{\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 \"key_0\": true,\n \"key_1\": true,\n \"key_2\": 8033.333484535774\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}", + "body": "{\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\": null,\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}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ff7ca486-2176-4011-a07c-74398f5fd92a", + "id": "9345e863-5dd2-4cbb-80a0-4fe9df45b66a", "name": "Unauthorized. Incorrect authentication credentials.", "originalRequest": { "url": { @@ -1038,7 +1038,7 @@ "_postman_previewlanguage": "json" }, { - "id": "33dd3279-4f65-4d6c-84ce-0638327c1d9a", + "id": "42ca75b9-1c01-4836-8ad7-bd153cfa3ef1", "name": "Forbidden. This Woosmap API is not enabled for this project.", "originalRequest": { "url": { @@ -1097,7 +1097,7 @@ "_postman_previewlanguage": "json" }, { - "id": "69cacf10-7def-4411-bc7b-fe63d1a97ef7", + "id": "b60fbe4f-ee3f-4c47-926c-c6110f774228", "name": "Not Found - `storeId` do not exist.", "originalRequest": { "url": { @@ -1150,7 +1150,7 @@ } }, { - "id": "87d0ba2f-c4e1-427f-8c9a-fe42c16a5c63", + "id": "67ffc45b-3e33-4033-bbb1-448170f9c365", "name": "Replace all assets", "request": { "name": "Replace all assets", @@ -1185,7 +1185,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": 5780\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": null\n }\n ]\n}", + "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": null,\n \"localizedNames\": {},\n \"openingHours\": null\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": 7366,\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -1213,7 +1213,7 @@ }, "response": [ { - "id": "769aab9d-3bc7-4d70-a2ce-2f223bc37a6a", + "id": "dd95b025-7c6c-4820-9957-6081a0a8eabe", "name": "Assets successfully replaced", "originalRequest": { "url": { @@ -1252,7 +1252,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": 5780\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": null\n }\n ]\n}", + "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": null,\n \"localizedNames\": {},\n \"openingHours\": null\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": 7366,\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -1274,7 +1274,7 @@ "_postman_previewlanguage": "json" }, { - "id": "dd048586-93a5-41e6-bd2c-612eac84d695", + "id": "4b3f1930-7c0f-4e47-977c-f28c6f8e7585", "name": "Invalid. The data is not a valid JSON.", "originalRequest": { "url": { @@ -1313,7 +1313,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": 5780\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": null\n }\n ]\n}", + "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": null,\n \"localizedNames\": {},\n \"openingHours\": null\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": 7366,\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -1335,7 +1335,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d1449e95-9328-48f1-98b2-127c2ca4a2e2", + "id": "defd0934-5698-4ce2-86ae-5eab7b0fa383", "name": "Unauthorized. Incorrect authentication credentials.", "originalRequest": { "url": { @@ -1374,7 +1374,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": 5780\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": null\n }\n ]\n}", + "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": null,\n \"localizedNames\": {},\n \"openingHours\": null\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": 7366,\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -1396,7 +1396,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d9a690d3-580d-4eb9-af9c-4bca0c9634fa", + "id": "9eda3051-d6d6-45d7-9143-337f90116b45", "name": "Forbidden. This Woosmap API is not enabled for this project.", "originalRequest": { "url": { @@ -1435,7 +1435,7 @@ "method": "POST", "body": { "mode": "raw", - "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": 5780\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": null\n }\n ]\n}", + "raw": "{\n \"stores\": [\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": null,\n \"localizedNames\": {},\n \"openingHours\": null\n },\n {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"name\": \"\",\n \"storeId\": \"\",\n \"address\": {\n \"lines\": [\n \"\",\n \"\"\n ],\n \"countryCode\": \"\",\n \"city\": \"\",\n \"zipcode\": \"\"\n },\n \"contact\": {\n \"website\": \"\",\n \"phone\": \"\",\n \"email\": \"\"\n },\n \"types\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"userProperties\": {\n \"key_0\": 7366,\n \"key_1\": \"string\"\n },\n \"localizedNames\": {},\n \"openingHours\": {\n \"timezone\": \"\",\n \"usual\": {\n \"1\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"3\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"4\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"5\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"6\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"7\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"default\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n },\n \"special\": {\n \"2015-02-07\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ],\n \"2015-02-08\": [\n {\n \"start\": \"\",\n \"end\": \"\"\n },\n {\n \"start\": \"\",\n \"end\": \"\"\n }\n ]\n }\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", @@ -1469,7 +1469,7 @@ "description": "The Zones Endpoint lets you associate geographic polygons (zones) with your stores and then search for stores whose zone contains a specific point. Unlike distance-based search, which relies on straight-line proximity, zone-based search accounts for real-world boundaries like delivery areas, service regions, or franchise territories.\nZone management provides a full set of CRUD operations: import zones in bulk, update existing zones, list all zones in your project, retrieve or delete individual zones by ID, and remove all zones at once. Each zone links a polygon (defined in WKT format) to a specific store via store_id and zone_id.\n\nOnce zones are imported, you can search for stores by adding `zone=true` to your Search request. The API returns stores whose zone polygon intersects the queried location rather than the nearest stores by distance.\n\n``` https://api.woosmap.com/zones ```\n", "item": [ { - "id": "f15382a3-15e4-4d89-b643-46f41730a114", + "id": "2f116184-66a8-4c7c-b990-4094a2e010f9", "name": "List your Zones", "request": { "name": "List your Zones", @@ -1537,7 +1537,7 @@ }, "response": [ { - "id": "db3acbaf-54cb-4fc4-8122-22e8ffbe7564", + "id": "ded995dc-a418-41d6-bd03-b6774d2ad42c", "name": "Zones successfully retrieved", "originalRequest": { "url": { @@ -1602,7 +1602,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a932f49f-03a3-4d8a-a402-6ce73a99db3c", + "id": "121ed3b2-bba6-4e7c-83b6-3e84cb9fb190", "name": "Unauthorized. Incorrect authentication credentials.", "originalRequest": { "url": { @@ -1667,7 +1667,7 @@ "_postman_previewlanguage": "json" }, { - "id": "65a69435-595e-48d2-96e6-b0377f77910e", + "id": "ab07ea3a-b341-427f-8175-a1d1e774aad2", "name": "Forbidden. This Woosmap API is not enabled for this project.", "originalRequest": { "url": { @@ -1732,7 +1732,7 @@ "_postman_previewlanguage": "json" }, { - "id": "be83e850-6947-4a5b-a6e9-73b20c88eefa", + "id": "455010df-5a6b-4f5c-9e7d-64160cd5280f", "name": "Too Many Requests. The rate limit for this endpoint has been exceeded.", "originalRequest": { "url": { @@ -1803,7 +1803,7 @@ } }, { - "id": "fabecc87-6180-4cb3-86c5-52a4813d061c", + "id": "81f7456c-962a-49e3-811f-5837f1183d76", "name": "Create your Zones", "request": { "name": "Create your Zones", @@ -1865,7 +1865,7 @@ }, "response": [ { - "id": "13b1e5db-0210-418e-98ab-884b6cc8d905", + "id": "a134f785-5b13-4f2a-a6de-f38a066a8fd2", "name": "Zones successfully created", "originalRequest": { "url": { @@ -1925,7 +1925,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0be09ae0-b771-438b-8560-04e5ab71acb0", + "id": "87444b16-3dfb-44ab-b68c-c23dcaea88b5", "name": "Invalid. The data is not a valid JSON.", "originalRequest": { "url": { @@ -1985,7 +1985,7 @@ "_postman_previewlanguage": "json" }, { - "id": "88c3c7ec-d88a-4dcf-b49f-78c0cb7b0b18", + "id": "590097f7-b6c0-439a-beb1-0a67f5d26fee", "name": "Unauthorized. Incorrect authentication credentials.", "originalRequest": { "url": { @@ -2045,7 +2045,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ef29e097-47f6-4b4a-9c07-bd34cbd6735c", + "id": "b8630899-7972-4c38-a24e-3886446ecc99", "name": "Forbidden. This Woosmap API is not enabled for this project.", "originalRequest": { "url": { @@ -2111,7 +2111,7 @@ } }, { - "id": "d79de081-3b41-46c9-9b1a-8175949eea27", + "id": "33be1f41-ddb8-4579-bb72-d6edd75889ae", "name": "Update the Zones", "request": { "name": "Update the Zones", @@ -2173,7 +2173,7 @@ }, "response": [ { - "id": "16c9c7a3-6c10-435c-8632-6014cb9e12c2", + "id": "f1688c3c-93a9-4b6e-8a08-f65e484359d9", "name": "Zones successfully updated", "originalRequest": { "url": { @@ -2233,7 +2233,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a7046505-77d6-4266-abac-2d9d38eaf801", + "id": "76278181-eb8d-4a77-945a-3be5a7985248", "name": "Invalid. The data is not a valid JSON.", "originalRequest": { "url": { @@ -2293,7 +2293,7 @@ "_postman_previewlanguage": "json" }, { - "id": "57bbf055-2a71-48dc-8f31-4794b873beba", + "id": "cc9b0763-d085-4ab9-bf1a-abe0675c9a45", "name": "Unauthorized. Incorrect authentication credentials.", "originalRequest": { "url": { @@ -2353,7 +2353,7 @@ "_postman_previewlanguage": "json" }, { - "id": "16952d82-29c0-4c0a-934d-dafcb5cd3439", + "id": "5dd9af75-4b7d-40be-a68a-8179779596e9", "name": "Forbidden. This Woosmap API is not enabled for this project.", "originalRequest": { "url": { @@ -2419,7 +2419,7 @@ } }, { - "id": "387242e4-272e-4d96-9da0-425b76527592", + "id": "d83db54e-498b-403d-b5d6-5b0f8b069326", "name": "Delete the Zones", "request": { "name": "Delete the Zones", @@ -2468,7 +2468,7 @@ }, "response": [ { - "id": "f12758da-a8b0-4e43-99f3-daa85daf6c90", + "id": "816f1dac-962c-4220-83d5-d0fabc80e184", "name": "Zones successfully deleted", "originalRequest": { "url": { @@ -2515,7 +2515,7 @@ "_postman_previewlanguage": "json" }, { - "id": "85d580c8-9a3f-42d4-9130-9cf48350495a", + "id": "7605bc68-79d0-4301-9fa1-6c41629cb17d", "name": "Unauthorized. Incorrect authentication credentials.", "originalRequest": { "url": { @@ -2562,7 +2562,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e2d49068-cd9d-4a94-baab-7d89ef97e6fc", + "id": "b4424d16-d977-49eb-8107-1be9e227ad45", "name": "Forbidden. This Woosmap API is not enabled for this project.", "originalRequest": { "url": { @@ -2615,7 +2615,7 @@ } }, { - "id": "62116d60-e0d7-49c1-b14b-58f61b838389", + "id": "ad588063-36d8-4e10-95e5-3f63548e6f80", "name": "Get Zone from ID", "request": { "name": "Get Zone from ID", @@ -2676,7 +2676,7 @@ }, "response": [ { - "id": "31ea8498-c333-40a4-b1b2-019b064b4c60", + "id": "65cb8d18-19c9-4763-b7aa-14d2496a14b5", "name": "Zone successfully retrieved", "originalRequest": { "url": { @@ -2735,7 +2735,7 @@ "_postman_previewlanguage": "json" }, { - "id": "005ba6be-6662-476e-8da1-9e74d757a8d9", + "id": "6b29eb78-cb1b-46f3-b802-195e5cac2251", "name": "Unauthorized. Incorrect authentication credentials.", "originalRequest": { "url": { @@ -2794,7 +2794,7 @@ "_postman_previewlanguage": "json" }, { - "id": "73aa5f94-6e10-4fa1-a85e-7b3506c7d0b5", + "id": "bf0745ca-2cf7-4b2b-83c9-005f314901b3", "name": "Forbidden. This Woosmap API is not enabled for this project.", "originalRequest": { "url": { @@ -2853,7 +2853,7 @@ "_postman_previewlanguage": "json" }, { - "id": "87bf49a2-76f3-471d-8e80-92583e89b696", + "id": "45858539-7a6c-420b-bdd4-f6fd36888ae0", "name": "Not Found - `zone_id` do not exist.", "originalRequest": { "url": { @@ -2906,7 +2906,7 @@ } }, { - "id": "3e2fdea0-dda4-4e50-acb9-f1b38b15cbe2", + "id": "fa7ae041-ffe3-40eb-a218-db9bc8f0c427", "name": "Delete Zone from ID", "request": { "name": "Delete Zone from ID", @@ -2967,7 +2967,7 @@ }, "response": [ { - "id": "c7b9eed9-8a0a-473f-b66b-116000ab36be", + "id": "1a0c4bd9-41e3-48be-86b1-c58431d8ed47", "name": "Zones successfully deleted", "originalRequest": { "url": { @@ -3026,7 +3026,7 @@ "_postman_previewlanguage": "json" }, { - "id": "70ff0cf0-adcc-4f33-b709-672311d5da40", + "id": "197aa017-013a-4b25-b602-e083bbf99798", "name": "Unauthorized. Incorrect authentication credentials.", "originalRequest": { "url": { @@ -3085,7 +3085,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8fc81b5b-cf81-4293-94ad-393833c16974", + "id": "8f06bb2c-e1b0-4061-b689-869f5715d722", "name": "Forbidden. This Woosmap API is not enabled for this project.", "originalRequest": { "url": { @@ -3156,7 +3156,7 @@ "description": "Geolocation API returns a location (or nearby stores) and accuracy radius based on an IP address. Request is done over HTTPS using GET. Response is formatted as JSON. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/support/api-keys/).\n", "item": [ { - "id": "6113344f-2924-441a-bb9c-e8469efa0a8d", + "id": "2a6ce434-3cc7-48e9-ac52-91fd81f1742c", "name": "Geolocation from an IP address", "request": { "name": "Geolocation from an IP address", @@ -3216,7 +3216,7 @@ }, "response": [ { - "id": "9e00df42-15d3-431f-a0ec-8aa139439f74", + "id": "0e336868-f13d-4b9a-aba4-4edc4d88a0be", "name": "Geolocation successfully retrieved", "originalRequest": { "url": { @@ -3273,7 +3273,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8cac312c-9adf-4eaa-8c76-ab0f445385fa", + "id": "b630b566-1df3-4ad2-b7b7-34d00531311a", "name": "Unauthorized. Incorrect authentication credentials.", "originalRequest": { "url": { @@ -3330,7 +3330,7 @@ "_postman_previewlanguage": "json" }, { - "id": "35fbe408-d31b-40f7-86cf-f61214c27f17", + "id": "63df7d35-21ac-44a5-9b7d-2799ad898e6d", "name": "Forbidden. This Woosmap API is not enabled for this project.", "originalRequest": { "url": { @@ -3387,7 +3387,7 @@ "_postman_previewlanguage": "json" }, { - "id": "03480f80-75ab-4dcb-91c4-328fc7358ddb", + "id": "6570e41d-bbd3-4626-987f-48b828c22277", "name": "Too Many Requests. The rate limit for this endpoint has been exceeded.", "originalRequest": { "url": { @@ -3450,7 +3450,7 @@ } }, { - "id": "3a1c8004-1bd3-4217-84ee-74bb5aef0ab2", + "id": "e865ee08-1e4c-4ec1-9251-52f2eec9ba5f", "name": "Assets nearby a Geolocation", "request": { "name": "Assets nearby a Geolocation", @@ -3528,7 +3528,7 @@ }, "response": [ { - "id": "ebde6d51-cd50-4a82-badb-4f11320997e2", + "id": "dbb7b39a-b96e-484d-a473-6371914ef843", "name": "Geolocation and Stores successufully retrieved", "originalRequest": { "url": { @@ -3598,12 +3598,12 @@ "value": "application/json" } ], - "body": "{\n \"stores\": {\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\": null,\n \"opening_hours\": null,\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\": null,\n \"opening_hours\": null,\n \"distance\": \"\"\n },\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"pagination\": {\n \"page\": \"\",\n \"pageCount\": \"\"\n }\n },\n \"viewport\": {\n \"northeast\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"southwest\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n },\n \"accuracy\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"country_code\": \"\",\n \"country_name\": \"\",\n \"continent\": \"\",\n \"region_state\": \"\",\n \"city\": \"\",\n \"postal_code\": \"\",\n \"timezone\": \"\",\n \"raw_offset\": \"\",\n \"dst_offset\": \"\"\n}", + "body": "{\n \"stores\": {\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 \"key_0\": 3490,\n \"key_1\": 8353,\n \"key_2\": false,\n \"key_3\": \"string\"\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\": null,\n \"opening_hours\": null,\n \"distance\": \"\"\n },\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"pagination\": {\n \"page\": \"\",\n \"pageCount\": \"\"\n }\n },\n \"viewport\": {\n \"northeast\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"southwest\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n },\n \"accuracy\": \"\",\n \"latitude\": \"\",\n \"longitude\": \"\",\n \"country_code\": \"\",\n \"country_name\": \"\",\n \"continent\": \"\",\n \"region_state\": \"\",\n \"city\": \"\",\n \"postal_code\": \"\",\n \"timezone\": \"\",\n \"raw_offset\": \"\",\n \"dst_offset\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "8936bed8-a2d1-44e8-a61b-6faa7659a45d", + "id": "3b882d12-ae3e-4d42-8fbc-31bfc536e369", "name": "Unauthorized. Incorrect authentication credentials.", "originalRequest": { "url": { @@ -3678,7 +3678,7 @@ "_postman_previewlanguage": "json" }, { - "id": "759514fa-6c7d-4903-a85b-ff2faaa418c2", + "id": "a51bf27b-c1c1-4e6e-9e47-d4df1711663d", "name": "Forbidden. This Woosmap API is not enabled for this project.", "originalRequest": { "url": { @@ -3753,7 +3753,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0c4f6177-a276-4c5b-8cf6-35b434cbb774", + "id": "88facc0b-2633-4bd5-bfa1-c1499fae2c4c", "name": "Too Many Requests. The rate limit for this endpoint has been exceeded.", "originalRequest": { "url": { @@ -3834,7 +3834,7 @@ } }, { - "id": "2e1ab5f5-fbff-42f2-a427-d09a545268f6", + "id": "dbc255e0-9aab-4f7c-a7b2-3ca7e5dac78d", "name": "Timezone", "request": { "name": "Timezone", @@ -3903,7 +3903,7 @@ }, "response": [ { - "id": "68d6443f-2606-4721-af1f-d83535fae7a8", + "id": "48c66a19-1f2f-48fc-a8db-97cd04f3f8fb", "name": "Timezone successfully retrieved", "originalRequest": { "url": { @@ -3969,7 +3969,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e4b161da-f5db-43e4-b79c-b24bd2a4ce4f", + "id": "e4d7b25c-0ca4-43b8-9b6a-5ad9ac8d6bf0", "name": "Unauthorized. Incorrect authentication credentials.", "originalRequest": { "url": { @@ -4035,7 +4035,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7a75cee2-8d22-498b-a262-1b9bcbda83d8", + "id": "76d64cd5-012d-45e7-9035-d1bacf70b51a", "name": "Forbidden. This Woosmap API is not enabled for this project.", "originalRequest": { "url": { @@ -4101,7 +4101,7 @@ "_postman_previewlanguage": "json" }, { - "id": "482ae2f1-239a-49dc-9c6a-e4676c279e6b", + "id": "9ab0c027-2146-4418-b9e9-32c940278ed8", "name": "Too Many Requests. The rate limit for this endpoint has been exceeded.", "originalRequest": { "url": { @@ -4179,7 +4179,7 @@ "description": "Woosmap Localities API is a web service that returns a great amount of geographical places in response to an HTTP request. Among others are city names, postal codes, suburbs, addresses or airports. Request is done over HTTPS using GET. Response is formatted as JSON. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/support/api-keys/).\n", "item": [ { - "id": "7d9caef7-becd-47e1-9c6c-beb29fb922ac", + "id": "e7283974-c7b3-4e2b-a8c3-b14be66543a9", "name": "Autocomplete for Localities", "request": { "name": "Autocomplete for Localities", @@ -4215,7 +4215,7 @@ "type": "text/plain" }, "key": "types", - "value": "city" + "value": "locality" }, { "disabled": false, @@ -4269,7 +4269,7 @@ "type": "text/plain" }, "key": "data", - "value": "standard" + "value": "advanced" }, { "disabled": false, @@ -4320,7 +4320,7 @@ }, "response": [ { - "id": "8527e23b-8998-4771-a9ac-4d9d1732d5c2", + "id": "1fe2d420-52ee-428b-bbfc-47a102ede32c", "name": "Autocompletion Localities successfully retrieved", "originalRequest": { "url": { @@ -4351,7 +4351,7 @@ "type": "text/plain" }, "key": "types", - "value": "city" + "value": "locality" }, { "disabled": false, @@ -4405,7 +4405,7 @@ "type": "text/plain" }, "key": "data", - "value": "standard" + "value": "advanced" }, { "disabled": false, @@ -4453,12 +4453,12 @@ "value": "application/json" } ], - "body": "{\n \"localities\": [\n {\n \"public_id\": \"\",\n \"types\": [\n \"borough\",\n \"route\"\n ],\n \"type\": \"\",\n \"description\": \"\",\n \"matched_substrings\": {\n \"description\": [\n {\n \"length\": \"\",\n \"offset\": \"\"\n },\n {\n \"length\": \"\",\n \"offset\": \"\"\n }\n ]\n },\n \"related\": {\n \"postal_codes\": [\n {\n \"public_id\": \"\",\n \"description\": \"\"\n },\n {\n \"public_id\": \"\",\n \"description\": \"\"\n }\n ]\n },\n \"has_addresses\": \"\"\n },\n {\n \"public_id\": \"\",\n \"types\": [\n \"hamlet\",\n \"route\"\n ],\n \"type\": \"\",\n \"description\": \"\",\n \"matched_substrings\": {\n \"description\": [\n {\n \"length\": \"\",\n \"offset\": \"\"\n },\n {\n \"length\": \"\",\n \"offset\": \"\"\n }\n ]\n },\n \"related\": {\n \"postal_codes\": [\n {\n \"public_id\": \"\",\n \"description\": \"\"\n },\n {\n \"public_id\": \"\",\n \"description\": \"\"\n }\n ]\n },\n \"has_addresses\": \"\"\n }\n ]\n}", + "body": "{\n \"localities\": [\n {\n \"public_id\": \"\",\n \"types\": [\n \"address\",\n \"hamlet\"\n ],\n \"type\": \"\",\n \"description\": \"\",\n \"matched_substrings\": {\n \"description\": [\n {\n \"length\": \"\",\n \"offset\": \"\"\n },\n {\n \"length\": \"\",\n \"offset\": \"\"\n }\n ]\n },\n \"related\": {\n \"postal_codes\": [\n {\n \"public_id\": \"\",\n \"description\": \"\"\n },\n {\n \"public_id\": \"\",\n \"description\": \"\"\n }\n ]\n },\n \"has_addresses\": \"\"\n },\n {\n \"public_id\": \"\",\n \"types\": [\n \"city\",\n \"admin_level\"\n ],\n \"type\": \"\",\n \"description\": \"\",\n \"matched_substrings\": {\n \"description\": [\n {\n \"length\": \"\",\n \"offset\": \"\"\n },\n {\n \"length\": \"\",\n \"offset\": \"\"\n }\n ]\n },\n \"related\": {\n \"postal_codes\": [\n {\n \"public_id\": \"\",\n \"description\": \"\"\n },\n {\n \"public_id\": \"\",\n \"description\": \"\"\n }\n ]\n },\n \"has_addresses\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "21fcdbfb-d5a6-42f5-a4eb-c4ff154a968b", + "id": "794a027f-abf3-4f8f-8dd3-a96032ddfb8e", "name": "Unauthorized. Incorrect authentication credentials.", "originalRequest": { "url": { @@ -4489,7 +4489,7 @@ "type": "text/plain" }, "key": "types", - "value": "city" + "value": "locality" }, { "disabled": false, @@ -4543,7 +4543,7 @@ "type": "text/plain" }, "key": "data", - "value": "standard" + "value": "advanced" }, { "disabled": false, @@ -4596,7 +4596,7 @@ "_postman_previewlanguage": "json" }, { - "id": "022c3d29-db25-46f3-8f57-d5fd749cb6ee", + "id": "a0b65c7b-60f6-41df-9bab-90369d79a97a", "name": "Forbidden. This Woosmap API is not enabled for this project.", "originalRequest": { "url": { @@ -4627,7 +4627,7 @@ "type": "text/plain" }, "key": "types", - "value": "city" + "value": "locality" }, { "disabled": false, @@ -4681,7 +4681,7 @@ "type": "text/plain" }, "key": "data", - "value": "standard" + "value": "advanced" }, { "disabled": false, @@ -4734,7 +4734,7 @@ "_postman_previewlanguage": "json" }, { - "id": "09c5bbd9-df11-48df-a315-0668e35b3c7b", + "id": "ae8e4346-3419-41ac-a760-9d43121f8135", "name": "Too Many Requests. The rate limit for this endpoint has been exceeded.", "originalRequest": { "url": { @@ -4765,7 +4765,7 @@ "type": "text/plain" }, "key": "types", - "value": "city" + "value": "locality" }, { "disabled": false, @@ -4819,7 +4819,7 @@ "type": "text/plain" }, "key": "data", - "value": "standard" + "value": "advanced" }, { "disabled": false, @@ -4878,7 +4878,7 @@ } }, { - "id": "70974de8-46f6-4ea0-924d-2106a16aeb15", + "id": "a7ad0540-c423-4023-903f-0a238796ba6a", "name": "Details of a Locality", "request": { "name": "Details of a Locality", @@ -4928,7 +4928,7 @@ { "disabled": false, "description": { - "content": "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 (This can only be one of alpha2,alpha3)", + "content": "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 (This can only be one of alpha2,alpha3)", "type": "text/plain" }, "key": "cc_format", @@ -4983,7 +4983,7 @@ }, "response": [ { - "id": "1e8447ad-4abb-4c25-8ad9-7a7b495b1286", + "id": "c758aa81-80eb-4093-af4d-1dde1e808bd8", "name": "Details Localities successfully retrieved", "originalRequest": { "url": { @@ -5028,7 +5028,7 @@ { "disabled": false, "description": { - "content": "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 (This can only be one of alpha2,alpha3)", + "content": "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 (This can only be one of alpha2,alpha3)", "type": "text/plain" }, "key": "cc_format", @@ -5080,12 +5080,12 @@ "value": "application/json" } ], - "body": "{\n \"result\": {\n \"public_id\": \"\",\n \"formatted_address\": \"\",\n \"types\": [\n \"borough\",\n \"route\"\n ],\n \"geometry\": {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"viewport\": {\n \"northeast\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"southwest\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n },\n \"shape\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ]\n ]\n },\n \"accuracy\": \"ROUTE\"\n },\n \"address_components\": [\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n },\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"name\": \"\",\n \"administrative_area_label\": \"\",\n \"status\": \"not_yet_built\",\n \"addresses\": {\n \"pagination\": {\n \"page\": \"\",\n \"page_count\": \"\",\n \"addresses_per_page\": \"\",\n \"address_count\": \"\"\n },\n \"list\": [\n {\n \"public_id\": \"\",\n \"description\": \"\"\n },\n {\n \"public_id\": \"\",\n \"description\": \"\"\n }\n ]\n }\n }\n}", + "body": "{\n \"result\": {\n \"public_id\": \"\",\n \"formatted_address\": \"\",\n \"types\": [\n \"admin_level\",\n \"town\"\n ],\n \"geometry\": {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"viewport\": {\n \"northeast\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"southwest\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n },\n \"shape\": {\n \"type\": \"MultiPoligon\",\n \"coordinates\": [\n [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ]\n ]\n },\n \"accuracy\": \"ROUTE\"\n },\n \"address_components\": [\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n },\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"name\": \"\",\n \"administrative_area_label\": \"\",\n \"status\": \"not_yet_built\",\n \"addresses\": {\n \"pagination\": {\n \"page\": \"\",\n \"page_count\": \"\",\n \"addresses_per_page\": \"\",\n \"address_count\": \"\"\n },\n \"list\": [\n {\n \"public_id\": \"\",\n \"description\": \"\"\n },\n {\n \"public_id\": \"\",\n \"description\": \"\"\n }\n ]\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "bc7507c1-e279-41b9-a32b-38bfd1e87fed", + "id": "1d6a136a-51d2-4143-b455-fc58852f1a62", "name": "Unauthorized. Incorrect authentication credentials.", "originalRequest": { "url": { @@ -5130,7 +5130,7 @@ { "disabled": false, "description": { - "content": "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 (This can only be one of alpha2,alpha3)", + "content": "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 (This can only be one of alpha2,alpha3)", "type": "text/plain" }, "key": "cc_format", @@ -5187,7 +5187,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a98c391f-26cd-4d54-bac4-87d9bde19951", + "id": "cec43268-5c78-479d-a924-9510fde3d38e", "name": "Forbidden. This Woosmap API is not enabled for this project.", "originalRequest": { "url": { @@ -5232,7 +5232,7 @@ { "disabled": false, "description": { - "content": "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 (This can only be one of alpha2,alpha3)", + "content": "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 (This can only be one of alpha2,alpha3)", "type": "text/plain" }, "key": "cc_format", @@ -5289,7 +5289,7 @@ "_postman_previewlanguage": "json" }, { - "id": "59d713a4-2bc5-47c0-b78b-473b58ec1471", + "id": "f4cb486c-47b8-40ba-a7b9-7443e1c7320e", "name": "Too Many Requests. The rate limit for this endpoint has been exceeded.", "originalRequest": { "url": { @@ -5334,7 +5334,7 @@ { "disabled": false, "description": { - "content": "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 (This can only be one of alpha2,alpha3)", + "content": "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 (This can only be one of alpha2,alpha3)", "type": "text/plain" }, "key": "cc_format", @@ -5397,7 +5397,7 @@ } }, { - "id": "dece1161-9159-435e-9404-83575a47e364", + "id": "4880d368-aaa8-47ba-b6ba-c305b0af0852", "name": "Geocode a locality or Reverse Geocode a latlng", "request": { "name": "Geocode a locality or Reverse Geocode a latlng", @@ -5442,7 +5442,7 @@ "type": "text/plain" }, "key": "types", - "value": "city" + "value": "locality" }, { "disabled": false, @@ -5496,7 +5496,7 @@ "type": "text/plain" }, "key": "data", - "value": "standard" + "value": "advanced" }, { "disabled": false, @@ -5538,7 +5538,7 @@ }, "response": [ { - "id": "50f0ca86-e33c-4d94-aa1a-d06280d86bc3", + "id": "ba8ecff2-ad05-4cfc-bd59-33c5b2180ad8", "name": "Request Localities Geocode successful", "originalRequest": { "url": { @@ -5578,7 +5578,7 @@ "type": "text/plain" }, "key": "types", - "value": "city" + "value": "locality" }, { "disabled": false, @@ -5632,7 +5632,7 @@ "type": "text/plain" }, "key": "data", - "value": "standard" + "value": "advanced" }, { "disabled": false, @@ -5671,12 +5671,12 @@ "value": "application/json" } ], - "body": "{\n \"results\": [\n {\n \"formatted_address\": \"\",\n \"types\": [\n \"neighbourhood\",\n \"locality\"\n ],\n \"administrative_area_label\": \"\",\n \"public_id\": \"\",\n \"geometry\": {\n \"location_type\": \"DISTRICT\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"viewport\": {\n \"northeast\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"southwest\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n },\n \"shape\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ]\n ]\n }\n },\n \"status\": \"not_yet_built\",\n \"address_components\": [\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n },\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"distance\": \"\",\n \"sub_buildings\": [\n {\n \"public_id\": \"\",\n \"description\": \"\"\n },\n {\n \"public_id\": \"\",\n \"description\": \"\"\n }\n ],\n \"scores_per_components\": {\n \"street_name\": \"\",\n \"postal_code\": \"\",\n \"locality\": \"\"\n }\n },\n {\n \"formatted_address\": \"\",\n \"types\": [\n \"hamlet\",\n \"route\"\n ],\n \"administrative_area_label\": \"\",\n \"public_id\": \"\",\n \"geometry\": {\n \"location_type\": \"POSTAL_CODE\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"viewport\": {\n \"northeast\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"southwest\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n },\n \"shape\": {\n \"type\": \"Polygon\",\n \"coordinates\": [\n [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ]\n ]\n }\n },\n \"status\": \"not_yet_built\",\n \"address_components\": [\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n },\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"distance\": \"\",\n \"sub_buildings\": [\n {\n \"public_id\": \"\",\n \"description\": \"\"\n },\n {\n \"public_id\": \"\",\n \"description\": \"\"\n }\n ],\n \"scores_per_components\": {\n \"street_name\": \"\",\n \"postal_code\": \"\",\n \"locality\": \"\"\n }\n }\n ]\n}", + "body": "{\n \"results\": [\n {\n \"formatted_address\": \"\",\n \"types\": [\n \"route\",\n \"quarter\"\n ],\n \"administrative_area_label\": \"\",\n \"public_id\": \"\",\n \"geometry\": {\n \"location_type\": \"RANGE_INTERPOLATED\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"viewport\": {\n \"northeast\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"southwest\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n },\n \"shape\": {\n \"type\": \"MultiPoligon\",\n \"coordinates\": [\n [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ]\n ]\n }\n },\n \"status\": \"not_yet_built\",\n \"address_components\": [\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n },\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"distance\": \"\",\n \"sub_buildings\": [\n {\n \"public_id\": \"\",\n \"description\": \"\"\n },\n {\n \"public_id\": \"\",\n \"description\": \"\"\n }\n ],\n \"scores_per_components\": {\n \"street_name\": \"\",\n \"postal_code\": \"\",\n \"locality\": \"\"\n }\n },\n {\n \"formatted_address\": \"\",\n \"types\": [\n \"country\",\n \"village\"\n ],\n \"administrative_area_label\": \"\",\n \"public_id\": \"\",\n \"geometry\": {\n \"location_type\": \"APPROXIMATE\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"viewport\": {\n \"northeast\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"southwest\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n },\n \"shape\": {\n \"type\": \"MultiPoligon\",\n \"coordinates\": [\n [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ],\n [\n [\n \"\",\n \"\"\n ],\n [\n \"\",\n \"\"\n ]\n ]\n ]\n }\n },\n \"status\": \"not_yet_built\",\n \"address_components\": [\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n },\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"distance\": \"\",\n \"sub_buildings\": [\n {\n \"public_id\": \"\",\n \"description\": \"\"\n },\n {\n \"public_id\": \"\",\n \"description\": \"\"\n }\n ],\n \"scores_per_components\": {\n \"street_name\": \"\",\n \"postal_code\": \"\",\n \"locality\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5dd1291f-73b4-4ab2-92e4-adf8d87d9d24", + "id": "a2a1f85a-3f41-40c3-add1-a653d5041ca9", "name": "Unauthorized. Incorrect authentication credentials.", "originalRequest": { "url": { @@ -5716,7 +5716,7 @@ "type": "text/plain" }, "key": "types", - "value": "city" + "value": "locality" }, { "disabled": false, @@ -5770,7 +5770,7 @@ "type": "text/plain" }, "key": "data", - "value": "standard" + "value": "advanced" }, { "disabled": false, @@ -5814,7 +5814,7 @@ "_postman_previewlanguage": "json" }, { - "id": "27f1c107-1b96-45ca-9947-d9c4e472ce15", + "id": "8954be90-4ce1-43d8-b4a9-cb13a1037e92", "name": "Forbidden. This Woosmap API is not enabled for this project.", "originalRequest": { "url": { @@ -5854,7 +5854,7 @@ "type": "text/plain" }, "key": "types", - "value": "city" + "value": "locality" }, { "disabled": false, @@ -5908,7 +5908,7 @@ "type": "text/plain" }, "key": "data", - "value": "standard" + "value": "advanced" }, { "disabled": false, @@ -5952,7 +5952,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d898b5bc-e2b1-4309-af83-c1d0dc6ea01f", + "id": "de841b84-1727-4b21-80c3-54c75e75d2e0", "name": "Too Many Requests. The rate limit for this endpoint has been exceeded.", "originalRequest": { "url": { @@ -5992,7 +5992,7 @@ "type": "text/plain" }, "key": "types", - "value": "city" + "value": "locality" }, { "disabled": false, @@ -6046,7 +6046,7 @@ "type": "text/plain" }, "key": "data", - "value": "standard" + "value": "advanced" }, { "disabled": false, @@ -6096,7 +6096,7 @@ } }, { - "id": "c28dd9f0-c7f8-4462-a11d-023232e4eacc", + "id": "1cd2e579-9152-4837-a188-ce0132c64ad6", "name": "Nearby points of interest", "request": { "name": "Nearby points of interest", @@ -6123,7 +6123,7 @@ "type": "text/plain" }, "key": "types", - "value": "business.cinema" + "value": "business.shop.electronics" }, { "disabled": false, @@ -6168,7 +6168,7 @@ "type": "text/plain" }, "key": "excluded_types", - "value": "business.cinema" + "value": "business.shop.electronics" } ], "variable": [] @@ -6201,7 +6201,7 @@ }, "response": [ { - "id": "c39f6945-4cce-462b-b987-dd10f1005353", + "id": "26256db2-e524-4354-9f8e-9a7564919993", "name": "Points of interests surrounding `location` and matching provided `types`, sorted by distance to `location`.", "originalRequest": { "url": { @@ -6223,7 +6223,7 @@ "type": "text/plain" }, "key": "types", - "value": "business.cinema" + "value": "business.shop.electronics" }, { "disabled": false, @@ -6268,7 +6268,7 @@ "type": "text/plain" }, "key": "excluded_types", - "value": "business.cinema" + "value": "business.shop.electronics" }, { "description": { @@ -6298,12 +6298,12 @@ "value": "application/json" } ], - "body": "{\n \"results\": [\n {\n \"types\": [\n \"medical.clinic\",\n \"business.food_and_drinks\"\n ],\n \"name\": \"\",\n \"public_id\": \"\",\n \"geometry\": {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"viewport\": {\n \"northeast\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"southwest\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n }\n },\n \"address_components\": [\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n },\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"categories\": [\n \"business.shop.bakery\",\n \"business.shop.bakery\"\n ],\n \"formatted_address\": \"\"\n },\n {\n \"types\": [\n \"business.shop.sports\",\n \"park.national\"\n ],\n \"name\": \"\",\n \"public_id\": \"\",\n \"geometry\": {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"viewport\": {\n \"northeast\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"southwest\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n }\n },\n \"address_components\": [\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n },\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"categories\": [\n \"hospitality.motel\",\n \"education.university\"\n ],\n \"formatted_address\": \"\"\n }\n ],\n \"pagination\": {\n \"next_page\": \"\",\n \"previous_page\": \"\"\n }\n}", + "body": "{\n \"results\": [\n {\n \"types\": [\n \"business.shop.sports\",\n \"business.fuel\"\n ],\n \"name\": \"\",\n \"public_id\": \"\",\n \"geometry\": {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"viewport\": {\n \"northeast\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"southwest\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n }\n },\n \"address_components\": [\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n },\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"categories\": [\n \"beach\",\n \"tourism\"\n ],\n \"formatted_address\": \"\"\n },\n {\n \"types\": [\n \"sports.golf\",\n \"tourism\"\n ],\n \"name\": \"\",\n \"public_id\": \"\",\n \"geometry\": {\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"viewport\": {\n \"northeast\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"southwest\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n }\n },\n \"address_components\": [\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n },\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"categories\": [\n \"business.parking\",\n \"business.food_and_drinks.pub\"\n ],\n \"formatted_address\": \"\"\n }\n ],\n \"pagination\": {\n \"next_page\": \"\",\n \"previous_page\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "5b8ffb26-feed-480b-b6a8-ffe150da1949", + "id": "7587991b-e39e-4019-9be4-50f5220047f0", "name": "Unauthorized. Incorrect authentication credentials.", "originalRequest": { "url": { @@ -6325,7 +6325,7 @@ "type": "text/plain" }, "key": "types", - "value": "business.cinema" + "value": "business.shop.electronics" }, { "disabled": false, @@ -6370,7 +6370,7 @@ "type": "text/plain" }, "key": "excluded_types", - "value": "business.cinema" + "value": "business.shop.electronics" }, { "description": { @@ -6405,7 +6405,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ef06f48a-ca39-4230-9f77-e9ad28f47572", + "id": "86beb1a7-4020-4460-942a-4577f91dd033", "name": "Forbidden. This Woosmap API is not enabled for this project.", "originalRequest": { "url": { @@ -6427,7 +6427,7 @@ "type": "text/plain" }, "key": "types", - "value": "business.cinema" + "value": "business.shop.electronics" }, { "disabled": false, @@ -6472,7 +6472,7 @@ "type": "text/plain" }, "key": "excluded_types", - "value": "business.cinema" + "value": "business.shop.electronics" }, { "description": { @@ -6507,7 +6507,7 @@ "_postman_previewlanguage": "json" }, { - "id": "93acb4cb-b63e-49f8-946e-da76fc309c82", + "id": "106aed0b-ba90-43fb-ac6f-4d68a3401360", "name": "Too Many Requests. The rate limit for this endpoint has been exceeded.", "originalRequest": { "url": { @@ -6529,7 +6529,7 @@ "type": "text/plain" }, "key": "types", - "value": "business.cinema" + "value": "business.shop.electronics" }, { "disabled": false, @@ -6574,1405 +6574,7 @@ "type": "text/plain" }, "key": "excluded_types", - "value": "business.cinema" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Too Many Requests", - "code": 429, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"detail\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true - } - } - ] - }, - { - "name": "Address API", - "description": "Woosmap Address API is a web service that returns addresses and other geographical places in response to an HTTP request. Request is done over HTTPS using GET. Response is formatted as JSON. You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/support/api-keys/).\n>**⚠️ This API has been deprecated in favour of Localities API**\n", - "item": [ - { - "id": "bdb9eac9-f52d-4184-a12c-b5f4390e54c0", - "name": "Autocomplete for Addresses", - "request": { - "name": "Autocomplete for Addresses", - "description": { - "content": "Autocomplete on worldwide suggestions for a for text-based geographic searches. It can match on full words as well as substrings.\n", - "type": "text/plain" - }, - "url": { - "protocol": "https", - "path": [ - "address", - "autocomplete", - "json" - ], - "host": [ - "api", - "woosmap", - "com" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "(Required) 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", - "type": "text/plain" - }, - "key": "input", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "components", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Bias for the results. Should be pass in `lat`,`lng` format.\n", - "type": "text/plain" - }, - "key": "location", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "language", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {}, - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "key" - }, - { - "key": "value", - "value": "{{apiKey}}" - }, - { - "key": "in", - "value": "query" - } - ] - } - }, - "response": [ - { - "id": "3ef23138-8dff-48e9-a9b0-c79463f960a5", - "name": "Autocompletion Address successfully retrieved", - "originalRequest": { - "url": { - "protocol": "https", - "path": [ - "address", - "autocomplete", - "json" - ], - "host": [ - "api", - "woosmap", - "com" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "(Required) 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", - "type": "text/plain" - }, - "key": "input", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "components", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Bias for the results. Should be pass in `lat`,`lng` format.\n", - "type": "text/plain" - }, - "key": "location", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "language", - "value": "" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"predictions\": [\n {\n \"description\": \"\",\n \"public_id\": \"\",\n \"matched_substring\": {\n \"description\": [\n {\n \"length\": \"\",\n \"offset\": \"\"\n },\n {\n \"length\": \"\",\n \"offset\": \"\"\n }\n ]\n },\n \"type\": \"address_block\",\n \"status\": \"INVALID_REQUEST\"\n },\n {\n \"description\": \"\",\n \"public_id\": \"\",\n \"matched_substring\": {\n \"description\": [\n {\n \"length\": \"\",\n \"offset\": \"\"\n },\n {\n \"length\": \"\",\n \"offset\": \"\"\n }\n ]\n },\n \"type\": \"house_number\",\n \"status\": \"REQUEST_DENIED\"\n }\n ],\n \"status\": \"INVALID_REQUEST\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "4edd1c5f-c77a-47dc-b44a-a2b5b513204d", - "name": "Unauthorized. Incorrect authentication credentials.", - "originalRequest": { - "url": { - "protocol": "https", - "path": [ - "address", - "autocomplete", - "json" - ], - "host": [ - "api", - "woosmap", - "com" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "(Required) 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", - "type": "text/plain" - }, - "key": "input", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "components", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Bias for the results. Should be pass in `lat`,`lng` format.\n", - "type": "text/plain" - }, - "key": "location", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "language", - "value": "" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"detail\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "5340e571-9bda-43d9-aa84-9091e3a73e54", - "name": "Forbidden. This Woosmap API is not enabled for this project.", - "originalRequest": { - "url": { - "protocol": "https", - "path": [ - "address", - "autocomplete", - "json" - ], - "host": [ - "api", - "woosmap", - "com" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "(Required) 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", - "type": "text/plain" - }, - "key": "input", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "components", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Bias for the results. Should be pass in `lat`,`lng` format.\n", - "type": "text/plain" - }, - "key": "location", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "language", - "value": "" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"detail\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "206d9b12-dd04-4cf7-a8fe-8f2aef5ec629", - "name": "Too Many Requests. The rate limit for this endpoint has been exceeded.", - "originalRequest": { - "url": { - "protocol": "https", - "path": [ - "address", - "autocomplete", - "json" - ], - "host": [ - "api", - "woosmap", - "com" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "(Required) 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", - "type": "text/plain" - }, - "key": "input", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "components", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Bias for the results. Should be pass in `lat`,`lng` format.\n", - "type": "text/plain" - }, - "key": "location", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "language", - "value": "" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Too Many Requests", - "code": 429, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"detail\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true - } - }, - { - "id": "9cbf3c2d-13b3-438c-80ad-12007b49a5ce", - "name": "Details of an Address", - "request": { - "name": "Details of an Address", - "description": { - "content": "Provides details of an address autocomplete suggestion (using the suggestion’s `public_id`).\n", - "type": "text/plain" - }, - "url": { - "protocol": "https", - "path": [ - "address", - "details", - "json" - ], - "host": [ - "api", - "woosmap", - "com" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "(Required) A textual identifier that uniquely identifies a locality, returned from an [Address Autocomplete](https://developers.woosmap.com/products/address-api/autocomplete/).\n", - "type": "text/plain" - }, - "key": "public_id", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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 (This can only be one of geometry)", - "type": "text/plain" - }, - "key": "fields", - "value": "geometry" - }, - { - "disabled": false, - "description": { - "content": "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 (This can only be one of alpha2,alpha3)", - "type": "text/plain" - }, - "key": "cc_format", - "value": "alpha3" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {}, - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "key" - }, - { - "key": "value", - "value": "{{apiKey}}" - }, - { - "key": "in", - "value": "query" - } - ] - } - }, - "response": [ - { - "id": "5cbee751-c5ce-46ce-a908-a76be15ca6ce", - "name": "Details Address successfully retrieved", - "originalRequest": { - "url": { - "protocol": "https", - "path": [ - "address", - "details", - "json" - ], - "host": [ - "api", - "woosmap", - "com" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "(Required) A textual identifier that uniquely identifies a locality, returned from an [Address Autocomplete](https://developers.woosmap.com/products/address-api/autocomplete/).\n", - "type": "text/plain" - }, - "key": "public_id", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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 (This can only be one of geometry)", - "type": "text/plain" - }, - "key": "fields", - "value": "geometry" - }, - { - "disabled": false, - "description": { - "content": "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 (This can only be one of alpha2,alpha3)", - "type": "text/plain" - }, - "key": "cc_format", - "value": "alpha3" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"status\": \"OK\",\n \"result\": {\n \"formatted_address\": \"\",\n \"types\": [\n \"address_block\",\n \"house_number\"\n ],\n \"public_id\": \"\",\n \"address_components\": [\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n },\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"geometry\": {\n \"location_type\": \"ROOFTOP\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"viewport\": {\n \"northeast\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"southwest\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n }\n }\n }\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "9db4faf6-d98d-474a-9d8b-e5db6c48453a", - "name": "Unauthorized. Incorrect authentication credentials.", - "originalRequest": { - "url": { - "protocol": "https", - "path": [ - "address", - "details", - "json" - ], - "host": [ - "api", - "woosmap", - "com" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "(Required) A textual identifier that uniquely identifies a locality, returned from an [Address Autocomplete](https://developers.woosmap.com/products/address-api/autocomplete/).\n", - "type": "text/plain" - }, - "key": "public_id", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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 (This can only be one of geometry)", - "type": "text/plain" - }, - "key": "fields", - "value": "geometry" - }, - { - "disabled": false, - "description": { - "content": "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 (This can only be one of alpha2,alpha3)", - "type": "text/plain" - }, - "key": "cc_format", - "value": "alpha3" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"detail\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "6b53fd81-62f9-4383-a412-077a1549a07c", - "name": "Forbidden. This Woosmap API is not enabled for this project.", - "originalRequest": { - "url": { - "protocol": "https", - "path": [ - "address", - "details", - "json" - ], - "host": [ - "api", - "woosmap", - "com" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "(Required) A textual identifier that uniquely identifies a locality, returned from an [Address Autocomplete](https://developers.woosmap.com/products/address-api/autocomplete/).\n", - "type": "text/plain" - }, - "key": "public_id", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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 (This can only be one of geometry)", - "type": "text/plain" - }, - "key": "fields", - "value": "geometry" - }, - { - "disabled": false, - "description": { - "content": "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 (This can only be one of alpha2,alpha3)", - "type": "text/plain" - }, - "key": "cc_format", - "value": "alpha3" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"detail\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "25a5b863-b5a1-4493-8e71-2ea7221cfe5d", - "name": "Too Many Requests. The rate limit for this endpoint has been exceeded.", - "originalRequest": { - "url": { - "protocol": "https", - "path": [ - "address", - "details", - "json" - ], - "host": [ - "api", - "woosmap", - "com" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "(Required) A textual identifier that uniquely identifies a locality, returned from an [Address Autocomplete](https://developers.woosmap.com/products/address-api/autocomplete/).\n", - "type": "text/plain" - }, - "key": "public_id", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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 (This can only be one of geometry)", - "type": "text/plain" - }, - "key": "fields", - "value": "geometry" - }, - { - "disabled": false, - "description": { - "content": "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 (This can only be one of alpha2,alpha3)", - "type": "text/plain" - }, - "key": "cc_format", - "value": "alpha3" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Too Many Requests", - "code": 429, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"detail\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - } - ], - "event": [], - "protocolProfileBehavior": { - "disableBodyPruning": true - } - }, - { - "id": "b990ce0b-9e6c-495a-ae0e-173c33c18d0b", - "name": "Geocode an Address or Reverse Geocode a latlng", - "request": { - "name": "Geocode an Address or Reverse Geocode a latlng", - "description": { - "content": "Provides details for an address or a geographic position. Either parameter `address` **or** `latlng` is required. Maximum of 25 queries per second (QPS)\n", - "type": "text/plain" - }, - "url": { - "protocol": "https", - "path": [ - "address", - "geocode", - "json" - ], - "host": [ - "api", - "woosmap", - "com" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "address", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Geographic coordinates. Should be pass in `lat`,`lng` format.\n", - "type": "text/plain" - }, - "key": "latlng", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "components", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "language", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Bias for the results. Should be pass in `lat`,`lng` format.\n", - "type": "text/plain" - }, - "key": "location", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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 (This can only be one of alpha2,alpha3)", - "type": "text/plain" - }, - "key": "cc_format", - "value": "alpha3" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "limit", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {}, - "auth": { - "type": "apikey", - "apikey": [ - { - "key": "key", - "value": "key" - }, - { - "key": "value", - "value": "{{apiKey}}" - }, - { - "key": "in", - "value": "query" - } - ] - } - }, - "response": [ - { - "id": "6bc4afda-f432-4480-be37-dcb4673791f5", - "name": "Request Address Geocode successful", - "originalRequest": { - "url": { - "protocol": "https", - "path": [ - "address", - "geocode", - "json" - ], - "host": [ - "api", - "woosmap", - "com" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "address", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Geographic coordinates. Should be pass in `lat`,`lng` format.\n", - "type": "text/plain" - }, - "key": "latlng", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "components", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "language", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Bias for the results. Should be pass in `lat`,`lng` format.\n", - "type": "text/plain" - }, - "key": "location", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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 (This can only be one of alpha2,alpha3)", - "type": "text/plain" - }, - "key": "cc_format", - "value": "alpha3" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "limit", - "value": "" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "OK", - "code": 200, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"results\": [\n {\n \"formatted_address\": \"\",\n \"types\": [\n \"house_number\",\n \"house_number\"\n ],\n \"address_components\": [\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n },\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"geometry\": {\n \"location_type\": \"GEOMETRIC_CENTER\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"viewport\": {\n \"northeast\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"southwest\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n }\n }\n },\n {\n \"formatted_address\": \"\",\n \"types\": [\n \"address\",\n \"locality\"\n ],\n \"address_components\": [\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n },\n {\n \"long_name\": \"\",\n \"short_name\": \"\",\n \"types\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"geometry\": {\n \"location_type\": \"APPROXIMATE\",\n \"location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"viewport\": {\n \"northeast\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"southwest\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n }\n }\n }\n ],\n \"status\": \"OK\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "fcb9c7b0-aa31-4844-ab46-2ff7c4662dcb", - "name": "Unauthorized. Incorrect authentication credentials.", - "originalRequest": { - "url": { - "protocol": "https", - "path": [ - "address", - "geocode", - "json" - ], - "host": [ - "api", - "woosmap", - "com" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "address", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Geographic coordinates. Should be pass in `lat`,`lng` format.\n", - "type": "text/plain" - }, - "key": "latlng", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "components", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "language", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Bias for the results. Should be pass in `lat`,`lng` format.\n", - "type": "text/plain" - }, - "key": "location", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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 (This can only be one of alpha2,alpha3)", - "type": "text/plain" - }, - "key": "cc_format", - "value": "alpha3" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "limit", - "value": "" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Unauthorized", - "code": 401, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"detail\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "0992131d-b5c9-474e-ab3b-277bd86aab75", - "name": "Forbidden. This Woosmap API is not enabled for this project.", - "originalRequest": { - "url": { - "protocol": "https", - "path": [ - "address", - "geocode", - "json" - ], - "host": [ - "api", - "woosmap", - "com" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "address", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Geographic coordinates. Should be pass in `lat`,`lng` format.\n", - "type": "text/plain" - }, - "key": "latlng", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "components", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "language", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Bias for the results. Should be pass in `lat`,`lng` format.\n", - "type": "text/plain" - }, - "key": "location", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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 (This can only be one of alpha2,alpha3)", - "type": "text/plain" - }, - "key": "cc_format", - "value": "alpha3" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "limit", - "value": "" - }, - { - "description": { - "content": "Added as a part of security scheme: apikey", - "type": "text/plain" - }, - "key": "key", - "value": "" - } - ], - "variable": [] - }, - "header": [ - { - "key": "Accept", - "value": "application/json" - } - ], - "method": "GET", - "body": {} - }, - "status": "Forbidden", - "code": 403, - "header": [ - { - "key": "Content-Type", - "value": "application/json" - } - ], - "body": "{\n \"detail\": \"\"\n}", - "cookie": [], - "_postman_previewlanguage": "json" - }, - { - "id": "dca4b279-5999-412c-a49a-de1a7b50f6d8", - "name": "Too Many Requests. The rate limit for this endpoint has been exceeded.", - "originalRequest": { - "url": { - "protocol": "https", - "path": [ - "address", - "geocode", - "json" - ], - "host": [ - "api", - "woosmap", - "com" - ], - "query": [ - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "address", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Geographic coordinates. Should be pass in `lat`,`lng` format.\n", - "type": "text/plain" - }, - "key": "latlng", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "components", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "language", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "Bias for the results. Should be pass in `lat`,`lng` format.\n", - "type": "text/plain" - }, - "key": "location", - "value": "" - }, - { - "disabled": false, - "description": { - "content": "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 (This can only be one of alpha2,alpha3)", - "type": "text/plain" - }, - "key": "cc_format", - "value": "alpha3" - }, - { - "disabled": false, - "description": { - "content": "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", - "type": "text/plain" - }, - "key": "limit", - "value": "" + "value": "business.shop.electronics" }, { "description": { @@ -8019,7 +6621,7 @@ "description": "", "item": [ { - "id": "74bd38fa-a2ef-44cd-8e56-6b9031b4735d", + "id": "bec6c33c-e0dc-46b1-8b30-085e5583ef75", "name": "Search for assets", "request": { "name": "Search for assets", @@ -8142,7 +6744,7 @@ }, "response": [ { - "id": "367c3bfe-e89c-416e-8c00-9e92502465b3", + "id": "bd683ae1-0c6a-4f14-9a4f-5ac165c07f99", "name": "Assets successfully retrieved", "originalRequest": { "url": { @@ -8257,12 +6859,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 \"key_0\": 3421.4800747584204,\n \"key_1\": \"string\",\n \"key_2\": 1514\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\": null,\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\": \"\"\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 \"key_0\": 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\": null,\n \"opening_hours\": null,\n \"distance\": \"\"\n },\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [\n \"\",\n \"\"\n ]\n }\n }\n ],\n \"pagination\": {\n \"page\": \"\",\n \"pageCount\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6d6d2b1e-abc8-476f-92e6-65e39d0efd55", + "id": "80f87d06-9f96-4e1b-b71d-b5a3fed5e8d5", "name": "Unauthorized. Incorrect authentication credentials.", "originalRequest": { "url": { @@ -8382,7 +6984,7 @@ "_postman_previewlanguage": "json" }, { - "id": "de19346e-6c48-4257-afd6-9ae933e6be42", + "id": "2bcb4b6f-118c-489a-a6ea-da29c941602a", "name": "Forbidden. This Woosmap API is not enabled for this project.", "originalRequest": { "url": { @@ -8502,7 +7104,7 @@ "_postman_previewlanguage": "json" }, { - "id": "653d3d0a-346f-4c4b-9052-1d636b546e1a", + "id": "a4cd88f0-5dc4-4a3b-b82c-09ca8ac7305c", "name": "Too Many Requests. The rate limit for this endpoint has been exceeded.", "originalRequest": { "url": { @@ -8628,7 +7230,7 @@ } }, { - "id": "05957855-3e76-4005-8106-282442903a08", + "id": "61d272cf-7cdd-4c1e-a658-cd4eda3d7fb7", "name": "Autocomplete for assets", "request": { "name": "Autocomplete for assets", @@ -8706,7 +7308,7 @@ }, "response": [ { - "id": "bb975049-5212-4f5c-add0-6430a875c04c", + "id": "18f4b784-3d44-4400-9fc7-60c910ed0786", "name": "Assets Successfully Replaced", "originalRequest": { "url": { @@ -8781,7 +7383,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f4dff760-0015-48ba-b1c9-e51eb1217ca7", + "id": "25296f9d-563c-4d7e-87ef-f3cd83bf2ac4", "name": "Unauthorized. Incorrect authentication credentials.", "originalRequest": { "url": { @@ -8856,7 +7458,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e9fb5110-b73c-404d-b7d8-200d25585573", + "id": "07f6b113-f7db-4ce5-9110-8e7d142d8a54", "name": "Forbidden. This Woosmap API is not enabled for this project.", "originalRequest": { "url": { @@ -8931,7 +7533,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a7830442-d5b7-4170-8453-b409471393ed", + "id": "5cfdba0d-c987-41df-9a50-69513029261d", "name": "Too Many Requests. The rate limit for this endpoint has been exceeded.", "originalRequest": { "url": { @@ -9012,7 +7614,7 @@ } }, { - "id": "a39f514e-8860-4136-b5ee-2d71e8ff4f67", + "id": "54e0ab18-1855-401f-8541-fa4fd5619dd0", "name": "Bounds for assets", "request": { "name": "Bounds for assets", @@ -9100,7 +7702,7 @@ }, "response": [ { - "id": "9dfbaa8c-627d-44a4-9939-8225c3abe680", + "id": "fef7350e-9e61-4547-a620-cb3c3d22ac85", "name": "Bounds successfully retrieved", "originalRequest": { "url": { @@ -9185,7 +7787,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0266b1fe-57bc-4195-a2cd-a5bd674b4dd4", + "id": "b45b3f85-4d57-4e71-8d98-f5cee86b5dce", "name": "Unauthorized. Incorrect authentication credentials.", "originalRequest": { "url": { @@ -9270,7 +7872,7 @@ "_postman_previewlanguage": "json" }, { - "id": "bf178d85-4938-4db1-98b6-8a1490a8b5a1", + "id": "ce8fa4fb-cd0e-42e7-8796-19305a46fada", "name": "Forbidden. This Woosmap API is not enabled for this project.", "originalRequest": { "url": { @@ -9355,7 +7957,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5f7da8bf-1473-4203-8c98-cb3e89aa0b36", + "id": "a5ee8527-88da-4d6e-82d9-2f4288208536", "name": "Too Many Requests. The rate limit for this endpoint has been exceeded.", "originalRequest": { "url": { @@ -9452,7 +8054,7 @@ "description": "The Woosmap Static Maps API lets you generate customizable, embeddable map images using simple HTTP requests. It’s a lightweight alternative to interactive maps—ideal for emails, reports, or websites where dynamic JavaScript maps aren't needed.\n\nYou provide parameters such as location, zoom level, size, and markers, and the API returns a map image that can be embedded directly into any webpage or application.\n", "item": [ { - "id": "c4b338c4-c74c-47ab-8e96-445ed1cd80ef", + "id": "93dbeda2-c8e9-4091-bc35-183ede89ee71", "name": "Get Static Map", "request": { "name": "Get Static Map", @@ -9626,7 +8228,7 @@ }, "response": [ { - "id": "1ca7de91-1c49-4a86-ba39-5a0722188fa9", + "id": "0ab23010-e5b0-4375-9c81-07458fc02ac9", "name": "Successful Response", "originalRequest": { "url": { @@ -9770,7 +8372,7 @@ "_postman_previewlanguage": "text" }, { - "id": "830a8606-9aae-4eb9-82e5-5e28d4d87263", + "id": "8dbadb19-dd0e-43f9-bfc4-148036022575", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -9914,7 +8516,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9274f123-2c3e-4d1b-9ad8-6c6e90aba770", + "id": "35ee3cc3-b1f9-4db4-bff0-cc4721295afe", "name": "Out of free quota.", "originalRequest": { "url": { @@ -10058,7 +8660,7 @@ "_postman_previewlanguage": "json" }, { - "id": "31b21ccf-d794-435b-8a13-7dc1a0725e7b", + "id": "285c4e57-1b5e-4b4a-a659-2b935dae794c", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -10202,7 +8804,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f2a14af3-88cc-4b7d-adc0-d76f999c4c46", + "id": "268ab292-9218-4fbb-8820-7fd0d3a7d2ac", "name": "Validation Error", "originalRequest": { "url": { @@ -10346,7 +8948,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3eefb65f-134c-4f90-9f01-3d754815f9fb", + "id": "37ddcb97-73f0-4091-84cc-4b21407063b9", "name": "Rate limit reached", "originalRequest": { "url": { @@ -10502,7 +9104,7 @@ "description": "The Woosmap for what3words integration enhances location search capabilities by incorporating what3words' unique\n3-word addressing system.\n\nThis API is a drop in replacement of what3words API but hosted on Woosmap Platform, with the addition of an endpoint leveraging the power of\n[Localities API](#tag/Woosmap_Platform_API_Reference_Localities-API) to convert a what3words address into a street address, bringing address level accuracy to what3words.\n", "item": [ { - "id": "c0324d06-ac39-4a25-8bad-73ee6ec88ac0", + "id": "667f0ee0-6aaa-4e24-9842-336e292bb45d", "name": "Convert To What 3 Words", "request": { "name": "Convert To What 3 Words", @@ -10577,7 +9179,7 @@ }, "response": [ { - "id": "81a3d836-5c9d-4ca4-b6b0-a4c8bdcfdf2d", + "id": "22ca0800-f33b-402c-bf3e-1317286bca3d", "name": "Successful Response", "originalRequest": { "url": { @@ -10649,7 +9251,7 @@ "_postman_previewlanguage": "json" }, { - "id": "85c39a78-159d-4869-bb9c-97d3ea1e298e", + "id": "51856e96-93a5-4be1-b77d-19b6306adace", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -10721,7 +9323,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ffc3ad5c-fe3e-4221-bc76-f0fd8a10acb7", + "id": "2162ce9d-d315-40b9-846c-2754329eb844", "name": "Out of free quota.", "originalRequest": { "url": { @@ -10793,7 +9395,7 @@ "_postman_previewlanguage": "json" }, { - "id": "348c05bf-aef8-48a9-ab3c-ca718c190d4d", + "id": "f3e51a84-462e-484c-966a-38aed80205d0", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -10865,7 +9467,7 @@ "_postman_previewlanguage": "json" }, { - "id": "61e1bc5f-b034-4da8-9beb-9dccb032955a", + "id": "6967e03a-dfce-4b92-80d7-a4869b9bd7d8", "name": "Validation Error", "originalRequest": { "url": { @@ -10937,7 +9539,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4ff882d6-f0d0-418e-984c-dcfcd30b75e9", + "id": "88a7c0a0-1506-44ae-9d8c-f7c138d4e6d0", "name": "Rate limit reached", "originalRequest": { "url": { @@ -11015,7 +9617,7 @@ } }, { - "id": "568d02ef-2e38-4694-9af4-4697c5326dc9", + "id": "b57b2f21-6b81-44ba-97c5-1446b7d9a66e", "name": "Convert To Address", "request": { "name": "Convert To Address", @@ -11081,7 +9683,7 @@ }, "response": [ { - "id": "77831879-bed7-4b9c-979b-292d72e63d6c", + "id": "7b892808-f0db-44d1-8dc6-7ff8d4554a1d", "name": "Successful Response", "originalRequest": { "url": { @@ -11139,12 +9741,12 @@ "value": "application/json" } ], - "body": "{\n \"results\": [\n {\n \"types\": [\n \"village\",\n \"address\"\n ],\n \"formatted_address\": \"\",\n \"public_id\": \"\",\n \"status\": \"\",\n \"sub_buildings\": [\n {\n \"public_id\": \"\",\n \"description\": \"\"\n },\n {\n \"public_id\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"types\": [\n \"postal_code\",\n \"village\"\n ],\n \"formatted_address\": \"\",\n \"public_id\": \"\",\n \"status\": \"\",\n \"sub_buildings\": [\n {\n \"public_id\": \"\",\n \"description\": \"\"\n },\n {\n \"public_id\": \"\",\n \"description\": \"\"\n }\n ]\n }\n ]\n}", + "body": "{\n \"results\": [\n {\n \"types\": [\n \"borough\",\n \"village\"\n ],\n \"formatted_address\": \"\",\n \"public_id\": \"\",\n \"status\": \"\",\n \"sub_buildings\": [\n {\n \"public_id\": \"\",\n \"description\": \"\"\n },\n {\n \"public_id\": \"\",\n \"description\": \"\"\n }\n ]\n },\n {\n \"types\": [\n \"hamlet\",\n \"postal_code\"\n ],\n \"formatted_address\": \"\",\n \"public_id\": \"\",\n \"status\": \"\",\n \"sub_buildings\": [\n {\n \"public_id\": \"\",\n \"description\": \"\"\n },\n {\n \"public_id\": \"\",\n \"description\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "e37fd043-f001-4d2f-a08c-f4a4d7fabec2", + "id": "ab095c00-ae6c-4da5-8243-2cf1f1e39744", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -11207,7 +9809,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6b1c63e6-53a7-4856-a0cc-3e5b00170131", + "id": "7c51435a-5ad2-459d-ac3d-be36d7a5d1ce", "name": "Out of free quota.", "originalRequest": { "url": { @@ -11270,7 +9872,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7bcf3945-bf2b-4cae-ba0c-33e8399e5779", + "id": "a2bc6fa3-7fde-4d95-8d82-f4edcaa78ce1", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -11333,7 +9935,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0ed71efd-923b-47e9-a560-1ebc77773b92", + "id": "07da1d7d-4437-46bb-a308-6f35ae107b63", "name": "Validation Error", "originalRequest": { "url": { @@ -11396,7 +9998,7 @@ "_postman_previewlanguage": "json" }, { - "id": "18d9e418-8bcd-4197-a400-501a3f054824", + "id": "ab08471d-21f1-4f30-9b65-c6b01923224c", "name": "Rate limit reached", "originalRequest": { "url": { @@ -11465,7 +10067,7 @@ } }, { - "id": "35ba4977-9778-4816-a2e7-1d8210e123ae", + "id": "ef8273e2-fd21-45c8-ae6f-f332a5dc5628", "name": "Autosuggest", "request": { "name": "Autosuggest", @@ -11594,7 +10196,7 @@ }, "response": [ { - "id": "f03e902b-4a9d-4d4c-a6b1-8b4def69cfe8", + "id": "ddc39a75-f8d4-4cce-97f6-a936052999ee", "name": "Successful Response", "originalRequest": { "url": { @@ -11720,7 +10322,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b2aa0d77-305b-47d7-ba73-eb34c1e4ef87", + "id": "27a5e0ca-c69c-43ea-888e-f8d366d25714", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -11846,7 +10448,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c19e4028-e43d-4ecb-aefe-9b9310837159", + "id": "76bbf73b-15bd-4d2e-a7fa-2ee70d1c4434", "name": "Out of free quota.", "originalRequest": { "url": { @@ -11972,7 +10574,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ce74cee7-8b33-42a0-b139-6080ed033fc2", + "id": "3fae8a72-0620-472c-afd3-b8d817309ba4", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -12098,7 +10700,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ffa5dd96-d5b8-4600-a402-8202b47fc08b", + "id": "72318842-4718-4f12-8bc1-53c9370d95b0", "name": "Validation Error", "originalRequest": { "url": { @@ -12224,7 +10826,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7f77b38b-d027-4e09-8913-01a76aa04672", + "id": "245f0390-b74f-4e33-8c5e-a4a16a91cdf4", "name": "Rate limit reached", "originalRequest": { "url": { @@ -12362,7 +10964,7 @@ "description": "The Indoor API suite provides comprehensive tools for indoor mapping, search, and navigation in complex venues.\n\nThe Indoor Map API renders detailed floor plans with customizable styling, while the Indoor Search API enables\nprecise location searching through an intelligent POI engine with autocompletion capabilities.\n\nFor wayfinding, the Indoor Distance API calculates optimal routes between indoor points, delivering polylines\nand turn-by-turn instructions. Advanced features include custom routing profiles for different user types\n(staff, visitors, etc.) and seamless integration with external systems.\n", "item": [ { - "id": "d26c349e-f669-44d6-a26b-9b0361d88c1b", + "id": "c47c0388-b61a-4bfa-92e7-2ab87ad69782", "name": "Get Venue By Key", "request": { "name": "Get Venue By Key", @@ -12421,7 +11023,7 @@ }, "response": [ { - "id": "bcb8660f-1c5e-4bba-b745-35a18de1b09e", + "id": "439571a3-c4f0-4827-bc5a-fe388a163818", "name": "OK", "originalRequest": { "url": { @@ -12478,7 +11080,7 @@ "_postman_previewlanguage": "json" }, { - "id": "174b4ee2-4d10-4fc1-8587-49ebb0ba90f3", + "id": "0141132e-f931-43fc-8c69-1f0188e65a5f", "name": "Unauthorized", "originalRequest": { "url": { @@ -12535,7 +11137,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e85cdc04-68ad-40f3-aa5d-e5d11198e5cd", + "id": "7974bdb1-4cdd-4b19-ad34-1db86748528e", "name": "Payment Required", "originalRequest": { "url": { @@ -12592,7 +11194,7 @@ "_postman_previewlanguage": "json" }, { - "id": "86648270-6bfd-4111-90db-b010210b0297", + "id": "3a65b77c-8ea1-4a3f-bd96-475528429f8b", "name": "Forbidden", "originalRequest": { "url": { @@ -12649,7 +11251,7 @@ "_postman_previewlanguage": "json" }, { - "id": "52aca1fd-d17c-4d87-b593-9f13d6b3fd9c", + "id": "b334658f-e687-4073-861e-d183abac1d42", "name": "Unprocessable Entity", "originalRequest": { "url": { @@ -12701,7 +11303,7 @@ "value": "application/json" } ], - "body": "{\n \"detail\": [\n {\n \"key_0\": true\n },\n {\n \"key_0\": \"string\"\n }\n ],\n \"context\": {\n \"key_0\": \"string\",\n \"key_1\": 9303.87602355564\n }\n}", + "body": "{\n \"detail\": [\n {\n \"key_0\": \"string\"\n },\n {\n \"key_0\": false\n }\n ],\n \"context\": {\n \"key_0\": 2942,\n \"key_1\": 1655.722526777006,\n \"key_2\": 1374.033707838611,\n \"key_3\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -12712,7 +11314,7 @@ } }, { - "id": "d29d227d-5e4c-46a9-92bc-d9ff2e464a58", + "id": "337be987-3ed9-4737-8f72-8cf6d7af05c1", "name": "Get Venues By Key", "request": { "name": "Get Venues By Key", @@ -12736,7 +11338,7 @@ "type": "text/plain" }, "key": "sort_by", - "value": "created_at" + "value": "name" } ], "variable": [] @@ -12769,7 +11371,7 @@ }, "response": [ { - "id": "8e86bb1e-6673-41d1-8b8e-87c6ca4325af", + "id": "7e1d63e8-5679-441c-88c3-4134f901d6c0", "name": "OK", "originalRequest": { "url": { @@ -12788,7 +11390,7 @@ "type": "text/plain" }, "key": "sort_by", - "value": "created_at" + "value": "name" }, { "description": { @@ -12823,7 +11425,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9373dc81-f3aa-4e86-81bc-ee3d73e652c5", + "id": "a9beaa89-95ee-43c9-8aee-5260455075e1", "name": "Unauthorized", "originalRequest": { "url": { @@ -12842,7 +11444,7 @@ "type": "text/plain" }, "key": "sort_by", - "value": "created_at" + "value": "name" }, { "description": { @@ -12877,7 +11479,7 @@ "_postman_previewlanguage": "json" }, { - "id": "fc55295a-3e60-4cf6-a870-c1d6209caf78", + "id": "c1d28e86-15ae-4ca6-8593-9fe66f6c2b30", "name": "Payment Required", "originalRequest": { "url": { @@ -12896,7 +11498,7 @@ "type": "text/plain" }, "key": "sort_by", - "value": "created_at" + "value": "name" }, { "description": { @@ -12931,7 +11533,7 @@ "_postman_previewlanguage": "json" }, { - "id": "fde525ae-ea9d-402d-bcf7-46dedd554e60", + "id": "09091ec1-c763-436e-8131-7a0acd16cb79", "name": "Forbidden", "originalRequest": { "url": { @@ -12950,7 +11552,7 @@ "type": "text/plain" }, "key": "sort_by", - "value": "created_at" + "value": "name" }, { "description": { @@ -12985,7 +11587,7 @@ "_postman_previewlanguage": "json" }, { - "id": "16ade78f-cdfd-4a60-a0aa-9ddadb65a905", + "id": "b4c6bca4-5fea-491e-ab46-62b030dce6a0", "name": "Unprocessable Entity", "originalRequest": { "url": { @@ -13004,7 +11606,7 @@ "type": "text/plain" }, "key": "sort_by", - "value": "created_at" + "value": "name" }, { "description": { @@ -13034,7 +11636,7 @@ "value": "application/json" } ], - "body": "{\n \"detail\": [\n {\n \"key_0\": true\n },\n {\n \"key_0\": \"string\"\n }\n ],\n \"context\": {\n \"key_0\": \"string\",\n \"key_1\": 9303.87602355564\n }\n}", + "body": "{\n \"detail\": [\n {\n \"key_0\": \"string\"\n },\n {\n \"key_0\": false\n }\n ],\n \"context\": {\n \"key_0\": 2942,\n \"key_1\": 1655.722526777006,\n \"key_2\": 1374.033707838611,\n \"key_3\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -13045,7 +11647,7 @@ } }, { - "id": "c7220917-c0d8-4bd6-af13-af9cf448c0e8", + "id": "863c94f8-3dbb-4972-b9b7-5d4e672ad545", "name": "Get Indoor Style", "request": { "name": "Get Indoor Style", @@ -13111,7 +11713,7 @@ }, "response": [ { - "id": "e6860b08-d602-4aa0-8538-5f158bf8f11e", + "id": "31fcb6ce-2cc6-40f9-9ab6-38d0bd175041", "name": "OK", "originalRequest": { "url": { @@ -13169,12 +11771,12 @@ "value": "application/json" } ], - "body": "{\n \"key_0\": 7801,\n \"key_1\": \"string\",\n \"key_2\": 8782.005126511285\n}", + "body": "{\n \"key_0\": 9322.617107087457,\n \"key_1\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "32f4d98e-4deb-4e0a-bedb-a27653dfd986", + "id": "e540aeb6-1098-4f54-9e2a-eed8e3ada322", "name": "Unauthorized", "originalRequest": { "url": { @@ -13237,7 +11839,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4e0c7368-eab9-47fc-bee1-15554ccde98d", + "id": "93486ed2-63ab-43bc-9b6e-7258b19d33d7", "name": "Payment Required", "originalRequest": { "url": { @@ -13300,7 +11902,7 @@ "_postman_previewlanguage": "json" }, { - "id": "afd04c7e-2589-420a-be5d-9cc3c8aa9829", + "id": "fd19a89b-8ee2-4b52-b28b-20ffc651650f", "name": "Forbidden", "originalRequest": { "url": { @@ -13363,7 +11965,7 @@ "_postman_previewlanguage": "json" }, { - "id": "85c6caef-3743-45c1-96cd-10e4ede4b558", + "id": "cf2eb028-5948-406e-a96f-549a2733175e", "name": "Unprocessable Entity", "originalRequest": { "url": { @@ -13421,7 +12023,7 @@ "value": "application/json" } ], - "body": "{\n \"detail\": [\n {\n \"key_0\": true\n },\n {\n \"key_0\": \"string\"\n }\n ],\n \"context\": {\n \"key_0\": \"string\",\n \"key_1\": 9303.87602355564\n }\n}", + "body": "{\n \"detail\": [\n {\n \"key_0\": \"string\"\n },\n {\n \"key_0\": false\n }\n ],\n \"context\": {\n \"key_0\": 2942,\n \"key_1\": 1655.722526777006,\n \"key_2\": 1374.033707838611,\n \"key_3\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -13432,7 +12034,7 @@ } }, { - "id": "9cefd3d7-7263-4575-9874-c82902f3b936", + "id": "bf26c9a0-362d-4e26-be57-ff1486fc9652", "name": "Distance Matrix", "request": { "name": "Distance Matrix", @@ -13537,7 +12139,7 @@ }, "response": [ { - "id": "8ff80aa1-e6ce-4c35-bdbd-68743aec0f27", + "id": "60aff900-6d0e-4e3b-ac30-812a7f999034", "name": "OK", "originalRequest": { "url": { @@ -13639,7 +12241,7 @@ "_postman_previewlanguage": "json" }, { - "id": "62eca0a7-443e-45af-8989-e55ad3012253", + "id": "d16b58bc-052e-4244-a1ec-da83eeb3f8f7", "name": "Bad Request", "originalRequest": { "url": { @@ -13741,7 +12343,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4cd52b81-e3e7-492d-9342-70206af8f5f7", + "id": "4ad17440-8fd9-48b6-b3e9-1464f65c6130", "name": "Unauthorized", "originalRequest": { "url": { @@ -13843,7 +12445,7 @@ "_postman_previewlanguage": "json" }, { - "id": "972f9a8e-1367-483b-86b4-1b138b38cf72", + "id": "5d7f32a1-d9ab-43d6-b440-b0f156be5295", "name": "Payment Required", "originalRequest": { "url": { @@ -13945,7 +12547,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2e4e3fa7-5b75-455f-b63c-550f6be77b30", + "id": "b1afd586-7d73-473c-be34-970e17635b05", "name": "Forbidden", "originalRequest": { "url": { @@ -14047,7 +12649,7 @@ "_postman_previewlanguage": "json" }, { - "id": "20ab4a11-4ad2-440d-b089-d4d3e344bd84", + "id": "4d84e779-e7ef-4026-a4c8-0e31ae7c1d69", "name": "Unprocessable Entity", "originalRequest": { "url": { @@ -14144,7 +12746,7 @@ "value": "application/json" } ], - "body": "{\n \"detail\": [\n {\n \"key_0\": true\n },\n {\n \"key_0\": \"string\"\n }\n ],\n \"context\": {\n \"key_0\": \"string\",\n \"key_1\": 9303.87602355564\n }\n}", + "body": "{\n \"detail\": [\n {\n \"key_0\": \"string\"\n },\n {\n \"key_0\": false\n }\n ],\n \"context\": {\n \"key_0\": 2942,\n \"key_1\": 1655.722526777006,\n \"key_2\": 1374.033707838611,\n \"key_3\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -14155,7 +12757,7 @@ } }, { - "id": "7cc12384-0d2e-4399-91b6-76756bf76fc6", + "id": "f13fe46b-ac37-4a06-908a-f203d78c6409", "name": "Directions", "request": { "name": "Directions", @@ -14287,7 +12889,7 @@ }, "response": [ { - "id": "0748b18b-a42a-4813-a1d6-a756d37914e4", + "id": "a423af7a-9fa1-47bb-b739-b8b405950025", "name": "OK", "originalRequest": { "url": { @@ -14416,7 +13018,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ec0d60d9-516b-453d-81c4-9ef36a216049", + "id": "d3302963-3841-40b7-b549-70b68a025495", "name": "Bad Request", "originalRequest": { "url": { @@ -14545,7 +13147,7 @@ "_postman_previewlanguage": "json" }, { - "id": "487f19b7-3e1b-46da-be2e-ec30facfb6f0", + "id": "f85c15ae-108b-472c-8e3e-3f829ddbe729", "name": "Unauthorized", "originalRequest": { "url": { @@ -14674,7 +13276,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e64c13e8-3146-4730-9acb-47f2429660ab", + "id": "14f768f1-9614-471a-9bbc-c1f622acd67c", "name": "Payment Required", "originalRequest": { "url": { @@ -14803,7 +13405,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3a28618c-c3e6-4ee3-8a8b-470e622f08a2", + "id": "a70e15a0-8274-40a4-ae63-2afd511c68d9", "name": "Forbidden", "originalRequest": { "url": { @@ -14932,7 +13534,7 @@ "_postman_previewlanguage": "json" }, { - "id": "432277c9-ce5c-4eb5-b9b8-b185f4661c1e", + "id": "21efb151-0f1d-454b-9056-84950c9b8761", "name": "Unprocessable Entity", "originalRequest": { "url": { @@ -15056,7 +13658,7 @@ "value": "application/json" } ], - "body": "{\n \"detail\": [\n {\n \"key_0\": true\n },\n {\n \"key_0\": \"string\"\n }\n ],\n \"context\": {\n \"key_0\": \"string\",\n \"key_1\": 9303.87602355564\n }\n}", + "body": "{\n \"detail\": [\n {\n \"key_0\": \"string\"\n },\n {\n \"key_0\": false\n }\n ],\n \"context\": {\n \"key_0\": 2942,\n \"key_1\": 1655.722526777006,\n \"key_2\": 1374.033707838611,\n \"key_3\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -15067,7 +13669,7 @@ } }, { - "id": "6c3f1c77-ea5f-4c7b-93ed-acbaf0101400", + "id": "e51d33ea-6f29-4341-ac56-5c4fb1c0c57f", "name": "Search Venue Pois By Key", "request": { "name": "Search Venue Pois By Key", @@ -15237,7 +13839,7 @@ }, "response": [ { - "id": "1ade5a11-4943-4528-8753-84c7c483258c", + "id": "7597ce30-ffd6-4705-84df-327c3e35c065", "name": "OK", "originalRequest": { "url": { @@ -15404,7 +14006,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e39f6115-fc45-4aef-b295-b6ef535c7003", + "id": "93d7243e-9bfb-47dd-8430-0488834ead49", "name": "Unauthorized", "originalRequest": { "url": { @@ -15571,7 +14173,7 @@ "_postman_previewlanguage": "json" }, { - "id": "69cd4a4d-a6c6-4ed7-bfe4-09059b6f76dd", + "id": "cfeecf54-54a6-477e-82e5-ce28c4e03e9e", "name": "Payment Required", "originalRequest": { "url": { @@ -15738,7 +14340,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1dac6c09-5b86-457f-8ba9-5c3d742b0f32", + "id": "7949d582-5aaa-4769-92eb-89974d739d33", "name": "Forbidden", "originalRequest": { "url": { @@ -15905,7 +14507,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e4784954-bdb7-4ca8-a318-027c3e46893c", + "id": "24bd07d1-f505-4e12-8156-73a7fccc8452", "name": "Unprocessable Entity", "originalRequest": { "url": { @@ -16067,7 +14669,7 @@ "value": "application/json" } ], - "body": "{\n \"detail\": [\n {\n \"key_0\": true\n },\n {\n \"key_0\": \"string\"\n }\n ],\n \"context\": {\n \"key_0\": \"string\",\n \"key_1\": 9303.87602355564\n }\n}", + "body": "{\n \"detail\": [\n {\n \"key_0\": \"string\"\n },\n {\n \"key_0\": false\n }\n ],\n \"context\": {\n \"key_0\": 2942,\n \"key_1\": 1655.722526777006,\n \"key_2\": 1374.033707838611,\n \"key_3\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -16078,7 +14680,7 @@ } }, { - "id": "631734ef-5e5e-4a20-aed5-c27aa4c57abe", + "id": "fdbc9bb4-257b-4372-abdd-b71eb4ce374f", "name": "Autocomplete Venue Pois By Key", "request": { "name": "Autocomplete Venue Pois By Key", @@ -16239,7 +14841,7 @@ }, "response": [ { - "id": "779061ac-608b-4bbc-8578-0b4d1861b685", + "id": "431b51b8-ebdf-4aa5-bf95-d5d0a516e0ad", "name": "OK", "originalRequest": { "url": { @@ -16397,7 +14999,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ff1eb53b-84e9-4199-bd8e-d4c17c9f7f96", + "id": "af64a949-0c2f-4d94-b1f7-13d22886bd15", "name": "Unauthorized", "originalRequest": { "url": { @@ -16555,7 +15157,7 @@ "_postman_previewlanguage": "json" }, { - "id": "60055861-1ed7-4792-be79-c4a6ce2816b4", + "id": "b39b620d-01a6-41c2-9a80-e58af8b57a4b", "name": "Payment Required", "originalRequest": { "url": { @@ -16713,7 +15315,7 @@ "_postman_previewlanguage": "json" }, { - "id": "104ac1f0-3b20-49fc-be4e-7c2505431112", + "id": "2a7be209-cde4-4b36-84a3-2d59dfadb569", "name": "Forbidden", "originalRequest": { "url": { @@ -16871,7 +15473,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4d7c4956-fcb5-4e77-8ae2-c3acb3046eb2", + "id": "51cb2d93-d78d-4887-90ef-1c3390c01dbd", "name": "Unprocessable Entity", "originalRequest": { "url": { @@ -17024,7 +15626,7 @@ "value": "application/json" } ], - "body": "{\n \"detail\": [\n {\n \"key_0\": true\n },\n {\n \"key_0\": \"string\"\n }\n ],\n \"context\": {\n \"key_0\": \"string\",\n \"key_1\": 9303.87602355564\n }\n}", + "body": "{\n \"detail\": [\n {\n \"key_0\": \"string\"\n },\n {\n \"key_0\": false\n }\n ],\n \"context\": {\n \"key_0\": 2942,\n \"key_1\": 1655.722526777006,\n \"key_2\": 1374.033707838611,\n \"key_3\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -17035,7 +15637,7 @@ } }, { - "id": "da000a5b-8ed6-471a-ae89-025d67901214", + "id": "d99e903e-5502-46bf-aee6-3b2968b288f0", "name": "Get Feature By Key", "request": { "name": "Get Feature By Key", @@ -17106,7 +15708,7 @@ }, "response": [ { - "id": "478d94b7-e4f9-43f9-b989-208664eb4054", + "id": "2e390daa-cf59-486d-a97d-f9f250ea32d8", "name": "OK", "originalRequest": { "url": { @@ -17170,12 +15772,12 @@ "value": "application/json" } ], - "body": "{\n \"properties\": {\n \"key_0\": \"string\",\n \"key_1\": 1112,\n \"key_2\": 1323.9994553775625\n },\n \"geometry\": {\n \"type\": \"\",\n \"coordinates\": \"\",\n \"bbox\": \"\"\n },\n \"id\": \"\",\n \"type\": \"Feature\"\n}", + "body": "{\n \"properties\": {\n \"key_0\": true\n },\n \"geometry\": {\n \"type\": \"\",\n \"coordinates\": \"\",\n \"bbox\": \"\"\n },\n \"id\": \"\",\n \"type\": \"Feature\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d8cafd9f-bc14-4184-a2a4-1109bf22e430", + "id": "f2e3fbce-2e87-46bd-8752-8c9753340758", "name": "Unauthorized", "originalRequest": { "url": { @@ -17244,7 +15846,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8b6816c2-be71-4a24-b8f6-49087030669c", + "id": "c32ac51a-be19-45c6-bb3a-f0b74afb1a86", "name": "Payment Required", "originalRequest": { "url": { @@ -17313,7 +15915,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b36dfc5d-275d-4bc1-9e35-6d7a0774a51b", + "id": "70d2f5bd-3bd1-4699-b36b-4ed4ad1ca51d", "name": "Forbidden", "originalRequest": { "url": { @@ -17382,7 +15984,7 @@ "_postman_previewlanguage": "json" }, { - "id": "676f70a3-5712-4332-ab41-5e4965ee8a51", + "id": "04b91e59-3c1d-40c8-8fbc-dd12d046c456", "name": "Unprocessable Entity", "originalRequest": { "url": { @@ -17446,7 +16048,7 @@ "value": "application/json" } ], - "body": "{\n \"detail\": [\n {\n \"key_0\": true\n },\n {\n \"key_0\": \"string\"\n }\n ],\n \"context\": {\n \"key_0\": \"string\",\n \"key_1\": 9303.87602355564\n }\n}", + "body": "{\n \"detail\": [\n {\n \"key_0\": \"string\"\n },\n {\n \"key_0\": false\n }\n ],\n \"context\": {\n \"key_0\": 2942,\n \"key_1\": 1655.722526777006,\n \"key_2\": 1374.033707838611,\n \"key_3\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -17457,7 +16059,7 @@ } }, { - "id": "1af5a679-01da-47b4-bab5-db5301c83d61", + "id": "d3c7ed5e-3c26-4c19-bcd4-479f63ab529f", "name": "Tiles By Key", "request": { "name": "Tiles By Key", @@ -17559,7 +16161,7 @@ }, "response": [ { - "id": "946fb54f-cf7a-4842-b1d1-2794811780e9", + "id": "88c7d8d9-dd84-47d8-98bd-0a623ebf88c1", "name": "OK", "originalRequest": { "url": { @@ -17658,7 +16260,7 @@ "_postman_previewlanguage": "json" }, { - "id": "544fd118-7e30-4f57-b522-ecef97c18d8f", + "id": "666ffaff-d5b2-45ed-8f83-e0d1a82d9366", "name": "Unauthorized", "originalRequest": { "url": { @@ -17757,7 +16359,7 @@ "_postman_previewlanguage": "json" }, { - "id": "db6cc906-0844-4885-8edd-958c09fa1979", + "id": "db33e049-e784-48d9-a672-40b95c8b30f7", "name": "Payment Required", "originalRequest": { "url": { @@ -17856,7 +16458,7 @@ "_postman_previewlanguage": "json" }, { - "id": "06ccc885-cfbf-43f0-8a15-4d73c95ce659", + "id": "d8eb2844-9372-4e24-b5db-77f374e16efd", "name": "Forbidden", "originalRequest": { "url": { @@ -17955,7 +16557,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ac498111-1ea1-45d7-99a9-638bae455b2a", + "id": "1f3d04e0-8ba0-4204-9d8c-81a91f840430", "name": "Unprocessable Entity", "originalRequest": { "url": { @@ -18049,7 +16651,7 @@ "value": "application/json" } ], - "body": "{\n \"detail\": [\n {\n \"key_0\": true\n },\n {\n \"key_0\": \"string\"\n }\n ],\n \"context\": {\n \"key_0\": \"string\",\n \"key_1\": 9303.87602355564\n }\n}", + "body": "{\n \"detail\": [\n {\n \"key_0\": \"string\"\n },\n {\n \"key_0\": false\n }\n ],\n \"context\": {\n \"key_0\": 2942,\n \"key_1\": 1655.722526777006,\n \"key_2\": 1374.033707838611,\n \"key_3\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } @@ -18066,7 +16668,7 @@ "description": "The Woosmap Distance Async API suite provides tools for large or difficult distance calculations.\n\n* **Matrix:** Compute travel distance and time for a matrix of multiple origins and destinations.\n\nRequests are made via HTTPS (GET/POST) and require an API key (`key` or `private_key`) for quota management.\n", "item": [ { - "id": "b479e49b-f34c-48e2-aae6-9c2ab00bbfd9", + "id": "3a780e07-1fcb-46c4-9866-767c5259d81b", "name": "Start Matrix Calculation", "request": { "name": "Start Matrix Calculation", @@ -18128,7 +16730,7 @@ }, "response": [ { - "id": "4db20e0d-ef0b-4370-8c10-f7539e372eb2", + "id": "808f0134-240f-48ae-89b1-52d4dd68bc52", "name": "Successful Response", "originalRequest": { "url": { @@ -18183,12 +16785,12 @@ "value": "application/json" } ], - "body": "{\n \"matrix_id\": \"\",\n \"status\": \"completed\"\n}", + "body": "{\n \"matrix_id\": \"\",\n \"status\": \"error\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "75c11947-b2d9-4325-811b-6bd4d2db1be5", + "id": "c69438e4-4f0b-4d91-9d77-76b367eeb742", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -18248,7 +16850,7 @@ "_postman_previewlanguage": "json" }, { - "id": "72ea664c-373c-41aa-a817-03adcae05fdb", + "id": "bc848100-45bb-4830-b199-db475b8e6306", "name": "Out of free quota.", "originalRequest": { "url": { @@ -18308,7 +16910,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4ac1fa2e-a4cc-4007-ba7d-ae40badf6efb", + "id": "8a5ce162-fce6-4052-935a-91ad1edc15ac", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -18368,7 +16970,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8a72147c-48d4-41fd-aee0-7708d3ed3aea", + "id": "14037d37-9f8b-43da-9d70-5fb8dc163f6a", "name": "Validation Error", "originalRequest": { "url": { @@ -18428,7 +17030,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c59790f6-82d6-4896-acae-9b26de89fad7", + "id": "9ac66a5f-b364-4a49-80d5-6a2e3130c1e6", "name": "Rate limit reached", "originalRequest": { "url": { @@ -18494,7 +17096,7 @@ } }, { - "id": "d643058b-9da5-4f8f-84e4-57ecd9e33dd6", + "id": "e9795abb-8c78-436f-b02a-632b479806ba", "name": "Check Matrix Calculation Status", "request": { "name": "Check Matrix Calculation Status", @@ -18555,7 +17157,7 @@ }, "response": [ { - "id": "52f44e90-e660-485f-857a-e963afc9904a", + "id": "49e1d732-aefc-4e38-afaa-31d73c05f17e", "name": "Successful Response", "originalRequest": { "url": { @@ -18609,12 +17211,12 @@ "value": "application/json" } ], - "body": "{\n \"status\": \"error\"\n}", + "body": "{\n \"status\": \"timeout\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "1a6661d7-b2fa-4336-aa17-8b7a2ed0c7c1", + "id": "fcadb977-3203-4092-8a88-8aecac47dc76", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -18673,7 +17275,7 @@ "_postman_previewlanguage": "json" }, { - "id": "01ca554c-35bf-46d4-b712-e0f0e1cc37d8", + "id": "acfdb123-0f6e-4a0f-8665-ef3f9208ad92", "name": "Out of free quota.", "originalRequest": { "url": { @@ -18732,7 +17334,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c1d280a2-d1e2-469a-a2bf-7ff24b4b81b6", + "id": "ac699a12-82ec-4aba-bb2e-58d4e3151a62", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -18791,7 +17393,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ea8b44da-6c4e-473a-bf34-e916c835b76d", + "id": "8182bceb-8ee8-4c9d-892a-961f932eb8fd", "name": "Validation Error", "originalRequest": { "url": { @@ -18850,7 +17452,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9c85f04d-e90f-4e2e-9ed6-75807567f1b3", + "id": "6219385f-08ff-4f5e-9f17-38a74d327eee", "name": "Rate limit reached", "originalRequest": { "url": { @@ -18915,7 +17517,7 @@ } }, { - "id": "3540ee1d-4ac8-496c-ac11-786ce27484b1", + "id": "ea081e3c-5189-43ba-ad1c-47d0ba257183", "name": "Get Matrix Calculation Result", "request": { "name": "Get Matrix Calculation Result", @@ -18975,7 +17577,7 @@ }, "response": [ { - "id": "2e8d7bc3-8d72-4bb6-ad6e-3603bcca738e", + "id": "c13fb288-46f6-4d12-8b4b-461c0695237e", "name": "Redirect to the result of the matrix calculation.", "originalRequest": { "url": { @@ -19033,7 +17635,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e81c955d-6f9b-4a83-9233-51d6028b97c5", + "id": "9451d40e-e219-4e60-987d-5ac8eec48586", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -19091,7 +17693,7 @@ "_postman_previewlanguage": "json" }, { - "id": "50e0639f-e778-4547-99b4-94519400ef96", + "id": "e7f4b3dd-4c13-41a8-8611-f42614db6de9", "name": "Out of free quota.", "originalRequest": { "url": { @@ -19149,7 +17751,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9f2d438a-8692-48f6-98d5-bbd526f21e3d", + "id": "18c9aa9b-189a-46e9-8ed0-f79f63ca25fa", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -19207,7 +17809,7 @@ "_postman_previewlanguage": "json" }, { - "id": "60b315cc-96dd-404d-8378-c11d1dfd1e0c", + "id": "bca21a7d-c42a-40fb-a26b-80bb7768c368", "name": "Validation Error", "originalRequest": { "url": { @@ -19265,7 +17867,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c09d427f-3082-46f1-9183-38b1dde60f90", + "id": "400cbd8e-c8c8-405c-851c-711397de7aff", "name": "Rate limit reached", "originalRequest": { "url": { @@ -19335,7 +17937,7 @@ "description": "The Transit API delivers comprehensive public transportation routing information by calculating optimal travel paths between\norigins and destinations. It provides detailed route data including distance, duration, polyline visualization,\nand complete step-by-step transit instructions with transfer points and transportation modes. The API is ideal for\napplications requiring accurate public transit navigation and trip planning capabilities.\n", "item": [ { - "id": "19fb3ac1-91b6-4be2-b7c4-2045f3d3df8c", + "id": "1a8bcafd-eea1-4eae-8d34-48862237bca2", "name": "Transit Route", "request": { "name": "Transit Route", @@ -19428,7 +18030,7 @@ }, "response": [ { - "id": "0237f1a3-08a5-495c-a279-7e32c74898b0", + "id": "d0a5ac23-fb52-46c7-b9c6-619c59b5c29a", "name": "Successful Response", "originalRequest": { "url": { @@ -19518,7 +18120,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c69c7033-49c7-42cf-a250-51c2b72b6334", + "id": "e7c7b6fd-4ab6-4b9d-b652-040a7db81cfb", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -19608,7 +18210,7 @@ "_postman_previewlanguage": "json" }, { - "id": "34e859d5-922a-40fd-99fa-fe54df82d665", + "id": "0bb68793-2d4f-4be9-9ccc-1bbc367a85af", "name": "Out of free quota.", "originalRequest": { "url": { @@ -19698,7 +18300,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8b632a89-0094-49ae-9b63-1eb92113f029", + "id": "87a8e90f-949b-45e9-9496-2cb6e8ff88a5", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -19788,7 +18390,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e619fa5c-49b1-44c0-bf8d-9a4601f6476f", + "id": "e0438685-003e-48b4-906f-c32d28d9fb13", "name": "Validation Error", "originalRequest": { "url": { @@ -19878,7 +18480,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1a650881-8e8f-4ef3-8583-d165e55768df", + "id": "c41ca297-3749-44f8-b4ec-86f54940a85d", "name": "Rate limit reached", "originalRequest": { "url": { @@ -19980,12 +18582,12 @@ "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", "item": [ { - "id": "e07c1a4d-ec89-4af9-8a46-891f73e91e26", + "id": "52d6ab18-d952-46e6-8bdc-14bb4eb217fc", "name": "Get Dataset", "request": { "name": "Get Dataset", "description": { - "content": "Gets dataset details.\n\n**Rate limit**: `1/1s`", + "content": "Gets dataset details.\n\n**Rate limit**: `1/1s`\n\n**Ratelimit:** 1/1s", "type": "text/plain" }, "url": { @@ -20038,7 +18640,7 @@ }, "response": [ { - "id": "12f68813-8ead-402c-8daa-bef1db8a2b03", + "id": "9ad80bdc-0d0e-4eb5-a9e5-bf538e8ad557", "name": "Successful Response", "originalRequest": { "url": { @@ -20094,7 +18696,7 @@ "_postman_previewlanguage": "json" }, { - "id": "69431779-052c-4742-b823-cd2917d93e8c", + "id": "1f9c7ad9-a8d0-4828-9a80-92d18c595aad", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -20150,7 +18752,7 @@ "_postman_previewlanguage": "json" }, { - "id": "dd46ec1e-4106-45af-98e0-311abd6db86e", + "id": "b1583938-5e64-460c-9df3-c28e715b6ff5", "name": "Out of free quota.", "originalRequest": { "url": { @@ -20206,7 +18808,7 @@ "_postman_previewlanguage": "json" }, { - "id": "13d9432b-f212-4de1-9739-c09b845e6d33", + "id": "3aa2d1f0-f8ce-4402-9ed6-04415cbb6829", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -20262,7 +18864,7 @@ "_postman_previewlanguage": "json" }, { - "id": "7e033585-53e9-42d3-bc88-1d23eb7bd1b3", + "id": "415e4aa3-ff8f-48d5-9dbf-d19537426d43", "name": "Dataset was not found", "originalRequest": { "url": { @@ -20318,7 +18920,7 @@ "_postman_previewlanguage": "json" }, { - "id": "566ea857-4b69-49e0-b316-8e4ac4e94e4e", + "id": "1ab629c1-4273-4f34-bfc9-5f568ae205dd", "name": "Validation Error", "originalRequest": { "url": { @@ -20374,7 +18976,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8b2dba69-779a-4af1-9d60-3dd5147d6cb2", + "id": "6e0ce85b-2b24-4872-8e53-1dac879a69dc", "name": "Rate limit reached", "originalRequest": { "url": { @@ -20436,12 +19038,12 @@ } }, { - "id": "397349e3-7413-4fe7-91ed-5a471fe1c2de", + "id": "b649b130-295c-498f-a2e3-2d8b7676239d", "name": "Delete Dataset", "request": { "name": "Delete Dataset", "description": { - "content": "Schedule a dataset for deletion, deletion will happen in 7 days.\n\n\n**Rate limit**: `1/1s`", + "content": "Schedule a dataset for deletion, deletion will happen in 7 days.\n\n\n**Rate limit**: `1/1s`\n\n**Ratelimit:** 1/1s", "type": "text/plain" }, "url": { @@ -20494,7 +19096,7 @@ }, "response": [ { - "id": "dc6efd7a-efb3-4458-a303-2047dd80a713", + "id": "1bd22bae-daa9-4b2a-916f-ad5abc4b11d0", "name": "Successful Response", "originalRequest": { "url": { @@ -20550,7 +19152,7 @@ "_postman_previewlanguage": "json" }, { - "id": "04f6eb64-8d87-44f7-8313-926793bdfda6", + "id": "6ba26a25-f8df-4a50-abf1-22953a21c2d4", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -20606,7 +19208,7 @@ "_postman_previewlanguage": "json" }, { - "id": "56c05cf9-9eef-49c5-908f-15fb9af1d632", + "id": "520d5db5-6405-4a9a-9fb9-35d88aaf8f8f", "name": "Out of free quota.", "originalRequest": { "url": { @@ -20662,7 +19264,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6bc81308-e270-48a9-9126-0218469aeefc", + "id": "a625e233-0d74-46c4-8c8d-59776c9f9bb7", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -20718,7 +19320,7 @@ "_postman_previewlanguage": "json" }, { - "id": "00cac43c-ee75-4b37-a8f0-b304b3e09d21", + "id": "37e2c4d6-3374-48cc-bad0-f981bf9366d4", "name": "Dataset was not found", "originalRequest": { "url": { @@ -20774,7 +19376,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2833974c-74b1-4cda-8079-170d665e7247", + "id": "ed6fbf23-0e44-4caa-9d2a-b8f62fe0c9e1", "name": "The Dataset was already scheduled for deletion.", "originalRequest": { "url": { @@ -20830,7 +19432,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8d2f4f5e-2efe-48a9-9cce-53fc96ed99cf", + "id": "8c597ce5-94d3-40bb-b0e2-710db03d84da", "name": "Validation Error", "originalRequest": { "url": { @@ -20886,7 +19488,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ad9e1aad-fa4f-4e4f-8525-6cc43ea0b8aa", + "id": "b6a576ad-b939-4232-b7e1-d45742f19e08", "name": "Rate limit reached", "originalRequest": { "url": { @@ -20948,12 +19550,12 @@ } }, { - "id": "f2179968-f341-4889-965d-547fa7e84664", + "id": "3aa42010-356e-4681-afc9-1a2c782c7c09", "name": "Update Dataset", "request": { "name": "Update Dataset", "description": { - "content": "Updates a dataset url or name.\n\n**Rate limit**: `1/1s`", + "content": "Updates a dataset url or name.\n\n**Rate limit**: `1/1s`\n\n**Ratelimit:** 1/1s", "type": "text/plain" }, "url": { @@ -21019,7 +19621,7 @@ }, "response": [ { - "id": "d2394b26-637f-407c-a1de-2ba43ce6cfe9", + "id": "d11b64ce-89e5-4c6f-b8d7-b45d93cac7cb", "name": "Successful Response", "originalRequest": { "url": { @@ -21088,7 +19690,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b91ead1b-c741-45b2-8cb4-b504c1c1c389", + "id": "b2957f4c-279d-495e-b297-364e9f33a89e", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -21157,7 +19759,7 @@ "_postman_previewlanguage": "json" }, { - "id": "cc9a34af-912d-445c-bc74-ead68d6b9bf7", + "id": "2ebe4424-ebbc-4bb2-8b94-1dcd807a1a73", "name": "Out of free quota.", "originalRequest": { "url": { @@ -21226,7 +19828,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5c41bb9c-a0a2-455c-928b-f8565ea4be15", + "id": "b55403e9-6570-4406-9946-db05ac526326", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -21295,7 +19897,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c296e77f-d5d0-4888-aa71-d2123aa79b35", + "id": "5078825f-4b38-4133-9fc6-2f9e435e31d1", "name": "Dataset was not found", "originalRequest": { "url": { @@ -21364,7 +19966,7 @@ "_postman_previewlanguage": "json" }, { - "id": "089f514d-824a-4635-a0bb-ea2f6633c19b", + "id": "190df23e-bc41-4b28-937e-1e43175d6543", "name": "Validation Error", "originalRequest": { "url": { @@ -21433,7 +20035,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2fa7514b-8061-4c86-87dc-8e09e7e46792", + "id": "ed336c3c-42b4-4d3a-854c-e07ee396ebe5", "name": "Rate limit reached", "originalRequest": { "url": { @@ -21508,12 +20110,12 @@ } }, { - "id": "3cc03607-0e5f-4801-aa1b-b603840d3606", + "id": "4cfadfbb-1d8c-47ca-8fd7-61e14f5a7fc3", "name": "List Datasets", "request": { "name": "List Datasets", "description": { - "content": "Lists datasets.\n\n**Rate limit**: `1/1s`", + "content": "Lists datasets.\n\n**Rate limit**: `1/1s`\n\n**Ratelimit:** 1/1s", "type": "text/plain" }, "url": { @@ -21574,7 +20176,7 @@ }, "response": [ { - "id": "0aa15d6f-b7cc-4221-97f4-8de676dbbb74", + "id": "0b775444-107b-4dae-8307-7f9bfd368e05", "name": "Successful Response", "originalRequest": { "url": { @@ -21637,7 +20239,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ff29016d-d76c-400a-ae78-fc11b2627f75", + "id": "9d8e3088-01a6-4ed4-9acf-3f3a3a7495d6", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -21700,7 +20302,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3ced69f8-efa9-496b-88ba-9601ef9edf46", + "id": "620f77f2-28b6-4ed2-a71f-6eae2b4b1817", "name": "Out of free quota.", "originalRequest": { "url": { @@ -21763,7 +20365,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a7bc255f-31fc-4260-9be2-595d8e649666", + "id": "630b48ae-adbe-41c1-b3f1-6cf43fe3f007", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -21826,7 +20428,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f208ca87-0be1-4de3-8bee-55c0aa7767d2", + "id": "60c12be9-8024-48ca-a7a2-740c292bed69", "name": "Validation Error", "originalRequest": { "url": { @@ -21889,7 +20491,7 @@ "_postman_previewlanguage": "json" }, { - "id": "67ffd0ed-9b54-449f-ae5e-1475ea73f59f", + "id": "4f4a9dd8-8727-4020-a878-8d025e62f47e", "name": "Rate limit reached", "originalRequest": { "url": { @@ -21958,12 +20560,12 @@ } }, { - "id": "77a3aba5-1e31-4a3b-9ce0-ef945ed86d55", + "id": "ac273700-fa82-4d08-a368-c0cc27aecc0d", "name": "Create Dataset", "request": { "name": "Create Dataset", "description": { - "content": "Creates a dataset.\n\n**Rate limit**: `1/1s`", + "content": "Creates a dataset.\n\n**Rate limit**: `1/1s`\n\n**Ratelimit:** 1/1s", "type": "text/plain" }, "url": { @@ -22018,7 +20620,7 @@ }, "response": [ { - "id": "295fa184-4def-432b-938f-a6cbbb71a172", + "id": "f7fa43e2-90ae-4e28-88fa-222ea5bcd3c7", "name": "Successful Response", "originalRequest": { "url": { @@ -22076,7 +20678,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c51d1010-a089-4a54-aca2-a778a0fee2fe", + "id": "4b8e31ee-691d-4f61-8f53-971183178117", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -22134,7 +20736,7 @@ "_postman_previewlanguage": "json" }, { - "id": "44f4c08d-a934-4904-958a-f1cf2a14d3c4", + "id": "06e73d11-a9cd-43d8-8955-88c547dc7b47", "name": "Out of free quota.", "originalRequest": { "url": { @@ -22192,7 +20794,7 @@ "_postman_previewlanguage": "json" }, { - "id": "ec07ef25-dec7-407b-a208-4fe93a04b7db", + "id": "09d4eab2-81c0-4b10-a40b-76bb2b17e080", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -22250,7 +20852,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2a462250-9962-4685-ad4e-c517fc9bad65", + "id": "4be23ea9-7580-47d8-9616-918283d69a4b", "name": "Validation Error", "originalRequest": { "url": { @@ -22308,7 +20910,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d5b22a62-fcac-44e8-8822-1b7770cfe067", + "id": "f49e3c4c-b84b-4fe3-bd7d-5e8b975d82e3", "name": "Rate limit reached", "originalRequest": { "url": { @@ -22372,12 +20974,12 @@ } }, { - "id": "99c59fef-bb29-4892-83d0-100bde2c1075", + "id": "d0c8e360-53d9-4be6-8b64-f0a14cda9483", "name": "Get Dataset Status", "request": { "name": "Get Dataset Status", "description": { - "content": "Returns the dataset import status.\n\n**Rate limit**: `1/5s`", + "content": "Returns the dataset import status.\n\n**Rate limit**: `1/5s`\n\n**Ratelimit:** 1/5s", "type": "text/plain" }, "url": { @@ -22431,7 +21033,7 @@ }, "response": [ { - "id": "4e11019b-21ab-459c-8e89-098867eae5a4", + "id": "6746fe44-6aee-46cb-878b-e5ba5ab4f281", "name": "Successful Response", "originalRequest": { "url": { @@ -22483,12 +21085,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"steps\": [\n {\n \"name\": \"import\",\n \"start\": \"\",\n \"end\": \"\",\n \"entries\": [\n {\n \"created_at\": \"\",\n \"detail\": \"\",\n \"level\": \"warning\"\n },\n {\n \"created_at\": \"\",\n \"detail\": \"\",\n \"level\": \"error\"\n }\n ],\n \"status\": \"in_progress\"\n },\n {\n \"name\": \"import\",\n \"start\": \"\",\n \"end\": \"\",\n \"entries\": [\n {\n \"created_at\": \"\",\n \"detail\": \"\",\n \"level\": \"info\"\n },\n {\n \"created_at\": \"\",\n \"detail\": \"\",\n \"level\": \"warning\"\n }\n ],\n \"status\": \"success\"\n }\n ],\n \"status\": \"success\"\n}", + "body": "{\n \"id\": \"\",\n \"steps\": [\n {\n \"name\": \"import\",\n \"start\": \"\",\n \"end\": \"\",\n \"entries\": [\n {\n \"created_at\": \"\",\n \"detail\": \"\",\n \"level\": \"warning\"\n },\n {\n \"created_at\": \"\",\n \"detail\": \"\",\n \"level\": \"info\"\n }\n ],\n \"status\": \"success\"\n },\n {\n \"name\": \"import\",\n \"start\": \"\",\n \"end\": \"\",\n \"entries\": [\n {\n \"created_at\": \"\",\n \"detail\": \"\",\n \"level\": \"warning\"\n },\n {\n \"created_at\": \"\",\n \"detail\": \"\",\n \"level\": \"info\"\n }\n ],\n \"status\": \"in_progress\"\n }\n ],\n \"status\": \"failed\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "b99f456d-fac2-4c5c-bced-8c77d1934e6c", + "id": "eb106122-1d71-4b46-97da-f88eb5b2e64e", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -22545,7 +21147,7 @@ "_postman_previewlanguage": "json" }, { - "id": "758428ee-c82c-466e-8e14-10d75c3ed1bc", + "id": "4391654f-6788-46f2-96e1-5729d168d7cb", "name": "Out of free quota.", "originalRequest": { "url": { @@ -22602,7 +21204,7 @@ "_postman_previewlanguage": "json" }, { - "id": "12f9d856-7de0-41a2-aeff-2f9c5e0cd15d", + "id": "6a20d52e-1a05-4723-84f3-c0847be7e1d5", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -22659,7 +21261,7 @@ "_postman_previewlanguage": "json" }, { - "id": "50b7ddc2-78a2-469d-aa7f-7c8cb7645972", + "id": "784b2ca0-1d23-49aa-810c-3eedd9893599", "name": "Dataset was not found", "originalRequest": { "url": { @@ -22716,7 +21318,7 @@ "_postman_previewlanguage": "json" }, { - "id": "39687b2d-d6cf-475f-a2ef-ed694cdc0d30", + "id": "f0a54415-db9f-48c3-af41-935f236171f0", "name": "Validation Error", "originalRequest": { "url": { @@ -22773,7 +21375,7 @@ "_postman_previewlanguage": "json" }, { - "id": "5102d46c-b599-420b-9a16-58cc17d04475", + "id": "7228081f-9434-4799-a77f-0350d1f4ff05", "name": "Rate limit reached", "originalRequest": { "url": { @@ -22836,12 +21438,12 @@ } }, { - "id": "05068840-ca7d-4598-805e-c26aecd81664", + "id": "c62c1bcb-c7d6-4616-9c6a-fb1e4e4a34d8", "name": "Trigger Import", "request": { "name": "Trigger Import", "description": { - "content": "Trigger the dataset import.\n\n**Rate limit**: `1/90s`", + "content": "Trigger the dataset import.\n\n**Rate limit**: `1/90s`\n\n**Ratelimit:** 1/90s", "type": "text/plain" }, "url": { @@ -22895,7 +21497,7 @@ }, "response": [ { - "id": "940c03ed-5e30-4b5c-ab2f-c93bc223cb1f", + "id": "35d2f234-ce84-4be6-8ad3-35002e1ec8a6", "name": "Successful Response", "originalRequest": { "url": { @@ -22952,7 +21554,7 @@ "_postman_previewlanguage": "json" }, { - "id": "61be7b91-deb1-495e-9171-ff0937566290", + "id": "27e801ae-9baf-4b56-892a-b89b77ede59a", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -23009,7 +21611,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d1ae64f9-6538-496b-9607-834b58253ff0", + "id": "fe46ddf4-fa54-42c9-b325-b4893b7fb85d", "name": "Out of free quota.", "originalRequest": { "url": { @@ -23066,7 +21668,7 @@ "_postman_previewlanguage": "json" }, { - "id": "febc0aef-f6a3-4132-8b9b-fcf554c449d2", + "id": "57d803e6-ebf0-4f49-ba63-8f605c9a5a8c", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -23123,7 +21725,7 @@ "_postman_previewlanguage": "json" }, { - "id": "94701164-e097-4b7e-85bd-20212a6ee260", + "id": "de141d0c-0f71-46e0-9045-8bfcfbc9292c", "name": "Dataset was not found", "originalRequest": { "url": { @@ -23180,7 +21782,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3099cb2d-60b0-4263-843a-d59bf321457f", + "id": "08a0a49f-6dff-4df0-b778-37d0f2df47ba", "name": "Validation Error", "originalRequest": { "url": { @@ -23237,7 +21839,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9d7c64fc-0ab2-43f8-b94c-3887a70b554e", + "id": "b1bcd9d2-5ee2-4e80-b205-d0176a30420d", "name": "Rate limit reached", "originalRequest": { "url": { @@ -23300,12 +21902,12 @@ } }, { - "id": "28329bcd-280b-450b-8b53-b6b2c0cb9319", + "id": "cc84ea4a-82a7-436b-aa93-b82be5321471", "name": "Reimport Dataset Webhook", "request": { "name": "Reimport Dataset Webhook", "description": { - "content": "Triggers the reimport of the dataset linked to the dataset.\n\n**Rate limit**: `1/90s`", + "content": "Triggers the reimport of the dataset linked to the dataset.\n\n**Rate limit**: `1/90s`\n\n**Ratelimit:** 1/90s", "type": "text/plain" }, "url": { @@ -23344,7 +21946,7 @@ }, "response": [ { - "id": "993c1103-9390-477a-86da-902bd0de4923", + "id": "c410682c-c03f-45da-8934-bf84568e2cd6", "name": "Successful Response", "originalRequest": { "url": { @@ -23393,7 +21995,7 @@ "_postman_previewlanguage": "json" }, { - "id": "21e4ffdf-6de4-4a08-a6cf-d217d90960de", + "id": "d3671c16-886d-4870-9580-9941092e638c", "name": "Unauthorized", "originalRequest": { "url": { @@ -23430,7 +22032,7 @@ "_postman_previewlanguage": "text" }, { - "id": "865886fd-6e52-4472-af83-a3fbb0532d7b", + "id": "c3aa0055-9955-4f74-a486-87d6334790ff", "name": "Payment Required", "originalRequest": { "url": { @@ -23467,7 +22069,7 @@ "_postman_previewlanguage": "text" }, { - "id": "a0bf7f9b-80a3-4108-b0c0-c0d0d091ea33", + "id": "9f9d7e4a-966d-4337-a807-55d3db36a6de", "name": "Forbidden", "originalRequest": { "url": { @@ -23504,7 +22106,7 @@ "_postman_previewlanguage": "text" }, { - "id": "bb43a0d7-0cba-444c-aac5-f9cc1950d655", + "id": "6729515d-1532-40f0-893c-0ac1692fdefb", "name": "Dataset was not found", "originalRequest": { "url": { @@ -23553,7 +22155,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6c7d8bfc-dee7-4778-bdf1-f7551f7e0137", + "id": "6847042b-5d68-49eb-9416-f136bd9e7e9f", "name": "Validation Error", "originalRequest": { "url": { @@ -23602,7 +22204,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e516afdc-94ee-4e7d-9415-ffc31c5eacbc", + "id": "091530d3-3441-4634-aa50-65f57166edfc", "name": "Rate limit reached", "originalRequest": { "url": { @@ -23657,12 +22259,12 @@ } }, { - "id": "22030ccb-1de4-46a7-a267-fb50cbcf0367", + "id": "877d9653-47b7-4f3d-8211-3f671d8a42f1", "name": "Search Features", "request": { "name": "Search Features", "description": { - "content": "Search for features.\n\n**Rate limit**: `20/1s`", + "content": "Search for features.\n\n**Rate limit**: `20/1s`\n\n**Ratelimit:** 20/1s", "type": "text/plain" }, "url": { @@ -23759,7 +22361,7 @@ }, "response": [ { - "id": "6c980f77-8512-49d6-8958-c4bb9c5ebbf2", + "id": "1e0a28c6-7fda-49f9-8f96-5a9f47d126ec", "name": "Successful Response", "originalRequest": { "url": { @@ -23853,12 +22455,12 @@ "value": "application/json" } ], - "body": "{\n \"features\": [\n {\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": 4076.3767335032685,\n \"key_1\": true\n }\n },\n {\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": 5504\n }\n }\n ],\n \"pagination\": {\n \"page\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n }\n}", + "body": "{\n \"features\": [\n {\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": 6878.5773018918635\n }\n },\n {\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": 8606.102279609959\n }\n }\n ],\n \"pagination\": {\n \"page\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "74348dde-4ffe-412b-9bb9-1f8e86847277", + "id": "339eaf62-5777-4bf8-ae8d-c69bc13b7464", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -23957,7 +22559,7 @@ "_postman_previewlanguage": "json" }, { - "id": "bc4f22f0-9c01-465e-bf9c-668fee28253c", + "id": "1106a67a-3e45-4b78-8496-eaa57f55a3b5", "name": "Out of free quota.", "originalRequest": { "url": { @@ -24056,7 +22658,7 @@ "_postman_previewlanguage": "json" }, { - "id": "17aa513d-3258-4c3b-b7c8-8f8e61f80c09", + "id": "724ca2e0-ebdf-465f-a9d7-4a5e3090d77b", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -24155,7 +22757,7 @@ "_postman_previewlanguage": "json" }, { - "id": "75baaed9-059f-479b-9fb7-3550f1ac5323", + "id": "fe30657e-222b-4fa9-8f1b-912b9b8e6233", "name": "Dataset was not found", "originalRequest": { "url": { @@ -24254,7 +22856,7 @@ "_postman_previewlanguage": "json" }, { - "id": "79cc9927-c77c-4cdd-bdd5-b3e8c753737d", + "id": "38aacc1c-8520-4e64-821e-feecd6c9d4ff", "name": "Validation Error", "originalRequest": { "url": { @@ -24353,7 +22955,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9e396d56-a7a6-4e04-8233-8e710e1b4385", + "id": "6685c426-0a66-4b41-9923-40c8788c8235", "name": "Rate limit reached", "originalRequest": { "url": { @@ -24458,12 +23060,12 @@ } }, { - "id": "739dc090-ec1d-4550-9249-d82635d13b2f", + "id": "32237acf-4a2c-4849-abae-f92209a7f958", "name": "Nearby Features", "request": { "name": "Nearby Features", "description": { - "content": "Search for features nearby geometry.\n\n**Rate limit**: `20/1s`", + "content": "Search for features nearby geometry.\n\n**Rate limit**: `20/1s`\n\n**Ratelimit:** 20/1s", "type": "text/plain" }, "url": { @@ -24560,7 +23162,7 @@ }, "response": [ { - "id": "9764659c-f296-40ea-90e7-bf5c5e678ffe", + "id": "c5f25114-e5e1-47ff-a79d-c70644a0db1b", "name": "Successful Response", "originalRequest": { "url": { @@ -24654,12 +23256,12 @@ "value": "application/json" } ], - "body": "{\n \"features\": [\n {\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": 4076.3767335032685,\n \"key_1\": true\n }\n },\n {\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": 5504\n }\n }\n ],\n \"pagination\": {\n \"page\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n }\n}", + "body": "{\n \"features\": [\n {\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": 6878.5773018918635\n }\n },\n {\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": 8606.102279609959\n }\n }\n ],\n \"pagination\": {\n \"page\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7dd3f91a-e99c-4f97-9cf8-e71816c85fc3", + "id": "278c41fb-e221-4eab-a14d-2d7825646e33", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -24758,7 +23360,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b2ead894-2e3a-412a-b22f-25439c12f2bb", + "id": "c72db805-9bc0-407d-a1f0-e9918b62d648", "name": "Out of free quota.", "originalRequest": { "url": { @@ -24857,7 +23459,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f4bc9423-6856-4cb1-9d5e-6033a3482fe0", + "id": "218ef07e-8b9f-4a52-994e-ecc0cae57ec1", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -24956,7 +23558,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d3c65b84-1a8d-4308-981b-b91055f0ec68", + "id": "ffe41081-8d78-453a-8c55-cae7c7fbdbf7", "name": "Dataset was not found", "originalRequest": { "url": { @@ -25055,7 +23657,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9d28cc75-b9a2-42c2-8127-5ad30e469472", + "id": "88509692-1192-429b-b98b-8e570769aa13", "name": "Validation Error", "originalRequest": { "url": { @@ -25154,7 +23756,7 @@ "_postman_previewlanguage": "json" }, { - "id": "cf23aec7-65d0-430e-aaf1-af7380a1e504", + "id": "78674554-78a2-4352-a1fb-cabfa5a046b0", "name": "Rate limit reached", "originalRequest": { "url": { @@ -25259,12 +23861,12 @@ } }, { - "id": "cf0a55ec-1071-4870-aeec-319eb3707df1", + "id": "3b952de6-cf37-45ec-8625-ce4897f737cc", "name": "Intersect Features", "request": { "name": "Intersect Features", "description": { - "content": "Returns the features that are intersecting with geometry.\n\n**Rate limit**: `20/1s`\n\n![Intersection](https://postgis.net/workshops/postgis-intro/_images/st_intersects.png)", + "content": "Returns the features that are intersecting with geometry.\n\n**Rate limit**: `20/1s`\n\n![Intersection](https://postgis.net/workshops/postgis-intro/_images/st_intersects.png)\n\n**Ratelimit:** 20/1s", "type": "text/plain" }, "url": { @@ -25361,7 +23963,7 @@ }, "response": [ { - "id": "f16296f1-7a50-44f3-8da8-6d70c44db8f5", + "id": "53d76cea-1b17-4e97-aed3-7a5ee76aec59", "name": "Successful Response", "originalRequest": { "url": { @@ -25455,12 +24057,12 @@ "value": "application/json" } ], - "body": "{\n \"features\": [\n {\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": 4076.3767335032685,\n \"key_1\": true\n }\n },\n {\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": 5504\n }\n }\n ],\n \"pagination\": {\n \"page\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n }\n}", + "body": "{\n \"features\": [\n {\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": 6878.5773018918635\n }\n },\n {\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": 8606.102279609959\n }\n }\n ],\n \"pagination\": {\n \"page\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "4606117a-fe5b-4185-af9d-eaee825e5ea1", + "id": "87096a0e-b00a-40cf-99e2-4f37839b36a7", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -25559,7 +24161,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f84e35ac-fca7-44f5-8ff1-e87ecd65c064", + "id": "eda8ca2e-09b0-450a-96f1-147b0dacaaa5", "name": "Out of free quota.", "originalRequest": { "url": { @@ -25658,7 +24260,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8edf358b-fc2e-4e8b-8e6c-2e35b0f5adab", + "id": "db330e4b-10a9-4c9d-99ee-98ba0b30c907", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -25757,7 +24359,7 @@ "_postman_previewlanguage": "json" }, { - "id": "06f86fe5-e0db-4355-8636-2a002dc5bf70", + "id": "75b72d49-55fe-47c6-a5e8-deb5b24ec85e", "name": "Dataset was not found", "originalRequest": { "url": { @@ -25856,7 +24458,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8d414334-8c06-4c60-addf-53b23ba61ea1", + "id": "6d810847-d77c-42f8-bf7d-940b7a33391d", "name": "Validation Error", "originalRequest": { "url": { @@ -25955,7 +24557,7 @@ "_postman_previewlanguage": "json" }, { - "id": "b70dddc7-cb5f-4169-b138-fd4dcbbe21a0", + "id": "f07f5fd5-c7d8-497a-b27f-4c21aae709b0", "name": "Rate limit reached", "originalRequest": { "url": { @@ -26060,12 +24662,12 @@ } }, { - "id": "dd991471-3ac9-43f1-b4ec-421cf1ee605b", + "id": "11413934-af61-405c-9a90-e96bce41fc29", "name": "Contains Features", "request": { "name": "Contains Features", "description": { - "content": "Search for features containing geometry.\n\n**Rate limit**: `20/1s`\n\n![Within](https://postgis.net/workshops/postgis-intro/_images/st_within.png)", + "content": "Search for features containing geometry.\n\n**Rate limit**: `20/1s`\n\n![Within](https://postgis.net/workshops/postgis-intro/_images/st_within.png)\n\n**Ratelimit:** 20/1s", "type": "text/plain" }, "url": { @@ -26162,7 +24764,7 @@ }, "response": [ { - "id": "4d071b7b-09bb-4ccb-a1f0-f383e0cfeccd", + "id": "8511f993-0cb8-486c-8dfc-6384d5ecd649", "name": "Successful Response", "originalRequest": { "url": { @@ -26256,12 +24858,12 @@ "value": "application/json" } ], - "body": "{\n \"features\": [\n {\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": 4076.3767335032685,\n \"key_1\": true\n }\n },\n {\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": 5504\n }\n }\n ],\n \"pagination\": {\n \"page\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n }\n}", + "body": "{\n \"features\": [\n {\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": 6878.5773018918635\n }\n },\n {\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": 8606.102279609959\n }\n }\n ],\n \"pagination\": {\n \"page\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "181195c9-04fa-443d-bcb1-aa4ecf2a2952", + "id": "393b26d8-18f9-4244-b05f-d4c88386f9ee", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -26360,7 +24962,7 @@ "_postman_previewlanguage": "json" }, { - "id": "c0b155df-90ae-4434-86bd-be8c0f17c1e7", + "id": "68a1ff1b-c3b9-4e75-b401-2643265d265f", "name": "Out of free quota.", "originalRequest": { "url": { @@ -26459,7 +25061,7 @@ "_postman_previewlanguage": "json" }, { - "id": "faaf3d53-fb58-4bcf-ae71-31cb00228b3b", + "id": "22d08d8c-efa1-4fdd-b5d5-22c996d6f1a7", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -26558,7 +25160,7 @@ "_postman_previewlanguage": "json" }, { - "id": "82df5be5-21b9-46b9-bf2e-87a749f9bd67", + "id": "6a988e4e-e809-4d1e-ab8a-959e4c75eaa5", "name": "Dataset was not found", "originalRequest": { "url": { @@ -26657,7 +25259,7 @@ "_postman_previewlanguage": "json" }, { - "id": "83ed4a6b-a17e-43a4-86da-a1c76d680061", + "id": "c1d1564f-5824-437c-ac3b-81d319f8a5de", "name": "Validation Error", "originalRequest": { "url": { @@ -26756,7 +25358,7 @@ "_postman_previewlanguage": "json" }, { - "id": "2ee04b44-7092-48fa-b808-1f6bbaa7cb3b", + "id": "e1537b62-18da-46ac-8c24-237b87a4afda", "name": "Rate limit reached", "originalRequest": { "url": { @@ -26861,12 +25463,12 @@ } }, { - "id": "5839603c-31e1-4e57-9fe6-883c8c14b09f", + "id": "87aad368-999a-4bee-81d8-993b6f3187a1", "name": "Within Features", "request": { "name": "Within Features", "description": { - "content": "Search for features within geometry.\n\n**Rate limit**: `20/1s`\n\n![Within](https://postgis.net/workshops/postgis-intro/_images/st_within.png)", + "content": "Search for features within geometry.\n\n**Rate limit**: `20/1s`\n\n![Within](https://postgis.net/workshops/postgis-intro/_images/st_within.png)\n\n**Ratelimit:** 20/1s", "type": "text/plain" }, "url": { @@ -26963,7 +25565,7 @@ }, "response": [ { - "id": "21a9d228-b79f-48b2-bbec-23632a7e55c1", + "id": "ed4917f4-38f5-4312-921c-a65f01770900", "name": "Successful Response", "originalRequest": { "url": { @@ -27057,12 +25659,12 @@ "value": "application/json" } ], - "body": "{\n \"features\": [\n {\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": 4076.3767335032685,\n \"key_1\": true\n }\n },\n {\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": 5504\n }\n }\n ],\n \"pagination\": {\n \"page\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n }\n}", + "body": "{\n \"features\": [\n {\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": 6878.5773018918635\n }\n },\n {\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": 8606.102279609959\n }\n }\n ],\n \"pagination\": {\n \"page\": \"\",\n \"prev\": \"\",\n \"next\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "d51574c5-4587-432a-9fe3-d9b7c74775d0", + "id": "6d5b240a-e361-43d5-90fc-5f2305532000", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -27161,7 +25763,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a93e10a2-a7fe-4b6a-ac2a-d7bf3fa3f931", + "id": "837ee357-91dd-4fd7-9658-30be5a9ba6d4", "name": "Out of free quota.", "originalRequest": { "url": { @@ -27260,7 +25862,7 @@ "_postman_previewlanguage": "json" }, { - "id": "43b06095-9457-4eb2-83da-5ef12a9323e2", + "id": "0aabde9c-36ee-4e5a-b4fc-86432e2d7c2d", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -27359,7 +25961,7 @@ "_postman_previewlanguage": "json" }, { - "id": "70b4b37d-1516-49d2-8c35-788a95cd848e", + "id": "225b4969-007d-44ba-96a1-55883cfd75ad", "name": "Dataset was not found", "originalRequest": { "url": { @@ -27458,7 +26060,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6e672159-0dfe-4d32-8926-cb7afc2ab174", + "id": "eacd6f97-3d15-428a-a72b-7fdcc82c0786", "name": "Validation Error", "originalRequest": { "url": { @@ -27557,7 +26159,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4bd788de-1a63-49b4-9f52-3a40040592da", + "id": "7499e237-ee65-4303-b4b3-3e394edb3e6f", "name": "Rate limit reached", "originalRequest": { "url": { @@ -27662,12 +26264,12 @@ } }, { - "id": "6bddf71b-88fe-442d-bdf0-9a53049b31fb", + "id": "79fcd379-2d24-4748-bc45-7c496b032006", "name": "Get Feature", "request": { "name": "Get Feature", "description": { - "content": "Gets a feature from its ID.\n\n**Rate limit**: `20/1s`", + "content": "Gets a feature from its ID.\n\n**Rate limit**: `20/1s`\n\n**Ratelimit:** 20/1s", "type": "text/plain" }, "url": { @@ -27751,7 +26353,7 @@ }, "response": [ { - "id": "a7b4c04e-0ed7-4345-a3fd-6fd3983ec289", + "id": "0ac9d62b-f6ff-4a1e-b251-ccf78ab3a858", "name": "Successful Response", "originalRequest": { "url": { @@ -27832,12 +26434,12 @@ "value": "application/json" } ], - "body": "{\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": true,\n \"key_1\": true,\n \"key_2\": true,\n \"key_3\": 6758.1345969740305\n }\n}", + "body": "{\n \"id\": \"\",\n \"geometry\": \"\",\n \"attributes\": {\n \"key_0\": 8772\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "ac06d2db-6e0e-4243-8774-efe59d5e3494", + "id": "f9220b57-7186-4a07-b13a-ee769548c152", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -27923,7 +26525,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3a65bab3-4377-4097-a624-fc5c4dfe9a06", + "id": "c2b15bed-85ce-4da5-b6c7-a9395fdd3819", "name": "Out of free quota.", "originalRequest": { "url": { @@ -28009,7 +26611,7 @@ "_postman_previewlanguage": "json" }, { - "id": "507fc878-fce6-42d4-8470-f8b9caff9e64", + "id": "df518787-80ca-464f-951e-b4625b58d345", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -28095,7 +26697,7 @@ "_postman_previewlanguage": "json" }, { - "id": "71f1d714-b3f5-4984-99d5-4735d7a82870", + "id": "51db27c5-38c8-4d5f-9933-d93d3d2861c8", "name": "Feature or Dataset were not found", "originalRequest": { "url": { @@ -28181,7 +26783,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6e329233-8651-4e1d-9882-f4b6495cf0f4", + "id": "15674c69-bc5f-4030-a728-d35fc6fcc9e6", "name": "Validation Error", "originalRequest": { "url": { @@ -28267,7 +26869,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d80da5e6-2022-4c82-9c65-c21184023772", + "id": "488ff41d-0e53-4870-b122-c5638933da4b", "name": "Rate limit reached", "originalRequest": { "url": { @@ -28365,7 +26967,7 @@ "description": "The Woosmap Distance API suite provides comprehensive tools for road travel calculations worldwide.\n\n* **Route:** Calculate travel distance, duration, and paths between origin and destination.\n* **Matrix:** Compute travel distance and time for a matrix of multiple origins and destinations.\n* **Isochrone:** Determine all locations reachable within a specific time or distance.\n* **Tolls:** Estimate toll costs and details for specific routes.\n\nRequests are made via HTTPS (GET/POST) and require an API key (`key` or `private_key`) for quota management.\n", "item": [ { - "id": "d4a4f834-f003-49f2-901f-bbf955000060", + "id": "1cd4a3b7-2a4b-4513-b7d3-c9796f188f47", "name": "Find Routes", "request": { "name": "Find Routes", @@ -28423,7 +27025,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -28532,7 +27134,7 @@ }, "response": [ { - "id": "f3d784ed-c30d-40f7-b9d9-9737fcfcdc98", + "id": "d062cc2e-73c9-4a63-a6b4-8fe722ebc400", "name": "Successful Response", "originalRequest": { "url": { @@ -28585,7 +27187,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -28696,7 +27298,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3c1ee49f-2d5d-437e-8293-05c07ba28da3", + "id": "40bf3d80-17d3-418e-b19d-984b4fb990c8", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -28749,7 +27351,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -28860,7 +27462,7 @@ "_postman_previewlanguage": "json" }, { - "id": "8b95565f-7085-417c-bfbb-f33b9ecc1aca", + "id": "7a22f0a0-5a3e-4428-811c-3745cedc661f", "name": "Out of free quota.", "originalRequest": { "url": { @@ -28913,7 +27515,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -29024,7 +27626,7 @@ "_postman_previewlanguage": "json" }, { - "id": "37c9e37d-ec2f-4cd6-a158-7e3c6ca867e6", + "id": "0cfbbe70-5fab-4d28-97d3-c7332e0bffb1", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -29077,7 +27679,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -29188,7 +27790,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e868e4d7-282b-4035-9534-92ba0053a8e6", + "id": "b85f18c2-337d-4c5a-8b34-c6980c58035d", "name": "Validation Error", "originalRequest": { "url": { @@ -29241,7 +27843,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -29352,7 +27954,7 @@ "_postman_previewlanguage": "json" }, { - "id": "9c73ecee-e877-44b2-8b2a-63010cec7dd7", + "id": "505e264f-c702-4ced-94c3-17a9f9f6ce7a", "name": "Rate limit reached", "originalRequest": { "url": { @@ -29405,7 +28007,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -29522,7 +28124,7 @@ } }, { - "id": "a75f17e4-d9d8-4890-a2b2-956aaecdc9f2", + "id": "5ec9d8d2-8323-4ccb-851c-aa52d9b7d828", "name": "Calculate Matrix", "request": { "name": "Calculate Matrix", @@ -29571,7 +28173,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -29671,7 +28273,7 @@ }, "response": [ { - "id": "10a61812-f150-4c9c-8973-3224f840df6d", + "id": "5e053f88-9035-4a54-bfae-bffcbe8a5372", "name": "Successful Response", "originalRequest": { "url": { @@ -29715,7 +28317,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -29812,12 +28414,12 @@ "value": "application/json" } ], - "body": "{\n \"rows\": [\n {\n \"elements\": [\n {\n \"status\": \"OK\",\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n }\n },\n {\n \"status\": \"OK\",\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n }\n }\n ]\n },\n {\n \"elements\": [\n {\n \"status\": \"ZERO_RESULTS\",\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n }\n },\n {\n \"status\": \"ZERO_RESULTS\",\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n }\n }\n ]\n }\n ],\n \"status\": \"OK\"\n}", + "body": "{\n \"rows\": [\n {\n \"elements\": [\n {\n \"status\": \"NOT_FOUND\",\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n }\n },\n {\n \"status\": \"OK\",\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n }\n }\n ]\n },\n {\n \"elements\": [\n {\n \"status\": \"OK\",\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n }\n },\n {\n \"status\": \"ERROR\",\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n }\n }\n ]\n }\n ],\n \"status\": \"OK\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "252d977a-77dd-4bb0-9798-5c458ea32ff3", + "id": "f1632bc0-01a9-45d4-8ddf-2085fdfff9aa", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -29861,7 +28463,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -29963,7 +28565,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1d6b4fe6-0ab0-4cf1-bcf0-c8c59adb7fcf", + "id": "bb855fae-425b-4e5f-b139-ad80df46f3b7", "name": "Out of free quota.", "originalRequest": { "url": { @@ -30007,7 +28609,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -30109,7 +28711,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3f076352-bf06-4950-9bc3-edd871cb01f3", + "id": "858f0f58-8808-439a-bc6f-fee9ba36bced", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -30153,7 +28755,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -30255,7 +28857,7 @@ "_postman_previewlanguage": "json" }, { - "id": "fb62652e-28c0-4480-87e5-c39b66316640", + "id": "14c78ea5-df1c-4738-abf3-8c4c2cef8184", "name": "Validation Error", "originalRequest": { "url": { @@ -30299,7 +28901,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -30401,7 +29003,7 @@ "_postman_previewlanguage": "json" }, { - "id": "3688ff11-03e3-4737-844a-508fef694bf9", + "id": "836a8d79-948a-4125-b920-90bd1f0b8099", "name": "Rate limit reached", "originalRequest": { "url": { @@ -30445,7 +29047,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -30553,7 +29155,7 @@ } }, { - "id": "7d43e25a-0a62-4d0b-aa01-08553f921524", + "id": "796b1917-5589-405e-9002-a2eaab448282", "name": "Calculate Matrix", "request": { "name": "Calculate Matrix", @@ -30624,7 +29226,7 @@ }, "response": [ { - "id": "eb96063c-da96-41b4-b46a-414b39cebbf7", + "id": "4d2d3077-e182-444f-929e-6c8229245370", "name": "Successful Response", "originalRequest": { "url": { @@ -30688,12 +29290,12 @@ "value": "application/json" } ], - "body": "{\n \"rows\": [\n {\n \"elements\": [\n {\n \"status\": \"OK\",\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n }\n },\n {\n \"status\": \"OK\",\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n }\n }\n ]\n },\n {\n \"elements\": [\n {\n \"status\": \"ZERO_RESULTS\",\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n }\n },\n {\n \"status\": \"ZERO_RESULTS\",\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n }\n }\n ]\n }\n ],\n \"status\": \"OK\"\n}", + "body": "{\n \"rows\": [\n {\n \"elements\": [\n {\n \"status\": \"NOT_FOUND\",\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n }\n },\n {\n \"status\": \"OK\",\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n }\n }\n ]\n },\n {\n \"elements\": [\n {\n \"status\": \"OK\",\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n }\n },\n {\n \"status\": \"ERROR\",\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n }\n }\n ]\n }\n ],\n \"status\": \"OK\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "7cf51bd4-1c13-4187-8552-113cfa082518", + "id": "e514a15b-b663-4efd-b375-66b5cc397152", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -30762,7 +29364,7 @@ "_postman_previewlanguage": "json" }, { - "id": "6041b7f5-4a8d-4e56-87e8-f50e172db969", + "id": "265edf88-c6d0-4c00-ad59-a0c9677ebeec", "name": "Out of free quota.", "originalRequest": { "url": { @@ -30831,7 +29433,7 @@ "_postman_previewlanguage": "json" }, { - "id": "85d05f2c-0190-4d87-b33a-26eb283ad439", + "id": "a4b6399b-8d19-42f5-80e9-44f2e45f8e08", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -30900,7 +29502,7 @@ "_postman_previewlanguage": "json" }, { - "id": "f51ae659-4f42-447b-886f-98b999fe7ae9", + "id": "f0261b40-352e-4378-864d-6ab67918f7e8", "name": "Validation Error", "originalRequest": { "url": { @@ -30969,7 +29571,7 @@ "_postman_previewlanguage": "json" }, { - "id": "86242ca5-0d7b-4184-9481-fb2c0a690276", + "id": "7cb00680-7acc-4425-8214-3b5b670b3560", "name": "Rate limit reached", "originalRequest": { "url": { @@ -31044,7 +29646,7 @@ } }, { - "id": "4ef6f0c0-de2a-4868-8d67-03429693a604", + "id": "ac740b77-e2d9-44be-a152-b6e998db8a4f", "name": "Calculate Isochrone", "request": { "name": "Calculate Isochrone", @@ -31093,7 +29695,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -31166,7 +29768,7 @@ }, "response": [ { - "id": "bf910e9a-6ac6-4391-9688-a7ad3385bb30", + "id": "74bccbb3-6204-44c1-876d-1e2c2a0f2e93", "name": "Successful Response", "originalRequest": { "url": { @@ -31210,7 +29812,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -31285,7 +29887,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1342ec9d-5373-43c1-bce4-8b446999b703", + "id": "7b5d04e8-7017-4c19-86fb-ec65959eb5f3", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -31329,7 +29931,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -31404,7 +30006,7 @@ "_postman_previewlanguage": "json" }, { - "id": "98a22f07-413b-4c8a-9dd9-abebd584df45", + "id": "be56ca7c-532a-4130-aef8-dc904d6cfde4", "name": "Out of free quota.", "originalRequest": { "url": { @@ -31448,7 +30050,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -31523,7 +30125,7 @@ "_postman_previewlanguage": "json" }, { - "id": "1b6427e2-b419-436b-b653-b07e575f4330", + "id": "6708e76c-3841-4db6-b5a4-3962cad96b26", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -31567,7 +30169,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -31642,7 +30244,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4d982268-5418-4252-acc8-1567b76a3639", + "id": "17c63590-309d-46d6-8236-b96594552e1b", "name": "Validation Error", "originalRequest": { "url": { @@ -31686,7 +30288,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -31761,7 +30363,7 @@ "_postman_previewlanguage": "json" }, { - "id": "0a38811e-efc4-44da-a92e-6f5bddeee0e4", + "id": "3bfeee11-356f-4d4e-b1c1-6a0e0f8e67d8", "name": "Rate limit reached", "originalRequest": { "url": { @@ -31805,7 +30407,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -31886,7 +30488,7 @@ } }, { - "id": "a56615dc-f519-4557-bef5-5cda8e701a4c", + "id": "672cbe46-bb51-4b64-b2ad-4e69d4f5d8e9", "name": "Calculate Isochrone", "request": { "name": "Calculate Isochrone", @@ -31957,7 +30559,7 @@ }, "response": [ { - "id": "237b8aef-8e92-4acd-8f40-7209d6a65fa1", + "id": "5904fd54-4e82-43d2-a871-04e479b376db", "name": "Successful Response", "originalRequest": { "url": { @@ -32026,7 +30628,7 @@ "_postman_previewlanguage": "json" }, { - "id": "35ef91e9-5e60-4d62-a0c5-541a69b0a918", + "id": "e8f0d0a7-194a-40a1-9659-e4052dabb165", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -32095,7 +30697,7 @@ "_postman_previewlanguage": "json" }, { - "id": "e8a8ea92-66e8-4c3b-81f4-f9ed5d764231", + "id": "f1a4aed9-209f-41ca-a02d-43e70bc9994c", "name": "Out of free quota.", "originalRequest": { "url": { @@ -32164,7 +30766,7 @@ "_postman_previewlanguage": "json" }, { - "id": "976552bf-a021-4db9-937e-136a843f5b43", + "id": "62018610-0412-4e7f-bfc3-189d4a75cd1c", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -32233,7 +30835,7 @@ "_postman_previewlanguage": "json" }, { - "id": "4568cb6b-d65f-4df2-982d-c0ae43e6be02", + "id": "49f097ea-af36-4e26-9332-3dcbe2b1615d", "name": "Validation Error", "originalRequest": { "url": { @@ -32302,7 +30904,7 @@ "_postman_previewlanguage": "json" }, { - "id": "59f65286-cd44-489a-be83-f046b2490222", + "id": "18ac6138-4f10-42e3-9ff6-d26d09c2ff0e", "name": "Rate limit reached", "originalRequest": { "url": { @@ -32377,7 +30979,7 @@ } }, { - "id": "34ec8931-aef6-4b7e-a6cf-3143dc2970a2", + "id": "1bd348f9-ccca-4615-9bdc-124b7c54a019", "name": "Find Tolls", "request": { "name": "Find Tolls", @@ -32453,7 +31055,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -32526,7 +31128,7 @@ }, "response": [ { - "id": "0c30dcbe-9bd0-43f1-a5a0-daa71c689ceb", + "id": "de17eb5c-09a4-4536-883f-46a93527db33", "name": "Successful Response", "originalRequest": { "url": { @@ -32597,7 +31199,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -32667,12 +31269,12 @@ "value": "application/json" } ], - "body": "{\n \"status\": \"\",\n \"routes\": [\n {\n \"overview_polyline\": {\n \"points\": \"\"\n },\n \"bounds\": {\n \"northeast\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"southwest\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n },\n \"legs\": [\n {\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n },\n \"duration\": {\n \"value\": \"\",\n \"text\": \"\"\n },\n \"start_location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"end_location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"tolls\": [\n {\n \"key_0\": 5948\n },\n {\n \"key_0\": false,\n \"key_1\": 5465\n }\n ],\n \"tollSystems\": [\n {\n \"key_0\": 8490.829538881184,\n \"key_1\": 3013,\n \"key_2\": \"string\",\n \"key_3\": 874\n },\n {\n \"key_0\": 6682.4684370527975,\n \"key_1\": \"string\"\n }\n ]\n },\n {\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n },\n \"duration\": {\n \"value\": \"\",\n \"text\": \"\"\n },\n \"start_location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"end_location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"tolls\": [\n {\n \"key_0\": 1817.4768811430608,\n \"key_1\": 8697\n },\n {\n \"key_0\": 6488,\n \"key_1\": true\n }\n ],\n \"tollSystems\": [\n {\n \"key_0\": 5312\n },\n {\n \"key_0\": 5991.754220056205,\n \"key_1\": 1852.205420438513\n }\n ]\n }\n ]\n },\n {\n \"overview_polyline\": {\n \"points\": \"\"\n },\n \"bounds\": {\n \"northeast\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"southwest\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n },\n \"legs\": [\n {\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n },\n \"duration\": {\n \"value\": \"\",\n \"text\": \"\"\n },\n \"start_location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"end_location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"tolls\": [\n {\n \"key_0\": \"string\",\n \"key_1\": 1924.156679816287,\n \"key_2\": 2259.5463542945417\n },\n {\n \"key_0\": 954,\n \"key_1\": 9500,\n \"key_2\": 5521.691108548436\n }\n ],\n \"tollSystems\": [\n {\n \"key_0\": true\n },\n {\n \"key_0\": 9168.3643294476\n }\n ]\n },\n {\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n },\n \"duration\": {\n \"value\": \"\",\n \"text\": \"\"\n },\n \"start_location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"end_location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"tolls\": [\n {\n \"key_0\": true,\n \"key_1\": 5403\n },\n {\n \"key_0\": true,\n \"key_1\": false,\n \"key_2\": false\n }\n ],\n \"tollSystems\": [\n {\n \"key_0\": \"string\",\n \"key_1\": 9993,\n \"key_2\": false,\n \"key_3\": false\n },\n {\n \"key_0\": 3374,\n \"key_1\": true\n }\n ]\n }\n ]\n }\n ]\n}", + "body": "{\n \"status\": \"\",\n \"routes\": [\n {\n \"overview_polyline\": {\n \"points\": \"\"\n },\n \"bounds\": {\n \"northeast\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"southwest\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n },\n \"legs\": [\n {\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n },\n \"duration\": {\n \"value\": \"\",\n \"text\": \"\"\n },\n \"start_location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"end_location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"tolls\": [\n {\n \"key_0\": 3900.6223502388048\n },\n {\n \"key_0\": 5178,\n \"key_1\": \"string\"\n }\n ],\n \"tollSystems\": [\n {\n \"key_0\": 8787.2193589621,\n \"key_1\": 9866.69184290433,\n \"key_2\": 8896.156357131933\n },\n {\n \"key_0\": \"string\"\n }\n ]\n },\n {\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n },\n \"duration\": {\n \"value\": \"\",\n \"text\": \"\"\n },\n \"start_location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"end_location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"tolls\": [\n {\n \"key_0\": \"string\",\n \"key_1\": 7835.185502109712,\n \"key_2\": 7239\n },\n {\n \"key_0\": 1658\n }\n ],\n \"tollSystems\": [\n {\n \"key_0\": 103\n },\n {\n \"key_0\": 9975.818676839386,\n \"key_1\": \"string\",\n \"key_2\": 5158.056831001114,\n \"key_3\": 9381.98702436539,\n \"key_4\": \"string\"\n }\n ]\n }\n ]\n },\n {\n \"overview_polyline\": {\n \"points\": \"\"\n },\n \"bounds\": {\n \"northeast\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"southwest\": {\n \"lat\": \"\",\n \"lng\": \"\"\n }\n },\n \"legs\": [\n {\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n },\n \"duration\": {\n \"value\": \"\",\n \"text\": \"\"\n },\n \"start_location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"end_location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"tolls\": [\n {\n \"key_0\": true,\n \"key_1\": 8686.621930956213\n },\n {\n \"key_0\": \"string\"\n }\n ],\n \"tollSystems\": [\n {\n \"key_0\": false\n },\n {\n \"key_0\": false,\n \"key_1\": false\n }\n ]\n },\n {\n \"distance\": {\n \"value\": \"\",\n \"text\": \"\"\n },\n \"duration\": {\n \"value\": \"\",\n \"text\": \"\"\n },\n \"start_location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"end_location\": {\n \"lat\": \"\",\n \"lng\": \"\"\n },\n \"tolls\": [\n {\n \"key_0\": \"string\",\n \"key_1\": true\n },\n {\n \"key_0\": \"string\"\n }\n ],\n \"tollSystems\": [\n {\n \"key_0\": 4422,\n \"key_1\": \"string\"\n },\n {\n \"key_0\": true\n }\n ]\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { - "id": "6b02cbae-c5d2-4412-a697-56beb842fd6e", + "id": "0445ebeb-1635-47cc-8b31-ddd6d6af8432", "name": "Unable to locate credentials.", "originalRequest": { "url": { @@ -32743,7 +31345,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -32818,7 +31420,7 @@ "_postman_previewlanguage": "json" }, { - "id": "a1cf0978-5023-459e-b120-9c2bc75396a1", + "id": "bb4c7d53-ef7b-4b13-a2cf-64f42b85f276", "name": "Out of free quota.", "originalRequest": { "url": { @@ -32889,7 +31491,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -32964,7 +31566,7 @@ "_postman_previewlanguage": "json" }, { - "id": "d65aed34-4f4b-41e2-a512-477ada00d8f6", + "id": "7c9dc00d-59a4-4e35-b7bc-aa6007261b76", "name": "Credentials found, but not matching.", "originalRequest": { "url": { @@ -33035,7 +31637,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -33110,7 +31712,7 @@ "_postman_previewlanguage": "json" }, { - "id": "860dbc9f-273d-499e-a83a-da33fbc58847", + "id": "e6e8a501-5172-4715-9e23-b221e7f7c863", "name": "Validation Error", "originalRequest": { "url": { @@ -33181,7 +31783,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -33256,7 +31858,7 @@ "_postman_previewlanguage": "json" }, { - "id": "bf6d27e7-07b7-4746-aafd-3772c961f8ee", + "id": "d5948d6f-3689-436c-8a3c-14f1cd1fe665", "name": "Rate limit reached", "originalRequest": { "url": { @@ -33327,7 +31929,7 @@ { "disabled": false, "description": { - "content": "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`. (This can only be one of en,fr,ca,de,es,he,it,ja,nl,pl,pt,ro,ru,uk,zh)", + "content": "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`. (This can only be one of en,fr,ca,da,de,es,et,fi,he,it,ja,nb,nl,pl,pt,ro,ru,sv,uk,zh)", "type": "text/plain" }, "key": "language", @@ -33422,7 +32024,7 @@ } ], "info": { - "_postman_id": "1a823709-3026-4a7b-9b01-4a15e7d5936d", + "_postman_id": "44a3a98c-4049-4272-9057-b29909fb7f75", "name": "Woosmap Platform API Reference", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { diff --git a/generator/requests/requests.ts b/generator/requests/requests.ts index 9f73858d..73a24d67 100644 --- a/generator/requests/requests.ts +++ b/generator/requests/requests.ts @@ -28,69 +28,6 @@ export const REQUESTS: SnippetRequest[] = [ ), }), }, - { - regionTag: "woosmap_http_address_autocomplete_collection", - request: new Request({ - url: new Url({ - protocol: "https", - host: "api.woosmap.com", - path: "/address/autocomplete/json", - query: [ - { - key: "input", - value: "Lond", - }, - { - key: "components", - value: "country:gb", - }, - ], - }), - header: [{key: "Referer", value: "http://localhost"}], - }), - }, - { - regionTag: "woosmap_http_address_details", - request: new Request({ - url: new Url({ - protocol: "https", - host: "api.woosmap.com", - path: "/address/details/json", - query: [ - { - key: "public_id", - value: "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0", - } - ], - }), - header: [{key: "Referer", value: "http://localhost"}], - }), - }, - { - regionTag: "woosmap_http_address_geocode_collection", - request: new Request({ - url: new Url({ - protocol: "https", - host: "api.woosmap.com", - path: "/address/geocode/json", - query: [ - { - key: "address", - value: "Place de la Resistance Paris", - }, - { - key: "components", - value: "country:FR" - }, - { - key: "limit", - value: "5" - } - ], - }), - header: [{key: "Referer", value: "http://localhost"}], - }), - }, { regionTag: "woosmap_http_distance_matrix", request: new Request({ diff --git a/redocly/redocly-merged-config.yaml b/redocly/redocly-merged-config.yaml index 0fabaff3..415de517 100644 --- a/redocly/redocly-merged-config.yaml +++ b/redocly/redocly-merged-config.yaml @@ -118,7 +118,6 @@ apis: tags: - "Geolocation API" - "Localities API" - - "Address API" - "Datasets API" - "Woosmap for what3words API" - name: "Stores" diff --git a/redocly/redocly-validate-config.yaml b/redocly/redocly-validate-config.yaml index d99c5043..a5a24f99 100644 --- a/redocly/redocly-validate-config.yaml +++ b/redocly/redocly-validate-config.yaml @@ -17,7 +17,6 @@ rules: - "Zones" - "Geolocation API" - "Localities API" - - "Address API" - "Woosmap for what3words API" - "Indoor API" - "Transit API" diff --git a/specification/index.yml b/specification/index.yml index cc36b55b..b1e14151 100644 --- a/specification/index.yml +++ b/specification/index.yml @@ -118,13 +118,3 @@ tags: This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/support/api-keys/). externalDocs: url: https://developers.woosmap.com/products/localities/get-started/ - - name: Address API - description: > - Woosmap Address API is a web service that returns addresses and other geographical places in response to an HTTP request. - Request is done over HTTPS using GET. Response is formatted as JSON. - You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key. - This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/support/api-keys/). - - >**⚠️ This API has been deprecated in favour of Localities API** - externalDocs: - url: https://developers.woosmap.com/products/address-api/get-started/ diff --git a/specification/parameters/_index.yml b/specification/parameters/_index.yml index aadaaa66..636d5bd6 100755 --- a/specification/parameters/_index.yml +++ b/specification/parameters/_index.yml @@ -1,25 +1,5 @@ # WARNING: This file is automatically updated as part of `npm run build`. -address_address_components: - $ref: "./address/address_components.yml" -address_address: - $ref: "./address/address.yml" -address_cc_format: - $ref: "./address/cc_format.yml" -address_fields: - $ref: "./address/fields.yml" -address_input: - $ref: "./address/input.yml" -address_language: - $ref: "./address/language.yml" -address_latlng: - $ref: "./address/latlng.yml" -address_limit: - $ref: "./address/limit.yml" -address_location: - $ref: "./address/location.yml" -address_public_id: - $ref: "./address/public_id.yml" geolocation_ip_address: $ref: "./geolocation/ip_address.yml" geolocation_limit: diff --git a/specification/parameters/address/address.yml b/specification/parameters/address/address.yml deleted file mode 100644 index 932a2601..00000000 --- a/specification/parameters/address/address.yml +++ /dev/null @@ -1,9 +0,0 @@ -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 diff --git a/specification/parameters/address/address_components.yml b/specification/parameters/address/address_components.yml deleted file mode 100644 index 280d5a31..00000000 --- a/specification/parameters/address/address_components.yml +++ /dev/null @@ -1,8 +0,0 @@ -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 `|`. -schema: - type: string - example: country:CAN|country:BEL -in: query \ No newline at end of file diff --git a/specification/parameters/address/cc_format.yml b/specification/parameters/address/cc_format.yml deleted file mode 100644 index d16f9c77..00000000 --- a/specification/parameters/address/cc_format.yml +++ /dev/null @@ -1,10 +0,0 @@ -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`). -schema: - type: string - enum: - - alpha2 - - alpha3 - example: alpha2 -in: query diff --git a/specification/parameters/address/fields.yml b/specification/parameters/address/fields.yml deleted file mode 100644 index b59f7b59..00000000 --- a/specification/parameters/address/fields.yml +++ /dev/null @@ -1,11 +0,0 @@ -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 diff --git a/specification/parameters/address/input.yml b/specification/parameters/address/input.yml deleted file mode 100644 index a63570e3..00000000 --- a/specification/parameters/address/input.yml +++ /dev/null @@ -1,9 +0,0 @@ -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. -schema: - type: string - example: "London" -required: true -in: query diff --git a/specification/parameters/address/language.yml b/specification/parameters/address/language.yml deleted file mode 100644 index 3ad54052..00000000 --- a/specification/parameters/address/language.yml +++ /dev/null @@ -1,9 +0,0 @@ -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 diff --git a/specification/parameters/address/latlng.yml b/specification/parameters/address/latlng.yml deleted file mode 100644 index f682137b..00000000 --- a/specification/parameters/address/latlng.yml +++ /dev/null @@ -1,9 +0,0 @@ -name: latlng -description: > - Geographic coordinates. Should be pass in `lat`,`lng` format. -schema: - type: string - example: 5.2,-2.3 - -required: false -in: query diff --git a/specification/parameters/address/limit.yml b/specification/parameters/address/limit.yml deleted file mode 100644 index df685760..00000000 --- a/specification/parameters/address/limit.yml +++ /dev/null @@ -1,9 +0,0 @@ -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 \ No newline at end of file diff --git a/specification/parameters/address/location.yml b/specification/parameters/address/location.yml deleted file mode 100644 index 547f9b62..00000000 --- a/specification/parameters/address/location.yml +++ /dev/null @@ -1,7 +0,0 @@ -name: location -description: > - Bias for the results. Should be pass in `lat`,`lng` format. -schema: - type: string - example: 5.2,-2.3 -in: query \ No newline at end of file diff --git a/specification/parameters/address/public_id.yml b/specification/parameters/address/public_id.yml deleted file mode 100644 index 2d702fee..00000000 --- a/specification/parameters/address/public_id.yml +++ /dev/null @@ -1,9 +0,0 @@ -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 diff --git a/specification/paths/_index.yml b/specification/paths/_index.yml index 9ecafa01..a3150821 100644 --- a/specification/paths/_index.yml +++ b/specification/paths/_index.yml @@ -71,24 +71,6 @@ summary: Nearby points of interest operationId: localitiesNearby $ref: "./localities/localitiesNearby.yml" -/address/autocomplete/json: - get: - deprecated: true - summary: Autocomplete for Addresses - operationId: addressAutocomplete - $ref: "./address/addressAutocomplete.yml" -/address/details/json: - get: - deprecated: true - summary: Details of an Address - operationId: addressDetails - $ref: "./address/addressDetails.yml" -/address/geocode/json: - get: - deprecated: true - summary: Geocode an Address or Reverse Geocode a latlng - operationId: addressGeocode - $ref: "./address/addressGeocode.yml" /zones: get: summary: List your Zones diff --git a/specification/paths/address/addressAutocomplete.yml b/specification/paths/address/addressAutocomplete.yml deleted file mode 100644 index fa31881d..00000000 --- a/specification/paths/address/addressAutocomplete.yml +++ /dev/null @@ -1,66 +0,0 @@ -servers: - - url: https://api.woosmap.com -tags: - - Address API -description: > - Autocomplete on worldwide suggestions for a for text-based geographic searches. - It can match on full words as well as substrings. -security: - - PublicApiKeyAuth: [] - RefererHeader: [] - - PrivateApiKeyAuth: [] - - PrivateApiKeyHeaderAuth: [] -parameters: - - $ref: "../../parameters/address/input.yml" - - $ref: "../../parameters/address/address_components.yml" - - $ref: "../../parameters/address/location.yml" - - $ref: "../../parameters/address/language.yml" -responses: - "200": - description: Autocompletion Address successfully retrieved - content: - application/json: - schema: - $ref: "../../schemas/AddressAutocompleteCollectionResponse.yml" - examples: - default: - summary: Autocomplete address results for input `Lond` and components `country:gb` - value: - $ref: "../../responses/woosmap_http_address_autocomplete_collection_response.yml" - "401": - description: Unauthorized. Incorrect authentication credentials. - content: - application/json: - schema: - $ref: "../../schemas/Error401.yml" - 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: "../../schemas/Error403.yml" - 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: "../../schemas/Error429.yml" - examples: - Forbidden: - summary: Error 429 - value: - detail: "The rate limit for this endpoint has been exceeded" -x-codeSamples: - - $ref: "../../snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.curl.yml" - - $ref: "../../snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.javascript.yml" - - $ref: "../../snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.python.yml" diff --git a/specification/paths/address/addressDetails.yml b/specification/paths/address/addressDetails.yml deleted file mode 100644 index 202fe948..00000000 --- a/specification/paths/address/addressDetails.yml +++ /dev/null @@ -1,65 +0,0 @@ -servers: - - url: https://api.woosmap.com -tags: - - Address API -description: > - Provides details of an address autocomplete suggestion (using the suggestion’s `public_id`). -security: - - PublicApiKeyAuth: [] - RefererHeader: [] - - PrivateApiKeyAuth: [] - - PrivateApiKeyHeaderAuth: [] -parameters: - - $ref: "../../parameters/address/public_id.yml" - - $ref: "../../parameters/address/fields.yml" - - $ref: "../../parameters/address/cc_format.yml" -responses: - "200": - description: Details Address successfully retrieved - content: - application/json: - schema: - $ref: "../../schemas/AddressDetailsResponse.yml" - examples: - default: - summary: Address Details for `London, England, United Kingdom` - value: - $ref: "../../responses/woosmap_http_address_details_response.yml" - - "401": - description: Unauthorized. Incorrect authentication credentials. - content: - application/json: - schema: - $ref: "../../schemas/Error401.yml" - 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: "../../schemas/Error403.yml" - 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: "../../schemas/Error429.yml" - examples: - Forbidden: - summary: Error 429 - value: - detail: "The rate limit for this endpoint has been exceeded" -x-codeSamples: - - $ref: "../../snippets/woosmap_http_address_details/woosmap_http_address_details.curl.yml" - - $ref: "../../snippets/woosmap_http_address_details/woosmap_http_address_details.javascript.yml" - - $ref: "../../snippets/woosmap_http_address_details/woosmap_http_address_details.python.yml" diff --git a/specification/paths/address/addressGeocode.yml b/specification/paths/address/addressGeocode.yml deleted file mode 100644 index 582eeeb4..00000000 --- a/specification/paths/address/addressGeocode.yml +++ /dev/null @@ -1,69 +0,0 @@ -servers: - - url: https://api.woosmap.com -tags: - - Address API -description: > - Provides details for an address or a geographic position. Either parameter `address` **or** `latlng` is required. Maximum of 25 queries per second (QPS) -security: - - PublicApiKeyAuth: [] - RefererHeader: [] - - PrivateApiKeyAuth: [] - - PrivateApiKeyHeaderAuth: [] -parameters: - - $ref: "../../parameters/address/address.yml" - - $ref: "../../parameters/address/latlng.yml" - - $ref: "../../parameters/address/address_components.yml" - - $ref: "../../parameters/address/language.yml" - - $ref: "../../parameters/address/location.yml" - - $ref: "../../parameters/address/cc_format.yml" - - $ref: "../../parameters/address/limit.yml" -responses: - "200": - description: Request Address Geocode successful - content: - application/json: - schema: - $ref: "../../schemas/AddressGeocodeCollectionResponse.yml" - examples: - default: - summary: Geocode Results for address `Place de la Resistance` with components `country:FR` - value: - $ref: "../../responses/woosmap_http_address_geocode_collection_response.yml" - - "401": - description: Unauthorized. Incorrect authentication credentials. - content: - application/json: - schema: - $ref: "../../schemas/Error401.yml" - 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: "../../schemas/Error403.yml" - 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: "../../schemas/Error429.yml" - examples: - Forbidden: - summary: Error 429 - value: - detail: "The rate limit for this endpoint has been exceeded" -x-codeSamples: - - $ref: "../../snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.curl.yml" - - $ref: "../../snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.javascript.yml" - - $ref: "../../snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.python.yml" diff --git a/specification/paths/localities/localitiesDetails.yml b/specification/paths/localities/localitiesDetails.yml index 0c66e4ed..44acbf13 100644 --- a/specification/paths/localities/localitiesDetails.yml +++ b/specification/paths/localities/localitiesDetails.yml @@ -13,7 +13,7 @@ parameters: - $ref: "../../parameters/localities/public_id.yml" - $ref: "../../parameters/localities/language.yml" - $ref: "../../parameters/localities/fields.yml" - - $ref: "../../parameters/address/cc_format.yml" + - $ref: "../../parameters/localities/cc_format.yml" - $ref: "../../parameters/localities/page.yml" - $ref: "../../parameters/localities/addresses_per_page.yml" responses: diff --git a/specification/responses/woosmap_http_address_autocomplete_collection_response.yml b/specification/responses/woosmap_http_address_autocomplete_collection_response.yml deleted file mode 100644 index c3f7f14e..00000000 --- a/specification/responses/woosmap_http_address_autocomplete_collection_response.yml +++ /dev/null @@ -1,32 +0,0 @@ -# [START woosmap_http_address_autocomplete_collection_response] -{ - "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", -} -# [END woosmap_http_address_autocomplete_collection_response] diff --git a/specification/responses/woosmap_http_address_autocomplete_response.yml b/specification/responses/woosmap_http_address_autocomplete_response.yml deleted file mode 100644 index 6171da38..00000000 --- a/specification/responses/woosmap_http_address_autocomplete_response.yml +++ /dev/null @@ -1,15 +0,0 @@ -# [START woosmap_http_address_autocomplete_response] -{ - "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0", - "description": "London, England, United Kingdom", - "matched_substring": { - "description": [ - { - "offset": 0, - "length": 4 - } - ] - }, - "type": "locality" -} -# [END woosmap_http_address_autocomplete_response] diff --git a/specification/responses/woosmap_http_address_details_response.yml b/specification/responses/woosmap_http_address_details_response.yml deleted file mode 100644 index c8dd4d49..00000000 --- a/specification/responses/woosmap_http_address_details_response.yml +++ /dev/null @@ -1,45 +0,0 @@ -# [START woosmap_http_address_details_response] -{ - "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 }, - }, - }, - }, - "status": "OK", -} -# [END woosmap_http_address_details_response] diff --git a/specification/responses/woosmap_http_address_geocode_collection_response.yml b/specification/responses/woosmap_http_address_geocode_collection_response.yml deleted file mode 100644 index 9495e093..00000000 --- a/specification/responses/woosmap_http_address_geocode_collection_response.yml +++ /dev/null @@ -1,60 +0,0 @@ -# [START woosmap_http_address_geocode_collection_response] -{ - "results": - [ - { - "formatted_address": "Place de la Résistance, 75007 Paris, France", - "types": ["address", "route"], - "address_components": - [ - { - "types": ["country"], - "long_name": "France", - "short_name": "FRA", - }, - { - "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"], - }, - ], - "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 }, - }, - }, - }, - ], - "status": "OK", -} -# [END woosmap_http_address_geocode_collection_response] diff --git a/specification/schemas/AddressAutocompleteCollectionResponse.yml b/specification/schemas/AddressAutocompleteCollectionResponse.yml deleted file mode 100644 index 4f5cb4e2..00000000 --- a/specification/schemas/AddressAutocompleteCollectionResponse.yml +++ /dev/null @@ -1,12 +0,0 @@ -title: AddressAutocompleteCollectionResponse -type: object -description: Address Collection Response containing Localities -properties: - predictions: - type: array - items: - $ref: "./AddressAutocompleteResponse.yml" - status: - $ref: "./AddressStatus.yml" -example: - $ref: "../responses/woosmap_http_address_autocomplete_collection_response.yml" \ No newline at end of file diff --git a/specification/schemas/AddressAutocompleteMatchedFields.yml b/specification/schemas/AddressAutocompleteMatchedFields.yml deleted file mode 100644 index 26a3e613..00000000 --- a/specification/schemas/AddressAutocompleteMatchedFields.yml +++ /dev/null @@ -1,9 +0,0 @@ -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: "./MatchedSubstring.yml" diff --git a/specification/schemas/AddressAutocompleteResponse.yml b/specification/schemas/AddressAutocompleteResponse.yml deleted file mode 100644 index daf9b721..00000000 --- a/specification/schemas/AddressAutocompleteResponse.yml +++ /dev/null @@ -1,20 +0,0 @@ -title: AddressAutocompleteResponse -type: object -description: Attributes describing an Address. -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: "./AddressAutocompleteMatchedFields.yml" - type: - $ref: "./AddressTypes.yml" - status: - $ref: "./AddressStatus.yml" -example: - $ref: "../responses/woosmap_http_address_autocomplete_response.yml" \ No newline at end of file diff --git a/specification/schemas/AddressDetailsResponse.yml b/specification/schemas/AddressDetailsResponse.yml deleted file mode 100644 index 27f6a8fe..00000000 --- a/specification/schemas/AddressDetailsResponse.yml +++ /dev/null @@ -1,27 +0,0 @@ -title: AddressDetailsResponse -type: object -description: Address Details Response -properties: - status: - $ref: "./AddressStatus.yml" - result: - description: the root node of address details - type: object - properties: - formatted_address: - $ref: "./FormattedAddress.yml" - types: - description: The types of result. - type: array - items: - $ref: "./AddressTypes.yml" - 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: "./AddressComponents.yml" - geometry: - $ref: "./AddressGeometry.yml" -example: - $ref: "../responses/woosmap_http_address_details_response.yml" diff --git a/specification/schemas/AddressGeocodeCollectionResponse.yml b/specification/schemas/AddressGeocodeCollectionResponse.yml deleted file mode 100644 index b74b51b9..00000000 --- a/specification/schemas/AddressGeocodeCollectionResponse.yml +++ /dev/null @@ -1,12 +0,0 @@ -title: AddressGeocodeCollectionResponse -type: object -description: Address Geocode Collection Response. Contains one or more Addresses with coordinates (default to one result for reverse geocoding) -properties: - results: - type: array - items: - $ref: "./AddressGeocodeResponse.yml" - status: - $ref: "./AddressStatus.yml" -example: - $ref: "../responses/woosmap_http_address_geocode_collection_response.yml" diff --git a/specification/schemas/AddressGeocodeResponse.yml b/specification/schemas/AddressGeocodeResponse.yml deleted file mode 100644 index 0a4878ae..00000000 --- a/specification/schemas/AddressGeocodeResponse.yml +++ /dev/null @@ -1,15 +0,0 @@ -title: AddressGeocodeResponse -type: object -description: Address Geocode Response -properties: - formatted_address: - $ref: "./FormattedAddress.yml" - 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 - items: - $ref: "./AddressGeocodeTypes.yml" - address_components: - $ref: "./AddressComponents.yml" - geometry: - $ref: "./AddressGeometry.yml" diff --git a/specification/schemas/AddressGeocodeTypes.yml b/specification/schemas/AddressGeocodeTypes.yml deleted file mode 100644 index 649f6b05..00000000 --- a/specification/schemas/AddressGeocodeTypes.yml +++ /dev/null @@ -1,12 +0,0 @@ -title: AddressGeocodeTypes -type: string -description: Contains the type of result. -enum: - - address - - house_number - - route - - address_block - - locality - - admin_level - - country - - place diff --git a/specification/schemas/AddressGeometry.yml b/specification/schemas/AddressGeometry.yml deleted file mode 100644 index 37219009..00000000 --- a/specification/schemas/AddressGeometry.yml +++ /dev/null @@ -1,26 +0,0 @@ -title: AddressGeometry -type: object -description: The location of the result, in latitude and longitude. Accuracy is also provided. -properties: - location_type: - description: > - Specifies additional data about the geocoded location. The following values are currently supported: - - `ROOFTOP` result is a precise geocode for which we have location information accurate down to street address precision. - - `RANGE_INTERPOLATED` result reflects an approximation (usually on a road) interpolated between two precise points (such as intersections). Interpolated results are generally returned when rooftop geocodes are unavailable for a street address. - - `GEOMETRIC_CENTER` result is the geometric center of a result such as a polyline (for example, a street) or polygon (city, region, …). - - `APPROXIMATE` result is approximate (usually when no other above value applies) - type: string - enum: - - ROOFTOP - - RANGE_INTERPOLATED - - GEOMETRIC_CENTER - - APPROXIMATE - location: - $ref: "./LatLngLiteral.yml" - viewport: - $ref: "./Bounds.yml" -example: { - "location": { "lat": 48.829405, "lng": 2.367944 }, - "location_type": "GEOMETRIC_CENTER", -} - diff --git a/specification/schemas/AddressStatus.yml b/specification/schemas/AddressStatus.yml deleted file mode 100644 index 05de471e..00000000 --- a/specification/schemas/AddressStatus.yml +++ /dev/null @@ -1,14 +0,0 @@ -title: AddressStatus -type: string -example: OK -description: > - Returns more info on if the request was successful or not, valid responses. - * `OK` indicates the response contains a valid result. - * `INVALID_REQUEST` indicates that the provided request was invalid (e.g. wrong URL syntax). - * `REQUEST_DENIED` indicates that the service denied use of the Address API (e.g. wrong API Key, wrong/no referer, …). - * `UNKNOWN_ERROR` indicates an Address API request could not be processed due to a server error. The request may succeed if you try again. -enum: - - OK - - INVALID_REQUEST - - REQUEST_DENIED - - UNKNOWN_ERROR diff --git a/specification/schemas/AddressTypes.yml b/specification/schemas/AddressTypes.yml deleted file mode 100644 index 7c3140b8..00000000 --- a/specification/schemas/AddressTypes.yml +++ /dev/null @@ -1,10 +0,0 @@ -title: AddressTypes -type: string -description: Contains the type of result. -enum: - - house_number - - route - - address_block - - locality - - admin_level - - country diff --git a/specification/schemas/_index.yml b/specification/schemas/_index.yml index 962e70c0..5dfca1fb 100644 --- a/specification/schemas/_index.yml +++ b/specification/schemas/_index.yml @@ -32,12 +32,6 @@ MatchedSubstring: $ref: "./MatchedSubstring.yml" AddressComponents: $ref: "./AddressComponents.yml" -AddressTypes: - $ref: "./AddressTypes.yml" -AddressGeocodeTypes: - $ref: "./AddressGeocodeTypes.yml" -AddressGeometry: - $ref: "./AddressGeometry.yml" Destinations: $ref: "./Destinations.yml" Origins: @@ -137,22 +131,6 @@ LocalitiesNearbyCollectionResponse: LocalitiesNearbyResponse: $ref: "./LocalitiesNearbyResponse.yml" -# Address -AddressAutocompleteCollectionResponse: - $ref: "./AddressAutocompleteCollectionResponse.yml" -AddressAutocompleteMatchedFields: - $ref: "./AddressAutocompleteMatchedFields.yml" -AddressAutocompleteResponse: - $ref: "./AddressAutocompleteResponse.yml" -AddressDetailsResponse: - $ref: "./AddressDetailsResponse.yml" -AddressStatus: - $ref: "./AddressStatus.yml" -AddressGeocodeCollectionResponse: - $ref: "./AddressGeocodeCollectionResponse.yml" -AddressGeocodeResponse: - $ref: "./AddressGeocodeResponse.yml" - ## Zones ZonesCollectionRequest: $ref: "./ZonesCollectionRequest.yml" diff --git a/specification/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.curl.yml b/specification/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.curl.yml deleted file mode 100644 index 561d73ea..00000000 --- a/specification/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.curl.yml +++ /dev/null @@ -1,5 +0,0 @@ -{ - "lang": "curl", - "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/address/autocomplete/json?input=Lond&components=country%3Agb&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'", -} diff --git a/specification/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.javascript.yml b/specification/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.javascript.yml deleted file mode 100644 index aa6a23c2..00000000 --- a/specification/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.javascript.yml +++ /dev/null @@ -1,5 +0,0 @@ -{ - "lang": "javascript", - "label": "JavaScript", - "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/address/autocomplete/json?input=Lond&components=country%3Agb&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));", -} diff --git a/specification/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.nodejs.yml b/specification/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.nodejs.yml deleted file mode 100644 index 6c8b4e5b..00000000 --- a/specification/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.nodejs.yml +++ /dev/null @@ -1,5 +0,0 @@ -{ - "lang": "nodejs", - "label": "NodeJS", - "source": "const axios = require('axios');\n\nlet config = {\n method: 'get',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/address/autocomplete/json?input=Lond&components=country%3Agb&key=YOUR_PUBLIC_API_KEY',\n headers: { \n 'Referer': 'http://localhost'\n }\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", -} diff --git a/specification/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.python.yml b/specification/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.python.yml deleted file mode 100644 index 8fc1ce35..00000000 --- a/specification/snippets/woosmap_http_address_autocomplete_collection/woosmap_http_address_autocomplete_collection.python.yml +++ /dev/null @@ -1,5 +0,0 @@ -{ - "lang": "python", - "label": "Python", - "source": "import requests\n\nurl = \"https://api.woosmap.com/address/autocomplete/json?input=Lond&components=country%3Agb&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", -} diff --git a/specification/snippets/woosmap_http_address_details/woosmap_http_address_details.curl.yml b/specification/snippets/woosmap_http_address_details/woosmap_http_address_details.curl.yml deleted file mode 100644 index 155478e6..00000000 --- a/specification/snippets/woosmap_http_address_details/woosmap_http_address_details.curl.yml +++ /dev/null @@ -1,5 +0,0 @@ -{ - "lang": "curl", - "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/address/details/json?public_id=aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'", -} diff --git a/specification/snippets/woosmap_http_address_details/woosmap_http_address_details.javascript.yml b/specification/snippets/woosmap_http_address_details/woosmap_http_address_details.javascript.yml deleted file mode 100644 index 68a94821..00000000 --- a/specification/snippets/woosmap_http_address_details/woosmap_http_address_details.javascript.yml +++ /dev/null @@ -1,5 +0,0 @@ -{ - "lang": "javascript", - "label": "JavaScript", - "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/address/details/json?public_id=aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));", -} diff --git a/specification/snippets/woosmap_http_address_details/woosmap_http_address_details.nodejs.yml b/specification/snippets/woosmap_http_address_details/woosmap_http_address_details.nodejs.yml deleted file mode 100644 index 4a0f8007..00000000 --- a/specification/snippets/woosmap_http_address_details/woosmap_http_address_details.nodejs.yml +++ /dev/null @@ -1,5 +0,0 @@ -{ - "lang": "nodejs", - "label": "NodeJS", - "source": "const axios = require('axios');\n\nlet config = {\n method: 'get',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/address/details/json?public_id=aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0&key=YOUR_PUBLIC_API_KEY',\n headers: { \n 'Referer': 'http://localhost'\n }\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", -} diff --git a/specification/snippets/woosmap_http_address_details/woosmap_http_address_details.python.yml b/specification/snippets/woosmap_http_address_details/woosmap_http_address_details.python.yml deleted file mode 100644 index 5d9bf1a0..00000000 --- a/specification/snippets/woosmap_http_address_details/woosmap_http_address_details.python.yml +++ /dev/null @@ -1,5 +0,0 @@ -{ - "lang": "python", - "label": "Python", - "source": "import requests\n\nurl = \"https://api.woosmap.com/address/details/json?public_id=aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0&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", -} diff --git a/specification/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.curl.yml b/specification/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.curl.yml deleted file mode 100644 index 599fe4c7..00000000 --- a/specification/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.curl.yml +++ /dev/null @@ -1,5 +0,0 @@ -{ - "lang": "curl", - "label": "cURL", - "source": "curl -L 'https://api.woosmap.com/address/geocode/json?address=Place%20de%20la%20Resistance%20Paris&components=country%3AFR&limit=5&key=YOUR_PUBLIC_API_KEY' \\\n-H 'Referer: http://localhost'", -} diff --git a/specification/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.javascript.yml b/specification/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.javascript.yml deleted file mode 100644 index cfa292b4..00000000 --- a/specification/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.javascript.yml +++ /dev/null @@ -1,5 +0,0 @@ -{ - "lang": "javascript", - "label": "JavaScript", - "source": "const requestOptions = {\n method: \"GET\",\n redirect: \"follow\"\n};\n\nfetch(\"https://api.woosmap.com/address/geocode/json?address=Place%20de%20la%20Resistance%20Paris&components=country%3AFR&limit=5&key=YOUR_PUBLIC_API_KEY\", requestOptions)\n .then((response) => response.text())\n .then((result) => console.log(result))\n .catch((error) => console.error(error));", -} diff --git a/specification/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.nodejs.yml b/specification/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.nodejs.yml deleted file mode 100644 index a2374971..00000000 --- a/specification/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.nodejs.yml +++ /dev/null @@ -1,5 +0,0 @@ -{ - "lang": "nodejs", - "label": "NodeJS", - "source": "const axios = require('axios');\n\nlet config = {\n method: 'get',\n maxBodyLength: Infinity,\n url: 'https://api.woosmap.com/address/geocode/json?address=Place%20de%20la%20Resistance%20Paris&components=country%3AFR&limit=5&key=YOUR_PUBLIC_API_KEY',\n headers: { \n 'Referer': 'http://localhost'\n }\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", -} diff --git a/specification/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.python.yml b/specification/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.python.yml deleted file mode 100644 index 43dfaf68..00000000 --- a/specification/snippets/woosmap_http_address_geocode_collection/woosmap_http_address_geocode_collection.python.yml +++ /dev/null @@ -1,5 +0,0 @@ -{ - "lang": "python", - "label": "Python", - "source": "import requests\n\nurl = \"https://api.woosmap.com/address/geocode/json?address=Place%20de%20la%20Resistance%20Paris&components=country%3AFR&limit=5&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", -}