Guides

create (publishing)

Creates a new goMobi domain.

Suggest Edits

Request parameters for create (publishing)

Standard parameters

  • action = create
  • object = publishing

Attributes

Parameters within the attributes associative array are described below.

Parameter nameObligationDefinition/Value
domainRequiredThe name of the mobile domain that you want to create.
end_user_auth_infoOptionalA list of the end user account information.

For more information, see the End user auth info table below.
service_typeRequiredThe type of Publishing service.

Allowed value is gomobi.
source_domainOptionalThe name of the domain on which the new mobile web page will be based.

End user auth info

Parameters within the end_user_auth_info associative array are described
below.

If you are adding the service to an existing account, you only need to specify the username; if you are creating a new account, you must specify username, email_address,and password.

📘

Note:

If you do not specify a username and password, the service will work; however, the domain owner will not be able to access the end user control panel at domainadmin.com. In that case, you can either provision the domain for your customer or you can provide your own end user interface.

Parameter nameObligationDefinition/Value
email_addressRequired if end_user_auth_info is specified and this is a new accountThe domain owner's email address.
passwordRequired if end_user_auth_info is specified and this is a new accountThe password associated with the Publishing service. The password must be at least 8 characters long.
usernameRequired if end_user_auth_info is specifiedThe username associated with the Publishing service. The username must be at least 6 characters long.

Response parameters for create (publishing)

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

Examples for create (publishing)

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">CREATE</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="source_domain">example.com</item>
                        <item key="end_user_auth_info">
                            <dt_assoc>
                                <item key="email_address">[email protected]</item>
                                <item key="password">BigPWTest</item>
                                <item key="username">danny1234</item>
                            </dt_assoc>
                        </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_text">Publishing service created</item>
                <item key="response_code">200</item>
                <item key="is_success">1</item>
            </dt_assoc>
        </data_block>
    </body>
</OPS_envelope>

Updated almost 4 years ago