Search Venue Pois By Key

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

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

Rate limit: 30/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.

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.

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

id
string

Filter by a comma seperated list of POI IDs.

Example: 1234,4321,9876

Response

200 application/json

OK

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

features
object[]

List of Indoor features

Show 6 propertiesHide 6 properties
features. properties
object required

Additional properties associated with this feature

features. type
string Defaults to Feature
features. geometry
GeometryCollection required

GeoJSON Geometry or Geometry Collection

features. id
integer
features. distance
number
features. duration
number

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/search?id=3623459&key=YOUR_PUBLIC_API_KEY' \
-H 'Referer: http://localhost'

    
        import requests

url = "https://api.woosmap.com/indoor/venues/west_pal/pois/search?id=3623459&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/search?id=3623459&key=YOUR_PUBLIC_API_KEY", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

    
        
{
"features": [
{
"distance": null,
"duration": null,
"geometry": {
"bbox": null,
"coordinates": [
[
[
-0.12419943632,
51.49927414881
],
[
-0.12419342215,
51.49930532278
],
[
-0.12419141597,
51.49931625597
],
[
-0.12419943632,
51.49927414881
]
]
],
"type": "Polygon"
},
"id": 3623459,
"properties": {
"name": "Painted Chamber",
"room": "office",
"level": "1",
"indoor": "area",
"building:ref": "Palace of Westminster",
"woosmap:logo": "https://woosmap-indoor-img.s3.amazonaws.com/Westminster/logo.png",
"woosmap:cover": "https://woosmap-indoor-img.s3.amazonaws.com/Westminster/paintedchamber.png",
"woosmap:label_id": 3623458,
"woosmap:zoom_icon_min": "16",
"woosmap:zoom_polygon_min": "16"
},
"type": "Feature"
}
],
"pagination": {
"page": 0,
"page_count": 1,
"per_page": 0,
"total": 1
}
}
Was this helpful?