Remote Procedure Calls

authenticateById

creates valid token, if user credentials are valid

Parameter

required

api_key (String 32)

client_id (integ)

on Success

returns token

on Failure

returns error

authenticateByRealm

creates valid token, if user credentials are valid

Parameter

required

api_key (String 32)

realm (String)

on Success

returns token

on Failure

returns error

createSingleAccount

create new User Account

Parameter

required

token as provided by authenticate-method

optional

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)

}

on Success

returns username, password, account_id

on Failure

returns error

deleteAccount

delete single Account

Parameter

required

token as provided by authenticate-method

username

on Success

returns deleted: True

on Failure

returns error

getAccountDetails

get Account Details

Parameter

required

session_id as provided by authenticate-method

username

on Success

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

)

on Failure

returns error

getAutoLoginURL

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

Parameter

required

token as provided by authenticate-method

location_id

on Success

returns url including parameters

on Failure

returns ''

getDefaults

get all or specific default values

Parameter

required

token as provided by authenticate-method

optional

location_id (0 = all locations)

on Success

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)

)

on Failure

returns error

getLogo

get Logo

Parameter

required

token as provided by authenticate-method

on Success

returns logo

on Failure

returns error

getNote

get note to be printed on ticket before user credentials

Parameter

required

token as provided by authenticate-method

on Success

returns note

on Failure

returns error

getTariffDetails

get all or specific default values

Parameter

required

token as provided by authenticate-method

(TODO: tariff_id or)

tariff_name

on Success

returns tariff_id TODO: returns tariff properties

on Failure

returns error

logout

logout and delete token

Parameter

required

token

on Success

returns logout: True or False

on Failure

returns error

isOnline

shows if a specific user is online or offline

Parameter

required

token as provided by authenticate-method

username

on Success

returns online: True or False

on Failure

returns online: False

reactivateAccount

resets status and validity of inactive / deleted account

Parameter

required

token as provided by authenticate-method

username

on Success

returns array of username and password

on Failure

returns error

setDefaults

set specific default values

Parameter

required

token as provided by authenticate-method

optional

location_id (0 for all locations)

data {

tariff_id

username_type ('numeric' or 'dateTime')

}

on Success

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)

)

on Failure

returns error