get_control_panel_url

Returns the URL for the goMobi control panel that you use to define the appearance of the mobile site.

📘

Important:

This link is only available for 5 minutes.

Request parameters for get_control_panel_url

Standard parameters

  • action = get_control_panel_url
  • object = publishing

Attributes

Parameters within the attributes associative array are described below.

Parameter nameObligationDefinition/Value
domainRequiredThe name of the mobile domain.
languageOptionalThe language in which the goMobi Control Panel is displayed. The URL that is returned will be for the Control Panel in the specified language.

The default is English.

Allowed values are:

de—German
en—English (US)
en-GB—English (UK)
es—Spanish
fr—French
it—Italian
ja—Japanese
nl—Dutch
pt—Portuguese
ru—Russian
sl—Slovenian
zh-CN—Chinese
service_typeRequiredThe type of Publishing service.

Allowed value is gomobi.

Response parameters for get_control_panel_url

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 nameObligationDefinition/Value
control_panel_urlReturned if is_success = trueThe URL for the goMobi control panel that you use to define the appearance of the mobile site.

Examples for get_control_panel_url

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_CONTROL_PANEL_URL</item>
                <item key="object">PUBLISHING</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="service_type">gomobi</item>
                        <item key="domain">example.net</item>
                        <item key="language">es</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">Got GoMobi control-panel URL for 'example.net'.</item>
                <item key="attributes">
                    <dt_assoc>
                        <item key="control_panel_url">https://cpsandbox.instantmobilizer.com/69/examp le.net/1290717040/G8%2BIDXjU0hyJ%2FnKMp7%2BJAwKX9T7mVg7Q%2BPcKA %2FSDN1hAFHSk%2FvMLQyBhQyXwZWj66TWHJ0%2BWPppK %0A70VKGNodLaiepIiIvQU9bpPu63O%2BsxmORtu4cQLzyKGQVYstjYhozrXhFJsGDK %2B30zU%2FvZEmalC4%0AL4x5qm9aQ28i75gUEb4%3D%0A/en</item>
                    </dt_assoc>
                </item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>