Server

<back to all web services

GetBrennstoffList

Brennstofflieferung
Requires Authentication
The following routes are available for this service:
GET/api/v1/brennstofflieferung
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class GetBrennstoffList : IHasBearerToken
{
    @ApiMember(IsRequired=true, ParameterType="query")
    var bearerToken:String? = null

    /**
    * Optional! Follow the format : /api/v1/brennstofflieferung?filter[ObjektGuid]=*
    */
    @DataMember(Name="filter[ObjektGuid]")
    @SerializedName("filter[ObjektGuid]")
    @ApiMember(Description="Optional! Follow the format : /api/v1/brennstofflieferung?filter[ObjektGuid]=*", ParameterType="query")
    var filterByObjektGuid:String? = null

    /**
    * Optional! Follow the format : /api/v1/brennstofflieferung?filter[EnergieVerwerterGuid]=*
    */
    @DataMember(Name="filter[EnergieVerwerterGuid]")
    @SerializedName("filter[EnergieVerwerterGuid]")
    @ApiMember(Description="Optional! Follow the format : /api/v1/brennstofflieferung?filter[EnergieVerwerterGuid]=*", ParameterType="query")
    var filterByEnergieVerwerterGuid:String? = null

    /**
    * Optional! Follow the format : /api/v1/brennstofflieferung?filter[BillingInformationGuid]=*
    */
    @DataMember(Name="filter[BillingInformationGuid]")
    @SerializedName("filter[BillingInformationGuid]")
    @ApiMember(Description="Optional! Follow the format : /api/v1/brennstofflieferung?filter[BillingInformationGuid]=*", ParameterType="query")
    var filterByBillingInformationGuid:String? = null
}

open class GetBrennstoffListResponse
{
    var brennstofflieferungen:ArrayList<Brennstofflieferung> = ArrayList<Brennstofflieferung>()
    var brennstoffMedium:ArrayList<BrennstoffMedium> = ArrayList<BrennstoffMedium>()
    var responseStatus:ResponseStatus? = null
}

@DataContract
open class Brennstofflieferung
{
    @DataMember
    var guid:UUID? = null

    @DataMember
    var deliveryDate:Date? = null

    @DataMember
    var salexTax:BigDecimal? = null

    @DataMember
    var emisionsTax:BigDecimal? = null

    @DataMember
    var c02Taxes:BigDecimal? = null

    @DataMember
    var customsTax:BigDecimal? = null

    @DataMember
    var otherCharges:BigDecimal? = null

    @DataMember
    var c02Price:BigDecimal? = null

    @DataMember
    var c02Tons:BigDecimal? = null

    @DataMember
    var quantity:BigDecimal? = null

    @DataMember
    var amount:BigDecimal? = null

    @DataMember
    var startMeterReadingValue:BigDecimal? = null

    @DataMember
    var endMeterReadingValue:BigDecimal? = null

    @DataMember
    var heizwert:BigDecimal? = null

    @DataMember
    var brennwert:Boolean? = null

    @DataMember
    var energyReliefAmountDescription:String? = null

    @DataMember
    var energyReliefAmount:BigDecimal? = null

    @DataMember
    var electricityReliefAmountDescription:String? = null

    @DataMember
    var electricityReliefAmount:BigDecimal? = null

    @DataMember
    var cO2EmissionsFactor:BigDecimal? = null

    @DataMember
    var cO2Text:String? = null

    @DataMember
    var cO2Active:Boolean? = null

    @DataMember
    var cO2PriceKnd:Boolean? = null

    @DataMember
    var cO2PriceLandlord:BigDecimal? = null

    @DataMember
    var cO2PriceRenter:BigDecimal? = null

    @DataMember
    var cO2Area:BigDecimal? = null

    @DataMember
    var isForCommercialUse:Boolean? = null

    @DataMember
    var isRenovationRequired:Boolean? = null

    @DataMember
    var isHeatingPadsImproved:Boolean? = null

    @DataMember
    var cO2KWh:BigDecimal? = null

    @DataMember
    var includedCO2SalesTax:BigDecimal? = null

    @DataMember
    var cO2Costs:BigDecimal? = null

    @DataMember
    var totalC02Weight:BigDecimal? = null

    @DataMember
    var noTotalDeductionC02Costs:Boolean? = null

    @DataMember
    var isDeleted:Boolean? = null

    @DataMember
    var isCreatedByApp:Boolean? = null

    @DataMember
    var brennstoffMediumGuid:UUID? = null

    @DataMember
    var billingInformation:BillingInformation? = null
}

@DataContract
open class BillingInformation
{
    @DataMember
    var guid:String? = null

    @DataMember
    var from:Date? = null

    @DataMember
    var to:Date? = null

    @DataMember
    var isCompleted:Boolean? = null

    @DataMember
    var hasNebenkosten:Boolean? = null
}

@DataContract
open class BrennstoffMedium
{
    @DataMember(Name="Guid")
    @SerializedName("Guid")
    var guid:String? = null

    @DataMember(Name="Bezeichnung")
    @SerializedName("Bezeichnung")
    var label:String? = null

    @DataMember(Name="Lagernd")
    @SerializedName("Lagernd")
    var storable:Boolean? = null

    @DataMember(Name="EinheitTyp")
    @SerializedName("EinheitTyp")
    var einheitType:String? = null

    @DataMember(Name="Heizwert")
    @SerializedName("Heizwert")
    var heizwert:BigDecimal? = null
}

Kotlin GetBrennstoffList DTOs

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

HTTP + CSV

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: inea-servdesk.eras-online.de 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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