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

modify_trade_designated_agent

Grants or revokes permission for TUCOWS to act as the designated agent for the specified domain. "Enabled" is the default status. If this feature is disabled, the current registrant will be required to approve, via email, any contact changes that affect the first name, last name, organization name, or email address.

Request Parameters modify_trade_designated_agent

Standard parameters:

  • action = modify_trade_designated_agent
  • object = domain
  • protocol = XCP

Attributes

Parameters within the attributes associative array are described below.

Parameter
Obligation
Definition/Value

domain

Required

The domain to which the trade pertains.

enable

Required

Possible values are:

  • 0 - Indicates that the registrant/owner will approve any and all contact owner changes for their domains via email. TUCOWS will not act as a "designated agent"

  • 1 - Indicates that the registrant agrees to all terms and conditions outlined in TUCOWS' service agreement), including that which states TUCOWS may act on behalf of the registrant as a "designated agent".

ip_address

Optional

The IP address of the registrant modifying the setting.

Response Parameters modify_trade_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 modify_trade_designated_agent

<?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">DOMAIN</item>
    <item key="action">MODIFY_TRADE_DESIGNATED_AGENT</item>
    <item key="attributes">
     <dt_assoc>
      <item key="enable">1</item>
      <item key="domain">weruiofh89q34gh78943g4.com</item>
      <item key="ip_address">0.0.0.0</item>
     </dt_assoc>
    </item>
   </dt_assoc>
  </data_block>
 </body>
</OPS_envelope>
<?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">DOMAIN</item>
    <item key="response_text">Command successful: The designated agent setting has been enabled (by reseller (via API); Source domain: weruiofh89q34gh78943g4.com; Supplied IP address: 0.0.0.0)</item>
    <item key="action">REPLY</item>
    <item key="response_code">200</item>
    <item key="is_success">1</item>
   </dt_assoc>
  </data_block>
 </body>
</OPS_envelope>

modify_trade_designated_agent

Grants or revokes permission for TUCOWS to act as the designated agent for the specified domain. "Enabled" is the default status. If this feature is disabled, the current registrant will be required to approve, via email, any contact changes that affect the first name, last name, organization name, or email address.