Autocomplete Venue Pois By Key

GET

https://api.woosmap.com/indoor/venues/{venue_id}/pois/autocomplete

Autocomplete text search of the features of a venue using a name or description

Rate limit: 20/1s

Authorization

private_key

apiKey query

X-Api-Key

apiKey header

key

apiKey query

Path Parameters

venue_id

string required

ID of the venue

Query Parameters

items_by_page

integer Defaults to 0

Number of items per page. A value of 0 means no pagination.

page

integer Defaults to 0

Page number. 0 being the first page.

from_location

string

A string with the format lat,lng,level

Example: 48.8818546,2.3572283,0

q

string

Search string. If not passed then all features will be listed alphabetically

extended

string

Option to search even not searchable pois (extended=full)

Example: full

level

integer

Filter by level.

building

string

Filter by building (use undefined to find POIs not associated with a building.).

category

string

Filter by category.

ref

string

Filter by a comma seperated list of POI Refs.

Example: ref:main_entrance,ref:side_entrance

language

string Defaults to en

A supported language as an ISO 639-1 2 letter code.

advanced_filter

string

Filter by complex queries on properties (ex: indoor:="room" OR door:="yes").

Response

200 application/json

pagination

object required

Pagination Information

Show 4 propertiesHide 4 properties

pagination. page

integer required

Current page number

pagination. page_count

integer required

Total number of pages

pagination. total

integer required

Total number of items

pagination. per_page

integer required

Number of items per page

predictions

object[]

List of Indoor features

Show 8 propertiesHide 8 properties

predictions. id

integer required

ID of the Feature

predictions. name

string | null

Name of the Feature

predictions. distance

number | null

If from location provided, is the distance in metres from that location

predictions. duration

number | null

If from location provided, is the duration in seconds from that location

predictions. level

string | null

Level of the Feature

predictions. ref

string | null

Reference of the Feature

predictions. building

string | null

Building the Feature is in

predictions. category

string | null

Catagory of the Feature

Errors

401

Unauthorized

application/json

detail

string required

402

Payment Required

application/json

No properties defined

403

Forbidden

application/json

No properties defined

422

Unprocessable Entity

application/json

detail

object[] required

The validation errors.

context

object required

Context

            curl -L -X GET 'https://api.woosmap.com/indoor/venues/west_pal/pois/autocomplete?q=cham&language=en&key=YOUR_PUBLIC_API_KEY' \
-H 'Referer: http://localhost'

            import requests

url = "https://api.woosmap.com/indoor/venues/west_pal/pois/autocomplete?q=cham&language=en&key=YOUR_PUBLIC_API_KEY"

payload={}
headers = {
    'Referer': 'http://localhost'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

            var requestOptions = {
  method: 'GET',
  redirect: 'follow'
};

fetch("https://api.woosmap.com/indoor/venues/west_pal/pois/autocomplete?q=cham&language=en&key=YOUR_PUBLIC_API_KEY", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

            {
  "pagination": {
    "page": 1,
    "page_count": 1,
    "per_page": 2,
    "total": 2
  },
  "predictions": [
    {
      "building": "Palace of Westminster",
      "category": null,
      "distance": null,
      "duration": null,
      "id": 3623459,
      "level": "1",
      "name": "Painted Chamber",
      "ref": null
    },
    {
      "building": "Palace of Westminster",
      "category": null,
      "distance": null,
      "duration": null,
      "id": 3624060,
      "level": "1",
      "name": "Lord Chamberlain's Private Office",
      "ref": null
    }
  ]
}

    