Landingpage WSDL
Model of the adition landingpagesThis service is stateful.
addtop
Deprecated 2011-01-01
This method will be removed in upcoming releases.
Use save() to persist a new entity
Description
Saves changes made to the Landingpage
int add()
Return Values
| int | The ID of the Landingpage (unique) |
clearObjectDatatop
Description
Clears the current object state.
This method will unload possibly loaded objects. Unsaved changes will be lost.
boolean clearObjectData()
Return Values
| boolean |
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 |
edittop
Deprecated 2011-01-01
This method will be removed in upcoming releases.
Use save() to persist changes made to an entity
Description
Saves changes made to the Landingpage
boolean edit()
Return Values
| boolean | TRUE on succes, FALSE on fail |
getByCampaignIdstop
Description
Returns landingpage ids by campaign ids
string getByCampaignIds(string $campaign_ids)
Parameters
| string | $campaign_ids | String of campaign ids |
Return Values
| string | $landingpageIds |
getByCompanyIdstop
Description
Returns landingpage ids by campaign ids
string getByCompanyIds(string $company_ids)
Parameters
| string | $company_ids | String of campaign ids |
Return Values
| string | $landingpageIds |
getCompanytop
Description
Returns the company model
int getCompany()
Return Values
| int |
getCompanyIdtop
Description
Returns the company id of the landingpage
int getCompanyId()
Return Values
| int | $comapnyId |
getIdtop
Description
Returns the landingpage id
int getId()
Return Values
| int | $id |
getNametop
Description
Returns the landingpage name
string getName()
Return Values
| string | $name |
getNetworktop
Description
Returns the current network id
int getNetwork()
Return Values
| int | Network ID |
getNetworkIdtop
Description
Returns the network id
int getNetworkId()
Return Values
| int | $networkId |
getOrdertop
Description
Returns the landingpage order
int getOrder()
Return Values
| int | $order |
getTokentop
Description
Gets the session token. Can be used for single-sign-on.
string getToken()
Return Values
| string |
getTrackingParamNamestop
Description
Returns the parameter names
string getTrackingParamNames()
Return Values
| string | $paramNames |
getTrackingSpotstop
Description
Returns the trackingspots by this landingpage id
string getTrackingSpots()
Return Values
| string |
isAutoLinkOnCampaignCreationtop
Description
Tells whether the landingpage is marked as auto-linkable on campaign creation or not.
boolean isAutoLinkOnCampaignCreation()
Return Values
| boolean |
loadtop
Description
Loads a landingpage
boolean load(int $identifier)
Parameters
| int | $identifier |
Return Values
| boolean | True on success, otherwise false |
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 |
removetop
Description
Removes the landingpage
boolean remove()
Return Values
| boolean |
removeByIdtop
Description
Removes a LandingpageModel with the given id
boolean removeById(int $id)
Parameters
| int | $id | ID of object to remove. |
Return Values
| boolean |
savetop
Description
Save the landingpage
boolean save()
Return Values
| boolean | True on success, otherwise false |
setAutoLinkOnCampaignCreationtop
Description
Marks the landingpage as auto-linkable to newly created campaigns or not.
By default, landing pages are not linked to new campaigns on creation and the user explicitly needs to call
Campaign::addLandingPage(). When a landing page is marked as auto-linkable, it will be automatically
linked to newly created campaigns.
boolean setAutoLinkOnCampaignCreation(boolean $flag)
Parameters
| boolean | $flag |
Return Values
| boolean |
setCompanyIdtop
Description
Sets the company id
boolean setCompanyId(int $company_id)
Parameters
| int | $company_id | Id of the company |
Return Values
| boolean | Returns TRUE on success or FALSE on failure. |
setCountingspotOrdertop
Description
Sets the countingspot order
boolean setCountingspotOrder(int $landingpage_id, int $countingspot_id)
Parameters
| int | $landingpage_id | |
| int | $countingspot_id |
Return Values
| boolean |
setNametop
Description
Sets the landingpage name
boolean setName(string $name)
Parameters
| string | $name | The landingpage name |
Return Values
| boolean | Returns TRUE on success or FALSE on failure. |
setOrdertop
Description
Sets the order of the landingpage
boolean setOrder(int $order)
Parameters
| int | $order |
Return Values
| boolean | Returns TRUE on success or FALSE on failure. |
setTrackingParamNametop
Description
Sets the order of the landingpage
boolean setTrackingParamName(string $name, string $value)
Parameters
| string | $name | The paramater name |
| string | $value | The paramater value |
Return Values
| boolean | Returns TRUE on success or FALSE on failure. |
validatetop
Description
Validates the object and returns an error stack.
string validate()
Return Values
| string |