Accounts-accountNumber-domains:GET - Revision history

Corinne.chui: 1 revision

2016-05-30T19:35:48Z

1 revision

Dragomir.penev at 18:02, 1 February 2016

2016-02-01T18:02:44Z

Mike.robski: 1 revision: Release 105

2015-04-03T17:56:34Z

1 revision: Release 105

Stanimir.dimitrov at 14:33, 13 March 2015

2015-03-13T14:33:50Z

Mike.robski: 1 revision: Release 101

2014-12-17T04:50:06Z

1 revision: Release 101

Stanimir.dimitrov at 13:51, 9 December 2014

2014-12-09T13:51:48Z

Mike.robski: 1 revision: Release 93

2014-05-08T07:35:04Z

1 revision: Release 93

Venzi.iliev: /* GET /accounts/{accountNumber}/domains/{domainName} */

2014-03-28T14:34:40Z

GET /accounts/{accountNumber}/domains/{domainName}

New page

= GET /accounts/''{accountNumber}''/domains =
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.

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

==== 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)

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

=== Request Headers ===
None.

=== Request Body ===
None.

== Response ==

=== Status Code ===
;200 OK
: Returns list of domains.

=== Response Body ===
List of list of domains and pages count.

== Example search for a domain product. ==
'''Request'''
<nowiki>
GET /accounts/acct839326/domains?page=1&pageSize=10&name=ng-test*&expired=false&expiring=false&expiresAfter=2014-04-11

</nowiki>

'''Response'''
<nowiki>
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"
}
]
}
</nowiki>

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

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

@@ Line 26: / Line 26: @@
 ;filterStatus
 : The product status (optional)
 ;page
 : page number (optional)
@@ Line 74: / Line 76: @@
          "expirationDate": "2018-02-02",
          "serviceSpecification": "http://{host:port}/accounts/acct839326/serviceSpecifications/core.dnr.com",
-         "service": "http://{host:port}/accounts/acct839326/products/acct839326-000001asfasgag2abeb7007f00000001000/services/acct839326-0000014a2sfw1441c1a8f45d6007f00000001000"
+         "service": "http://{host:port}/accounts/acct839326/products/acct839326-000001asfasgag2abeb7007f00000001000/services/acct839326-0000014a2sfw1441c1a8f45d6007f00000001000",
+       }
      ],
@@ Line 111: / Line 114: @@
          "expirationDate": "2018-02-02",
          "serviceSpecification": "http://{host:port}/accounts/acct839326/serviceSpecifications/core.dnr.com",
-         "service": "http://{host:port}/accounts/acct839326/products/acct839326-000001asfasgag2abeb7007f00000001000/services/acct839326-0000014a2sfw1441c1a8f45d6007f00000001000"
+         "service": "http://{host:port}/accounts/acct839326/products/acct839326-000001asfasgag2abeb7007f00000001000/services/acct839326-0000014a2sfw1441c1a8f45d6007f00000001000",
+       }
      ],

@@ Line 10: / Line 10: @@
 ==== Parameters ====
-;name
+;filterName
-: Domain name or wildcard pattern (optional).
+: The product name or wildcard pattern (optional).
-;expired
+;filterDomainName
 : true|false (optional)
-;expiring
+;filterExpiring
 : true|false (optional)
-;days
+;filterDays
 : 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
+;filterExpiresBefore
 : yyyy-mm-dd (optional)
-;expiresAfter
+;filterExpiresAfter
 : yyyy-mm-dd (optional)
 ;page
 : page number (optional)
@@ Line 30: / Line 34: @@
 ;accountNumber
 : client account number
 === Request Headers ===
@@ Line 51: / Line 53: @@
 '''Request'''
   <nowiki>
-GET /accounts/acct839326/domains?page=1&pageSize=10&name=ng-test*&expired=false&expiring=false&expiresAfter=2014-04-11
+GET /accounts/acct839326/domains?page=1&pageSize=10&filterName=ng-test*&filterExpired=false&filterExpiring=false&filterExpiresAfter=2014-04-11
   </nowiki>
@@ Line 69: / Line 108: @@
          "billingCycle": 12,
          "name": "ng-test-fitnesse-20130202-0605.com",
          "expirationDate": "2018-02-02",
          "serviceSpecification": "http://{host:port}/accounts/acct839326/serviceSpecifications/core.dnr.com",
-         "productInstanceUrl": "http://{host:port}/accounts/acct839326/products/acct839326-000001asfasgag2abeb7007f00000001000/services/acct839326-0000014a2sfw1441c1a8f45d6007f00000001000"
+         "service": "http://{host:port}/accounts/acct839326/products/acct839326-000001asfasgag2abeb7007f00000001000/services/acct839326-0000014a2sfw1441c1a8f45d6007f00000001000"
+       }
      ],
@@ Line 77: / Line 117: @@
+     [
+       {
-         "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",
+         "href": "http://{host:port}/accounts/acct839326/domains?filterDomainName=ng-test-fitnesse-20130202-0605.com",
          "rel": "self"
+       }