Domains-domainName-privateregistration:GET
From Hostway API Documentation
Revision as of 12:34, 31 January 2014 by Mike.robski (Talk | contribs)
GET /domains/{domainName}/privateregistration
Get the privateregistration info for a domain.
Contents |
Request
GET /domains/{domainName}/privateregistration
Parameters
None.
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.
Request Headers
None.
Request Body
None.
Response
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.
Response Body
The privateregistration info.
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.
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"
}
See also
