Latest revision as of 01:35, 8 May 2014

[edit] GET /accounts/{accountNumber}/domains/{domainName}

Search for domains in client's account. Standard paging parameters can be used. The result is in standard paging format: list of list of results and pages count. You can search by name (with wildcard), expired or expiring (within 45 days of expiration) domains, or specify date range for expiration.

[edit] Request

GET /accounts/{accountNumber}/domains

[edit] Parameters

name

Domain name or wildcard pattern (optional).

expired

true|false (optional)

expiring

true|false (optional)

days

number of days (optional) to be used in conjunction with expiring or expired. The default value is 45 days, i.e. a domain is considered "expiring" if it expires in 45 days or less.

expiresBefore

yyyy-mm-dd (optional)

expiresAfter

yyyy-mm-dd (optional)

page

page number (optional)

pageSize

number of items per page (optional)

[edit] 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.

[edit] Request Headers

None.

[edit] Request Body

None.

[edit] Response

[edit] Status Code

200 OK

Returns list of domains.

[edit] Response Body

List of list of domains and pages count.

[edit] Example search for a domain product.

Request

GET /accounts/acct839326/domains?page=1&pageSize=10&name=ng-test*&expired=false&expiring=false&expiresAfter=2014-04-11

 

Response

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

{
  "total_count": 1,
  "list": 
    [
      {
        "status": "open",
        "createDate": "2013-02-02",
        "billingCycle": 12,
        "name": "ng-test-fitnesse-20130202-0605.com",
        "expirationDate": "2018-02-02"
      }
    ],
  "links":
    [
      {
        "href": "http://{host:port}/accounts/acct839326/domains?page=1&pageSize=10&filterName=ng-test-fitnesse-search-20131010-022746.com&filterActivationDate='2013-10-10'&filterMonthlyCycle=12&filterStatus=open",
        "rel": "self"
      }
    ]
}
 

[edit] See also

• Common Features