Characteristic Web Service 2.0

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: Characteristic
• 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 characteristics by id

Input

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

Output

• characteristic(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 characteristics that meet the conditions

Input

1. conditions(s) (Struct|null): the conditions the characteristics has to meet.
   Possible keys:
   • importance.min: float between 0 and 1
   • importance.max: float between 0 and 1
   • routeSuitable: boolean
   • poiSuitable: boolean
   • keywords: words separated by spaces
   • name: words separated by spaces
2. sorting (String|Array): determines the order of the characteristics. When there are multiple sorting criteria, an array is necessary.
   Possible sortings:
   • id [ASC|DESC]
3. limit (Integer): maximum number of characteristics returned
4. offset (Integer): number of characteristics to skip

Output

• characteristic(s) (Array(Object)): an array of characteristics in de passed order is returned

Back to RouteYou