User Web Service 2.0

This web service gives you access to the user information. You can log in and view you detailed account information. Limited info (nick, country, language) of other users is also accessible.

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: User
• 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 a user.

Input

1. id (integer) : The id of the user for which you want the info.
2. language (String|Null): language in iso2
3. options (Struct|Null):
   • possibility to return users privileges: array('privileges' => true)

Output

• user(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.

logInWithId

Log in a user in the current session with his user-id and password.

Input

1. id (integer) : The id of the user.
2. password (string) : The password of the user.

Output

• user (Object): the user information

array (
  'id': identifier of the user
  'type' => 
  array (
    'id': identifier of the user type
  ),
  'email':
  'emailVerified': true if a user has confirmed his emailadres
  'flag': iso2 country code of the users country
  'preferredLanguage': preferred language of the user
  'accessLevel': determines the access to documentation
  'unitSystem' => 
  array (
    'code': the unit system the user uses: metric ('m') or imperial ('i')
  ),
  'name': an array with the nick of the user. The key is the language iso2 code
  'languages': a list of languages (iso2) in which the name is available  
  'privileges': a list of privile-ids
)

 

logInWithEmail

Log in a user in the current session with his email and password.

Input

1. email (string) : The email of the user.
2. password (string) : The password of the user.
3. options (Struct|Null): optional

Output

• user (Object): the user information

logInWithExternal

Log in a user in the current session with his platform specific identifier. To use this functionality you need to request permission.

Input

1. methodId(integer) : the method id identifies the external platform.
2. identifier(string) : The identifier of the user, specific for each platform.
3. options (Struct|Null): optional

Output

• user (Object): the user information

logOut

Logout the currently logged in user.

Input

No parameters.

Output

(boolean) True if successful. When failed, an error is returned.

getLoggedInUserData

Get the most recent information of the logged in user

Input

• No parameters

Output

• user (Object): the user information. Identical output like the logIn calls

Back to RouteYou