simple_transfer_status (domains)
Returns the status of an existing simple_transfer, including all domain information and status(es) and registrant data in the transfer.
Request parameters for simple_transfer_transfer(domains)
Standard parameters
- action =simple_transfer_status
- object = domain
Attributes
Parameters within the attributes associative array are described below.
| Parameter name | Obligation | Definition/Value |
|---|---|---|
| simple_transfer_job_id | Required | The numerical ID assigned to the job. |
Response parameters for simple_transfer_status (domains)
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 |
|---|---|---|
| id | Always returned. | The job ID #. |
| name | Returned if is_success = true | Name assigned to the specific job. |
| status | Returned if is_success = true | Completed: Job completed. Pending: Awaiting registry. Failed: Transfer failed. |
| request_date | Returned if is_success = true | UTCZ date of the request. e.g. 2015-01-01T00:00:00Z |
| completion_data | Returned if is_success = true | is_success = true UTCZ date of completion. e.g. 2015-02-01T00:00:00Z |
| domain_list | Returned if is_success = true | Parent of domain_name and auth_info. |
| domain_name | Returned if is_success = true | The domain name to be transferred. |
| status | Returned if is_success = true | Completed: Job completed. Pending: Awaiting registry. Failed: Transfer failed. |
| registrant_id | Returned if is_success = true | Numerical registrant ID. |
| name | Returned if is_success = true | Full name of the registrant. |
| email_adderss | Returned if is_success = true | Email address of the registrant. |
| status | Returned if is_success=true | Returned as “status” but not used for the registrant(s). |
Examples for simple_transfer_status (domains)
<?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="object">DOMAIN</item>
<item key="action">SIMPLE_TRANSFER_STATUS</item>
<item key="attributes">
<dt_assoc>
<item key="simple_transfer_job_id">134</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
<?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="object">DOMAIN</item>
<item key="response_text">Simple transfer job information successfully loaded</item>
<item key="action">REPLY</item>
<item key="attributes">
<dt_assoc>
<item key="completion_date"></item>
<item key="status">in_progress</item>
<item key="name">domain_bulk_transfer_2016-06-22_18:10</item>
<item key="id">100545</item>
<item key="registrant_list">
<dt_array>
<item key="0">
<dt_assoc>
<item key="email_address">[email protected]</item>
<item key="status">approved</item>
<item key="name">John Smith</item>
<item key="id">55555</item>
</dt_assoc>
</item>
</dt_array>
</item>
<item key="request_date">2016-06-22T18:11:24Z</item>
<item key="domain_list">
<dt_array>
<item key="0">
<dt_assoc>
<item key="domain_name">test1-mydomain.com</item>
<item key="status">awaiting_completion</item>
<item key="registrant_id">55555</item>
<item key="reason"></item>
</dt_assoc>
</item>
<item key="1">
<dt_assoc>
<item key="domain_name">test2-mydomain.com</item>
<item key="status">failed</item>
<item key="registrant_id"></item>
<item key="reason">Domain not transferable: Transfer in progress</item>
</dt_assoc>
</item>
<item key="2">
<dt_assoc>
<item key="domain_name">test3-mydomain.com</item>
<item key="status">awaiting_completion</item>
<item key="registrant_id">55555</item>
<item key="reason"></item>
</dt_assoc>
</item>
<item key="3">
<dt_assoc>
<item key="domain_name">test4-mydomain.com</item>
<item key="status">awaiting_completion</item>
<item key="registrant_id">55555</item>
<item key="reason"></item>
</dt_assoc>
</item>
<item key="4">
<dt_assoc>
<item key="domain_name">test5-mydomain.com</item>
<item key="status">awaiting_completion</item>
<item key="registrant_id">55555</item>
<item key="reason"></item>
</dt_assoc>
</item>
<item key="5">
<dt_assoc>
<item key="domain_name">test6-mydomain.com</item>
<item key="status">awaiting_completion</item>
<item key="registrant_id">55555</item>
<item key="reason"></item>
</dt_assoc>
</item>
<item key="6">
<dt_assoc>
<item key="domain_name">test7-mydomain.com</item>
<item key="status">awaiting_completion</item>
<item key="registrant_id">55555</item>
<item key="reason"></item>
</dt_assoc>
</item>
</dt_array>
</item>
</dt_assoc>
</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Updated over 1 year ago