Dangl\AVACloud\AvaConversionApi

All URIs are relative to https://avacloud-api.dangl-it.com

Method	HTTP request	Description
avaConversionConvertToAva	POST /conversion/ava/ava	Converts Dangl.AVA projects to Dangl.AVA. This is useful when you want to generate the calculated properties.
avaConversionConvertToExcel	POST /conversion/ava/excel	Converts Dangl.AVA projects to Excel
avaConversionConvertToGaeb	POST /conversion/ava/gaeb	Converts Dangl.AVA projects to GAEB
avaConversionConvertToOenorm	POST /conversion/ava/oenorm	Converts Dangl.AVA projects to Oenorm
avaConversionConvertToReb	POST /conversion/ava/reb	Converts Dangl.AVA projects to REB
avaConversionConvertToSia	POST /conversion/ava/sia	Converts Dangl.AVA projects to SIA 451

avaConversionConvertToAva

\Dangl\AVACloud\Model\ProjectDto avaConversionConvertToAva($ava_project, $try_auto_generate_item_numbers_and_schema, $remove_plain_text_long_texts, $remove_html_long_texts)

Converts Dangl.AVA projects to Dangl.AVA. This is useful when you want to generate the calculated properties.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: Dangl.Identity
$config = Dangl\AVACloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Dangl\AVACloud\Api\AvaConversionApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$ava_project = new \Dangl\AVACloud\Model\ProjectDto(); // \Dangl\AVACloud\Model\ProjectDto | The Dangl.AVA project
$try_auto_generate_item_numbers_and_schema = true; // bool | If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
$remove_plain_text_long_texts = true; // bool | If set to true, plain text long texts will be removed from the output to reduce response sizes
$remove_html_long_texts = true; // bool | If set to true, html long texts will be removed from the output to reduce response sizes

try {
    $result = $apiInstance->avaConversionConvertToAva($ava_project, $try_auto_generate_item_numbers_and_schema, $remove_plain_text_long_texts, $remove_html_long_texts);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvaConversionApi->avaConversionConvertToAva: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
ava_project	\Dangl\AVACloud\Model\ProjectDto	The Dangl.AVA project
try_auto_generate_item_numbers_and_schema	bool	If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.	[optional]
remove_plain_text_long_texts	bool	If set to true, plain text long texts will be removed from the output to reduce response sizes	[optional]
remove_html_long_texts	bool	If set to true, html long texts will be removed from the output to reduce response sizes	[optional]

Return type

\Dangl\AVACloud\Model\ProjectDto

Authorization

Dangl.Identity

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
Accept: application/vnd.com.dangl-it.ProjectDto.v1+json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

avaConversionConvertToExcel

\SplFileObject avaConversionConvertToExcel($ava_project, $try_auto_generate_item_numbers_and_schema, $write_prices, $write_long_texts, $conversion_culture)

Converts Dangl.AVA projects to Excel

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: Dangl.Identity
$config = Dangl\AVACloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Dangl\AVACloud\Api\AvaConversionApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$ava_project = new \Dangl\AVACloud\Model\ProjectDto(); // \Dangl\AVACloud\Model\ProjectDto | The Dangl.AVA project
$try_auto_generate_item_numbers_and_schema = true; // bool | If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
$write_prices = true; // bool | Defaults to true
$write_long_texts = true; // bool | Defaults to true
$conversion_culture = "conversion_culture_example"; // string | The culture that should be used for the conversion process, to have localized Excel files

try {
    $result = $apiInstance->avaConversionConvertToExcel($ava_project, $try_auto_generate_item_numbers_and_schema, $write_prices, $write_long_texts, $conversion_culture);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvaConversionApi->avaConversionConvertToExcel: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
ava_project	\Dangl\AVACloud\Model\ProjectDto	The Dangl.AVA project
try_auto_generate_item_numbers_and_schema	bool	If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.	[optional]
write_prices	bool	Defaults to true	[optional]
write_long_texts	bool	Defaults to true	[optional]
conversion_culture	string	The culture that should be used for the conversion process, to have localized Excel files	[optional]

Return type

\SplFileObject

Authorization

Dangl.Identity

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
Accept: text/plain, application/json, text/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

avaConversionConvertToGaeb

\SplFileObject avaConversionConvertToGaeb($ava_project, $try_auto_generate_item_numbers_and_schema, $destination_gaeb_type, $target_exchange_phase_transform, $enforce_strict_offer_phase_long_text_output, $export_quantity_determination, $remove_unprintable_characters_from_texts, $force_include_descriptions)

Converts Dangl.AVA projects to GAEB

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: Dangl.Identity
$config = Dangl\AVACloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Dangl\AVACloud\Api\AvaConversionApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$ava_project = new \Dangl\AVACloud\Model\ProjectDto(); // \Dangl\AVACloud\Model\ProjectDto | The Dangl.AVA project
$try_auto_generate_item_numbers_and_schema = true; // bool | If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
$destination_gaeb_type = "destination_gaeb_type_example"; // string | Defaults to GAEB XML V3.2
$target_exchange_phase_transform = "target_exchange_phase_transform_example"; // string | Defaults to none, meaning no transformation will be done
$enforce_strict_offer_phase_long_text_output = true; // bool | Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.
$export_quantity_determination = true; // bool | Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property.
$remove_unprintable_characters_from_texts = true; // bool | If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.
$force_include_descriptions = true; // bool | If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.

try {
    $result = $apiInstance->avaConversionConvertToGaeb($ava_project, $try_auto_generate_item_numbers_and_schema, $destination_gaeb_type, $target_exchange_phase_transform, $enforce_strict_offer_phase_long_text_output, $export_quantity_determination, $remove_unprintable_characters_from_texts, $force_include_descriptions);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvaConversionApi->avaConversionConvertToGaeb: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
ava_project	\Dangl\AVACloud\Model\ProjectDto	The Dangl.AVA project
try_auto_generate_item_numbers_and_schema	bool	If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.	[optional]
destination_gaeb_type	string	Defaults to GAEB XML V3.2	[optional]
target_exchange_phase_transform	string	Defaults to none, meaning no transformation will be done	[optional]
enforce_strict_offer_phase_long_text_output	bool	Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will be strictly schema compliant. If this is not enabled, any text that is marked to contain a text addition is exported in full to ensure that incorrectly used text additions are still preserved in the export.	[optional]
export_quantity_determination	bool	Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the 'QtyDeterm' (Quantity Determination, or Quantity Take Off) fields. To control this, you can set custom quantity calculations in the 'QuantityComponents' property of positions. Please see the entry for 'Quantity Determination' in the Dangl.AVA HowTo documentation section. Please be advised that enabling this might export data that was not intended to be exported, like internal quantity calculation details, depending on what data you put in the 'QuantityComponents' property.	[optional]
remove_unprintable_characters_from_texts	bool	If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.	[optional]
force_include_descriptions	bool	If this is enabled, all description elements like texts and execution descriptions will be output to the result. This is mostly only applicable to GAEB exports to phase 84 - Offer, which does typically not include descriptions.	[optional]

Return type

\SplFileObject

Authorization

Dangl.Identity

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
Accept: text/plain, application/json, text/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

avaConversionConvertToOenorm

\SplFileObject avaConversionConvertToOenorm($ava_project, $try_auto_generate_item_numbers_and_schema, $destination_oenorm_type, $try_repair_project_structure, $skip_try_enforce_schema_compliant_xml_output, $remove_unprintable_characters_from_texts)

Converts Dangl.AVA projects to Oenorm

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: Dangl.Identity
$config = Dangl\AVACloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Dangl\AVACloud\Api\AvaConversionApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$ava_project = new \Dangl\AVACloud\Model\ProjectDto(); // \Dangl\AVACloud\Model\ProjectDto | The Dangl.AVA project
$try_auto_generate_item_numbers_and_schema = true; // bool | If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
$destination_oenorm_type = "destination_oenorm_type_example"; // string | Defaults to Lv2015
$try_repair_project_structure = true; // bool | Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target
$skip_try_enforce_schema_compliant_xml_output = true; // bool | If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option.
$remove_unprintable_characters_from_texts = true; // bool | If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.

try {
    $result = $apiInstance->avaConversionConvertToOenorm($ava_project, $try_auto_generate_item_numbers_and_schema, $destination_oenorm_type, $try_repair_project_structure, $skip_try_enforce_schema_compliant_xml_output, $remove_unprintable_characters_from_texts);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvaConversionApi->avaConversionConvertToOenorm: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
ava_project	\Dangl\AVACloud\Model\ProjectDto	The Dangl.AVA project
try_auto_generate_item_numbers_and_schema	bool	If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.	[optional]
destination_oenorm_type	string	Defaults to Lv2015	[optional]
try_repair_project_structure	bool	Defaults to false. If this is enabled, the converter will try to ensure that the project structure can be mapped to Oenorm. It might introduce additional group levels to ensure a compatible target	[optional]
skip_try_enforce_schema_compliant_xml_output	bool	If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml based. By default, AVACloud will try to add required fields, even if no data is present, with sensible defaults. This behavior can be disabled with this option.	[optional]
remove_unprintable_characters_from_texts	bool	If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion might fail in case some text content contains characters that are not allowed in XML output formats.	[optional]

Return type

\SplFileObject

Authorization

Dangl.Identity

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
Accept: text/plain, application/json, text/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

avaConversionConvertToReb

\SplFileObject avaConversionConvertToReb($ava_project, $try_auto_generate_item_numbers_and_schema, $destination_reb_type)

Converts Dangl.AVA projects to REB

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: Dangl.Identity
$config = Dangl\AVACloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Dangl\AVACloud\Api\AvaConversionApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$ava_project = new \Dangl\AVACloud\Model\ProjectDto(); // \Dangl\AVACloud\Model\ProjectDto | The Dangl.AVA project
$try_auto_generate_item_numbers_and_schema = true; // bool | If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.
$destination_reb_type = "destination_reb_type_example"; // string | Defaults to D11

try {
    $result = $apiInstance->avaConversionConvertToReb($ava_project, $try_auto_generate_item_numbers_and_schema, $destination_reb_type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvaConversionApi->avaConversionConvertToReb: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
ava_project	\Dangl\AVACloud\Model\ProjectDto	The Dangl.AVA project
try_auto_generate_item_numbers_and_schema	bool	If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.	[optional]
destination_reb_type	string	Defaults to D11	[optional]

Return type

\SplFileObject

Authorization

Dangl.Identity

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
Accept: text/plain, application/json, text/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

avaConversionConvertToSia

\SplFileObject avaConversionConvertToSia($ava_project, $try_auto_generate_item_numbers_and_schema)

Converts Dangl.AVA projects to SIA 451

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: Dangl.Identity
$config = Dangl\AVACloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Dangl\AVACloud\Api\AvaConversionApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$ava_project = new \Dangl\AVACloud\Model\ProjectDto(); // \Dangl\AVACloud\Model\ProjectDto | The Dangl.AVA project
$try_auto_generate_item_numbers_and_schema = true; // bool | If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.

try {
    $result = $apiInstance->avaConversionConvertToSia($ava_project, $try_auto_generate_item_numbers_and_schema);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AvaConversionApi->avaConversionConvertToSia: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
ava_project	\Dangl\AVACloud\Model\ProjectDto	The Dangl.AVA project
try_auto_generate_item_numbers_and_schema	bool	If this is set to true, AVACloud will try to generate item numbers and an item number schema automatically for the input project. The operation will not have any effect if either an item number schema is already present, or if any of the elements already has an item number.	[optional]

Return type

\SplFileObject

Authorization

Dangl.Identity

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
Accept: text/plain, application/json, text/json, application/problem+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

AvaConversionApi.md

Latest commit

History

AvaConversionApi.md

File metadata and controls

Dangl\AVACloud\AvaConversionApi

avaConversionConvertToAva

Example

Parameters

Return type

Authorization

HTTP request headers

avaConversionConvertToExcel

Example

Parameters

Return type

Authorization

HTTP request headers

avaConversionConvertToGaeb

Example

Parameters

Return type

Authorization

HTTP request headers

avaConversionConvertToOenorm

Example

Parameters

Return type

Authorization

HTTP request headers

avaConversionConvertToReb

Example

Parameters

Return type

Authorization

HTTP request headers

avaConversionConvertToSia

Example

Parameters

Return type

Authorization

HTTP request headers