Portal_GetAwardedDomains


Definition

This command will get a list of domains awarded to watchlist users belonging to the parent reseller.

Usage

This command will get a list of all domains that have been awarded to the resellers watchlist users. Only domains that have not yet been marked as provisioned will be returned by this command.

Availability

All resellers have access to this command.

Implementation on eNom.com

This command is not utilized on enom.com as it is intended for partner integration

Constraints

The query must meet the following requirements:

  • The login ID and password must be valid.

Input parameters

Build the query string using this syntax:

https://resellertest.enom.com/interface.asp?
command=nameofcommand&uid=yourloginid&pw=yourpassword
&paramname=paramvalue&nextparamname=nextparamvalue

 

Parameter Status Description Max Size
UID Required Account login ID 20
PW Required Account password 20
RecordCount Optional; default is 25 The maximum number of records to return. maximum records is capped at 100 3
RecordOption Optional; default is 0 Determine the type of domains you will get back; Permitted values are:
0 - Only return domains that a Reseller has not provisioned
1 - Only return domains that a Reseller has already provisioned
2 - Return all data, even ones that have already been awarded
5
StartPosition Optional; default is 1 Optionally set which value to start at. This allows you to optionally page through the results. 5
Tld Optional; default is NULL Optionally allows you to filter the results only to domains with the specified TLD 5
DomainNameID Optional; default is NULL Optionally allows you to filter the results only to the single domain with the specified Domain Name ID. 5

 

Returned parameters and values

Parameter Description
DomainCount Number of domains returned in this response
TotalDomainCount Total number of domains available to be returned
NextStartPosition Next starting position to use for those paging through the results.
DomainName The Domain Name
EmailAddress The Email Address of the portal user
ExpirationDate The domains expiration date.
RegisterDate The domains registration date.
ForeignLoginID The login ID on your system that registered the domain.
PortalDomainId The Portal Domain Name ID of the domain.
RegisterPrice The users registration price. This is the price that they paid.
RenewPrice The users registration price. This is the price that they would pay to renew the domain at your current pricing.
RegistrationPeriod The number of years the domain is registered for
ResellerProvisioned Boolean value indicating if you have marked this domain as provisioned into your system.
ResellerProvisionedDate If the domain is marked as provisioned, this is the date that it was done so.
RegistrationStatus Registration status of the domain. Example: Registered, Expired, etc.
ErrCount The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
ErrX Error messages explaining the failure. These can be presented as is back to the client.
Done True indicates this entire response has reached you successfully.

 

Notes

  • The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
  • Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.
  • Note: NewStartPosition is calculated by total results, start position and records to return. It is advised that if you are paging through the results that you do the calculation yourself with the values that make sense for your application.
  • Note: ForeignLoginID is the "LoginID" that you pass along to the PORTAL_GETTOKEN API Command

Example