Class GaebConversionClient
Inheritance
Inherited Members
Namespace: Dangl.AVACloud.Client
Assembly: Dangl.AVACloud.Client.dll
Syntax
public class GaebConversionClient
Constructors
| Improve this Doc View SourceGaebConversionClient(String, HttpClient)
Declaration
public GaebConversionClient(string baseUrl, HttpClient httpClient)
Parameters
Type | Name | Description |
---|---|---|
System.String | baseUrl | |
System.Net.Http.HttpClient | httpClient |
Properties
| Improve this Doc View SourceBaseUrl
Declaration
public string BaseUrl { get; set; }
Property Value
Type | Description |
---|---|
System.String |
JsonSerializerSettings
Declaration
protected JsonSerializerSettings JsonSerializerSettings { get; }
Property Value
Type | Description |
---|---|
Newtonsoft.Json.JsonSerializerSettings |
ReadResponseAsString
Declaration
public bool ReadResponseAsString { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Methods
| Improve this Doc View SourceConvertToAvaAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)
Converts GAEB files to Dangl.AVA projects
Declaration
public virtual Task<ProjectDto> ConvertToAvaAsync(FileParameter gaebFile, bool? supportSkippedItemNumberLevelsInPositions, bool? removePlainTextLongTexts, bool? removeHtmlLongTexts, bool? outputHtmlAsXml, bool? keepEmptyHtmlText, bool? allowUpperCaseItemNumbers, bool? allowLumpSumItemsWithDifferingQuantities)
Parameters
Type | Name | Description |
---|---|---|
FileParameter | gaebFile | The input file |
System.Nullable<System.Boolean> | supportSkippedItemNumberLevelsInPositions | Defaults to 'false'. This controls if, when deserializing GAEB files, skipped levels in position
|
System.Nullable<System.Boolean> | removePlainTextLongTexts | If set to true, plain text long texts will be removed from the output to reduce response sizes |
System.Nullable<System.Boolean> | removeHtmlLongTexts | If set to true, html long texts will be removed from the output to reduce response sizes |
System.Nullable<System.Boolean> | outputHtmlAsXml | Defaults to 'false'. If this is enabled, then Html text will be output as XML in the output.
|
System.Nullable<System.Boolean> | keepEmptyHtmlText | Defaults to 'false'. If this is enabled, then Html text that is empty will be kept in the output.
|
System.Nullable<System.Boolean> | allowUpperCaseItemNumbers | Defaults to 'false'. If this is enabled, then the ItemNumber of positions will be in uppercase
|
System.Nullable<System.Boolean> | allowLumpSumItemsWithDifferingQuantities | Defaults to 'false'.
|
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<Dangl.AVA.IO.Dto.v1.ProjectDto> |
Exceptions
Type | Condition |
---|---|
SwaggerException | A server side error occurred. |
ConvertToAvaAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)
Converts GAEB files to Dangl.AVA projects
Declaration
public virtual async Task<ProjectDto> ConvertToAvaAsync(FileParameter gaebFile, bool? supportSkippedItemNumberLevelsInPositions, bool? removePlainTextLongTexts, bool? removeHtmlLongTexts, bool? outputHtmlAsXml, bool? keepEmptyHtmlText, bool? allowUpperCaseItemNumbers, bool? allowLumpSumItemsWithDifferingQuantities, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
FileParameter | gaebFile | The input file |
System.Nullable<System.Boolean> | supportSkippedItemNumberLevelsInPositions | Defaults to 'false'. This controls if, when deserializing GAEB files, skipped levels in position
|
System.Nullable<System.Boolean> | removePlainTextLongTexts | If set to true, plain text long texts will be removed from the output to reduce response sizes |
System.Nullable<System.Boolean> | removeHtmlLongTexts | If set to true, html long texts will be removed from the output to reduce response sizes |
System.Nullable<System.Boolean> | outputHtmlAsXml | Defaults to 'false'. If this is enabled, then Html text will be output as XML in the output.
|
System.Nullable<System.Boolean> | keepEmptyHtmlText | Defaults to 'false'. If this is enabled, then Html text that is empty will be kept in the output.
|
System.Nullable<System.Boolean> | allowUpperCaseItemNumbers | Defaults to 'false'. If this is enabled, then the ItemNumber of positions will be in uppercase
|
System.Nullable<System.Boolean> | allowLumpSumItemsWithDifferingQuantities | Defaults to 'false'.
|
System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<Dangl.AVA.IO.Dto.v1.ProjectDto> |
Exceptions
Type | Condition |
---|---|
SwaggerException | A server side error occurred. |
ConvertToExcelAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)
Converts GAEB files to Excel
Declaration
public virtual Task<FileResponse> ConvertToExcelAsync(FileParameter gaebFile, bool? supportSkippedItemNumberLevelsInPositions, bool? writePrices, bool? writeLongTexts, string conversionCulture, bool? includeArticleNumbers, bool? outputHtmlAsXml, bool? keepEmptyHtmlText, bool? allowUpperCaseItemNumbers, bool? allowLumpSumItemsWithDifferingQuantities)
Parameters
Type | Name | Description |
---|---|---|
FileParameter | gaebFile | The input file |
System.Nullable<System.Boolean> | supportSkippedItemNumberLevelsInPositions | Defaults to 'false'. This controls if, when deserializing GAEB files, skipped levels in position
|
System.Nullable<System.Boolean> | writePrices | Defaults to true |
System.Nullable<System.Boolean> | writeLongTexts | Defaults to true |
System.String | conversionCulture | The culture that should be used for the conversion process, to have
|
System.Nullable<System.Boolean> | includeArticleNumbers | If this is enabled, then a new column will be created in the overview worksheet
|
System.Nullable<System.Boolean> | outputHtmlAsXml | Defaults to 'false'. If this is enabled, then Html text will be output as XML in the output.
|
System.Nullable<System.Boolean> | keepEmptyHtmlText | Defaults to 'false'. If this is enabled, then Html text that is empty will be kept in the output.
|
System.Nullable<System.Boolean> | allowUpperCaseItemNumbers | Defaults to 'false'. If this is enabled, then the ItemNumber of positions will be in uppercase
|
System.Nullable<System.Boolean> | allowLumpSumItemsWithDifferingQuantities | Defaults to 'false'.
|
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<FileResponse> |
Exceptions
Type | Condition |
---|---|
SwaggerException | A server side error occurred. |
ConvertToExcelAsync(FileParameter, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, String, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)
Converts GAEB files to Excel
Declaration
public virtual async Task<FileResponse> ConvertToExcelAsync(FileParameter gaebFile, bool? supportSkippedItemNumberLevelsInPositions, bool? writePrices, bool? writeLongTexts, string conversionCulture, bool? includeArticleNumbers, bool? outputHtmlAsXml, bool? keepEmptyHtmlText, bool? allowUpperCaseItemNumbers, bool? allowLumpSumItemsWithDifferingQuantities, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
FileParameter | gaebFile | The input file |
System.Nullable<System.Boolean> | supportSkippedItemNumberLevelsInPositions | Defaults to 'false'. This controls if, when deserializing GAEB files, skipped levels in position
|
System.Nullable<System.Boolean> | writePrices | Defaults to true |
System.Nullable<System.Boolean> | writeLongTexts | Defaults to true |
System.String | conversionCulture | The culture that should be used for the conversion process, to have
|
System.Nullable<System.Boolean> | includeArticleNumbers | If this is enabled, then a new column will be created in the overview worksheet
|
System.Nullable<System.Boolean> | outputHtmlAsXml | Defaults to 'false'. If this is enabled, then Html text will be output as XML in the output.
|
System.Nullable<System.Boolean> | keepEmptyHtmlText | Defaults to 'false'. If this is enabled, then Html text that is empty will be kept in the output.
|
System.Nullable<System.Boolean> | allowUpperCaseItemNumbers | Defaults to 'false'. If this is enabled, then the ItemNumber of positions will be in uppercase
|
System.Nullable<System.Boolean> | allowLumpSumItemsWithDifferingQuantities | Defaults to 'false'.
|
System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<FileResponse> |
Exceptions
Type | Condition |
---|---|
SwaggerException | A server side error occurred. |
ConvertToGaebAsync(FileParameter, Nullable<Boolean>, Nullable<DestinationGaebType>, Nullable<DestinationGaebExchangePhase>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)
Converts GAEB files to GAEB files. Used for example when
transforming or repairing GAEB files.
Declaration
public virtual Task<FileResponse> ConvertToGaebAsync(FileParameter gaebFile, bool? supportSkippedItemNumberLevelsInPositions, DestinationGaebType? destinationGaebType, DestinationGaebExchangePhase? targetExchangePhaseTransform, bool? enforceStrictOfferPhaseLongTextOutput, bool? exportQuantityDetermination, bool? removeUnprintableCharactersFromTexts, bool? forceIncludeDescriptions, bool? treatNullItemNumberSchemaAsInvalid, bool? outputHtmlAsXml, bool? keepEmptyHtmlText, bool? allowUpperCaseItemNumbers, bool? allowLumpSumItemsWithDifferingQuantities)
Parameters
Type | Name | Description |
---|---|---|
FileParameter | gaebFile | The input file |
System.Nullable<System.Boolean> | supportSkippedItemNumberLevelsInPositions | Defaults to 'false'. This controls if, when deserializing GAEB files, skipped levels in position
|
System.Nullable<DestinationGaebType> | destinationGaebType | Defaults to GAEB XML V3.2 |
System.Nullable<DestinationGaebExchangePhase> | targetExchangePhaseTransform | Defaults to none, meaning no transformation will be done. The phases are:
|
System.Nullable<System.Boolean> | enforceStrictOfferPhaseLongTextOutput | Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will
|
System.Nullable<System.Boolean> | exportQuantityDetermination | Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the
|
System.Nullable<System.Boolean> | removeUnprintableCharactersFromTexts | If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion
|
System.Nullable<System.Boolean> | forceIncludeDescriptions | If this is enabled, all description elements like texts and execution descriptions will be output
|
System.Nullable<System.Boolean> | treatNullItemNumberSchemaAsInvalid | When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas.
|
System.Nullable<System.Boolean> | outputHtmlAsXml | Defaults to 'false'. If this is enabled, then Html text will be output as XML in the output.
|
System.Nullable<System.Boolean> | keepEmptyHtmlText | Defaults to 'false'. If this is enabled, then Html text that is empty will be kept in the output.
|
System.Nullable<System.Boolean> | allowUpperCaseItemNumbers | Defaults to 'false'. If this is enabled, then the ItemNumber of positions will be in uppercase
|
System.Nullable<System.Boolean> | allowLumpSumItemsWithDifferingQuantities | Defaults to 'false'.
|
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<FileResponse> |
Exceptions
Type | Condition |
---|---|
SwaggerException | A server side error occurred. |
ConvertToGaebAsync(FileParameter, Nullable<Boolean>, Nullable<DestinationGaebType>, Nullable<DestinationGaebExchangePhase>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)
Converts GAEB files to GAEB files. Used for example when
transforming or repairing GAEB files.
Declaration
public virtual async Task<FileResponse> ConvertToGaebAsync(FileParameter gaebFile, bool? supportSkippedItemNumberLevelsInPositions, DestinationGaebType? destinationGaebType, DestinationGaebExchangePhase? targetExchangePhaseTransform, bool? enforceStrictOfferPhaseLongTextOutput, bool? exportQuantityDetermination, bool? removeUnprintableCharactersFromTexts, bool? forceIncludeDescriptions, bool? treatNullItemNumberSchemaAsInvalid, bool? outputHtmlAsXml, bool? keepEmptyHtmlText, bool? allowUpperCaseItemNumbers, bool? allowLumpSumItemsWithDifferingQuantities, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
FileParameter | gaebFile | The input file |
System.Nullable<System.Boolean> | supportSkippedItemNumberLevelsInPositions | Defaults to 'false'. This controls if, when deserializing GAEB files, skipped levels in position
|
System.Nullable<DestinationGaebType> | destinationGaebType | Defaults to GAEB XML V3.2 |
System.Nullable<DestinationGaebExchangePhase> | targetExchangePhaseTransform | Defaults to none, meaning no transformation will be done. The phases are:
|
System.Nullable<System.Boolean> | enforceStrictOfferPhaseLongTextOutput | Defaults to false. If this is enabled, exported long texts to GAEB XML that use text additions will
|
System.Nullable<System.Boolean> | exportQuantityDetermination | Defaults to false. If this is enabled, quantities are exported in detail in GAEB XML targets via the
|
System.Nullable<System.Boolean> | removeUnprintableCharactersFromTexts | If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion
|
System.Nullable<System.Boolean> | forceIncludeDescriptions | If this is enabled, all description elements like texts and execution descriptions will be output
|
System.Nullable<System.Boolean> | treatNullItemNumberSchemaAsInvalid | When exporting to GAEB, an item number schema is usually required. AVACloud will try to fix invalid item number schemas.
|
System.Nullable<System.Boolean> | outputHtmlAsXml | Defaults to 'false'. If this is enabled, then Html text will be output as XML in the output.
|
System.Nullable<System.Boolean> | keepEmptyHtmlText | Defaults to 'false'. If this is enabled, then Html text that is empty will be kept in the output.
|
System.Nullable<System.Boolean> | allowUpperCaseItemNumbers | Defaults to 'false'. If this is enabled, then the ItemNumber of positions will be in uppercase
|
System.Nullable<System.Boolean> | allowLumpSumItemsWithDifferingQuantities | Defaults to 'false'.
|
System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<FileResponse> |
Exceptions
Type | Condition |
---|---|
SwaggerException | A server side error occurred. |
ConvertToOenormAsync(FileParameter, Nullable<Boolean>, Nullable<DestinationOenormType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>)
Converts GAEB files to Oenorm files
Declaration
public virtual Task<FileResponse> ConvertToOenormAsync(FileParameter gaebFile, bool? supportSkippedItemNumberLevelsInPositions, DestinationOenormType? destinationOenormType, bool? tryRepairProjectStructure, bool? skipTryEnforceSchemaCompliantXmlOutput, bool? removeUnprintableCharactersFromTexts, bool? outputHtmlAsXml, bool? keepEmptyHtmlText, bool? allowUpperCaseItemNumbers, bool? allowLumpSumItemsWithDifferingQuantities)
Parameters
Type | Name | Description |
---|---|---|
FileParameter | gaebFile | The input file |
System.Nullable<System.Boolean> | supportSkippedItemNumberLevelsInPositions | Defaults to 'false'. This controls if, when deserializing GAEB files, skipped levels in position
|
System.Nullable<DestinationOenormType> | destinationOenormType | Defaults to Lv2015 |
System.Nullable<System.Boolean> | tryRepairProjectStructure | Defaults to false. If this is enabled, the converter will try to ensure that the project structure
|
System.Nullable<System.Boolean> | skipTryEnforceSchemaCompliantXmlOutput | If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml
|
System.Nullable<System.Boolean> | removeUnprintableCharactersFromTexts | If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion
|
System.Nullable<System.Boolean> | outputHtmlAsXml | Defaults to 'false'. If this is enabled, then Html text will be output as XML in the output.
|
System.Nullable<System.Boolean> | keepEmptyHtmlText | Defaults to 'false'. If this is enabled, then Html text that is empty will be kept in the output.
|
System.Nullable<System.Boolean> | allowUpperCaseItemNumbers | Defaults to 'false'. If this is enabled, then the ItemNumber of positions will be in uppercase
|
System.Nullable<System.Boolean> | allowLumpSumItemsWithDifferingQuantities | Defaults to 'false'.
|
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<FileResponse> |
Exceptions
Type | Condition |
---|---|
SwaggerException | A server side error occurred. |
ConvertToOenormAsync(FileParameter, Nullable<Boolean>, Nullable<DestinationOenormType>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, CancellationToken)
Converts GAEB files to Oenorm files
Declaration
public virtual async Task<FileResponse> ConvertToOenormAsync(FileParameter gaebFile, bool? supportSkippedItemNumberLevelsInPositions, DestinationOenormType? destinationOenormType, bool? tryRepairProjectStructure, bool? skipTryEnforceSchemaCompliantXmlOutput, bool? removeUnprintableCharactersFromTexts, bool? outputHtmlAsXml, bool? keepEmptyHtmlText, bool? allowUpperCaseItemNumbers, bool? allowLumpSumItemsWithDifferingQuantities, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
FileParameter | gaebFile | The input file |
System.Nullable<System.Boolean> | supportSkippedItemNumberLevelsInPositions | Defaults to 'false'. This controls if, when deserializing GAEB files, skipped levels in position
|
System.Nullable<DestinationOenormType> | destinationOenormType | Defaults to Lv2015 |
System.Nullable<System.Boolean> | tryRepairProjectStructure | Defaults to false. If this is enabled, the converter will try to ensure that the project structure
|
System.Nullable<System.Boolean> | skipTryEnforceSchemaCompliantXmlOutput | If this option is enabled, AVACloud will not attempt to force a schema-compliant Xml output for ÖNorm targets that are Xml
|
System.Nullable<System.Boolean> | removeUnprintableCharactersFromTexts | If this is enabled, unprintable characters are removed from text elements. Otherwise, the conversion
|
System.Nullable<System.Boolean> | outputHtmlAsXml | Defaults to 'false'. If this is enabled, then Html text will be output as XML in the output.
|
System.Nullable<System.Boolean> | keepEmptyHtmlText | Defaults to 'false'. If this is enabled, then Html text that is empty will be kept in the output.
|
System.Nullable<System.Boolean> | allowUpperCaseItemNumbers | Defaults to 'false'. If this is enabled, then the ItemNumber of positions will be in uppercase
|
System.Nullable<System.Boolean> | allowLumpSumItemsWithDifferingQuantities | Defaults to 'false'.
|
System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<FileResponse> |
Exceptions
Type | Condition |
---|---|
SwaggerException | A server side error occurred. |
ReadObjectResponseAsync<T>(HttpResponseMessage, IReadOnlyDictionary<String, IEnumerable<String>>, CancellationToken)
Declaration
protected virtual async Task<GaebConversionClient.ObjectResponseResult<T>> ReadObjectResponseAsync<T>(HttpResponseMessage response, IReadOnlyDictionary<string, IEnumerable<string>> headers, CancellationToken cancellationToken)
Parameters
Type | Name | Description |
---|---|---|
System.Net.Http.HttpResponseMessage | response | |
System.Collections.Generic.IReadOnlyDictionary<System.String, System.Collections.Generic.IEnumerable<System.String>> | headers | |
System.Threading.CancellationToken | cancellationToken |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GaebConversionClient.ObjectResponseResult<T>> |
Type Parameters
Name | Description |
---|---|
T |