Remote Procedure Calls

creates valid token, if user credentials are valid

• api_key (String 32)
• client_id (integ)

returns token

returns error

creates valid token, if user credentials are valid

• api_key (String 32)
• realm (String)

returns token

returns error

create new User Account

• token as provided by authenticate-method

data {

• username (String(50))
  

  if requested username  already exists it will get added '-' plus next free number  
  example: username meier becomes meier-5 
  if you don't enter anything a username will be created based on current time
  If you use a system where the client domains (e.g. @hotspot.de) are shown with the username, 
  you don't have to care for that. 
  Internally all usernames have '@' plus the client domain added;  

• password (String(25)) (Clear-Text)
• tariff_id (Integer)
• valid_from (Date YYYY-MM-DD)
• valid_to (Date YYYY-MM-DD)
• gender (m,f)
• first_name (String(50))
• last_name (String(50))
• email (String(60))
• telephone (String(20))
• language (de, en …)
• room (String(50))
• additional_info (String(100))
• allowed_locations (array of location ids)

}

returns username, password, account_id

returns error

delete single Account

• token as provided by authenticate-method
• username

returns deleted: True

returns error

get Account Details

• session_id as provided by authenticate-method
• username

returns array (

• username
• password
• tariff_id
• valid_from (YYYY-MM-DD)
• valid_to (YYYY-MM-DD)
• gender (m,f)
• first_name
• last_name
• email
• telephone
• language (de, en …)
• room
• additional_info
• allowed_locations

)

returns error

get URL for autologin for the current location configuration
contains one or more of the following variables to be replaced:
%u for username
%p for password
%l for location_id
%t for token

• token as provided by authenticate-method
• location_id

returns url including parameters

returns ''

get all or specific default values

• token as provided by authenticate-method

• location_id (0 = all locations)

returns default values (

• realm
• password_length
• password_type (number, letters, alphanumeric, mixed)
• valid_days
• tariff_id
• username_type (default for empty usernames: numeric or dateTime)

)

returns error

get Logo

• token as provided by authenticate-method

returns logo

returns error

get note to be printed on ticket before user credentials

• token as provided by authenticate-method

returns note

returns error

get all or specific default values

• token as provided by authenticate-method
• (TODO: tariff_id or)
• tariff_name

returns tariff_id TODO: returns tariff properties

returns error

logout and delete token

• token

returns logout: True or False

returns error

shows if a specific user is online or offline

• token as provided by authenticate-method
• username

returns online: True or False

returns online: False

resets status and validity of inactive / deleted account

• token as provided by authenticate-method
• username

returns array of username and password

returns error

set specific default values

• token as provided by authenticate-method

• location_id (0 for all locations)

data {

• tariff_id
• username_type ('numeric' or 'dateTime')

}

returns array of default values

options array (

• realm
• password_length
• password_type (number, letters, alphanumeric, mixed)
• valid_days
• tariff_id
• username_type (default for empty usernames: numeric or dateTime)

)

returns error