TrackingspotService Types

TrackingspotService WSDL

Class TrackingspotService
This service is stateless.

addExternalSpotstop

Description



IntegerList addExternalSpots(TrackingSpot $tracking_spot)

Parameters

TrackingSpot $tracking_spot

Return Values

IntegerList

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

generateWebsiteTagtop

Description



string generateWebsiteTag(TrackingSpot $tracking_spot)

Parameters

TrackingSpot $tracking_spot

Return Values

string

getCompanyListtop

Description



IntegerList getCompanyList(int $trackingspot_id)

Parameters

int $trackingspot_id

Return Values

IntegerList

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

getTrackingSpottop

Description



TrackingSpot getTrackingSpot(int $tracking_spot_id)

Parameters

int $tracking_spot_id

Return Values

TrackingSpot

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

removeExternalSpotstop

Description



boolean removeExternalSpots(int $tracking_spot_id, IntegerList $external_spot_ids)

Parameters

int $tracking_spot_id
IntegerList $external_spot_ids

Return Values

boolean

sendTrackingspotTagstop

Description



EmailInfoResult sendTrackingspotTags(TrackingSpot $tracking_spot, EmailInfo $email_info)

Parameters

TrackingSpot $tracking_spot
EmailInfo $email_info

Return Values

EmailInfoResult

EmailInfotop

Definition

object EmailInfo {
- ShortEmailTemplate $emailTemplate

optional

See: EmailTemplateService

- Array <int> $recipientContactIds

optional

See: ContactService

- Array <int> $recipientUserIds

optional

See: UserService

- EmailRecipientList $recipientEmails

optional

}

EmailInfoResulttop

Definition

object EmailInfoResult {
- Array <int> $failedContactIds

optional

- Array <int> $failedUserIds

optional

- Array <string> $failedEmails

optional

}

EmailRecipienttop

Definition

object EmailRecipient {
- string $emailAddress

required

- string $firstName

required

- string $lastName

required

}

EmailRecipientListtop

Definition

object EmailRecipientList {
- EmailRecipient $emailAddresses

required

}

ExternalSubSpottop

Definition

object ExternalSubSpot {
- int $id

optional

- int $companyId

required

If companyId has value 0, the external spot will be assigned to the default-partner

- string $nonSslCode

required

- string $name

required

- boolean $active

required

}

ExternalSubSpotListtop

Definition

object ExternalSubSpotList {
- Array <ExternalSubSpot> $externalSubSpots

optional

}

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.

object IntegerList {
- Array <int> $integers

optional

The integers

}

ShortEmailTemplatetop

Definition

object ShortEmailTemplate {
- 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

}

TrackingSpottop

Definition

object TrackingSpot {
- int $id

required

- int $landingpageId

required

- string $name

required

- boolean $success

required

- boolean $containertag

required

- boolean $ssl

required

- int $order

optional

- ExternalSubSpotList $externalSubSpots

optional

- TrackingSpotWebsiteTag $trackingSpotWebsiteTag

optional

- boolean $withTcfParameters

optional

Enables TCF (GDPR) parameters when retrieving tags from the service.

It must be explicitly set to true when retrieving the tags in order to use TCF (GDPR) parameters, otherwise the default behavior ignores these parameters. This value is not persisted, this means it needs to be set on request time, based on the use-case.

}

TrackingSpotWebsiteTagtop

Definition

object TrackingSpotWebsiteTag {
- string $tagType

required

- string $code

optional

- string $extraParameters

optional

- string $sortCriteria

optional

- string $sortDirection

optional

}

Console