Knowledge Base/API v1.0/Domain Name

List Domain Names

-
posted this on August 08, 2011 14:58

ListDomainNames

This API is no longer supported and will no longer be available beginning November 15th, 2012

This method retrieves the list of Domain Names that your account has registered with Tier 3.

URL:

https://api.tier3.com/REST/Domain/ListDomainNames/<format>



ListDomainNames Request Attributes:

Attribute Name Type Required Description
Search String No This text, if provided, will be used as a search value to filter your Domains. If not provided, all Domain Names will be retrieved.


Example Messages: XML:

<ListDomainNamesRequest>
  <Search>.com</Search>
</ListDomainNamesRequest>


JSON:

{
  "Search":".com"
}



Response Attributes:

Attribute Name Type Description
Success Boolean True if the request was successful, otherwise False.
Message String A description of the result. The contents of this field does not contain any actionable information, it is purely intended to provide a human readable description of the result.
StatusCode Int This value will help to identify any errors which were encountered while processing the request. The value of '0' indicates success, all non-zero StatusCodes indicate an error state.
Domains List A list of DomainName objects.
DomainName Complex Details of a given Domain Name registration.
AutoRenew Boolean True if the domain is set up for Tier 3 to automatically renew it when it is set to expire.
ExpirationDate DateTime The date the domain name registration is set to expire.
ID Int The internal Tier3 ID of the domain name.
Name String The domain name that has been registered.


Example Responses: XML:

<ListDomainNamesResponse Success="true" Message="The domain names were successfuly listed." StatusCode="0">
  <Domains>
    <DomainName AutoRenew="true" ExpirationDate="2011-05-24T00:00:00" ID="100001" Name="mycompany.com" />
    <DomainName AutoRenew="false" ExpirationDate="2011-05-24T00:00:00" ID="100001" Name="myotherdomain.com" />
  </Domains>
</ListDomainNamesResponse>


JSON:

{
  "Domains":[
    {
      "AutoRenew":true,
      "ExpirationDate":"\/Date(1306220400000)\/",
      "ID":1,
      "Name":"mycompany.com"
    },
    {
      "AutoRenew":false,
      "ExpirationDate":"\/Date(1306220400000)\/",
      "ID":2,
      "Name":"myotherdomain.com"
    }
  ],
  "Success":true,
  "Message":"The domain names were successfuly listed.",
  "StatusCode":0
}



Valid Status Codes returned by the ListDomainNames Method:

Status Code Description
0 ListDomainNames request was successfully processed
2 Unknown Error - An application error occurred processing your request, contact Tier3 support to resolve the issue.
3 Invalid Request Format. This value indicates that the XML or JSON requests do not match the expected format.
100 Authentication Failed - You must logon to the API prior to calling this method.