MBAPI Element Index
MBAPI Intro → MBAPI Command Index → GetTLDs

GetTLDs

Description

Command to get TLD data, how other data is related to TLDs, and some data related to TLDs.

Attributes

package
modernbill
subpackage
mbapi
version
0.9
author
Andy Christ
author
Ben Woolley

Example Request

	<mbapi>
		<command><!-- string --></command>
		<showXMLHeader><!-- boolean --></showXMLHeader>
		<params>
			<tldID><!-- int --></tldID>
			<registrarID><!-- int --></registrarID>
			<tldExtension><!-- string --></tldExtension>
			<tldName><!-- string --></tldName>
			<tldWhoisServer><!-- string --></tldWhoisServer>
			<tldWhoisResp><!-- string --></tldWhoisResp>
			<tldActive><!-- boolean --></tldActive>
			<tldAutoSearch><!-- boolean --></tldAutoSearch>
			<tldTransferMinimumCycleID><!-- int --></tldTransferMinimumCycleID>
			<tldMinimumCycleID><!-- int --></tldMinimumCycleID>
			<tldMaximumCycleID><!-- int --></tldMaximumCycleID>
			<tldRenewType><!-- int --></tldRenewType>
			<tldIsTransferable><!-- boolean --></tldIsTransferable>
			<tldTransferType><!-- int --></tldTransferType>
			<tldIDNSupport><!-- boolean --></tldIDNSupport>
			<tldIDNType><!-- int --></tldIDNType>
			<tldRemoteLockEnabled><!-- boolean --></tldRemoteLockEnabled>
		</params>
	</mbapi>

Example Response

	<mbapi>
		<header>
			<remoteSessionID><!-- hex --></remoteSessionID>
			<errorCount><!-- int --></errorCount>
			<errors>
				<error>
					<title><!-- string --></title>
					<message><!-- string --></message>
				</error>
			</errors>
			<numResults><!-- int --></numResults>
			<numAffectedRows><!-- int --></numAffectedRows>
		</header>
		<results>
			<TLDs>
				<TLD>
					<tldID><!-- int --></tldID>
					<registrarID><!-- int --></registrarID>
					<tldExtension><!-- string --></tldExtension>
					<tldName><!-- string --></tldName>
					<tldWhoisServer><!-- string --></tldWhoisServer>
					<tldWhoisResp><!-- string --></tldWhoisResp>
					<tldActive><!-- boolean --></tldActive>
					<tldAutoSearch><!-- boolean --></tldAutoSearch>
					<tldTransferMinimumCycleID><!-- int --></tldTransferMinimumCycleID>
					<tldMinimumCycleID><!-- int --></tldMinimumCycleID>
					<tldMaximumCycleID><!-- int --></tldMaximumCycleID>
					<tldRenewType><!-- int --></tldRenewType>
					<tldIsTransferable><!-- boolean --></tldIsTransferable>
					<tldTransferType><!-- int --></tldTransferType>
					<tldIDNSupport><!-- boolean --></tldIDNSupport>
					<tldIDNType><!-- int --></tldIDNType>
					<tldRemoteLockEnabled><!-- boolean --></tldRemoteLockEnabled>
					<products>
						<product>
							<productID><!-- int --></productID>
						</product>
					</products>
					<ghostProducts>
						<ghostProduct>
							<productID><!-- int --></productID>
						</ghostProduct>
					</ghostProducts>
				</TLD>
			</TLDs>
		</results>
	</mbapi>

Request Elements

mbapi
Type
group
Description

MBAPI request document root.

Children
command
Type
string
Description

Required. The string GetTLDs.

showXMLHeader
Type
boolean
Description

Whether to show an XML header in the results.

params
Type
group
Description

GetTLDs parameters.

Children
tldID
Type
int
Description

ID of this TLD.

registrarID
Type
int
Description

The config group ID of this TLD's regisrar.

tldExtension
Type
string
Description

The extension of this TLD without the leading dot. For example, co.uk or org.

tldName
Type
string
Description

The name of this TLD.

tldWhoisServer
Type
string
Description

The hostname of the whois server for this TLD.

tldWhoisResp
Type
string
Description

The string to search for in the whois response which signifies that a domain is available.

tldActive
Type
boolean
Description

Whether this TLD is active.

tldAutoSearch
Type
boolean
Description

Whether the order form should automatically check this TLD whenever any domain is queried.

tldTransferMinimumCycleID
Type
int
Description

ID for the cycle for the minimum duration for a transfer to this TLD.

tldMinimumCycleID
Type
int
Description

ID for the cycle for the mimimum duration for which a domain of this TLD may be purchased.

tldMaximumCycleID
Type
int
Description

ID for the cycle for the maximum duration for which a domain of this TLD may be purchased.

tldRenewType
Type
int
Description

The type of renewal for this TLD.

  • 0: Disabled
  • 1: Renewed by the registrar
  • 2: Renewed by ModernBill

tldIsTransferable
Type
boolean
Description

Whether this TLD is transferable.

tldTransferType
Type
int
Description

The type of transfer for this TLD.

  • 0: Code
  • 1: Fax
  • 2: Email
  • 3: Mail

tldIDNSupport
Type
boolean
Description

Whether IDN is supported by this TLD's registrar.

tldIDNType
Type
int
Description

The type of IDN supported by this TLD's registrar.

  • 0: Puny Code

tldRemoteLockEnabled
Type
boolean
Description

Allow this TLD to be locked at the registrar.

Response Elements

mbapi
Type
group
Description

MBAPI response document root.

Children
header
Type
group
Description

Contains result meta data: data about the result itself.

Children
remoteSessionID
Type
hex
Description

A session ID that may be used for authentication instead of a remote access hash.

errorCount
Type
int
Description

The number of errors that occured.

errors
Type
group
Description

Contains any errors that occured.

Children
error
Type
group
Description

Contains information relating to a single error. Occurs header errorCount times.

Children
title
Type
string
Description

The title of the error.

message
Type
string
Description

The error message.

numResults
Type
int
Description

The number of results that have been returned. For Get commands.

numAffectedRows
Type
int
Description

The number of rows that have been affected. For Set commands.

results
Type
group
Description

Contains any results.

Children
TLDs
Type
group
Description

Contains all TLD results.

Children
TLD
Type
group
Description

Contains all results for a single TLD. Occurs header numResults times.

Children
tldID
Type
int
Description

ID of this TLD.

registrarID
Type
int
Description

The config group ID of this TLD's regisrar.

tldExtension
Type
string
Description

The extension of this TLD without the leading dot. For example, co.uk or org.

tldName
Type
string
Description

The name of this TLD.

tldWhoisServer
Type
string
Description

The hostname of the whois server for this TLD.

tldWhoisResp
Type
string
Description

The string to search for in the whois response which signifies that a domain is available.

tldActive
Type
boolean
Description

Whether this TLD is active.

tldAutoSearch
Type
boolean
Description

Whether the order form should automatically check this TLD whenever any domain is queried.

tldTransferMinimumCycleID
Type
int
Description

ID for the cycle for the minimum duration for a transfer to this TLD.

tldMinimumCycleID
Type
int
Description

ID for the cycle for the mimimum duration for which a domain of this TLD may be purchased.

tldMaximumCycleID
Type
int
Description

ID for the cycle for the maximum duration for which a domain of this TLD may be purchased.

tldRenewType
Type
int
Description

The type of renewal for this TLD.

  • 0: Disabled
  • 1: Renewed by the registrar
  • 2: Renewed by ModernBill

tldIsTransferable
Type
boolean
Description

Whether this TLD is transferable.

tldTransferType
Type
int
Description

The type of transfer for this TLD.

  • 0: Code
  • 1: Fax
  • 2: Email
  • 3: Mail

tldIDNSupport
Type
boolean
Description

Whether IDN is supported by this TLD's registrar.

tldIDNType
Type
int
Description

The type of IDN supported by this TLD's registrar.

  • 0: Puny Code

tldRemoteLockEnabled
Type
boolean
Description

Allow this TLD to be locked at the registrar.

products
Type
group
Description

Contains data about how products are really related to this TLD.

Children
product
Type
group
Description

Contains data for a single product that is really related to this TLD. This may occur multiple times.

Children
productID
Type
int
Description

ID of a product that is really related to this TLD.

ghostProducts
Type
group
Description

Contains data about how products are imaginarily related to this TLD.

Children
ghostProduct
Type
group
Description

Contains data for a single product that is really imaginarily to this TLD. This may occur multiple times.

Children
productID
Type
int
Description

ID of a product that is imaginarily related to this TLD.