RPT_GetReport


Definition

Retrieve an itemized list of one type of activity in a domain name account.

Usage

Use this command to retrieve a list of one of the following types of account activity in a domain name account: registrations, renewals, transfers, private label, subaccounts, accounting, or expiring names.

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/myaccount/newReports.asp

When you choose one of the seven report types listed above under Usage, the view report button calls the RPT_GetReport command.

Constraints

The query must meet the following requirements:

  • The login ID and password must be valid.
  • The beginning date for reports must be no earlier than 6 months before today.
  • The ResponseType must be XML. You can parse the XML response after receiving it.

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
Version Optional; default is 0 Version of this command. Permitted values are 0 and 1. Use Version=1 to receive the return parameters listed in the Returned parameters table below. Version=0 and Version=1 return parameters vary slightly in the data returned and in the tag names. We recommend that you use Version=1,which avoids timeouts by supporting paging of results, and queueing of the query. 20
ReportType Required Type of report to generate. Permitted values are:
0 Registrations
1 Renewals
2 Transfers In
11 Transfers Out
3 Private Label (Instant Reseller and Registry Rocket)
4 Sub-Accounts
5 Accounting
6 Expiring Domains
10 Pricing Editor Updates
13 Business Listing Bulk Update
15 Business Listing Domain Update
16 Transactions
17 Order History
18 Periodic Billing History
20 Premium Registration
21 Monthly Invoices
22 Invoice History
23 Invoice Detail
24 List of Invoices
25 Top Watchlist TLDs
26 Watchlist Summary
27 Top Watchlists
28 All Watchlists
29 All Watchlist Details
30 Domain Name History
31 Domain Verification/Suspension
1?
BeginDate Optional; default is the last day of the month, two months before the current month First date to include in the report. Must be no earlier than six months before today. Use format MM/DD/YYYY 10
EndDate Optional; default is today’s date Last date to include in the report. Use format MM/DD/YYYY 10
Start Optional; default is 1 In the overall list of returns for this report type and date range, the start position for the return to this query. 8
RecordsToReturn Optional; default is 100 if Download=False Number of items to return in this report. 8
Download Required Do you wish to run report in real time or deliver to this account’s Billing contact email address? Permitted values are: True Send the report via email False Real-time and deliver in API response Reports will always be delivered by email if they extend past four months before today, or if they includemore than 25,000 results. ?
ReportOutputType Required If delivering the report via email, ReportOutputType must be 2. ?
ResponseType Required Format of response. Permitted value is XML. 4

 

Returned parameters and values

Parameter Description
RptString List report descriptions
ThreeMoPast The date three months before today
SixMoPast The date six months before today
BeginDate The first date included in this report
EndDate The last date included in this report
ID Report type identification number
Name Report name
ReportType Report type specified in this query string
ReportName Name of the report type specified in this query string
QueueReportResults Should report results be queued. Permitted values are 1 to queue results; 0 to send results immediately via HTTP.
ReportResults Results specific to this report type. The results, and return parameters, vary by report type.
DomainName Domain name
OrderID Order identification number
Commission Commission
SalePrice Sale price
DateApplied Date sale was recorded
LoginID Login ID to which this order was delivered
NewStartPosition In the full list of results, the start position of the next page of results
ThisStartPosition In the full list of results, the position of the first result listed on this page
ThisEndPosition In the full list of results, the position of the last result listed on this page
PreviousStartPosition In the full list of results, the position of the previous page of results
TotalReturned Number of results listed on this page
TotalRows Number of results total for this report
ShowPrevious Should this page show a link to the previous page of results?
ShowNext Should this page show a link to the next page of results?
ShowPaging Should this page show links to previous and next results?
Version Version of this command that generated this return
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 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