FlashFilter WSDL
A FlashFilter modelThis service is stateful.Flash no longer supported by the browsers.
Examples +
- create
- create
- edit
- edit
- delete
- delete
- create inventoried
- create inventoried
- create subfilter
- create subfilter
addtop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Saves changes made to the FlashFilter
int add()
Return Values
| int | The ID of the FlashFilter (unique) |
addFilterClusterGrouptop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Add to filter cluster group
boolean addFilterClusterGroup(int $filter_cluster_group)
Parameters
| int | $filter_cluster_group |
Return Values
| boolean |
addParenttop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Add a parent
boolean addParent(string $parent_type, int $parent_id)
Parameters
| string | $parent_type | $parentType |
| int | $parent_id |
Return Values
| boolean |
addVersiontop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Add a flash version to the current filter
boolean addVersion(int $version)
Parameters
| int | $version |
Return Values
| boolean |
clearObjectDatatop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Clears the current object state.
This method will unload possibly loaded objects. Unsaved changes will be lost.
boolean clearObjectData()
Return Values
| boolean |
doComplexCalltop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
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 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Saves changes made to the FlashFilter
boolean edit()
Return Values
| boolean | TRUE on succes, FALSE on fail |
getAllFlashVersionstop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Returns all flashversions added to the current filter
string getAllFlashVersions()
Return Values
| string |
getDescriptiontop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Get filter description
Applies to inventoried and sub-filters
string getDescription()
Return Values
| string |
getFilterClusterGroupIdstop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Get filter cluster group ids
string getFilterClusterGroupIds()
Return Values
| string |
getIdtop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Get id
int getId()
Return Values
| int | $id |
getNametop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Get filter name
Applies to inventoried and sub-filters
string getName()
Return Values
| string |
getNetworktop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Returns the current network id
int getNetwork()
Return Values
| int | Network ID |
getNetworkIdtop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Returns the current network id. Alias for getNetwork()
int getNetworkId()
Return Values
| int | Network ID |
getParentstop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Gets the filter parents
For multiple parents:
{
"campaign" : [1, 2, .., N],
"banner" : [1, 2, .., N]
}
For no parents:
{
"<orphan>" : [0]
}
For single filter parent (current filter must be a sub-filter):
{
"<filter>" : [N]
}
string getParents()
Return Values
| string |
getPeriodtop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Get period for the limit (e.g. hourly, daily, weeky, monthly)
string getPeriod()
Return Values
| string |
getSummarytop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Get a textual summary for a loaded Filter
string getSummary()
Return Values
| string |
getTokentop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Gets the session token. Can be used for single-sign-on.
string getToken()
Return Values
| string |
getTypetop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Get type
string getType()
Return Values
| string | $type |
getValidParentTypestop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Get list of valid parent types
string getValidParentTypes()
Return Values
| string |
hasMultipleParentstop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Determines, whether the filter has multiple parents
boolean hasMultipleParents()
Return Values
| boolean |
hasParentstop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Determines, whether the filter has parents
boolean hasParents()
Return Values
| boolean |
isInventoriedtop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Determines, whether the filter is inventoried.
boolean isInventoried()
Return Values
| boolean |
isInvertedtop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Get inverted flag
boolean isInverted()
Return Values
| boolean |
isSubFiltertop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Determines, whether the filter is a sub-filter, a non-inventoried filter
which may be referenced in another filter specified by his parent
boolean isSubFilter()
Return Values
| boolean |
isVisibletop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Determines, whether the filter is visible
and can be therefore assigned to other objects,
i.e. referenced in the code of a TagFilter.
boolean isVisible()
Return Values
| boolean |
loadtop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Load a filter by its ID
boolean load(int $id)
Parameters
| int | $id | The id of the filter to load |
Return Values
| boolean | True on success, otherwise false |
logintop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
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 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
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
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Destroys the active session, logging out the user.
boolean logout()
Return Values
| boolean | true on success, false on fail |
removetop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Remove filter
boolean remove()
Return Values
| boolean | True on success, otherwise false |
removeByIdtop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Removes a FlashFilterFilterModel with the given id
boolean removeById(int $id)
Parameters
| int | $id | ID of object to remove. |
Return Values
| boolean |
removeFilterClusterGrouptop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Remove from filter cluster group
boolean removeFilterClusterGroup(int $filter_cluster_group)
Parameters
| int | $filter_cluster_group |
Return Values
| boolean |
removeParenttop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Remove a parent
boolean removeParent(string $parent_type, int $parent_id)
Parameters
| string | $parent_type | $parentType |
| int | $parent_id |
Return Values
| boolean |
removeVersiontop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Remove a flash version from the current filter
boolean removeVersion(int $version)
Parameters
| int | $version |
Return Values
| boolean |
savetop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Persists current object state
boolean save()
Return Values
| boolean | True on success, otherwise false |
setDescriptiontop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Set filter description
Applies to inventoried and sub-filters
boolean setDescription(string $description)
Parameters
| string | $description |
Return Values
| boolean |
setInventoriedtop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Set the inventoried flag.
If true, the filter will be available in the network-wide inventory under an unique name.
Once a filter has been inventoried and saved, the inventoried flag cannot be changed.
boolean setInventoried(boolean $inventoried)
Parameters
| boolean | $inventoried |
Return Values
| boolean |
setInvertedtop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Inverts the current filter, i.e. everywhere but NOT in ...
boolean setInverted(boolean $inverted)
Parameters
| boolean | $inverted |
Return Values
| boolean |
setNametop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Set filter name
Applies to inventoried and sub-filters
boolean setName(string $name)
Parameters
| string | $name |
Return Values
| boolean |
setVisibletop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Set visibility
Applies to inventoried and sub-filters
boolean setVisible(boolean $visible)
Parameters
| boolean | $visible |
Return Values
| boolean |
validatetop
Deprecated 2025-02-10
This method will be removed in upcoming releases.
Flash no longer supported by the browsers.
Description
Validates the object and returns an error stack.
string validate()
Return Values
| string |