get_service _info
Gets information about the goMobi service.
Request parameters for get_service_info
Standard parameters
- action = get_service_info
- object = publishing
Attributes
Parameters within the attributes associative array are described below.
Parameter name | Obligation | Definition/Value |
---|---|---|
domain | Required | The name of the mobile domain. |
service_type | Required | The type of Publishing service. Allowed value is gomobi. |
Response parameters for get_service_info
Standard parameters
- action = reply
- object = publishing
- 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 |
---|---|---|
aliases | Returned if aliases exist and is_success = true | The list of aliases associated with the domain. |
billing_date | Returned if is_success = true | The next billing date for the goMobi service. |
creation_date | Returned if is_success = true | The date the goMobi service was purchased. |
domain | Returned if is_success = true | The name of the mobile domain. |
gomobi | Returned if is_success = true | Lists information about the goMobi service. For more information, see the gomobi table below. |
status | Returned if is_success = true | The current status of the goMobi service. Allowed values are: active—The service is active. deleted—The service is no longer active and cannot be re-enabled. disabled—The mobile site is not accessible, but the reseller is still being billed. insufficient funds—The reseller has insufficient funds in their account to cover the charges for the current billing period. let expire—The service will expire at the end of the current billing period. processed—The order has been processed. |
gomobi
Parameters within the gomobi associative array are described below.
Parameter name | Obligation | Definition/Value |
---|---|---|
source_domain | Always returned | The name of the domain on which the mobile domain is based. |
Examples for get_service_info
Request
<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<OPS_envelope>
<header>
<version>0.9</version>
</header>
<body>
<data_block>
<dt_assoc>
<item key="protocol">XCP</item>
<item key="action">GET_SERVICE_INFO</item>
<item key="object">PUBLISHING</item>
<item key="attributes">
<dt_assoc>
<item key="service_type">gomobi</item>
<item key="domain">example.net</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Response
<?xml version='1.0' encoding="UTF-8" standalone="no"?>
<!DOCTYPE OPS_envelope SYSTEM "ops.dtd">
<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">PUBLISHING</item>
<item key="response_code">200</item>
<item key="is_success">1</item>
<item key="response_text">Service information retrieved.</item>
<item key="attributes">
<dt_assoc>
<item key="service_type">gomobi</item>
<item key="gomobi">
<dt_assoc>
<item key="source_domain">example.com</item>
</dt_assoc>
</item>
<item key="domain">example.net</item>
<item key="creation_date">2010-11-26 12:33:03 UTC</item>
<item key="status">active</item>
<item key="aliases">
<dt_array>
<item key="0">example.net</item>
<item key="1">example.org</item>
<item key="2">example.info</item>
<item key="3">example.biz</item>
<item key="4">example.us</item>
</dt_array>
</item>
<item key="billing_date">2010-12-26 12:33:03 UTC</item>
</dt_assoc>
</item>
</dt_assoc>
</data_block>
</body>
</OPS_envelope>
Updated over 1 year ago