Group 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: Group
• 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 groups by id

Input

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

Output

• group(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 groups that meet the conditions

Input

1. conditions(s) (Struct|null): the conditions the groups has to meet. Default only public groups
   Possible keys:
   • owner.id: integer|array
   • score.min: float between 0 and 1
   • score.max: float between 0 and 1
   • language: iso2 language code (example: 'nl', 'en', 'fr', 'de', ...)
   • keywords: words separated by spaces
   • name: words separated by spaces
   • route.id: integer|array
   • member.id: integer|array
2. sorting (String|Array): determines the order of the groups. When there are multiple sorting criteria, an array is necessary.
   Possible sortings:
   • id [ASC|DESC]
   • score [ASC|DESC]
   • owner.id [ASC|DESC]
3. limit (Integer): maximum number of groups returned
4. offset (Integer): number of groups to skip (maximum 10000)
5. cache (boolean|null): when null, the web service chooses if cache is activated. Otherwise overruled by the boolean

Output

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

changeLanguage

Change the language of a group

Input

1. id (Integer)): the id of the group you want to change
2. current language (String): the current language
3. new language (String): the language it should be

Output

• successful (boolean): true if successful

save

Make changes to a group. The right permissions are necessary

Input

1. data (Struct): the data to update

Output

• success (Boolean): true if successful, false if not

addRoute

Link a group to a route. The right permissions are necessary

Input

1. groupId (Integer): the id of the group
2. routeId (Integer): the id of the route

Output

• success (Boolean): true if successful, false if not

removeRoute

Unlink a group from a route. The right permissions are necessary

Input

1. groupId (Integer): the id of the group
2. routeId (Integer): the id of the route

Output

• success (Boolean): true if successful, false if not

addPoi

Link a group to a poi. The right permissions are necessary

Input

1. groupId (Integer): the id of the group
2. poiId (Integer): the id of the poi

Output

• success (Boolean): true if successful, false if not

removePoi

Unlink a group from a poi. The right permissions are necessary

Input

1. groupId (Integer): the id of the group
2. poiId (Integer): the id of the poi

Output

• success (Boolean): true if successful, false if not

addMember

Add a member to a group. The right permissions are necessary

Input

1. groupId (Integer): the id of the group

Output

• success (Boolean): true if successful, false if not

removeMember

Unlink a member of a group. The right permissions are necessary

Input

1. groupId (Integer): the id of the group
2. memberId(Integer): the id of the user

Output

• success (Boolean): true if successful, false if not

Back to RouteYou