Domains-domainName-privateregistration:GET
From Hostway API Documentation
(Difference between revisions)
(Created page with "= GET /domains/''{domainName}''/privateregistration = Get the privateregistration info for a domain. __TOC__ == Request == <code>GET /domains/''{domainName}''/privateregistra...") |
Mike.robski (Talk | contribs) m (1 revision: Release 90) |
Latest revision as of 12:34, 31 January 2014
[edit] GET /domains/{domainName}/privateregistration
Get the privateregistration info for a domain.
Contents |
[edit] Request
GET /domains/{domainName}/privateregistration
[edit] Parameters
None.
[edit] URI Parameters
- 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.
[edit] Request Headers
None.
[edit] Request Body
None.
[edit] Response
[edit] Status Code
- 200 OK
- Returns the privateregistration info
- 404 Not Found
- No domain records found for the given domain name.
- 500 Internal Server Error
- An error has occurred with the back end or the domain registry.
[edit] Response Body
The privateregistration info.
[edit] Parameters
- type - string
- The privateregistration product type, either "full" or "light"
- productTypeConfiguration- string
- The product name, e.g. "core.privateregistration"
- email - string
- (Optional) The forwarding e-mail address for "full" type privateregistration.
[edit] Example of getting the domain authorization code.
Request
GET /domains/example.com/privateregistration
Response
200 OK Content-Type: application/json; charset=UTF-8 { "type": "full", "productTypeConfiguration": "core.privateregistration", "email": "test@test.com" }
[edit] See also