Company Types

Company WSDL


This service is stateful.

Examples +

  • tagging
  • tagging
.

    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 Company

    int add()

    Return Values

    int The ID of the Company (unique)

    addAddresstop

    Description

    Adds an address to a company

    boolean addAddress(string $street, string $postalcode, string $city, int $country_id, string $type)

    Parameters

    string $street $street The Streetname including the house number
    string $postalcode $postalcode the postalcode
    string $city $city the city
    int $country_id $countryId the countrys id
    string $type $type the type id of the address

    Return Values

    boolean

    addMailtop

    Description

    Adds an email

    boolean addMail(string $email, string $type)

    Parameters

    string $email $email the email address
    string $type $type the type of the email address

    Return Values

    boolean

    addParentAgencytop

    Description

    Ads parent agency to company

    boolean addParentAgency(int $agency)

    Parameters

    int $agency

    Return Values

    boolean

    addPhonenumbertop

    Description

    Adds an phonenumber to a company

    boolean addPhonenumber(string $areacode, string $number, string $extension, int $country_id, string $type)

    Parameters

    string $areacode $areacode the areacode
    string $number $number the number
    string $extension $extension the number extension
    int $country_id $countryId the countrys id
    string $type $type the type of the address

    Return Values

    boolean

    assignTaggingPeculiaritytop

    Description

    Assign a tagging peculiarity to the company

    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 Company

    boolean edit()

    Return Values

    boolean TRUE on succes, FALSE on fail

    editAddresstop

    Description

    Updates an address of a company

    boolean editAddress(string $street, string $postalcode, string $city, int $country_id, string $type)

    Parameters

    string $street $street The Streetname including the house number
    string $postalcode $postalcode the postalcode
    string $city $city the city
    int $country_id $countryId the countrys id
    string $type $type the type id of the address

    Return Values

    boolean

    editMailtop

    Description

    Updates an email

    boolean editMail(string $email, string $type)

    Parameters

    string $email $email the email address
    string $type $type the type of the email address

    Return Values

    boolean

    editPhoneNumbertop

    Description

    Updates an phonenumber

    boolean editPhoneNumber(string $areacode, string $number, string $extension, int $country_id, string $type)

    Parameters

    string $areacode $areacode the areacode
    string $number $number the number
    string $extension $extension the number extension
    int $country_id $countryId the countrys id
    string $type $type the type of the address

    Return Values

    boolean

    getAddresstop

    Description

    Gets an address of a company

    string getAddress(string $type)

    Parameters

    string $type $type the type of the address

    Return Values

    string Data of the address

    getAgencytop

    Description

    Returns true if the company is flagged as an agency, false otherwise.

    boolean getAgency()

    Return Values

    boolean

    getAgencyClienttop

    Description

    GetAgencyClient

    boolean getAgencyClient()

    Return Values

    boolean

    getAllAddressestop

    Description

    Gets all addresses of a company

    string getAllAddresses()

    Return Values

    string All related addresses

    getAllMailAddressestop

    Description

    Gets all mails of

    string getAllMailAddresses()

    Return Values

    string of all mails

    getAllPhoneNumberstop

    Description

    Gets all phone numbers of a company

    string getAllPhoneNumbers()

    Return Values

    string of all phone numbers

    getAssignedTaggingPeculiaritiestop

    Description

    Gets the assigned tagging peculiarities

    string getAssignedTaggingPeculiarities()

    Return Values

    string

    getClienttop

    Description

    Returns true if the company is flagged as an client, false otherwise.

    boolean getClient()

    Return Values

    boolean

    getDsaBehalftop

    Description



    string getDsaBehalf()

    Return Values

    string

    getDsaPaidtop

    Description



    string getDsaPaid()

    Return Values

    string

    getEffectiveTaggingPeculiaritiestop

    Description

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

    string getEffectiveTaggingPeculiarities()

    Return Values

    string

    getExternalIdtop

    Description

    Gets the external ID of the company

    string getExternalId()

    Return Values

    string

    getIdtop

    Description

    GetId

    int getId()

    Return Values

    int

    getMailtop

    Description

    Gets mail by given type

    string getMail(string $type)

    Parameters

    string $type $type

    Return Values

    string Mail

    getNametop

    Description

    Gets the name of the company.

    string getName()

    Return Values

    string

    getNetworktop

    Description

    Returns the current network id

    int getNetwork()

    Return Values

    int Network ID

    getNetworkIdtop

    Description

    Gets the current network ID.

    int getNetworkId()

    Return Values

    int

    getOvkIdtop

    Description

    Gets the OVK-ID

    string getOvkId()

    Return Values

    string OVK-ID

    getParentAgenciestop

    Description

    Gets all the parent agencies of this company

    string getParentAgencies()

    Return Values

    string

    getPhoneNumbertop

    Description

    Gets a phonenumber

    string getPhoneNumber(string $type)

    Parameters

    string $type $type the type id of the phonnumber

    Return Values

    string with the data of the phonenumber

    getPostCodetop

    Description

    Returns the postCode for this object.
    Please refer to our customer wiki for more information about the inheritance logic.

    string getPostCode()

    Return Values

    string

    getPreCodetop

    Description

    Returns the preCode for this object.
    Please refer to our customer wiki for more information about the inheritance logic.

    string getPreCode()

    Return Values

    string

    getPublishertop

    Description

    Returns true if the company is flagged as an publisher, false otherwise.

    boolean getPublisher()

    Return Values

    boolean

    getRealTimeBiddingSettingstop

    Description



    RealTimeBiddingSettings getRealTimeBiddingSettings()

    Return Values

    RealTimeBiddingSettings

    getTokentop

    Description

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

    string getToken()

    Return Values

    string

    getUserIdtop

    Description

    Gets the current user ID.

    int getUserId()

    Return Values

    int

    hasPostCodetop

    Description

    Checks, whether postCode for this object is set or not.
    Please refer to our customer wiki for more information about the inheritance logic.

    boolean hasPostCode()

    Return Values

    boolean

    hasPreCodetop

    Description

    Checks, whether preCode for this object is set or not.
    Please refer to our customer wiki for more information about the inheritance logic.

    boolean hasPreCode()

    Return Values

    boolean

    hasTaggingBlockertop

    Description

    Determines whether the company has a tagging blocker

    boolean hasTaggingBlocker()

    Return Values

    boolean

    isTaggingPecuiliarityAssignedtop

    Description

    Determines whether the given tagging peculiarity is assigned to the company

    boolean isTaggingPecuiliarityAssigned(int $peculiarity)

    Parameters

    int $peculiarity The peculiarity

    Return Values

    boolean

    loadtop

    Description

    Load a Company

    boolean load(int $id)

    Parameters

    int $id The contentunit 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 the company

    boolean remove()

    Return Values

    boolean True on success, otherwise false

    removeAddresstop

    Description

    Removes an address from a company

    boolean removeAddress(string $type)

    Parameters

    string $type $type the type of the address

    Return Values

    boolean

    removeByIdtop

    Description

    Removes a CompanyModel with the given id

    boolean removeById(int $id)

    Parameters

    int $id ID of object to remove.

    Return Values

    boolean

    removeMailtop

    Description

    Removes an email

    boolean removeMail(string $type)

    Parameters

    string $type $type Type of email

    Return Values

    boolean

    removeParentAgencytop

    Description

    Removes parent agency from company

    boolean removeParentAgency(int $agency)

    Parameters

    int $agency

    Return Values

    boolean

    removePhoneNumbertop

    Description

    Removes a phonenumber

    boolean removePhoneNumber(string $type)

    Parameters

    string $type $type the type of the phonenumber

    Return Values

    boolean

    removePostCodetop

    Description

    Removes the postCode on this object. Has a direct impact on the banner preCode.
    Please refer to our customer wiki for more information about the inheritance logic.

    boolean removePostCode()

    Return Values

    boolean True on success, otherwise false

    removePreCodetop

    Description

    Removes the preCode on this object. Has a direct impact on the banner preCode.
    Please refer to our customer wiki for more information about the inheritance logic.

    boolean removePreCode()

    Return Values

    boolean True on success, otherwise false

    savetop

    Description

    Persists current object state

    boolean save()

    Return Values

    boolean True on success, otherwise false

    setAgencytop

    Description

    Sets a flag whether the company is an agency or not.

    boolean setAgency(boolean $agency)

    Parameters

    boolean $agency

    Return Values

    boolean

    setAgencyClienttop

    Description

    Sets a flag whether the company is an agency client or not.

    boolean setAgencyClient(boolean $agency_client)

    Parameters

    boolean $agency_client

    Return Values

    boolean

    setClienttop

    Description

    Toggles the client flag for the company (AgencyClient).

    boolean setClient(boolean $client)

    Parameters

    boolean $client

    Return Values

    boolean

    setDsaBehalftop

    Description



    boolean setDsaBehalf(string $value)

    Parameters

    string $value

    Return Values

    boolean

    setDsaPaidtop

    Description



    boolean setDsaPaid(string $value)

    Parameters

    string $value

    Return Values

    boolean

    setExternalIdtop

    Description

    Sets an external id for the company.

    boolean setExternalId(string $external_id)

    Parameters

    string $external_id

    Return Values

    boolean

    setNametop

    Description

    Sets a name for the the company.

    boolean setName(string $name)

    Parameters

    string $name

    Return Values

    boolean

    setOvkIdtop

    Description

    Sets the OVK-ID

    boolean setOvkId(string $ovk_id)

    Parameters

    string $ovk_id

    Return Values

    boolean Always true

    setPostCodetop

    Description

    Sets the postCode for this object. Has a direct impact on the banner preCode.
    Please refer to our customer wiki for more information about the inheritance logic.

    boolean setPostCode(string $code)

    Parameters

    string $code PostCode, Maximum length is: 64000 characters

    Return Values

    boolean

    setPreCodetop

    Description

    Sets the preCode for this object. Has a direct impact on the banner preCode.
    Please refer to our customer wiki for more information about the inheritance logic.

    boolean setPreCode(string $code)

    Parameters

    string $code PreCode, Maximum length is: 64000 characters

    Return Values

    boolean

    setPublishertop

    Description

    Toggles the company as publisher/website.

    boolean setPublisher(boolean $publisher)

    Parameters

    boolean $publisher

    Return Values

    boolean

    setRealTimeBiddingSettingstop

    Description



    boolean setRealTimeBiddingSettings(RealTimeBiddingSettings $rtb_settings)

    Parameters

    RealTimeBiddingSettings $rtb_settings

    Return Values

    boolean True on success, otherwise false

    setTaggingBlockertop

    Description

    Sets tagging blocker on the company

    boolean setTaggingBlocker()

    Return Values

    boolean

    unassignTaggingPeculiaritytop

    Description

    Unassign a tagging peculiarity from a the company

    boolean unassignTaggingPeculiarity(int $peculiarity)

    Parameters

    int $peculiarity The peculiarity

    Return Values

    boolean

    unsetTaggingBlockertop

    Description

    Unset tagging blocker from the company

    boolean unsetTaggingBlocker()

    Return Values

    boolean

    validatetop

    Description

    Validates the object and returns an error stack.

    string validate()

    Return Values

    string

    RealTimeBiddingSettingstop

    Definition

    object RealTimeBiddingSettings {
    - string $advertiserDomain

    required

    }

    Console