From Hostway API Documentation

(Difference between revisions)

Jump to: navigation, search

Latest revision as of 23:58, 1 July 2014

GET /accounts/{accountNumber}/domains/transfers/{domainName}

This call will return detailed information on a domain transfer that is in progress for the given domain name and customer number.

Request

GET /accounts/{accountNumber}/domains/transfers/{domainName}

URI Parameters

accountNumber: client account number

Template:DomainTransfer

Parameters

None.

Request Headers

Accept: application/json

Request Body

None.

Response

Status Code

200 OK: Returns status for transfer.

403 Forbidden

This customer is not authorized to view the transfer. Possibly the transfer belongs to another account.

404 Not Found

No transfer order found for this domain and account number.

500 Internal Server Error

Registry error.

Response Body

Status info for the transfer order.

Parameters

history: List of status objects (see below for the status fields)

status: Current status object with the following fields:

Status object fields

canBeReset: Boolean value that indicates if a transfer is in a state that can be reset. This means the transfer ran into a problem that prevents it from proceeding until corrective actions are taken and the transfer is reset. If a transfer is still in progress it cannot be reset. Nor may a transfer be reset if it has been voided.

status: Status value of the transfer order. Valid statuses are:

Status	Can be Reset	Description
0	N	Transfer request created - awaiting fax
1	N	WhoIs information matches
2	Y	Canceled due to WhoIs error
3	N	Pending due to domain status
4	Y	Canceled due to domain status
5	N	Transferred and paid successfully
6	Y	Transfer incomplete charge problem
7	N	Frozen due to charge problem
8	Y	NSI rejected transfer
9	N	Awaiting auto verification of transfer request
10	Y	Unable to retrieve current domain contacts from UWhois
11	N	Auto verification of transfer request initiated
12	N	Awaiting for auto transfer string validation
13	N	Domain awaiting transfer initiation
14	N	Domain transfer initiated and awaiting approval
15	Y	Canceled - cannot obtain domain contacts from UWhois
16	Y	Canceled - domain contacts did not response to verification e-mails
17	Y	Canceled - domain contacts did not approve transfer of domain
18	N	Canceled - domain validation string is invalid
19	N	Canceled - Whois information provided does not match current registrant
20	N	Canceled - Domain is currently not registered and cannot be transferred
21	N	Canceled - Domain already registered in account & cannot be transferred
22	Y	Canceled - Domain is locked at current registrar
23	Y	Canceled - Transfer already initiated for this domain
24	Y	Canceled - Unable to transfer due to unknown error
25	Y	Canceled - Transfer rejected by losing registrar
26	Y	Canceled - Transfer authorization fax not received
27	Y	Canceled by customer
28	N	Fax received - awaiting registrant verification
29	N	Awaiting manual fax verification
30	N	Canceled - Domain name is invalid or is Invalid for Transfers
31	Y	Canceled - Domain is currently undergoing transfer by another Registrar
32	Y	Canceled - Invalid EPP/authorization key - Please contact current registrar to obtain correct key
33	N	Canceled - Cannot transfer domain from name-only account
34	N	Unable to complete transfer. Transfers must include a change in registrar.
35	N	Transfer request not yet submitted
36	N	Canceled - Account is not authorized to perform domain transfers
37	Y	Canceled - Domain was not retagged or not retagged in time by losing registrar
45	Y	Order cancelled

description: Description of the status.

emailAddress (optional): E-mail address to which FOA notification was sent

statusChangeDate (optional): The date when status has changed

authInfo: The current authInfo value being used to start the transfer at the registry. The authInfo can be updated using the reset transfer call. For example if the transfer is blocking with a status of 32, the authInfo needs to be updated, or the losing registrar must set the authInfo to the present value.

Example of getting transfer status.

Request

GET /accounts/acct12345/domains/transfers/test.com

Response

200 OK
Content-Type: application/json; charset=UTF-8

{
   "status": {
      "status": 7,
      "emailAddress": "joshbond@usa.net",
      "description": "Auto verification of transfer request initiated",
      "statusChangeDate": "2014-03-25T11:15:11-05:00",
      "authInfo": "auth123$000",
      "canBeReset": false
   },
   "history": [{
      "status": 7,
      "emailAddress": "joshbond@usa.net",
      "description": "Auto verification of transfer request initiated",
      "statusChangeDate": "2014-03-25T11:15:11-05:00",
      "authInfo": "auth123$000",
      "canBeReset": false
   }]
}

@@ Line 1: / Line 1: @@
 = GET /accounts/''{accountNumber}''/domains/transfers/''{domainName}'' =
-Get transfer status for a transfer order.
+This call will return detailed information on a domain transfer that is in progress for the given domain name and customer number.
 __TOC__
@@ Line 9: / Line 9: @@
 ;accountNumber
 : client account number
-{{DomainName}}
+{{DomainTransfer}}
 === Parameters ===
@@ Line 25: / Line 25: @@
 ;200 OK
 : Returns status for transfer.
+;403 Forbidden
+This customer is not authorized to view the transfer. Possibly the transfer belongs to another account.
 ;404 Not Found
@@ Line 36: / Line 39: @@
 === Parameters ===
+;history
+:List of status objects (see below for the status fields)
+;status
+:Current status object with the following fields:
+=== Status object fields ===
+;canBeReset
+:Boolean value that indicates if a transfer is in a state that can be reset. This means the transfer ran into a problem that prevents it from proceeding until corrective actions are taken and the transfer is reset. If a transfer is still in progress it cannot be reset. Nor may a transfer be reset if it has been voided.
 ;status
 :Status value of the transfer order. Valid statuses are:
-WHOIS_PEND = 1;
+<table border="1" cellpadding="0" cellspacing="0">
-WHOIS_MANUAL = 2;
+<tr><th>Status</th><th>Can be Reset</th><th>Description</th></tr>
-WHOIS_CANCEL = 2;
+<tr><td>0</td><td>  N</td><td>Transfer request created - awaiting fax</td></tr>
-WHOIS_OK = 3;
+<tr><td>1</td><td>  N</td><td>WhoIs information matches</td></tr>
-CONFIRM_TIMEOUT = 4;
+<tr><td>2</td><td>  Y</td><td>Canceled due to WhoIs error</td></tr>
-CONFIRM_NACK = 5;
+<tr><td>3</td><td>  N</td><td>Pending due to domain status</td></tr>
-CONFIRM_ACK = 6;
+<tr><td>4</td><td>  Y</td><td>Canceled due to domain status</td></tr>
-CONFIRM_PEND = 7;
+<tr><td>5</td><td>  N</td><td>Transferred and paid successfully</td></tr>
-REGISTRY_IP = 8;
+<tr><td>6</td><td>  Y</td><td>Transfer incomplete charge problem</td></tr>
-REGISTRY_PEND = 9;
+<tr><td>7</td><td>  N</td><td>Frozen due to charge problem</td></tr>
-REGISTRY_COMPLETE = 10;
+<tr><td>8</td><td>  Y</td><td>NSI rejected transfer</td></tr>
-REGISTRY_TIMEOUT = 11;
+<tr><td>9</td><td>  N</td><td>Awaiting auto verification of transfer request</td></tr>
-REGISTRY_ERROR = 12;
+<tr><td>10</td><td> Y</td><td>Unable to retrieve current domain contacts from UWhois</td></tr>
-REGISTRY_NACK = 13;
+<tr><td>11</td><td> N</td><td>Auto verification of transfer request initiated</td></tr>
-ACTIVE = 14;
+<tr><td>12</td><td> N</td><td>Awaiting for auto transfer string validation</td></tr>
-TRAN_AWAY = 15;
+<tr><td>13</td><td> N</td><td>Domain awaiting transfer initiation</td></tr>
-TRANSFER_NONE = 16;
+<tr><td>14</td><td> N</td><td>Domain transfer initiated and awaiting approval</td></tr>
-REGISTRAR_NACK = 17;
+<tr><td>15</td><td> Y</td><td>Canceled - cannot obtain domain contacts from UWhois</td></tr>
+<tr><td>16</td><td> Y</td><td>Canceled - domain contacts did not response to verification e-mails</td></tr>
+<tr><td>17</td><td> Y</td><td>Canceled - domain contacts did not approve transfer of domain</td></tr>
+<tr><td>18</td><td> N</td><td>Canceled - domain validation string is invalid</td></tr>
+<tr><td>19</td><td> N</td><td>Canceled - Whois information provided does not match current registrant</td></tr>
+<tr><td>20</td><td> N</td><td>Canceled - Domain is currently not registered and cannot be transferred</td></tr>
+<tr><td>21</td><td> N</td><td>Canceled - Domain already registered in account & cannot be transferred</td></tr>
+<tr><td>22</td><td> Y</td><td>Canceled - Domain is locked at current registrar</td></tr>
+<tr><td>23</td><td> Y</td><td>Canceled - Transfer already initiated for this domain</td></tr>
+<tr><td>24</td><td> Y</td><td>Canceled - Unable to transfer due to unknown error</td></tr>
+<tr><td>25</td><td> Y</td><td>Canceled - Transfer rejected by losing registrar</td></tr>
+<tr><td>26</td><td> Y</td><td>Canceled - Transfer authorization fax not received</td></tr>
+<tr><td>27</td><td> Y</td><td>Canceled by customer</td></tr>
+<tr><td>28</td><td> N</td><td>Fax received - awaiting registrant verification</td></tr>
+<tr><td>29</td><td> N</td><td>Awaiting manual fax verification</td></tr>
+<tr><td>30</td><td> N</td><td>Canceled - Domain name is invalid or is Invalid for Transfers</td></tr>
+<tr><td>31</td><td> Y</td><td>Canceled - Domain is currently undergoing transfer by another Registrar</td></tr>
+<tr><td>32</td><td> Y</td><td>Canceled - Invalid EPP/authorization key - Please contact current registrar to obtain correct key</td></tr>
+<tr><td>33</td><td> N</td><td>Canceled - Cannot transfer domain from name-only account</td></tr>
+<tr><td>34</td><td> N</td><td>Unable to complete transfer. Transfers must include a change in registrar.</td></tr>
+<tr><td>35</td><td> N</td><td>Transfer request not yet submitted</td></tr>
+<tr><td>36</td><td> N</td><td>Canceled - Account is not authorized to perform domain transfers</td></tr>
+<tr><td>37</td><td> Y</td><td>Canceled - Domain was not retagged or not retagged in time by losing registrar</td></tr>
+<tr><td>45</td><td> Y</td><td>Order cancelled</td></tr>
+</table>
 ;description
@@ Line 66: / Line 104: @@
 ;statusChangeDate (optional)
 :The date when status has changed
+;authInfo
+:The current authInfo value being used to  start the transfer at the registry. The authInfo can be updated using the reset transfer call. For example if the transfer is blocking with a status of 32, the authInfo needs to be updated, or the losing registrar must set the authInfo to the present value.
 == Example of getting transfer status. ==
@@ Line 79: / Line 120: @@
 {
-    "status": 7,
+    "status": {
-   "emailAddress": "joshbond@usa.net",
+      "status": 7,
-   "description": "Auto verification of transfer request initiated",
+      "emailAddress": "joshbond@usa.net",
-    "statusChangeDate": "2014-03-25T11:15:11-05:00"
+      "description": "Auto verification of transfer request initiated",
+      "statusChangeDate": "2014-03-25T11:15:11-05:00",
+      "authInfo": "auth123$000",
+      "canBeReset": false
+    },
+   "history": [{
+      "status": 7,
+      "emailAddress": "joshbond@usa.net",
+      "description": "Auto verification of transfer request initiated",
+      "statusChangeDate": "2014-03-25T11:15:11-05:00",
+      "authInfo": "auth123$000",
+      "canBeReset": false
+   }]
 }
   </nowiki>

Accounts-accountNumber-domains-transfer-domainName:GET

Latest revision as of 23:58, 1 July 2014

GET /accounts/{accountNumber}/domains/transfers/{domainName}

Contents

Request

URI Parameters

Parameters

Request Headers

Request Body

Response

Status Code

Response Body

Parameters

Status object fields

Example of getting transfer status.

See also

Personal tools

Namespaces

Variants

Views

Actions

Search

APIs

Navigation

Toolbox