Accounts-accountNumber-domains:GET

From Hostway API Documentation
(Difference between revisions)
Jump to: navigation, search
m (1 revision)
 
(4 intermediate revisions by 3 users not shown)
Line 10: Line 10:
  
 
==== Parameters ====
 
==== Parameters ====
−
;name
+
;filterName
−
: Domain name or wildcard pattern (optional).
+
: The product name or wildcard pattern (optional).
−
;expired
+
;filterDomainName
 +
: The product domain name (optional)
 +
;filterExpired
 
: true|false (optional)
 
: true|false (optional)
−
;expiring
+
;filterExpiring
 
: true|false (optional)
 
: 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.
 
: 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)
 
: yyyy-mm-dd (optional)
−
;expiresAfter
+
;filterExpiresAfter
 
: yyyy-mm-dd (optional)
 
: yyyy-mm-dd (optional)
 +
;filterStatus
 +
: The product status (optional)
 +
;filterServiceSpecificationTextKey
 +
: Filter by serviceSpecificationTextKey. The filter accepts wildcard search (optional)
 
;page
 
;page
 
: page number (optional)
 
: page number (optional)
Line 30: Line 36:
 
;accountNumber
 
;accountNumber
 
: client account number
 
: client account number
−
{{DomainName}}
 
−
 
  
 
=== Request Headers ===
 
=== Request Headers ===
Line 51: Line 55:
 
'''Request'''
 
'''Request'''
 
  <nowiki>
 
  <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>
 +
 
 +
'''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",
 +
        "domainName": "ng-test-fitnesse-20130202-0605.com",
 +
        "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",
 +
        "serviceSpecificationTextKey": "core.dnr.com"
 +
      }
 +
    ],
 +
  "links":
 +
    [
 +
      {
 +
        "href": "http://{host:port}/accounts/acct839326/domains?page=1&pageSize=10&filterName=ng-test*&filterExpired=false&filterExpiring=false&filterExpiresAfter=2014-04-11",
 +
        "rel": "self"
 +
      }
 +
    ]
 +
}
 +
</nowiki>
 +
 
 +
== Example search for a domain product. ==
 +
'''Request'''
 +
<nowiki>
 +
GET /accounts/acct839326/domains?filterDomainName=ng-test-fitnesse-20130202-0605.com
  
 
  </nowiki>
 
  </nowiki>
Line 69: Line 111:
 
         "billingCycle": 12,
 
         "billingCycle": 12,
 
         "name": "ng-test-fitnesse-20130202-0605.com",
 
         "name": "ng-test-fitnesse-20130202-0605.com",
 +
        "domainName": "ng-test-fitnesse-20130202-0605.com",
 
         "expirationDate": "2018-02-02",
 
         "expirationDate": "2018-02-02",
 
         "serviceSpecification": "http://{host:port}/accounts/acct839326/serviceSpecifications/core.dnr.com",
 
         "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",
 +
        "serviceSpecificationTextKey": "core.dnr.com"
 
       }
 
       }
 
     ],
 
     ],
Line 77: Line 121:
 
     [
 
     [
 
       {
 
       {
−
         "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"
 
         "rel": "self"
 
       }
 
       }

Latest revision as of 13:35, 30 May 2016

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.

Contents

Request

GET /accounts/{accountNumber}/domains

Parameters

filterName
The product name or wildcard pattern (optional).
filterDomainName
The product domain name (optional)
filterExpired
true|false (optional)
filterExpiring
true|false (optional)
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.
filterExpiresBefore
yyyy-mm-dd (optional)
filterExpiresAfter
yyyy-mm-dd (optional)
filterStatus
The product status (optional)
filterServiceSpecificationTextKey
Filter by serviceSpecificationTextKey. The filter accepts wildcard search (optional)
page
page number (optional)
pageSize
number of items per page (optional)

URI Parameters

accountNumber
client account number

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 

GET /accounts/acct839326/domains?page=1&pageSize=10&filterName=ng-test*&filterExpired=false&filterExpiring=false&filterExpiresAfter=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",
        "domainName": "ng-test-fitnesse-20130202-0605.com",
        "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",
        "serviceSpecificationTextKey": "core.dnr.com"
      }
    ],
  "links":
    [
      {
        "href": "http://{host:port}/accounts/acct839326/domains?page=1&pageSize=10&filterName=ng-test*&filterExpired=false&filterExpiring=false&filterExpiresAfter=2014-04-11",
        "rel": "self"
      }
    ]
}

Example search for a domain product.

Request 

GET /accounts/acct839326/domains?filterDomainName=ng-test-fitnesse-20130202-0605.com

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",
        "domainName": "ng-test-fitnesse-20130202-0605.com",
        "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",
        "serviceSpecificationTextKey": "core.dnr.com"
      }
    ],
  "links":
    [
      {
        "href": "http://{host:port}/accounts/acct839326/domains?filterDomainName=ng-test-fitnesse-20130202-0605.com",
        "rel": "self"
      }
    ]
}

See also


blog comments powered by Disqus

Retrieved from "http://docs.hostway.com/index.php?title=Accounts-accountNumber-domains:GET&oldid=2417"
Personal tools
Namespaces
Variants
Actions
APIs
Navigation
Toolbox