Server

<back to all web services

GetBrennstoffList

Brennstofflieferung
Requires Authentication
The following routes are available for this service:
GET/api/v1/brennstofflieferung
"use strict";
export class BillingInformation {
    /** @param {{guid?:string,from?:string,to?:string,isCompleted?:boolean,hasNebenkosten?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    guid;
    /** @type {string} */
    from;
    /** @type {string} */
    to;
    /** @type {boolean} */
    isCompleted;
    /** @type {boolean} */
    hasNebenkosten;
}
export class Brennstofflieferung {
    /** @param {{guid?:string,deliveryDate?:string,salexTax?:number,emisionsTax?:number,c02Taxes?:number,customsTax?:number,otherCharges?:number,c02Price?:number,c02Tons?:number,quantity?:number,amount?:number,startMeterReadingValue?:number,endMeterReadingValue?:number,heizwert?:number,brennwert?:boolean,energyReliefAmountDescription?:string,energyReliefAmount?:number,electricityReliefAmountDescription?:string,electricityReliefAmount?:number,cO2EmissionsFactor?:number,cO2Text?:string,cO2Active?:boolean,cO2PriceKnd?:boolean,cO2PriceLandlord?:number,cO2PriceRenter?:number,cO2Area?:number,isForCommercialUse?:boolean,isRenovationRequired?:boolean,isHeatingPadsImproved?:boolean,cO2KWh?:number,includedCO2SalesTax?:number,cO2Costs?:number,totalC02Weight?:number,noTotalDeductionC02Costs?:boolean,isDeleted?:boolean,isCreatedByApp?:boolean,brennstoffMediumGuid?:string,billingInformation?:BillingInformation}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    guid;
    /** @type {string} */
    deliveryDate;
    /** @type {?number} */
    salexTax;
    /** @type {?number} */
    emisionsTax;
    /** @type {?number} */
    c02Taxes;
    /** @type {?number} */
    customsTax;
    /** @type {?number} */
    otherCharges;
    /** @type {?number} */
    c02Price;
    /** @type {?number} */
    c02Tons;
    /** @type {?number} */
    quantity;
    /** @type {?number} */
    amount;
    /** @type {?number} */
    startMeterReadingValue;
    /** @type {?number} */
    endMeterReadingValue;
    /** @type {number} */
    heizwert;
    /** @type {boolean} */
    brennwert;
    /** @type {string} */
    energyReliefAmountDescription;
    /** @type {?number} */
    energyReliefAmount;
    /** @type {string} */
    electricityReliefAmountDescription;
    /** @type {?number} */
    electricityReliefAmount;
    /** @type {?number} */
    cO2EmissionsFactor;
    /** @type {string} */
    cO2Text;
    /** @type {?boolean} */
    cO2Active;
    /** @type {?boolean} */
    cO2PriceKnd;
    /** @type {?number} */
    cO2PriceLandlord;
    /** @type {?number} */
    cO2PriceRenter;
    /** @type {?number} */
    cO2Area;
    /** @type {?boolean} */
    isForCommercialUse;
    /** @type {?boolean} */
    isRenovationRequired;
    /** @type {?boolean} */
    isHeatingPadsImproved;
    /** @type {?number} */
    cO2KWh;
    /** @type {?number} */
    includedCO2SalesTax;
    /** @type {?number} */
    cO2Costs;
    /** @type {?number} */
    totalC02Weight;
    /** @type {?boolean} */
    noTotalDeductionC02Costs;
    /** @type {boolean} */
    isDeleted;
    /** @type {boolean} */
    isCreatedByApp;
    /** @type {string} */
    brennstoffMediumGuid;
    /** @type {BillingInformation} */
    billingInformation;
}
export class BrennstoffMedium {
    /** @param {{Guid?:string,Bezeichnung?:string,Lagernd?:boolean,EinheitTyp?:string,Heizwert?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
    /** @type {string} */
    Bezeichnung;
    /** @type {boolean} */
    Lagernd;
    /** @type {string} */
    EinheitTyp;
    /** @type {?number} */
    Heizwert;
}
export class GetBrennstoffListResponse {
    /** @param {{brennstofflieferungen?:Brennstofflieferung[],brennstoffMedium?:BrennstoffMedium[],responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Brennstofflieferung[]} */
    brennstofflieferungen;
    /** @type {BrennstoffMedium[]} */
    brennstoffMedium;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class GetBrennstoffList {
    /** @param {{bearerToken?:string,filter_ObjektGuid_?:string,filter_EnergieVerwerterGuid_?:string,filter_BillingInformationGuid_?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    bearerToken;
    /**
     * @type {string}
     * @description Optional! Follow the format : /api/v1/brennstofflieferung?filter[ObjektGuid]=* */
    filter_ObjektGuid_;
    /**
     * @type {string}
     * @description Optional! Follow the format : /api/v1/brennstofflieferung?filter[EnergieVerwerterGuid]=* */
    filter_EnergieVerwerterGuid_;
    /**
     * @type {string}
     * @description Optional! Follow the format : /api/v1/brennstofflieferung?filter[BillingInformationGuid]=* */
    filter_BillingInformationGuid_;
}

JavaScript 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: hbr-regional-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
		}
	}
}