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

get_trade_lock_setting

Queries the current state of the 60 day transfer lock setting for the specified domain, and whether or not it can be modified at this time. You can modify this setting as long as the 60 day transfer lock is not currently in progress.

Request Parameters for get_trade_lock_setting

Standard parameters

  • action = get_trade_lock_setting
  • object = domain

Attributes

Parameters within the attributes associative array are described below.

Parameter name
Obligation
Definition/Value

domain

Required

The domain to which the trade pertains.

Response Parameters for get_trade_lock_setting

Standard parameters

  • action = reply
  • object = domain
  • 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

Attributes

The attributes array includes an array of associative arrays, one for each
domain queried. The associative array for each domain includes the contact
set for that domain.

Parameters within the attributes associative array are described below.

Parameter name
Obligation
Definition/Value

can_modify

Always returned

Indicates whether the 60-day trade lock can be modified at this time.

Possible values are:

  • 1 - Modification is allowed

  • 0 - Modification is not currently allowed

allow_hold_after_trade

Always returned

Indicates whether the standard post-trade-completion 60-day transfer lock setting is enabled. The default value is always 1 unless it is explicitly disabled.

Possible values are:

  • 1 - Enabled

  • 0 - Disabled

Examples for get_trade_lock_setting

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">DOMAIN</item>
    <item key="action">GET_TRADE_LOCK_SETTING</item>
    <item key="attributes">
     <dt_assoc>
      <item key="domain">icanntradetest2.com</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="protocol">XCP</item>
    <item key="object">DOMAIN</item>
    <item key="response_text">Command successful</item>
    <item key="action">REPLY</item>
    <item key="attributes">
     <dt_assoc>
      <item key="can_modify">1</item>
      <item key="allow_hold_after_trade">0</item>
     </dt_assoc>
    </item>
    <item key="response_code">200</item>
    <item key="is_success">1</item>
   </dt_assoc>
  </data_block>
 </body>
</OPS_envelope>

get_trade_lock_setting

Queries the current state of the 60 day transfer lock setting for the specified domain, and whether or not it can be modified at this time. You can modify this setting as long as the 60 day transfer lock is not currently in progress.