Server

<back to all web services

GetBrennstoffList

Brennstofflieferung
Requires Authentication
The following routes are available for this service:
GET/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 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 BrennstoffMedium:
    guid: Optional[str] = None
    label: Optional[str] = None
    storable: bool = False
    einheit_type: Optional[str] = None
    heizwert: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetBrennstoffListResponse:
    brennstofflieferungen: Optional[List[Brennstofflieferung]] = None
    brennstoff_medium: Optional[List[BrennstoffMedium]] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetBrennstoffList(IHasBearerToken):
    # @ApiMember(IsRequired=true, ParameterType="query")
    bearer_token: Optional[str] = None

    # @ApiMember(Description="Optional! Follow the format : /api/v1/brennstofflieferung?filter[ObjektGuid]=*", ParameterType="query")
    filter_by_objekt_guid: Optional[str] = None
    """
    Optional! Follow the format : /api/v1/brennstofflieferung?filter[ObjektGuid]=*
    """


    # @ApiMember(Description="Optional! Follow the format : /api/v1/brennstofflieferung?filter[EnergieVerwerterGuid]=*", ParameterType="query")
    filter_by_energie_verwerter_guid: Optional[str] = None
    """
    Optional! Follow the format : /api/v1/brennstofflieferung?filter[EnergieVerwerterGuid]=*
    """


    # @ApiMember(Description="Optional! Follow the format : /api/v1/brennstofflieferung?filter[BillingInformationGuid]=*", ParameterType="query")
    filter_by_billing_information_guid: Optional[str] = None
    """
    Optional! Follow the format : /api/v1/brennstofflieferung?filter[BillingInformationGuid]=*
    """

Python GetBrennstoffList DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /api/v1/brennstofflieferung HTTP/1.1 
Host: mdf-servdesk.eras-online.de 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}