API: OpenSRS

OpenSRS API Guide: Domains and SSL

Welcome to the OpenSRS API guide. Here you will find comprehensive documentation regarding our domain and SSL services. We hope this guide will help you start working with OpenSRS as quickly as possible. If you have any questions or concerns, please do not hesitate to contact help@opensrs.com

Get Started

enable_designated_agent

Grants permission for Tucows to act as the Designated Agent on behalf of a New Registrant. This setting needs to be submitted prior to the actual Change of Registrant request. If enabled, the New Registrant (by its combination of firstname, lastname, organization and email) will be flagged as having accepted Tucows as their Designated Agent, so that Tucows will accept subsequent Change of Registrant requests without requesting further confirmation from the New Registrant.

Request Parameters enable_designated_agent

Standard parameters:

  • action = enable_designated_agent
  • object = icann_trade_registrant
  • protocol = XCP

Attributes

Parameters within the attributes associative array are described below.

Parameter
Obligation
Definition/Value

owner

Required

Contains contact details of a New Registrant. Contact details are submitted as a list of required sub-items.

The list of required sub-items consists of:

  • first_name
  • last_name
  • org_name
  • email

ip_address

Required

The IP address of the registrant modifying the setting.

Response Parameters enable_designated_agent

Standard parameters

  • action = reply
  • object = reply
  • is_success = a Boolean is returned, indicating success or failure of the
    request
  • response_code = response code indicating outcome of the request
  • response_text = message describing the outcome of the request

Examples for enable_designated_agent

Request

<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
 <header>
  <version>0.9</version>
  </header>
 <body>
  <data_block>
   <dt_assoc>
    <item key="protocol">XCP</item>
    <item key="object">icann_trade_registrant</item>
    <item key="action">enable_designated_agent</item>
    <item key="attributes">
     <dt_assoc>
      <item key="owner">
       <dt_assoc>
        <item key="email">johndoe@example.com</item>
        <item key="org_name">Example Corp.</item>
        <item key="last_name">Doe</item>
        <item key="first_name">John</item>
       </dt_assoc>
      </item>
      <item key="ip_address">0.0.0.0</item>
     </dt_assoc>
    </item>
   </dt_assoc>
  </data_block>
 </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding="UTF-8" standalone="no" ?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
 <header>
  <version>0.9</version>
  </header>
 <body>
  <data_block>
   <dt_assoc>
    <item key="action">REPLY</item>
    <item key="response_code">200</item>
    <item key="protocol">XCP</item>
    <item key="is_success">1</item>
    <item key="response_text">Command successful</item>
    <item key="object">ICANN_TRADE_REGISTRANT</item>
   </dt_assoc>
  </data_block>
 </body>
</OPS_envelope>

enable_designated_agent

Grants permission for Tucows to act as the Designated Agent on behalf of a New Registrant. This setting needs to be submitted prior to the actual Change of Registrant request. If enabled, the New Registrant (by its combination of firstname, lastname, organization and email) will be flagged as having accepted Tucows as their Designated Agent, so that Tucows will accept subsequent Change of Registrant requests without requesting further confirmation from the New Registrant.