Server

<back to all web services

PutBrennstoff

Brennstofflieferung
Requires Authentication
The following routes are available for this service:
PUT/api/v1/brennstofflieferung
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PutBrennstoffResponse:
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BillingInformation:
    guid: Optional[str] = None
    from_: datetime.datetime = field(metadata=config(field_name='from'), default=datetime.datetime(1, 1, 1))
    to: datetime.datetime = datetime.datetime(1, 1, 1)
    is_completed: bool = False
    has_nebenkosten: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Brennstofflieferung:
    guid: Optional[str] = None
    delivery_date: datetime.datetime = datetime.datetime(1, 1, 1)
    salex_tax: Optional[Decimal] = None
    emisions_tax: Optional[Decimal] = None
    c02_taxes: Optional[Decimal] = None
    customs_tax: Optional[Decimal] = None
    other_charges: Optional[Decimal] = None
    c02_price: Optional[Decimal] = None
    c02_tons: Optional[Decimal] = None
    quantity: Optional[Decimal] = None
    amount: Optional[Decimal] = None
    start_meter_reading_value: Optional[Decimal] = None
    end_meter_reading_value: Optional[Decimal] = None
    heizwert: Decimal = decimal.Decimal(0)
    brennwert: bool = False
    energy_relief_amount_description: Optional[str] = None
    energy_relief_amount: Optional[Decimal] = None
    electricity_relief_amount_description: Optional[str] = None
    electricity_relief_amount: Optional[Decimal] = None
    c_o2_emissions_factor: Optional[Decimal] = None
    c_o2_text: Optional[str] = None
    c_o2_active: Optional[bool] = None
    c_o2_price_knd: Optional[bool] = None
    c_o2_price_landlord: Optional[Decimal] = None
    c_o2_price_renter: Optional[Decimal] = None
    c_o2_area: Optional[Decimal] = None
    is_for_commercial_use: Optional[bool] = None
    is_renovation_required: Optional[bool] = None
    is_heating_pads_improved: Optional[bool] = None
    c_o2_k_wh: Optional[Decimal] = None
    included_c_o2_sales_tax: Optional[Decimal] = None
    c_o2_costs: Optional[Decimal] = None
    total_c02_weight: Optional[Decimal] = None
    no_total_deduction_c02_costs: Optional[bool] = None
    is_deleted: bool = False
    is_created_by_app: bool = False
    brennstoff_medium_guid: Optional[str] = None
    billing_information: Optional[BillingInformation] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RelatedTo:
    guid: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PutBrennstoff(IHasBearerToken):
    # @ApiMember(IsRequired=true, ParameterType="body")
    brennstofflieferung: Optional[Brennstofflieferung] = None

    # @ApiMember(IsRequired=true, ParameterType="body")
    related_to_energie_verwerter: Optional[RelatedTo] = None

    # @ApiMember(IsRequired=true, ParameterType="body")
    related_to_brennstoff_medium: Optional[RelatedTo] = None

    # @ApiMember(ParameterType="body")
    related_to_billing_information: Optional[RelatedTo] = None

    # @ApiMember(IsRequired=true, ParameterType="body")
    bearer_token: Optional[str] = None

Python PutBrennstoff DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /api/v1/brennstofflieferung HTTP/1.1 
Host: calotec-portal-servdesk.eras-online.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PutBrennstoff xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Put">
  <BearerToken>String</BearerToken>
  <Brennstofflieferung xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models">
    <d2p1:Amount>0</d2p1:Amount>
    <d2p1:BillingInformation>
      <d2p1:From>0001-01-01T00:00:00</d2p1:From>
      <d2p1:Guid>String</d2p1:Guid>
      <d2p1:HasNebenkosten>false</d2p1:HasNebenkosten>
      <d2p1:IsCompleted>false</d2p1:IsCompleted>
      <d2p1:To>0001-01-01T00:00:00</d2p1:To>
    </d2p1:BillingInformation>
    <d2p1:BrennstoffMediumGuid>00000000-0000-0000-0000-000000000000</d2p1:BrennstoffMediumGuid>
    <d2p1:Brennwert>false</d2p1:Brennwert>
    <d2p1:C02Price>0</d2p1:C02Price>
    <d2p1:C02Taxes>0</d2p1:C02Taxes>
    <d2p1:C02Tons>0</d2p1:C02Tons>
    <d2p1:CO2Active>false</d2p1:CO2Active>
    <d2p1:CO2Area>0</d2p1:CO2Area>
    <d2p1:CO2Costs>0</d2p1:CO2Costs>
    <d2p1:CO2EmissionsFactor>0</d2p1:CO2EmissionsFactor>
    <d2p1:CO2KWh>0</d2p1:CO2KWh>
    <d2p1:CO2PriceKnd>false</d2p1:CO2PriceKnd>
    <d2p1:CO2PriceLandlord>0</d2p1:CO2PriceLandlord>
    <d2p1:CO2PriceRenter>0</d2p1:CO2PriceRenter>
    <d2p1:CO2Text>String</d2p1:CO2Text>
    <d2p1:CustomsTax>0</d2p1:CustomsTax>
    <d2p1:DeliveryDate>0001-01-01T00:00:00</d2p1:DeliveryDate>
    <d2p1:ElectricityReliefAmount>0</d2p1:ElectricityReliefAmount>
    <d2p1:ElectricityReliefAmountDescription>String</d2p1:ElectricityReliefAmountDescription>
    <d2p1:EmisionsTax>0</d2p1:EmisionsTax>
    <d2p1:EndMeterReadingValue>0</d2p1:EndMeterReadingValue>
    <d2p1:EnergyReliefAmount>0</d2p1:EnergyReliefAmount>
    <d2p1:EnergyReliefAmountDescription>String</d2p1:EnergyReliefAmountDescription>
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
    <d2p1:Heizwert>0</d2p1:Heizwert>
    <d2p1:IncludedCO2SalesTax>0</d2p1:IncludedCO2SalesTax>
    <d2p1:IsCreatedByApp>false</d2p1:IsCreatedByApp>
    <d2p1:IsDeleted>false</d2p1:IsDeleted>
    <d2p1:IsForCommercialUse>false</d2p1:IsForCommercialUse>
    <d2p1:IsHeatingPadsImproved>false</d2p1:IsHeatingPadsImproved>
    <d2p1:IsRenovationRequired>false</d2p1:IsRenovationRequired>
    <d2p1:NoTotalDeductionC02Costs>false</d2p1:NoTotalDeductionC02Costs>
    <d2p1:OtherCharges>0</d2p1:OtherCharges>
    <d2p1:Quantity>0</d2p1:Quantity>
    <d2p1:SalexTax>0</d2p1:SalexTax>
    <d2p1:StartMeterReadingValue>0</d2p1:StartMeterReadingValue>
    <d2p1:TotalC02Weight>0</d2p1:TotalC02Weight>
  </Brennstofflieferung>
  <RelatedToBillingInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models">
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
  </RelatedToBillingInformation>
  <RelatedToBrennstoffMedium xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models">
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
  </RelatedToBrennstoffMedium>
  <RelatedToEnergieVerwerter xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models">
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
  </RelatedToEnergieVerwerter>
</PutBrennstoff>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PutBrennstoffResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Put">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</PutBrennstoffResponse>