Accounts-accountNumber-domains-domainName-search:GET - Revision history

Mike.robski: 1 revision: Release 93

2014-05-08T07:35:04Z

1 revision: Release 93

Venzi.iliev at 14:31, 28 March 2014

2014-03-28T14:31:38Z

Mike.robski: 1 revision: Release 87

2013-11-15T21:22:24Z

1 revision: Release 87

Philip.rittscher: /* Example search for a domain product. */

2013-10-15T17:06:12Z

Example search for a domain product.

New page

= GET /accounts/''{accountNumber}''/domains/''{domainName}''/search =
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/''{domainName}''/search</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/search?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 1: / Line 1: @@
-= GET /accounts/''{accountNumber}''/domains/''{domainName}''/search =
+= 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.
@@ Line 7: / Line 7: @@
 __TOC__
 == Request ==
-<code>GET /accounts/''{accountNumber}''/domains/''{domainName}''/search</code>
+<code>GET /accounts/''{accountNumber}''/domains</code>
 ==== Parameters ====
@@ Line 51: / Line 51: @@
 '''Request'''
   <nowiki>
-GET /accounts/acct839326/domains/search?page=1&pageSize=10&name=ng-test*&expired=false&expiring=false&expiresAfter=2014-04-11
+GET /accounts/acct839326/domains?page=1&pageSize=10&name=ng-test*&expired=false&expiring=false&expiresAfter=2014-04-11
   </nowiki>