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 [2016/08/23 12:20] co |
en:syces:api_hidden:rpcs [2016/09/21 12:38] (current) co |
||
---|---|---|---|
Line 146: | Line 146: | ||
== required == | == required == | ||
* token as provided by authenticate-method | * 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 == | ||
- | return all or requested default values | + | returns logo |
== 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 | ||
+ | |||
+ | |||
Line 167: | Line 205: | ||
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 == | ||
- | returns tariff properties | + | == on Success == |
+ | returns tariff_id | ||
+ | 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 200: | Line 242: | ||
=== Parameter === | === Parameter === | ||
== required == | == required == | ||
- | * session_id | + | * token as provided by authenticate-method |
* username | * username | ||
Line 206: | 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 217: | 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 == |