get subreseller
Returns information about a subreseller account.
Standard parameters
- action = get
- object = subreseller
Attributes
Parameters within the attributes associative array are described below.
| Parameter name | Obligation | Definition/Value |
|---|---|---|
| username | Required | Username of the subreseller. |
Response parameters for get subreseller
Standard parameters
- action = reply
- is_success = a Boolean is returned, indicating success or failure of the request
- response_code = response code indicating outcome of the request
- response_text = message describing the outcome of the request
Attributes
If the request is successful, the attributes associative array may include the
following:
| Parameter name | Obligation | Definition/Value |
|---|---|---|
| allowed_tld_list | Returned if is_success = true | List of TLDs that the subreseller is allowed to sell. |
| ccp_enabled | Returned if is_success = true | Indicates whether credit card payments are allowed for the subreseller. N—No Y—Yes |
| cert_permission | Returned if is_success = true | Indicates whether the subreseller is allowed to sell SSL Certificates. 0—No 1—Yes |
| contact_set | Returned if is_success = true | Sub-Reseller’s contact information. The admin contact for a subreseller is the Emergency Contact, which is not the same as a domain admin contact. The following values are required for the subreseller admin contact: first_name, last_name, org_name, phone, and email. The tech contact, can include any of the fields explained in the contact_set section; however, it must include first_name, last_name, org_name, address1, city, phone, and email. If country is Canada or U.S, it also includes the state and postal code parameters. |
| low_balance_email | Returned if is_success = true | The email address to which notices are sent when the subreseller's account balance falls to a predefined level. |
| nameservers | Optional | List of default nameservers for the subreseller. |
| payment_email | Optional | The email address to which payment notices are sent. |
| pricing_plan | Returned if is_success= true | The pricing plan assigned to the subreseller. |
| reseller_id | Returned if is_success= true | The ID of the reseller who created and manages the subreseller. |
| status | Returned if is_success= true | Set the status of the account. Allowed values are active, onhold, locked, canceled, and paid_only. |
| storefront_rwi | Optional | Indicates whether the Storefront link displays in the RWI for this subreseller (and hence whether the subreseller can configure a Storefront). N—Do not display the Store front link Y—Display the Store front link |
| system_status_email | Returned if is_success= true | The email address that will receive system status messages. |
| url | Optional | The web address of the account. |
| username | Returned if is_success= true | Username for the new subreseller. |
Examples for get subreseller
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">GET</item>
<item key="object">SUBRESELLER</item>
<item key="attributes">
<dt_assoc>
<item key="username">subtest</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">REPLY</item>
<item key="object">SUBRESELLER</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="response_text">Query Successful</item>
<item key="pricing_plan_id">84</item>
<item key="pricing_plan">silver</item>
<item key="attributes">
<dt_assoc>
<item key="system_status_email">[email protected]</item>
<item key="low_balance_email">[email protected]</item>
<item key="status">cancelled</item>
<item key="cert_permission">0</item>
<item key="nameservers">
<dt_assoc>
<item key="fqdn4" />
<item key="fqdn2">ns2.systemdns.com</item>
<item key="fqdn5" />
<item key="fqdn1">ns1.systemdns.com</item>
<item key="fqdn6" />
<item key="fqdn3" />
</dt_assoc>
</item>
<item key="payment_email">[email protected]</item>
<item key="username">subtest</item>
<item key="allowed_tld_list">
<dt_array>
<item key="0">.cc</item>
<item key="1">.com.vc</item>
<item key="2">.net</item>
<item key="3">.com</item>
<item key="4">.nl</item>
<item key="5">.mobi</item>
<item key="6">.fr</item>
<item key="7">.tv</item>
<item key="8">.ltd.uk</item>
<item key="9">.co.uk</item>
<item key="10">.me.uk</item>
<item key="11">.vc</item>
<item key="12">.at</item>
<item key="13">.info</item>
<item key="14">.it</item>
<item key="15">.ch</item>
<item key="16">.net.uk</item>
<item key="17">.mx</item>
<item key="18">.us</item>
<item key="19">.es</item>
<item key="20">.org.vc</item>
<item key="21">.asia</item>
<item key="22">.org</item>
<item key="23">.be</item>
<item key="24">.tel</item>
<item key="25">.eu</item>
<item key="26">.net.vc</item>
<item key="27">.plc.uk</item>
<item key="28">.biz</item>
<item key="29">.ca</item>
<item key="30">.name</item>
<item key="31">.de</item>
<item key="32">.dk</item>
<item key="33">.org.uk</item>
<item key="34">.li</item>
<item key="35">.me</item>
</dt_array>
</item>
<item key="wsb_permission">0</item>
<item key="contact_set">
<dt_assoc>
<item key="admin">
<dt_assoc>
<item key="email">[email protected]</item>
<item key="org_name" />
<item key="phone">+1.4165551234</item>
<item key="phone2">+1.4165551123</item>
<item key="first_name">John</item>
<item key="last_name">Doe</item>
</dt_assoc>
</item>
<item key="tech">
<dt_assoc>
<item key="org_name">Sub Reseller Company Inc.</item>
<item key="first_name">John</item>
<item key="last_name">Doe</item>
<item key="title">CEO</item>
<item key="phone">+1.4165551122 x333</item>
<item key="fax">+1.4165551221</item>
<item key="email">[email protected]</item>
<item key="address1">55 Reseller Ave</item>
<item key="address2">Suite 99</item>
<item key="address3"></item>
<item key="city">New York</item>
<item key="state">NY</item>
<item key="country">US</item>
<item key="postal_code"> 70218</item>
</dt_assoc>
</item>
</dt_assoc>
</item>
<item key="storefront_rwi">Y</item>
<item key="ccp_enabled">Y</item>
<item key="reseller_id">9782</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Updated over 2 years ago