Remote Procedure Calls - SyCes Handbuch

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

====== Remote Procedure Calls ======
===== authenticate =====
creates valid sessionid, if user credentials are valid \\
password is built with following rule: hash[hash[password]+id]

=== Parameter ===
== required ==
  * username
  * password (see above)
== on Success ==

returns sessionid

== 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))
  * 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
== optional ==
  * 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

== optional ==
  * tariff_id 
  * valid_days_from_creation (0 = unlimited, maximum 365) 
  * location_id

== on Success ==

returns array of default values

== on Failure ==

returns error

Trace: • Create/Edit Assistant • createAccount • Create Voucher • Remote Procedure Calls • Custom Templates (not for Default Free Service) • Walled Garden Options

Search

Navigation

Print/export

Tools

QR Code