BannerpoolService Types

BannerpoolService WSDL

SOAP interface for bannerpool
This service is stateless.

getByCompanyIdtop

Description

Returns a list of all bannerpools for given company.

BannerpoolList getByCompanyId(int $company_id)

Parameters

int $company_id

Return Values

BannerpoolList

getByCurrentNetworktop

Description

Returns a list of all bannerpools for the network
WARNING: Requires administrator rights.

BannerpoolList getByCurrentNetwork()

Return Values

BannerpoolList

getByIdstop

Description

Gets bannerpools for given IDs.

BannerpoolList getByIds(IntegerList $ids)

Parameters

IntegerList $ids

Return Values

BannerpoolList

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

logouttop

Description

Destroys the active session, logging out the user.

boolean logout()

Return Values

boolean true on success, false on fail

removetop

Description



boolean remove(int $id)

Parameters

int $id

Return Values

boolean

savetop

Description



int save(Bannerpool $bannerpool)

Parameters

Bannerpool $bannerpool Object holding the bannerpool values.

Return Values

int The id.

Bannerpooltop

Definition

Container object for bannerpool information.
WARNING: The bannerIds property of the complex type is read only (setting it would have no effect).
Use the banner service to add banners to the bannerpool.

object Bannerpool {
- int $id

optional

- int $companyId

required

- string $name

required

- boolean $active

required

- Array <int> $bannerIds

optional

See: Banner

}

BannerpoolListtop

Definition

A list containing bannerpools.

object BannerpoolList {
- Array <Bannerpool> $bannerpools

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

}

ValidationErrorMessagetop

Definition

object ValidationErrorMessage {
- string $identifier

required

- Array <string> $messages

required

}

ValidationErrorMessageListtop

Definition

object ValidationErrorMessageList {
- Array <ValidationErrorMessage> $messages

optional

}

Console