doComplexCalltop
Description
Execute a complex call.
For further information read the API-User documentation.
string doComplexCall(string $xmlstr)
Parameters
| string | $xmlstr | XML of Complex Statements |
Return Values
| string | The output produced by the statements |
getNetworktop
Description
Returns the current network id
int getNetwork()
Return Values
| int | Network ID |
getNetworkIdtop
Deprecated 2011-01-01
This method will be removed in upcoming releases.
Description
Returns the current network id. Alias for getNetwork()
int getNetworkId()
Return Values
| int | Network ID |
getShortUserInfoListtop
Description
Returns list of short user infos.
Requires admin rights.
ShortUserInfoList getShortUserInfoList()
Return Values
| ShortUserInfoList |
getTokentop
Description
Gets the session token. Can be used for single-sign-on.
string getToken()
Return Values
| string |
getUserIdsForGroupIdtop
Description
Returns ids of users for a given group
IntegerList getUserIdsForGroupId(int $group_id)
Parameters
| int | $group_id |
Return Values
| IntegerList |
logintop
Description
Initializes a new session with given information
boolean login(string $user, string $pass, int $network)
Parameters
| string | $user | Username |
| string | $pass | Password |
| int | $network | $network Network ID |
Return Values
| boolean | true on success, false on fail |
loginSmartPhonetop
Deprecated 2014-12-22
This method will be removed in upcoming releases.
Was only useful for the mobile app, which is not supported anymore.
Description
Login method
boolean loginSmartPhone(string $user, string $pass, int $network, string $client)
Parameters
| string | $user | Username |
| string | $pass | Password |
| int | $network | $network Network ID |
| string | $client | Client token e.g. "apn" token of iPhone |
Return Values
| boolean | TRUE on success, FALSE on fail |
logouttop
Description
Destroys the active session, logging out the user.
boolean logout()
Return Values
| boolean | true on success, false on fail |
IntegerListtop
Definition
IntegerList for SoapServices.
You may want to use this to pass a list of integers (e.g. ids) as
parameter in you soap service.
- - Array <int> $integers
-
optional
The integers
ShortUserInfotop
Definition
- - int $id
-
required
- - string $firstName
-
required
- - string $lastName
-
required
- - boolean $active
-
optional