Server

<back to all web services

GetBrennstoffList

Brennstofflieferung
Requires Authentication
The following routes are available for this service:
GET/api/v1/brennstofflieferung
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get;
using Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models;
using Eras2Web.Service.Desktop.Server.ServiceModel.Stammdaten;

namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get
{
    public partial class GetBrennstoffList
        : IHasBearerToken
    {
        [ApiMember(IsRequired=true, ParameterType="query")]
        public virtual string BearerToken { get; set; }

        ///<summary>
        ///Optional! Follow the format : /api/v1/brennstofflieferung?filter[ObjektGuid]=*
        ///</summary>
        [DataMember(Name="filter[ObjektGuid]")]
        [ApiMember(Description="Optional! Follow the format : /api/v1/brennstofflieferung?filter[ObjektGuid]=*", ParameterType="query")]
        public virtual string FilterByObjektGuid { get; set; }

        ///<summary>
        ///Optional! Follow the format : /api/v1/brennstofflieferung?filter[EnergieVerwerterGuid]=*
        ///</summary>
        [DataMember(Name="filter[EnergieVerwerterGuid]")]
        [ApiMember(Description="Optional! Follow the format : /api/v1/brennstofflieferung?filter[EnergieVerwerterGuid]=*", ParameterType="query")]
        public virtual string FilterByEnergieVerwerterGuid { get; set; }

        ///<summary>
        ///Optional! Follow the format : /api/v1/brennstofflieferung?filter[BillingInformationGuid]=*
        ///</summary>
        [DataMember(Name="filter[BillingInformationGuid]")]
        [ApiMember(Description="Optional! Follow the format : /api/v1/brennstofflieferung?filter[BillingInformationGuid]=*", ParameterType="query")]
        public virtual string FilterByBillingInformationGuid { get; set; }
    }

    public partial class GetBrennstoffListResponse
    {
        public virtual IEnumerable<Brennstofflieferung> Brennstofflieferungen { get; set; }
        public virtual IEnumerable<BrennstoffMedium> BrennstoffMedium { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models
{
    [DataContract]
    public partial class BillingInformation
    {
        [DataMember]
        public virtual string Guid { get; set; }

        [DataMember]
        public virtual DateTime From { get; set; }

        [DataMember]
        public virtual DateTime To { get; set; }

        [DataMember]
        public virtual bool IsCompleted { get; set; }

        [DataMember]
        public virtual bool HasNebenkosten { get; set; }
    }

    [DataContract]
    public partial class Brennstofflieferung
    {
        [DataMember]
        public virtual Guid Guid { get; set; }

        [DataMember]
        public virtual DateTime DeliveryDate { get; set; }

        [DataMember]
        public virtual decimal? SalexTax { get; set; }

        [DataMember]
        public virtual decimal? EmisionsTax { get; set; }

        [DataMember]
        public virtual decimal? C02Taxes { get; set; }

        [DataMember]
        public virtual decimal? CustomsTax { get; set; }

        [DataMember]
        public virtual decimal? OtherCharges { get; set; }

        [DataMember]
        public virtual decimal? C02Price { get; set; }

        [DataMember]
        public virtual decimal? C02Tons { get; set; }

        [DataMember]
        public virtual decimal? Quantity { get; set; }

        [DataMember]
        public virtual decimal? Amount { get; set; }

        [DataMember]
        public virtual decimal? StartMeterReadingValue { get; set; }

        [DataMember]
        public virtual decimal? EndMeterReadingValue { get; set; }

        [DataMember]
        public virtual decimal Heizwert { get; set; }

        [DataMember]
        public virtual bool Brennwert { get; set; }

        [DataMember]
        public virtual string EnergyReliefAmountDescription { get; set; }

        [DataMember]
        public virtual decimal? EnergyReliefAmount { get; set; }

        [DataMember]
        public virtual string ElectricityReliefAmountDescription { get; set; }

        [DataMember]
        public virtual decimal? ElectricityReliefAmount { get; set; }

        [DataMember]
        public virtual decimal? CO2EmissionsFactor { get; set; }

        [DataMember]
        public virtual string CO2Text { get; set; }

        [DataMember]
        public virtual bool? CO2Active { get; set; }

        [DataMember]
        public virtual bool? CO2PriceKnd { get; set; }

        [DataMember]
        public virtual decimal? CO2PriceLandlord { get; set; }

        [DataMember]
        public virtual decimal? CO2PriceRenter { get; set; }

        [DataMember]
        public virtual decimal? CO2Area { get; set; }

        [DataMember]
        public virtual bool? IsForCommercialUse { get; set; }

        [DataMember]
        public virtual bool? IsRenovationRequired { get; set; }

        [DataMember]
        public virtual bool? IsHeatingPadsImproved { get; set; }

        [DataMember]
        public virtual decimal? CO2KWh { get; set; }

        [DataMember]
        public virtual decimal? IncludedCO2SalesTax { get; set; }

        [DataMember]
        public virtual decimal? CO2Costs { get; set; }

        [DataMember]
        public virtual decimal? TotalC02Weight { get; set; }

        [DataMember]
        public virtual bool? NoTotalDeductionC02Costs { get; set; }

        [DataMember]
        public virtual bool IsDeleted { get; set; }

        [DataMember]
        public virtual bool IsCreatedByApp { get; set; }

        [DataMember]
        public virtual Guid BrennstoffMediumGuid { get; set; }

        [DataMember]
        public virtual BillingInformation BillingInformation { get; set; }
    }

}

namespace Eras2Web.Service.Desktop.Server.ServiceModel.Stammdaten
{
    [DataContract]
    public partial class BrennstoffMedium
    {
        [DataMember(Name="Guid")]
        public virtual string Guid { get; set; }

        [DataMember(Name="Bezeichnung")]
        public virtual string Label { get; set; }

        [DataMember(Name="Lagernd")]
        public virtual bool Storable { get; set; }

        [DataMember(Name="EinheitTyp")]
        public virtual string EinheitType { get; set; }

        [DataMember(Name="Heizwert")]
        public virtual decimal? Heizwert { get; set; }
    }

}

C# GetBrennstoffList DTOs

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

HTTP + JSV

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

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