Poi Web Service 2.0

Table of contents

Info

Remark: This is a RouteYou+ service. Please contact sales[at-r.] if you want to make use of this service and you don't have yet an agreement with RouteYou.

Technical

The web service is accessible using:

Overview of provided functions

get

Get information of one or multiple pois by id

Input

  1. id(s) (Integer|Array(Integer)): get the poi(s) with the given id(s)
  2. language (String|Null): language in iso2
  3. options (Struct|Null)

Output

search

Get the pois that meet the conditions

Input

  1. conditions (Struct|null): the conditions the pois has to meet. Default only public pois
    Possible keys:
    • bounds: array(
      'min' => array(
        'lon' => <min longitude>,
        'lat' => <min latitude>
      ),
      'max' => array(
        'lon' => <max longitude>,
        'lat' => <max latitude>
      )
      )
    • id: integer|array
    • type.id: integer|array
    • owner.id: integer|array
    • score.min: float between 0 and 1
    • score.max: float between 0 and 1
    • editedDate.min: date (+time) in iso 8601
    • editedDate.max: date (+time) in iso 8601
    • flag: iso2 country code (example: 'be', 'nl', 'de', ..)
    • language: iso2 language code (example: 'nl', 'en', 'fr', 'de', ...)
    • keywords: words separated by spaces
    • group.id: integer|array
    • characteristic.id: integer|array
    • theme.id: integer|array
    • favorite.user.id: integer|array
    • permission.readable: true //show all allowed pois. Default only public pois are returned
  2. sorting (String|Array): determines the order of the pois. When there are multiple sorting criteria, an array is necessary.
    Possible sortings:
    • id [ASC|DESC]
    • score [ASC|DESC]
    • owner.id [ASC|DESC]
    • viewCount [ASC|DESC]
    • viewCountThisMonth [ASC|DESC]
    • editedDate [ASC|DESC]
  3. limit (Integer): maximum number of pois returned (default of 10, maximum 100 routes per call)
  4. offset (Integer): number of pois to skip

Output

searchBounds

Retrieves the bounding box around all pois matching the given conditions

Input

  1. conditions(s) (Struct|null): the conditions the pois have to meet. Default only public pois.
    Identical to conditions of function search.

Output

getType

Get poi type(s) by id

Input

  1. id(s) (Integer|Array(Integer)|Null): get the poi type(s) with the given id(s). All types are returned when null.
  2. language (String|Null): language in iso2

Output

getTypeHierarchy

Get poi type(s) with their hierarchy by id

Input

  1. id(s) (Integer|Array(Integer)): get the poi type(s) with the given id(s)
  2. language (String|Null): language in iso2

Output

© 2006-2021 RouteYou - www.routeyou.com