Request Parameters for modify_trade_lock_setting
Standard parameters:
- action = modify_trade_lock_setting
- object = domain
- protocol = XCP
Attributes
Parameters within the attributes associative array are described below.
Parameter name | Obligation | Definition/Value |
|---|---|---|
domain | Required | The domain for which the trade lock setting is being modified. |
enable | Required | Possible values are:
|
ip_address | Required | The IP address of the Current Registrant at the time when they gave their explicit consent to opting out of the transfer lock. |
Response Parameters for modify_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
Examples for modify_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">modify_trade_lock_setting</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>
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: The 60-day trade hold has been enabled (by reseller (via API); 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>
Updated less than a minute ago