Service Provider API GetTemplate

Synopsis
public array GetTemplate( array $domainlist )
Description

Returns the template ID for a domain.

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)
string[] $domainlist yes Array of domains. (max. 100 per request)
Returns
Type Description
array

The return value contains the following elements:

Type Key Description
string domain Domain name in ACE format
integer templateId

Template ID.

This can be either:

  • One of the available template IDs returned by GetParkingTemplateList.
  • -2 - Indicates that the template auto-rotation is enabled.
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
<?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.net'],
        ]
    ];

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

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