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.
|
|
owner_confirm_date |
Always returned in the case of a transferred-in domain. |
Date when the owner responded to the transfer request. |
|
owner_confirm_ |
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_ |
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_ |
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. |