WSB_GetOverview


Definition

Get all Website Builder accounts detail for a customer.

Usage

Use this command to get setails about all Website Builder accounts for a loginid.

Availability

All resellers have access to this command.

Implementation on eNom.com

Log on to resellertest.enom.com with Login ID resellid, password resellpw.

https://resellertest.enom.com/web-site-builder/details.aspx?

When this page loads it will call the API Command WSB_GetOverview command.

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
StartRecordNum Optional What Record Number to start with ?
SortOrder Optional values are ASC(ascending) or DESC(descending) ?
StatusFilter Optional Permitted Values: Awaiting Configuration Service Active Billing Failed Pending Renewal Cancellation Pending Service Canceled Pending Expiration Service Expired Service Deleted ?
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
websitebuildsite

Node found under websitebuildsites, each node has the following attributes:
brandref: brand id for reseller
billingcycle: values are Monthly or Yearly
username
emailaddress
siteref: site id
userref: user id
prodstatusid: id for status
prodstatusdesc: Values are:

  • Awaiting Configuration
  • Service Active
  • Billing Failed
  • Pending Renewal
  • Cancellation Pending
  • Service Canceled
  • Pending Expiration
  • Service Expired
  • Service Deleted

expirationdate: Expiration Date for Free Trial or will be equal to Next Billing Date
prodtype: id for product
proddesc: Website Builder Product Name
vasitemid: Website Builder Account ID which is used in API calls to reference individual accounts
nextbillingdate: Next Billing Date
statusdesc: Status Description domain: Domain associated with Website Builder

Success true indicates Website Builder account was created, false indicates it was not so look at ErrX
Command Name of command executed
ErrCount The number of errors if any occurred. If greater than zero check the Errx
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 parameterErr(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.

Example