get_transfers

Request parameters for get_transfers_in

Standard parameters

action = get_transfers_in
object = domain

Attributes

Parameters within the attributes associative array are described below.

Parameter name	Obligation	Definition/Value
completed_from	Optional	Definition/Value
completed_to	Optional	Specify the end date for the search. Only domains transferred on or before the specified date are returned. Use the format YYYY-MM-DD.
domain	Optional	Submit the domain name attribute only if you want to check if a particular domain has been transferred in.
limit	Optional	The maximum number of domains to return per page, up to 40.
losing_registrar	Optional	Search for transfers-in according to losing registrar. String and wildcards (*) accepted.
order_id	Optional	ID number of the order.
order_from	Optional	Specify a starting date, in the format YYYY- MM-DD from which to return orders. Can be used with the order_to parameter to specify a range within which to search. If not used with order_to, all orders from the order_from date onward are returned.
order_to	Optional	Specify an end date, in the format YYYY- MM-DD, before which to return orders. Can be used with the attribute order_from parameter to specify a range within which to search. If not used with order_from, all orders from the order_to date and earlier are returned.
owner_confirm_from	Optional	Search for transferred-in domains according to the date from when the owner confirmed or denied the transfer. Can be used with the owner_confirm_to attribute to specify a range within which to search. Use the format YYYY-MM-DD. Note: The year specified cannot exceed 2030.
owner_confirm_ip	Optional	The IP address from which the owner confirmed or denied the transfer-in request.
owner_confirm_to	Optional	Search for transferred-in domains according to the date prior to when the owner confirmed or denied the transfer. Can be used with the owner_confirm_from attribute to specify a range within which to search. Use the format YYYY-MM-DD. Note: The year specified cannot exceed 2030.
owner_request_from	Optional	Search for transferred domains according to the date when the email was been sent to the request_address. Can be used with the owner_request_to attribute to specify a range within which to search. If not used with owner_request_to, all domains from the owner_request_from date onward are returned. The year specified cannot exceed 2030; otherwise an error is returned. Use the format YYYY-MM-DD.
owner_request_to	Optional	Search for transferred domains according to the date prior to which the email was been sent to the request_address. Can be used with the owner_request_from attribute to specify a range within which to search. If not used with owner_request_from, all domains ever transferred in prior to the owner_request_to date are returned. Use the format YYYY-MM-DD. Note: The year specified cannot exceed 2030; otherwise an error is returned.
page	Optional	Determines which page to retrieve, using the page number. The page index starts at 0 (zero).
request_address	Optional	The admin email address at the time of notification. Wildcards (*) accepted.
status	Optional	Search for transferred domains by status. Allowed values are pending_admin, pending_owner, pending_registry, completed, or cancelled.
transfer_id	Optional	ID number of the transfer.

Response parameters for get_transfers_in

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
page	Returned if specified in the request and is_success = true	The number of the page retrieved.
page_size	Returned if specified in the request and is_success = true	The maximum number of domains returned per page.
total	Returned if is_success = true	The number of transferred-in domains.
transfers	Returned if a transferred-in domain exists and meets the specified search criteria and is_success = true	Contains arrays that list details about each transfer-in. For more information, see the Transfers table below.

Transfers

Parameters within the transfers associative array are described below.

Parameter name	Obligation	Definition/Value
affiliate_id	Returned if specified in the transfer order.	The unique identifier of an RSP's affiliate, which allows the RSP to track orders coming through different affiliates.
completed_date	Always returned in the case of a transferred-in domain.	Date when the transfer was completed.
completed_date_epoch	Always returned in the case of a transferred-in domain.	Date when the transfer was completed, in UNIX time.
domain	Returned if a transferred- in domain exists and meets the specified search criteria.	The domain that was transferred in.
gaining_registrar	Always returned in the case of a transferred-in domain.	The registrar that gained the transferred-in domain.
losing_registrar	Always returned in the case of a transferred-in domain.	The registrar that lost the transferred-in domain.
order_date	Always returned in the case of a transferred-in domain.	Date the order was created.
order_date_epoch	Always returned in the case of a transferred-in domain.	Date the order was created, in UNIX time.
owner_choice	Always returned in the case of a transferred-in domain.	Indicates the owner's response to the transfer-in request. I—Ignored Y—Approved * N—Declined
owner_confirm_date	Always returned in the case of a transferred-in domain.	Date when the owner responded to the transfer request.
owner_confirm_date_epoch	Always returned in the case of a transferred-in domain.	Date when the owner responded to the transfer request, in UNIX time.
owner_confirm_ip	Always returned in the case of a transferred-in domain.	The IP address from which the owner responded to the transfer request.
owner_request_date	Always returned in the case of a transferred-in domain.	Date when transfer request was sent to the owner.
owner_request_date_e poch	Always returned in the case of a transferred-in domain.	Date when transfer request was sent to the owner, in UNIX time.
registry_request_date	Always returned in the case of a transferred-in domain.	The date when the transfer request was sent to the registry.
registry_request_date_epoch	Always returned in the case of a transferred-in domain.	The date when the transfer request was sent to the registry, in UNIX time.
request_address	Always returned in the case of a transferred-in domain.	The admin contact email address, at the time of transfer notification.
request_date	Always returned in the case of a transferred-in domain.	The date when the transfer request was sent.
request_date_epoch	Always returned in the case of a transferred-in domain.	The date when the transfer request was sent, in UNIX time.
status	Always returned in the case of a transferred-in domain.	The status of the transfer: pending_owner, pending_registry, completed, or cancelled. Note: pending_admin has been deprecated.
transfer_id	Always returned.	ID number of the transfer.

Examples for get_transfers_in

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="action">GET_TRANSFERS_IN</item>
                <item key="object">DOMAIN</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="owner_request_to">2006-10-06</item>
                        <item key="page">1</item>
                        <item key="status">cancelled</item>
                        <item key="transfer_id">1234</item>
                        <item key="request_address">[email protected]</item>
                        <item key="losing_registrar">Tucows</item>
                        <item key="completed_to">2006-10-06</item>
                        <item key="domain">example.cc</item>
                        <item key="order_from">2006-10-04</item>
                        <item key="order_to">2008-10-06</item>
                        <item key="order_id">987625</item>
                        <item key="completed_from">2006-10-04</item>
                        <item key="limit">20</item>
                        <item key="owner_confirm_to">2006-10-06</item>
                        <item key="owner_request_from">2006-10-04</item>
                        <item key="owner_confirm_from">2006-10-04</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="action">REPLY</item>
                <item key="object">DOMAIN</item>
                <item key="is_success">1</item>
                <item key="response_code">200</item>
                <item key="response_text">Command successful</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="page_size">20</item>
                        <item key="page">1</item>
                        <item key="total">1</item>
                        <item key="transfers">
                            <dt_array>
                                <item key="0">
                                    <dt_assoc>
                                        <item key="owner_request_date">06-OCT-
                                            2006 14:23:54</item>
                                        <item key="status">cancelled</item>
                                        <item key="affiliate_id">NUAffiliate123</item>
                                        <item key="registry_request_date" />
                                        <item key="owner_confirm_date" />
                                        <item key="registry_request_date_epoch" />
                                        <item key="owner_confirm_ip" />
                                        <item key="completed_date">06-OCT-2006
                                            14:59:01</item>
                                        <item key="order_date_epoch">1159729141</item>
                                        <item key="owner_confirm_date_epoch" />
                                        <item key="request_address">[email protected]</item>
                                        <item key="losing_registrar">Tucows</item>
                                        <item key="domain">kaka.cc</item>
                                        <item key="order_date">06-OCT-2006
                                            14:23:52</item>
                                        <item key="completed_date_epoch">1160159032</item>
                                        <item key="owner_request_date_epoch">1160159034</item>
                                        <item key="transfer_id">1234</item>
                                    </dt_assoc>
                                </item>
                            </dt_array>
                        </item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>