Trackingspot WSDL
Model of the adition trackingspots (countingspots)This 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 Trackingspot
int add()
Return Values
| int | The ID of the Trackingspot (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 Trackingspot
boolean edit()
Return Values
| boolean | TRUE on succes, FALSE on fail |
enableTcfParameterstop
Description
Enables TCF (GDPR) parameters for subsequent requests.
boolean enableTcfParameters()
Return Values
| boolean | True on success, otherwise false |
getContainerTagtop
Description
Returns the container tag flag
boolean getContainerTag()
Return Values
| boolean | $containertag |
getIdtop
Description
Returns the trackingspot id
int getId()
Return Values
| int | $id |
getLandingpageIdtop
Description
Returns the landingpage id
int getLandingpageId()
Return Values
| int | $landingpageId |
getNametop
Description
Returns the trackingspot name
string getName()
Return Values
| string | $name |
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 |
getOrdertop
Description
Returns the order of the trackingspots
int getOrder()
Return Values
| int | $order |
getSpotCodetop
Description
Returns the spot code of the trackingspot
string getSpotCode()
Return Values
| string |
getSsltop
Description
Returns the ssl flag
boolean getSsl()
Return Values
| boolean | $ssl |
getSuccesstop
Description
Returns the success flag
boolean getSuccess()
Return Values
| boolean | $success |
getTokentop
Description
Gets the session token. Can be used for single-sign-on.
string getToken()
Return Values
| string |
loadtop
Description
Loads a trackingspot by its id
boolean load(int $id)
Parameters
| int | $id |
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 a trackingspot
Sets the deleted flag to now
boolean remove()
Return Values
| boolean |
removeByIdtop
Description
Removes a TrackingspotModel with the given id
boolean removeById(int $id)
Parameters
| int | $id | ID of object to remove. |
Return Values
| boolean |
savetop
Description
Persists current object state
boolean save()
Return Values
| boolean | True on success, otherwise false |
setContainerTagtop
Description
Sets the container tag flag
boolean setContainerTag(boolean $containertag)
Parameters
| boolean | $containertag |
Return Values
| boolean | Returns TRUE on success or FALSE on failure. |
setLandingpageIdtop
Description
Sets the landingpage id
boolean setLandingpageId(int $landingpage_id)
Parameters
| int | $landingpage_id |
Return Values
| boolean | Returns TRUE on success or FALSE on failure. |
setNametop
Description
Sets the trackingspot name
boolean setName(string $name)
Parameters
| string | $name |
Return Values
| boolean | Returns TRUE on success or FALSE on failure. |
setOrdertop
Description
Sets the order
boolean setOrder(int $order)
Parameters
| int | $order |
Return Values
| boolean | Returns TRUE on success or FALSE on failure. |
setSsltop
Description
Sets the ssl flag
boolean setSsl(boolean $ssl)
Parameters
| boolean | $ssl |
Return Values
| boolean | Returns TRUE on success or FALSE on failure. |
setSuccesstop
Description
Sets the succes flag
boolean setSuccess(boolean $success)
Parameters
| boolean | $success |
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 |