GM_GetSubscriptions


Definition

Retrieve a list of the goMobi subscriptions in an account.

Usage

Use this command to retrieve a list of the goMobi subscriptions in an account.

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-mobile-2/manage.aspx

The GM_GetSubscriptions command generates the list of goMobi subscriptions on this page.

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
SortBy Optional; default is StatusID Sort the list of goMobi subscriptions by this parameter. Permitted values are the return parameters in a GM_GetSubscriptions response:
MobileDomainName
SourceDomainName
StatusDesc
NextBillingDate
StatusID
GMSubscriptionID
RenewDate
16
SortOrder Optional; default is Asc Arrange the sorted list in ascending or descending order? Permitted values are Asc or Desc 4
RecordsToReturn Optional; default is 25 Number of records to return in this response. Permitted values are numeric 5
StartPosition Optional; default is 1 In the sorted list, start with the entry in this position.
For example, to return items 26 through 50 in a sorted list, submit RecordsToReturn=25&StartPosition=26
5
StatusFilter Optional; if no value is supplied, all statuses are returned Return records that match this filter. Permitted values are the StatusID values returned by the GM_GetStatuses command:
1 Service Active
2 Cancellation Pending
3 Service Disabled
4 Billing Failed
1
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
MobileDomainName Domain name that displays this mobilized site
SourceDomainName Domain name of the desktop web site from which this mobile site derives its content
StatusDesc Status description of this goMobi subscription
NextBillingDate Next billing date:
7 days ahead of expiration date for monthly billing
14 days ahead of expiration for yearly billing
StatusId Status identification number corresponding to the StatusDesc value
GMSubscriptionId Identification number for this goMobi subscription
TotalCount Total number of goMobi subscriptions in this list
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