add_softwareinstall() | API Reference

Signature

add_softwareinstall(array $parameters): mixed

Parameters

Pass these parameters as KasRequestParams. Every request also requires kas_login, kas_auth_type, and kas_auth_data, as shown in SOAP with PHP.

Name	Description	Requirement
`software_id`	See the return value of get_softwareinstall	Required
`software_database`	The database to use	Required
`software_database_password`	The database password	Required
`software_hostname`	The host name of the software	Required
`software_install_example_data`	Install example data if available: Y\|N	Optional Default: `N`
`software_path`	The path of the software	Required
`software_admin_mail`	The email address for the confirmation email, RFC 2822	Required
`software_admin_user`	The admin user	Required
`software_admin_pass`	The password for the admin access	Required
`language`	The language of the confirmation email: de\|en	Optional Default: `de`

PHP example

<?php

// $sessionToken is returned by KasAuth, see SOAP with PHP.
$parameters = [
    'software_id' => 'typo3_v1.2.3',
    'software_database' => 'd0123456',
    'software_hostname' => 'example.com',
    'software_path' => 'directory',
    'software_admin_mail' => 'admin@example.com',
    'software_admin_pass' => 'password',
    'language' => 'de',
];

try {
    $client = new SoapClient('https://kasapi.kasserver.com/soap/wsdl/KasApi.wsdl');
    $response = $client->KasApi(json_encode([
        'kas_login' => 'w0123456',
        'kas_auth_type' => 'session',
        'kas_auth_data' => $sessionToken,
        'kas_action' => 'add_softwareinstall',
        'KasRequestParams' => $parameters,
    ]));
    print_r($response);
} catch (SoapFault $fault) {
    echo 'Error: ' . $fault->faultstring;
}

Open interactive example

Responses and error codes

TRUE the action was carried out
missing_parameter a required parameter is missing
in_progress a software installation is already running
install_example_data_syntax_incorrect
admin_mail_syntax_incorrect
admin_user_syntax_incorrect
admin_user_forbidden
admin_password_forbidden
domain_doesnt_exist
host_using_redirect
kas_inst_software_forbidden the account may not use the software installation
language_syntax_incorrect
software_database_not_found
software_id_not_found
software_database_password_incorrect