This is an old revision of the document!
Table of Contents
Remote Procedure Calls
authenticateByClientId
creates valid sessionid, if user credentials are valid
api_key is built with following rule: hash[hash[api_key]+id]
Parameter
required
- api_key (String 32)
- client_id (integ)
on Success
returns sessionid
on Failure
returns error
authenticateByRealm
creates valid sessionid, if user credentials are valid
api_key is built with following rule: hash[hash[api_key]+id]
Parameter
required
- api_key (String 32)
- realm (String)
on Success
returns sessionid
on Failure
returns error
logout
logout and set the sessionid to invalid
Parameter
required
- sessionid
on Success
returns ok
on Failure
returns error
createSingleAccount
create new User Account
Parameter
required
* sessionid as provided by authenticate-method
optional
- 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
on Failure
returns error
deleteAccount
delete single Account
Parameter
required
- sessionid as provided by authenticate-method
- username
on Success
returns true
on Failure
returns error
getAccountDetails
get Account Details
Parameter
required
- sessionid 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
getDefaults
get all or specific default values
Parameter
required
- sessionid as provided by authenticate-method
- location_id (0 = all locations)
optional
options array (
- tariff_id
- valid_days_from_creation
- realm
- password_length
- password_type (number, letters, alphanumeric, mixed)
)
on Success
returns all or requested default values
on Failure
returns error
getTariffDetails
get all or specific default values
Parameter
required
- sessionid as provided by authenticate-method
- tariff_id or tariff_name
on Success
returns tariff properties
on Failure
returns error
setDefaults
set specific default values
Parameter
required
- sessionid as provided by authenticate-method
- location_id ( 0 = for all locations)
optional
- tariff_id
- valid_days_from_creation (0 = unlimited, maximum 365)
on Success
returns array of default values
on Failure
returns error
