Poi Web Service 2.0

Table of contents

• Info
• Technical
• Overview of provided functions
  • get
    • Input
    • Output
  • search
    • Input
    • Output
  • searchBounds
    • Input
    • Output
  • getType
    • Input
    • Output
  • getTypeHierarchy
    • Input
    • Output

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.

• Service name: Poi
• Version: 2.0

Technical

The web service is accessible using:

• XML-RPC: Info on how to use
• JSONP: Info on how to use
• JSON-RPC: Info on how to use

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

• poi(s) (Object|Struct(Object)): if the input is just one id, an object is returned. If the input is an array, an array with the ids as key and the objects as value is returned.

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 (maximum 10000)

Output

• pois (Array(Object)): an array of pois in the passed order is returned

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

• bounding box (String): Box composed of minimum longitude, minimum latitude, maximum longitude and maximum latitude

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

• poitype(s) (Object|Array(Object)): if the input is just one id, an object is returned. If the input is an array, an array with the ids as key and the objects as value is returned.

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

• poi type(s) (Object|Array(Object)): if the input is just one id, an object is returned. If the input is an array, an array with the ids as key and the objects as value is returned.

Back to RouteYou