MBAPI Element Index
MBAPI Intro → MBAPI Command Index → GetCerts

GetCerts

Description

This class is an instantion of the Command class, that executes a command pertaining to fetching SSL certificate information, in the default case from the database. This class should only be instantiated by dispatchMBAPI() found in include/heart/mbapi/mbapi.php. Something similar to the following XML should be passed to dispatchMBAPI() when you want to call the GetCerts command:

Attributes

package
modernbill
subpackage
mbapi
version
0.1
author
Michael Fountain
author
Andy Christ

Example Request

	<mbapi>
		<command><!-- None --></command>
		<showXMLHeader><!-- None --></showXMLHeader>
		<params>
			<certID><!-- int --></certID>
			<packageID><!-- int --></packageID>
			<clientID><!-- int --></clientID>
			<orID><!-- int --></orID>
			<rID><!-- int --></rID>
			<orStatus><!-- int --></orStatus>
			<orSuccesscode><!-- string --></orSuccesscode>
			<orErrorcode><!-- string --></orErrorcode>
			<CSRDomainName><!-- string --></CSRDomainName>
			<certTimestamp><!-- int --></certTimestamp>
			<certTimestampGreaterThan><!-- int --></certTimestampGreaterThan>
			<certTimestampLessThan><!-- int --></certTimestampLessThan>
			<certTimestampGreatest><!-- int --></certTimestampGreatest>
			<certTimestampLeast><!-- int --></certTimestampLeast>
			<orStartstamp><!-- int --></orStartstamp>
			<orStartstampGreaterThan><!-- int --></orStartstampGreaterThan>
			<orStartstampLessThan><!-- int --></orStartstampLessThan>
			<orStartstampGreatest><!-- int --></orStartstampGreatest>
			<orStartstampLeast><!-- int --></orStartstampLeast>
			<orSubmitstamp><!-- int --></orSubmitstamp>
			<orSubmitstampGreaterThan><!-- int --></orSubmitstampGreaterThan>
			<orSubmitstampLessThan><!-- int --></orSubmitstampLessThan>
			<orSubmitstampGreatest><!-- int --></orSubmitstampGreatest>
			<orSubmitstampLeast><!-- int --></orSubmitstampLeast>
			<CSRStartDate><!-- int --></CSRStartDate>
			<CSRStartDateGreaterThan><!-- int --></CSRStartDateGreaterThan>
			<CSRStartDateLessThan><!-- int --></CSRStartDateLessThan>
			<CSRStartDateGreatest><!-- int --></CSRStartDateGreatest>
			<CSRStartDateLeast><!-- int --></CSRStartDateLeast>
			<CSREndDate><!-- int --></CSREndDate>
			<CSREndDateGreaterThan><!-- int --></CSREndDateGreaterThan>
			<CSREndDateLessThan><!-- int --></CSREndDateLessThan>
			<CSREndDateGreatest><!-- int --></CSREndDateGreatest>
			<CSREndDateLeast><!-- int --></CSREndDateLeast>
			<getProductPackage><!-- int --></getProductPackage>
			<getClientData><!-- int --></getClientData>
			<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
certID
Type
int
Description

The ID of the cert item to fetch. This will always select at most 1 cert.

packageID
Type
int
Description

The ID of the package that the cert is associated with.

clientID
Type
int
Description

The client ID of the certs that you wish to fetch.

orID
Type
int
Description

The order ID of the cert that you wish to fetch. This will always select at most 1 cert.

rID
Type
int
Description

The SSLFactory reseller ID used to order this cert. In most instances, this will be the same for all certs in a ModernBill install so has limited search utility.

orStatus
Type
int
Description

The status of the certs that you wish to fetch.

orSuccesscode
Type
string
Description

The textual success code for the cert order.

orErrorcode
Type
string
Description

The textual error code for the cert order.

CSRDomainName
Type
string
Description

The domain name on the CSR that is used to generate the cert.

certTimestamp
Type
int
Description

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

certTimestampGreaterThan
Type
int
Description

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

certTimestampLessThan
Type
int
Description

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

certTimestampGreatest
Type
int
Description

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

certTimestampLeast
Type
int
Description

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

orStartstamp
Type
int
Description

The exact UNIX timestamp for the datetime a cert order was started.

orStartstampGreaterThan
Type
int
Description

The minimum UNIX timestamp for the datetime a cert order was started.

orStartstampLessThan
Type
int
Description

The maximum UNIX timestamp for the datetime a cert order was started.

orStartstampGreatest
Type
int
Description

The highest UNIX timestamp for the datetime a cert order was started. This will return all dates less than or equal to this timestamp.

orStartstampLeast
Type
int
Description

The lowest UNIX timestamp for the datetime a cert order was started. This will return all dates greater than or equal to this timestamp.

orSubmitstamp
Type
int
Description

The exact UNIX timestamp for the datetime a cert order was submitted.

orSubmitstampGreaterThan
Type
int
Description

The minimum UNIX timestamp for the datetime a cert order was submitted.

orSubmitstampLessThan
Type
int
Description

The maximum UNIX timestamp for the datetime a cert order was submitted.

orSubmitstampGreatest
Type
int
Description

The highest UNIX timestamp for the datetime a cert order was submitted. This will return all dates less than or equal to this timestamp.

orSubmitstampLeast
Type
int
Description

The lowest UNIX timestamp for the datetime a cert order was submitted. This will return all dates greater than or equal to this timestamp.

CSRStartDate
Type
int
Description

The exact UNIX timestamp for the start date of the cert's validity.

CSRStartDateGreaterThan
Type
int
Description

The minimum UNIX timestamp for the start date of the cert's validity.

CSRStartDateLessThan
Type
int
Description

The maximum UNIX timestamp for the start date of the cert's validity.

CSRStartDateGreatest
Type
int
Description

The highest UNIX timestamp for the start date of the cert's validity. This will return all dates less than or equal to this timestamp.

CSRStartDateLeast
Type
int
Description

The lowest UNIX timestamp for the start date of the cert's validity. This will return all dates greater than or equal to this timestamp.

CSREndDate
Type
int
Description

The exact UNIX timestamp for the end date of the cert's validity.

CSREndDateGreaterThan
Type
int
Description

The minimum UNIX timestamp for the end date of the cert's validity.

CSREndDateLessThan
Type
int
Description

The maximum UNIX timestamp for the end date of the cert's validity.

CSREndDateGreatest
Type
int
Description

The highest UNIX timestamp for the end date of the cert's validity. This will return all dates less than or equal to this timestamp.

CSREndDateLeast
Type
int
Description

The lowest UNIX timestamp for the end date of the cert's validity. This will return all dates greater than or equal to this timestamp.

getProductPackage
Type
int
Description

If 1 will retrieve addititional product information.

getClientData
Type
int
Description

If 1 will retrieve the client information.

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

Response Elements

None