Service Provider API GetDomainSetup

Synopsis
public array GetDomainSetup( array $domainlist )
Description

Used to get domain specific settings.

Notice: The function will always return actual effective settings. If a null value comes back, it means it was never set and a fallback to a standard value is used.
SOAP
This function can be called using SOAP.
Parameters
Type Parameter Mandatory Description
integer $partnerid yes Partner ID.
string $signkey yes Sign key.
string $username yes User name. (max. 25 characters)
string $password yes Password. (max. 16 characters)
array $domainlist no Array of domains. If not specified, the setups for all domains in the customer account are returned.
integer $startFrom no Offset to start from.
integer $results no Maximum number of results to be returned. (max. 100 per request)
Returns
Type Description
array

The return value contains the following elements:

Type Key Description
string domainName Domain name in ACE format.
string nameLanguage ISO-639 two-letter language codes. (i.e. de=German, en=English ...)
string relatedLinks deprecated Show related links. (Y or N)
string searchBox Show search box. (Y or N)
string disclaimer Show disclaimer. (Y or N)
string systemLinks deprecated Show system links. (Y or N)
string buyBox Show buy box. (Y or N)
string popUnder deprecated Enable pop-under ads. (Y or N)
string twoclickPage deprecated Enable two-click layout. (Y or N)
string comment deprecated Domain comment for further description (i.e.: a project to sell with the domain).
string status ok if everything is in order. Otherwise a fault code.
string message Clear if everything is ok. Otherwise a fault string.
Version
1.0

List of Domains

<?php
try {
    // Create a new client by providing the endpoint to the constructor.
    $client = new SoapClient(
        null,
        [
            'location'     => 'https://api.sedo.com/api/v1/',
            'soap_version' => SOAP_1_1,
            'encoding'     => 'UTF-8',
            'uri'          => 'urn:SedoInterface',
            'style'        => SOAP_RPC,
            'use'          => SOAP_ENCODED,
        ]
    );

    // Set the values for the array
    $params = [
        'partnerid'  => 1234,
        'signkey'    => 'abcdefghijklmnopqrstuvwxyz0123456789',
        'username'   => 'johndoe',
        'password'   => 'secret',
        'domainlist' => ['example.com', 'example.com'],
    ];

    // Call the SOAP method
    $result = $client->GetDomainSetup($params);

    // Display the result
    print_r($result);
} catch (SoapFault $e) {
    echo 'Error: '.$e->getMessage();
}

Whole Account

<?php
try {
    // Create a new client by providing the endpoint to the constructor.
    $client = new SoapClient(
        null,
        [
            'location'     => 'https://api.sedo.com/api/v1/',
            'soap_version' => SOAP_1_1,
            'encoding'     => 'UTF-8',
            'uri'          => 'urn:SedoInterface',
            'style'        => SOAP_RPC,
            'use'          => SOAP_ENCODED,
        ]
    );

    // Set the values for the array
    $params = [
        'partnerid' => 1234,
        'signkey'   => 'abcdefghijklmnopqrstuvwxyz0123456789',
        'username'  => 'johndoe',
        'password'  => 'secret',
        'startfrom' => 0,
        'results'   => 10,
    ];

    // Call the SOAP method
    $result = $client->GetDomainSetup($params);

    // Display the result
    print_r($result);
} catch (SoapFault $e) {
    echo 'Error: '.$e->getMessage();
}