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 |
getAutoReportShortEmailTemplateListtop
Description
Returns email templates for AutoReports
ShortEmailTemplateList getAutoReportShortEmailTemplateList(string $auto_report_area_type)
Parameters
| string | $auto_report_area_type | @see AutoReportService::getAreaTypes() |
Return Values
| ShortEmailTemplateList |
getLanguagestop
Description
StringList getLanguages()
Return Values
| StringList |
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 |
getTokentop
Description
Gets the session token. Can be used for single-sign-on.
string getToken()
Return Values
| string |
getTrackingSpotTagShortEmailTemplateListtop
Description
Returns email templates for TrackingSpot tag generation
ShortEmailTemplateList getTrackingSpotTagShortEmailTemplateList()
Return Values
| ShortEmailTemplateList |
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 |
ShortEmailTemplatetop
Definition
- - int $id
-
optional
- - string $name
-
required
- - string $description
-
optional
- - string $subject
-
required
- - string $language
-
required
- - string $body
-
required
- - string $replyTo
-
optional
- - boolean $sendBcc
-
required
When true, an bcc mail will always be sent to the replyTo address
ShortEmailTemplateListtop
Definition
StringListtop
Definition
- - Array <string> $strings
-
optional
The strings