UserGroupService Types

UserGroupService WSDL


This service is stateless.

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

getShortUserGroupInfoListtop

Description

Returns list of short user group infos.
Requires admin rights.

ShortUserGroupInfoList getShortUserGroupInfoList()

Return Values

ShortUserGroupInfoList

getTokentop

Description

Gets the session token. Can be used for single-sign-on.

string getToken()

Return Values

string

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

ShortUserGroupInfotop

Definition

object ShortUserGroupInfo {
- int $id

required

- string $name

required

}

ShortUserGroupInfoListtop

Definition

object ShortUserGroupInfoList {
- Array <ShortUserGroupInfo> $shortUserGroupInfos

optional

}

Console