Request parameters for get_domains_by_expiredate

Standard parameters

action = get_domains_by_expiredate
object = domain

Attributes

Parameters within the attributes associative array are described below.

Parameter name	Obligation	Definition/Value
exp_from	Required	Used in conjunction with exp_to attribute. The date from which to list expiring domains. Date must be in the format YYYY-MM-DD.
exp_to	Required	Used in conjunction with exp_from attribute. The date until which to list expiring domains. Date must be in the format YYYY-MM-DD.
limit	Optional - if not specified, the default '40' will be used.	The number of domains to return on each page.
page	Optional - if not specified, the default '1' will be used.	Determines which page to retrieve, using the page number. The page index starts at 0 (zero).

Response parameters for get_domains_by_expiredate

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

If the request is successful, the attributes associative array may include the
following:

Parameter name	Obligation	Definition/Value
exp_domains	Returned if is_success = true	Lists the domains that expire during the specified period. For more information, see the Exp_Domains table below.
page	Returned if is_success = true	The number of the page retrieved.
remainder	Returned if is_success = true	Indicates if some expiring domains were not returned due to restrictions set by the page and limit values. 0—No, all expiring domains are listed. 1—Yes, there are remaining expiring domains not listed.
total	Returned if is_success = true	The total number of domains expiring in the specified date range.

Exp_Domains

Parameters within the exp_domains associative array are described below.

Parameter name	Obligation	Definition/Value
expiredate	Always returned	The date the domain expires.
f_auto_renew	Always returned	Flag (Y or N) indicating whether domain is automatically renewed.
f_let_expire	Always returned	Flag (Y or N) indicating whether domain is allowed to expire.
name	Always returned	The name of the domain that is expiring.

Examples for get_domains_by_expiredate

Request

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">get_domains_by_expiredate</item>
                <item key="object">domain</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="limit">20</item>
                        <item key="exp_from">2009-12-03</item>
                        <item key="exp_to">2009-12-25</item>
                        <item key="page">1</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Response

<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
    <header>
        <version>0.9</version>
    </header>
    <body>
        <data_block>
            <dt_assoc>
                <item key="protocol">XCP</item>
                <item key="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="is_success">1</item>
                <item key="response_text">Command successful</item>
                <item key="response_code">200</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="page">1</item>
                        <item key="total">2</item>
                        <item key="remainder">0</item>
                        <item key="exp_domains">
                            <dt_array>
                                <item key="0">
                                    <dt_assoc>
                                        <item key="f_let_expire">N</item>
                                        <item key="name">katarina.biz</item>
                                        <item key="expiredate">2009-12-18
                                            23:59:59</item>
                                        <item key="f_auto_renew">N</item>
                                    </dt_assoc>
                                </item>
                                <item key="1">
                                    <dt_assoc>
                                        <item key="name">kristina.ch</item>
                                        <item key="expiredate">2009-12-18
                                            23:59:59</item>
                                        <item key="f_let_expire">N</item>
                                        <item key="f_auto_renew">N</item>
                                    </dt_assoc>
                                </item>
                            </dt_array>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>