Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
en:syces:api_hidden:rpcs [2015/08/25 07:54] co |
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 | + | returns |
| == 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 | + | returns |
| == on Failure == | == on Failure == | ||
| Line 38: | Line 36: | ||
| === Parameter === | === Parameter === | ||
| == required == | == required == | ||
| - | * session_id | + | * token as provided by authenticate-method |
| == optional == | == optional == | ||
| + | data { | ||
| * username (String(50))\\ | * username (String(50))\\ | ||
| Line 62: | 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 77: | Line 76: | ||
| === Parameter === | === Parameter === | ||
| == required == | == required == | ||
| - | * session_id | + | * token as provided by authenticate-method |
| * username | * username | ||
| == on Success == | == on Success == | ||
| - | returns deleted: True or False | + | returns deleted: True |
| == on Failure == | == on Failure == | ||
| returns error | returns error | ||
| Line 115: | 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 121: | Line 145: | ||
| === Parameter === | === Parameter === | ||
| == required == | == required == | ||
| - | * session_id | + | * token as provided by authenticate-method |
| - | * location_id (0 = all locations) | + | |
| == optional == | == optional == | ||
| - | options array ( | + | * location_id |
| - | * tariff_id | + | |
| - | * valid_days_from_creation | + | == on Success == |
| + | returns default values | ||
| + | ( | ||
| * realm | * realm | ||
| * password_length | * password_length | ||
| * password_type (number, letters, alphanumeric, | * password_type (number, letters, alphanumeric, | ||
| + | * 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 | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ===== 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 ===== | ===== getTariffDetails ===== | ||
| get all or specific default values | get all or specific default values | ||
| + | |||
| === Parameter === | === Parameter === | ||
| == required == | == required == | ||
| - | * session_id | + | * token as provided by authenticate-method |
| - | * tariff_id or tariff_name | + | * (TODO: |
| + | * tariff_name | ||
| == on Success == | == on Success == | ||
| - | + | returns tariff_id | |
| - | returns tariff properties | + | TODO: returns tariff properties |
| == on Failure == | == on Failure == | ||
| returns error | returns error | ||
| + | |||
| ===== logout ===== | ===== logout ===== | ||
| - | logout and set the sessionid to invalid | + | logout and delete token |
| === Parameter === | === Parameter === | ||
| == required == | == required == | ||
| - | * session_id | + | * token |
| == on Success == | == on Success == | ||
| Line 175: | Line 242: | ||
| === Parameter === | === Parameter === | ||
| == required == | == required == | ||
| - | * session_id | + | * token as provided by authenticate-method |
| * username | * username | ||
| Line 181: | Line 248: | ||
| returns online: 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 == | ||
| returns error | returns error | ||
| + | |||
| + | |||
| Line 192: | Line 279: | ||
| === Parameter === | === Parameter === | ||
| == required == | == required == | ||
| - | * session_id | + | * token as provided by authenticate-method |
| - | * location_id (0 for all locations) | + | |
| == optional == | == optional == | ||
| + | * location_id (0 for all locations) | ||
| + | data { | ||
| * tariff_id | * tariff_id | ||
| - | * valid_days | + | * username_type |
| + | } | ||
| == on Success == | == on Success == | ||
| returns array of default values | returns array of default values | ||
| + | |||
| + | options array ( | ||
| + | * realm | ||
| + | * password_length | ||
| + | * password_type (number, letters, alphanumeric, | ||
| + | * valid_days | ||
| + | * tariff_id | ||
| + | * username_type (default for empty usernames: numeric or dateTime) | ||
| + | |||
| + | ) | ||
| + | |||
| == on Failure == | == on Failure == | ||
