Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
en:syces:api_hidden:rpcs [2015/08/11 08:35]
bb 		en:syces:api_hidden:rpcs [2016/09/21 12:38] (current)
co
Line 1: Line 1:
 ====== Remote Procedure Calls ====== ====== Remote Procedure Calls ======
-===== authenticateByClientId ===== +===== authenticateById ===== 
-creates valid sessionid, if user credentials are valid \\ +creates valid token, if user credentials are valid \\
-api_key is built with following rule: hash[hash[api_key]+id]+
  
 === Parameter === === Parameter ===
Line 10: Line 9:
 == on Success == == on Success ==
  
-returns sessionid+returns token
  
 == on Failure == == on Failure ==
Line 17: Line 16:
  
 ===== authenticateByRealm ===== ===== authenticateByRealm =====
-creates valid sessionid, if user credentials are valid \\ +creates valid token, if user credentials are valid \\
-api_key is built with following rule: hash[hash[api_key]+id]+
  
 === Parameter === === Parameter ===
Line 26: Line 24:
 == on Success == == on Success ==
  
-returns sessionid+returns token
  
 == on Failure == == on Failure ==
  
 returns error returns error
-===== logout ===== 
-logout and set the sessionid to invalid 
- 
-=== Parameter === 
-== required == 
-  * sessionid 
-== on Success == 
- 
-returns ok 
- 
-== on Failure == 
- 
-returns error 
- 
  
  
Line 52: Line 36:
 === Parameter === === Parameter ===
 == required == == required ==
-* sessionid as provided by authenticate-method+  * token as provided by authenticate-method
 == optional == == optional ==
 +data {
   * username (String(50))\\   * username (String(50))\\
  
Line 76: Line 61:
   * additional_info (String(100))   * additional_info (String(100))
   * allowed_locations (array of location ids)   * allowed_locations (array of location ids)
 +}
 == on Success == == on Success ==
  
-returns username, password+returns username, password, account_id
  
 == on Failure == == on Failure ==
Line 91: Line 76:
 === Parameter === === Parameter ===
 == required ==  == required == 
-  * sessionid as provided by authenticate-method+  * token as provided by authenticate-method
   * username   * username
  
 == on Success == == on Success ==
-returns true+returns deleted: True
 == on Failure == == on Failure ==
 returns error returns error
Line 104: Line 89:
 === Parameter === === Parameter ===
 == required == == required ==
-  * sessionid as provided by authenticate-method+  * session_id as provided by authenticate-method
   * username   * username
  
Line 129: Line 114:
  
 returns error 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 ===== ===== getDefaults =====
Line 135: Line 145:
 === Parameter === === Parameter ===
 == required == == required ==
-  * sessionid as provided by authenticate-method +  * token as provided by authenticate-method 
-  * location_id (0 = all locations)+
 == optional == == optional ==
-options array ( +  * location_id (0 = all locations) 
-  * tariff_id + 
-  * valid_days_from_creation+== on Success == 
 +returns default values 
 +(
   * realm   * realm
   * password_length   * password_length
   * password_type (number, letters, alphanumeric, mixed)   * 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 == == on Success ==
 +returns logo
  
-returns all or requested default values 
 == on Failure == == on Failure ==
  
 returns error returns error
  
-===== getTariffDetails ===== 
  
-get all or specific default values+ 
 + 
 + 
 +===== getNote ===== 
 +get note to be printed on ticket before user credentials  
 === Parameter === === Parameter ===
 == required == == required ==
-  * sessionid as provided by authenticate-method +  * token as provided by authenticate-method 
-  * tariff_id or tariff_name+  
  
 == on Success == == on Success ==
- +returns note
-returns tariff properties+
  
 == on Failure == == on Failure ==
Line 169: Line 199:
 returns error returns error
  
-===== setDefaults ===== 
  
-set specific default values+ 
 + 
 +===== getTariffDetails ===== 
 + 
 +get all or specific default values 
 === Parameter === === Parameter ===
 == required == == required ==
-  * sessionid as provided by authenticate-method +  * token as provided by authenticate-method 
-  * location_id (for all locations)+  * (TODO: tariff_id or) 
 +  * tariff_name
  
-== optional == 
-  * tariff_id  
-  * valid_days_from_creation (0 = unlimited, maximum 365)  
  
 == on Success == == on Success ==
 +returns tariff_id
 +TODO: returns tariff properties
  
-returns array of default values+== on Failure == 
 + 
 +returns error 
 + 
 + 
 +===== logout ===== 
 +logout and delete token 
 + 
 +=== Parameter === 
 +== required == 
 +  * token 
 +== on Success == 
 + 
 +returns logout: True or False
  
 == on Failure == == on Failure ==
Line 195: Line 242:
 === Parameter === === Parameter ===
 == required == == required ==
-  * sessionid as provided by authenticate-method+  * token as provided by authenticate-method
   * username   * username
  
 == on Success == == on Success ==
  
-returns True or False+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 == == on Failure ==
Line 209: Line 274:
  
  
 +===== 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
  
  

Trace:

QR Code
QR Code Remote Procedure Calls (generated for current page)