Website Types

Website WSDL

A website model
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 Website

int add()

Return Values

int The ID of the Website (unique)

addFoldertop

Description

Adds the website to a folder

boolean addFolder(int $folder)

Parameters

int $folder

Return Values

boolean True if the folder was not already assigned, false otherwise

assignTaggingPeculiaritytop

Description

Assign a tagging peculiarity to the website

boolean assignTaggingPeculiarity(int $peculiarity)

Parameters

int $peculiarity The peculiarity

Return Values

boolean

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 Website

boolean edit()

Return Values

boolean TRUE on succes, FALSE on fail

getAssignedTaggingPeculiaritiestop

Description

Gets the assigned tagging peculiarities

string getAssignedTaggingPeculiarities()

Return Values

string

getCompanytop

Description

Returns the publisher company that owns the website

int getCompany()

Return Values

int

getEffectiveTaggingPeculiaritiestop

Description

Gets the effective assigned tagging peculiarities (active, also inherited)

string getEffectiveTaggingPeculiarities()

Return Values

string

getExternalIdtop

Description



string getExternalId()

Return Values

string

getIdtop

Description



int getId()

Return Values

int

getNametop

Description



string getName()

Return Values

string

getNetworktop

Description

Returns the current network id

int getNetwork()

Return Values

int Network ID

getNetworkIdtop

Description



int getNetworkId()

Return Values

int

getTokentop

Description

Gets the session token. Can be used for single-sign-on.

string getToken()

Return Values

string

getUpdatedAttop

Description



string getUpdatedAt()

Return Values

string

getUrltop

Description



string getUrl()

Return Values

string

getUserIdtop

Description



int getUserId()

Return Values

int

hasTaggingBlockertop

Description

Determines whether the website has a tagging blocker

boolean hasTaggingBlocker()

Return Values

boolean

isTaggingPecuiliarityAssignedtop

Description

Determines whether the given tagging peculiarity is assigned to the website

boolean isTaggingPecuiliarityAssigned(int $peculiarity)

Parameters

int $peculiarity The peculiarity

Return Values

boolean

loadtop

Description

Loads a website

boolean load(int $id)

Parameters

int $id The website id to load

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

Delete a website

boolean remove()

Return Values

boolean Returns TRUE on success FALSE on failure.

removeByIdtop

Description

Removes a WebsiteModel with the given id

boolean removeById(int $id)

Parameters

int $id ID of object to remove.

Return Values

boolean

removeFoldertop

Description

Removes the website from a folder

boolean removeFolder(int $folder)

Parameters

int $folder

Return Values

boolean True if the folder was assigned, false otherwise

savetop

Description

Persists current object state

boolean save()

Return Values

boolean

searchInWebsiteTreetop

Description

Search in the website tree this will include website,contentunitgroup and contentunit

string searchInWebsiteTree(string $search_string, int $limit, int $offset)

Parameters

string $search_string $searchString
int $limit
int $offset

Return Values

string

setCompanytop

Description

Sets the publisher company that owns the website.

boolean setCompany(int $company)

Parameters

int $company

Return Values

boolean

setExternalIdtop

Description



boolean setExternalId(string $external_id)

Parameters

string $external_id

Return Values

boolean

setNametop

Description

The name for the current website

boolean setName(string $name)

Parameters

string $name

Return Values

boolean

setTaggingBlockertop

Description

Sets tagging blocker on the website

boolean setTaggingBlocker()

Return Values

boolean

setUrltop

Description

The url for the current website

boolean setUrl(string $url)

Parameters

string $url

Return Values

boolean

unassignTaggingPeculiaritytop

Description

Unassign a tagging peculiarity from a the website

boolean unassignTaggingPeculiarity(int $peculiarity)

Parameters

int $peculiarity The peculiarity

Return Values

boolean

unsetTaggingBlockertop

Description

Unset tagging blocker from the website

boolean unsetTaggingBlocker()

Return Values

boolean

validatetop

Description

Validates the object and returns an error stack.

string validate()

Return Values

string

Console