GetAddressBook


Definition

Retrieve all contact information that has been entered for all domains in this account.

Usage

Use this command to retrieve all contact information that has been entered for domains in this account.

This command retrieves only information associated with names in this account. It does not retrieve information from subaccounts.

A typical use for this command is for accounts that offer real-time purchases, where the account contains domain names registered by many customers.

Availability

All resellers have access to this command.

Implementation on eNom.com

This command is not implemented on enom.com. This command will typically be used by a domain name reseller for administrative purposes.

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
PageSize Optional; default is 100 Number of contacts to return in this response 4
Page Optional; default is 1 Which page of responses to return. For example, if PageSize=100&Page=2 generates the second “page” of 100 contacts: contacts 101 through 200. 3
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
AddressRec Record number for this contact, assigned dynamically when this query runs
PartyID Party ID for this contact, a permanent value
OrganizationName Organization name
JobTitle Job title
FirstName First name
LastName Last name
Address1 Street address, first line
Address2 Street address, second line
City City
StateProvince State or province
StateProvinceChoice S indicates the StateProvince value is a state; P indicates province
PostalCode Postal code
Country Country
Phone Phone number
PhoneExt Phone extension
Fax Fax number
Email Email address
Count Number of contacts returned in this response (may be fewer than the PageSize value)
TotalPages Total number of “pages” of contacts that exist for this account, given the Page Size value submitted in this query.
Command Name of command executed
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 first contact in the response will always be the Billing contact for the account. This is true regardless ofthe Page and PageSize values submitted in the query.
  • Other than the first contact in the response, contacts are listed in the order they are retrieved from ourdatabase. No sort parameters are offered for this command.
  • 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.

Example