Accounts-accountNumber-domains-transfer-domainName:GET
From Hostway API Documentation
Revision as of 01:35, 8 May 2014 by Mike.robski (Talk | contribs)
GET /accounts/{accountNumber}/domains/transfers/{domainName}
Get transfer status for a transfer order.
Contents |
Request
GET /accounts/{accountNumber}/domains/transfers/{domainName}
URI Parameters
- accountNumber
- client account number
- domainName - string
- The domain name. IE: example.com is a valid domain name, whereas http://www.example.com or www.example.com are not. If the domain name is invalid, or is otherwise not registerable such as for a non-existent or non-supported TLD, an error will be returned. Domain names are case insensitive. The domain name must be an open or suspended product under the authenticated franchise.
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
GET /accounts/acct12345/domains/transfers/test.com
Response
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" }
See also