Mike.robski: 1 revision: Release 95

2014-07-02T05:58:26Z

1 revision: Release 95

Venzi.iliev at 13:23, 23 May 2014

2014-05-23T13:23:56Z

Mike.robski: 1 revision: Release 93

2014-05-08T07:35:04Z

1 revision: Release 93

Venzi.iliev: /* Request */

2014-03-28T14:30:41Z

Request

New page

= GET /accounts/''{accountNumber}''/domains/transfers/''{domainName}'' =
Get transfer status for a transfer order.

__TOC__
== Request ==
<code>GET /accounts/''{accountNumber}''/domains/transfers/''{domainName}''</code>

=== URI Parameters ===
;accountNumber
: client account number
{{DomainName}}

=== Parameters ===
None.

=== Request Headers ===
Accept: application/json

=== Request Body ===
None.

== Response ==

=== Status Code ===
;200 OK
: Returns status for transfer.

;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 ===
;status
:Status value of the transfer order. Valid statuses are:

WHOIS_PEND = 1;
WHOIS_MANUAL = 2;
WHOIS_CANCEL = 2;
WHOIS_OK = 3;
CONFIRM_TIMEOUT = 4;
CONFIRM_NACK = 5;
CONFIRM_ACK = 6;
CONFIRM_PEND = 7;
REGISTRY_IP = 8;
REGISTRY_PEND = 9;
REGISTRY_COMPLETE = 10;
REGISTRY_TIMEOUT = 11;
REGISTRY_ERROR = 12;
REGISTRY_NACK = 13;
ACTIVE = 14;
TRAN_AWAY = 15;
TRANSFER_NONE = 16;
REGISTRAR_NACK = 17;

;description
:Description of the status.

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

;statusChangeDate (optional)
:The date when status has changed

== Example of getting transfer status. ==
'''Request'''
<nowiki>
GET /accounts/acct12345/domains/transfers/test.com
</nowiki>

'''Response'''
<nowiki>
200 OK
Content-Type: application/json; charset=UTF-8

{
"status": 7,
"emailAddress": "joshbond@usa.net",
"description": "Auto verification of transfer request initiated",
"statusChangeDate": "2014-03-25T11:15:11-05:00"
}
</nowiki>

== See also ==
* [[Common Features]]

{{disqus}}
[[Category:Hostway API]]
[[Category:Domain Name Registration API]]

@@ 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.
 ;404 Not Found
@@ Line 36: / Line 39: @@
 === Parameters ===
 ;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>
 ;description
@@ Line 66: / Line 104: @@
 ;statusChangeDate (optional)
 :The date when status has changed
 == 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",
+}
   </nowiki>

Accounts-accountNumber-domains-transfer-domainName:GET - Revision history

Mike.robski: 1 revision: Release 95

Venzi.iliev at 13:23, 23 May 2014

Mike.robski: 1 revision: Release 93

Venzi.iliev: /* Request */