Server

<back to all web services

GetBrennstoffList

Brennstofflieferung
Requires Authentication
The following routes are available for this service:
GET/api/v1/brennstofflieferung
namespace Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BillingInformation() = 
        [<DataMember>]
        member val Guid:String = null with get,set

        [<DataMember>]
        member val From:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val To:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val IsCompleted:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val HasNebenkosten:Boolean = new Boolean() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type Brennstofflieferung() = 
        [<DataMember>]
        member val Guid:Guid = new Guid() with get,set

        [<DataMember>]
        member val DeliveryDate:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val SalexTax:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val EmisionsTax:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val C02Taxes:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val CustomsTax:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val OtherCharges:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val C02Price:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val C02Tons:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val Quantity:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val Amount:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val StartMeterReadingValue:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val EndMeterReadingValue:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val Heizwert:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Brennwert:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val EnergyReliefAmountDescription:String = null with get,set

        [<DataMember>]
        member val EnergyReliefAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val ElectricityReliefAmountDescription:String = null with get,set

        [<DataMember>]
        member val ElectricityReliefAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val CO2EmissionsFactor:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val CO2Text:String = null with get,set

        [<DataMember>]
        member val CO2Active:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val CO2PriceKnd:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val CO2PriceLandlord:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val CO2PriceRenter:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val CO2Area:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val IsForCommercialUse:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val IsRenovationRequired:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val IsHeatingPadsImproved:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val CO2KWh:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val IncludedCO2SalesTax:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val CO2Costs:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val TotalC02Weight:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val NoTotalDeductionC02Costs:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val IsDeleted:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val IsCreatedByApp:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val BrennstoffMediumGuid:Guid = new Guid() with get,set

        [<DataMember>]
        member val BillingInformation:BillingInformation = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BrennstoffMedium() = 
        [<DataMember(Name="Guid")>]
        member val Guid:String = null with get,set

        [<DataMember(Name="Bezeichnung")>]
        member val Label:String = null with get,set

        [<DataMember(Name="Lagernd")>]
        member val Storable:Boolean = new Boolean() with get,set

        [<DataMember(Name="EinheitTyp")>]
        member val EinheitType:String = null with get,set

        [<DataMember(Name="Heizwert")>]
        member val Heizwert:Nullable<Decimal> = new Nullable<Decimal>() with get,set

    [<AllowNullLiteral>]
    type GetBrennstoffListResponse() = 
        member val Brennstofflieferungen:IEnumerable<Brennstofflieferung> = null with get,set
        member val BrennstoffMedium:IEnumerable<BrennstoffMedium> = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type GetBrennstoffList() = 
        [<ApiMember(IsRequired=true, ParameterType="query")>]
        member val BearerToken:String = null with 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")>]
        member val FilterByObjektGuid:String = null with 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")>]
        member val FilterByEnergieVerwerterGuid:String = null with 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")>]
        member val FilterByBillingInformationGuid:String = null with get,set

F# 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: imm-con-gmbh-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
		}
	}
}