MBAPI Element Index
MBAPI Intro → MBAPI Command Index → GetDomains

GetDomains

Description

This class fetches domain information, in the default case from the database. This class should only be instantiated by dispatchMBAPI() found in include/mbapi/mbapi.php. Something similar to the following XML should be passed to dispatchMBAPI() when you want to call the GetDomains command:

Attributes

package
modernbill
subpackage
mbapi
version
0.1
author
Vic Fryzel
author
Andy Christ

Example Request

	<mbapi>
		<command><!-- None --></command>
		<showXMLHeader><!-- None --></showXMLHeader>
		<params>
			<packageID><!-- int --></packageID>
			<clientID><!-- int --></clientID>
			<domainID><!-- int --></domainID>
			<domainSLD><!-- string --></domainSLD>
			<domainTLD><!-- string --></domainTLD>
			<domainName><!-- string --></domainName>
			<domainRenewType><!-- int --></domainRenewType>
			<domainDateCreated><!-- int --></domainDateCreated>
			<domainDateCreatedGreaterThan><!-- int --></domainDateCreatedGreaterThan>
			<domainDateCreatedLessThan><!-- int --></domainDateCreatedLessThan>
			<domainDateCreatedGreatest><!-- int --></domainDateCreatedGreatest>
			<domainDateCreatedLeast><!-- int --></domainDateCreatedLeast>
			<domainDateExpires><!-- int --></domainDateExpires>
			<domainDateExpiresGreaterThan><!-- int --></domainDateExpiresGreaterThan>
			<domainDateExpiresLessThan><!-- int --></domainDateExpiresLessThan>
			<domainDateExpiresGreatest><!-- int --></domainDateExpiresGreatest>
			<domainDateExpiresLeast><!-- int --></domainDateExpiresLeast>
			<domainDateLastSync><!-- int --></domainDateLastSync>
			<domainDateLastSyncGreaterThan><!-- int --></domainDateLastSyncGreaterThan>
			<domainDateLastSyncLessThan><!-- int --></domainDateLastSyncLessThan>
			<domainDateLastSyncGreatest><!-- int --></domainDateLastSyncGreatest>
			<domainDateLastSyncLeast><!-- int --></domainDateLastSyncLeast>
			<packageType><!-- int --></packageType>
			<comparisonOperator><!-- string --></comparisonOperator>
			<sortDir><!-- None --></sortDir>
			<sortColumn><!-- None --></sortColumn>
			<recordOffset><!-- None --></recordOffset>
			<numRecords><!-- None --></numRecords>
		</params>
	</mbapi>

Example Response

None

Request Elements

mbapi
Type
None
Description
None
Children
command
Type
None
Description
None
showXMLHeader
Type
None
Description
None
params
Type
None
Description
None
Children
packageID
Type
int
Description

The ID of the package associated with this domain. This will always select at most 1 domain.

clientID
Type
int
Description

The ID of the client whose domains should be fetched.

domainID
Type
int
Description

The ID of the domain. This will always select at most 1 domain.

domainSLD
Type
string
Description

The SLD portion of the domain. This is the "ibm" portion of ibm.com

domainTLD
Type
string
Description

The TLD portion of the domain. This is the "co.uk" portion of bbc.co.uk

domainName
Type
string
Description

The domain name to fetch. This is a searched using a LIKE clause, so an exact, full name is not necessary.

domainRenewType
Type
int
Description

Set to 1 to retieve domains that are set to auto-renew at the registrar.

domainDateCreated
Type
int
Description

The exact UNIX timestamp for which a domain in the result set was created.

domainDateCreatedGreaterThan
Type
int
Description

The minimum UNIX timestamp for which a domain in the result set was created

domainDateCreatedLessThan
Type
int
Description

The maximum UNIX timestamp for which a domain in the result set was created.

domainDateCreatedGreatest
Type
int
Description

The highest UNIX timestamp for a domain in the result set was created. This will return all dates less than or equal to this timestamp.

domainDateCreatedLeast
Type
int
Description

The lowest UNIX timestamp for a domain in the result set was created. This will return all dates greater than or equal to this timestamp.

domainDateExpires
Type
int
Description

The exact UNIX timestamp for which a domain in the result set was Expires.

domainDateExpiresGreaterThan
Type
int
Description

The minimum UNIX timestamp for which a domain in the result set was Expires

domainDateExpiresLessThan
Type
int
Description

The maximum UNIX timestamp for which a domain in the result set was Expires.

domainDateExpiresGreatest
Type
int
Description

The highest UNIX timestamp for a domain in the result set was Expires. This will return all dates less than or equal to this timestamp.

domainDateExpiresLeast
Type
int
Description

The lowest UNIX timestamp for a domain in the result set was Expires. This will return all dates greater than or equal to this timestamp.

domainDateLastSync
Type
int
Description

The UNIX timestamp of when the last Domain Sync has occured.

domainDateLastSyncGreaterThan
Type
int
Description

The minimum UNIX timestamp for which a domain in the result set was last sync.

domainDateLastSyncLessThan
Type
int
Description

The maximum UNIX timestamp for which a domain in the result set was last sync.

domainDateLastSyncGreatest
Type
int
Description

The highest UNIX timestamp for a domain in the result set was last sync. This will return all dates less than or equal to this timestamp.

domainDateLastSyncLeast
Type
int
Description

The lowest UNIX timestamp for a domain in the result set was last sync. This will return all dates greater than or equal to this timestamp.

packageType
Type
int
Description

The product / package type to limit to. Needed when you don't want to include the hosting package

comparisonOperator
Type
string
Description

Used with some columns to denote type of comparison to use the the query. Ex. LIKE, =

sortDir
Type
None
Description
None
sortColumn
Type
None
Description
None
recordOffset
Type
None
Description
None
numRecords
Type
None
Description
None

Response Elements

None