Server

<back to all web services

GetBrennstoffList

Brennstofflieferung
Requires Authentication
The following routes are available for this service:
GET/api/v1/brennstofflieferung

// @DataContract
export class BillingInformation
{
    // @DataMember
    public guid: string;

    // @DataMember
    public from: string;

    // @DataMember
    public to: string;

    // @DataMember
    public isCompleted: boolean;

    // @DataMember
    public hasNebenkosten: boolean;

    public constructor(init?: Partial<BillingInformation>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Brennstofflieferung
{
    // @DataMember
    public guid: string;

    // @DataMember
    public deliveryDate: string;

    // @DataMember
    public salexTax?: number;

    // @DataMember
    public emisionsTax?: number;

    // @DataMember
    public c02Taxes?: number;

    // @DataMember
    public customsTax?: number;

    // @DataMember
    public otherCharges?: number;

    // @DataMember
    public c02Price?: number;

    // @DataMember
    public c02Tons?: number;

    // @DataMember
    public quantity?: number;

    // @DataMember
    public amount?: number;

    // @DataMember
    public startMeterReadingValue?: number;

    // @DataMember
    public endMeterReadingValue?: number;

    // @DataMember
    public heizwert: number;

    // @DataMember
    public brennwert: boolean;

    // @DataMember
    public energyReliefAmountDescription: string;

    // @DataMember
    public energyReliefAmount?: number;

    // @DataMember
    public electricityReliefAmountDescription: string;

    // @DataMember
    public electricityReliefAmount?: number;

    // @DataMember
    public cO2EmissionsFactor?: number;

    // @DataMember
    public cO2Text: string;

    // @DataMember
    public cO2Active?: boolean;

    // @DataMember
    public cO2PriceKnd?: boolean;

    // @DataMember
    public cO2PriceLandlord?: number;

    // @DataMember
    public cO2PriceRenter?: number;

    // @DataMember
    public cO2Area?: number;

    // @DataMember
    public isForCommercialUse?: boolean;

    // @DataMember
    public isRenovationRequired?: boolean;

    // @DataMember
    public isHeatingPadsImproved?: boolean;

    // @DataMember
    public cO2KWh?: number;

    // @DataMember
    public includedCO2SalesTax?: number;

    // @DataMember
    public cO2Costs?: number;

    // @DataMember
    public totalC02Weight?: number;

    // @DataMember
    public noTotalDeductionC02Costs?: boolean;

    // @DataMember
    public isDeleted: boolean;

    // @DataMember
    public isCreatedByApp: boolean;

    // @DataMember
    public brennstoffMediumGuid: string;

    // @DataMember
    public billingInformation: BillingInformation;

    public constructor(init?: Partial<Brennstofflieferung>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BrennstoffMedium
{
    // @DataMember(Name="Guid")
    public Guid: string;

    // @DataMember(Name="Bezeichnung")
    public Bezeichnung: string;

    // @DataMember(Name="Lagernd")
    public Lagernd: boolean;

    // @DataMember(Name="EinheitTyp")
    public EinheitTyp: string;

    // @DataMember(Name="Heizwert")
    public Heizwert?: number;

    public constructor(init?: Partial<BrennstoffMedium>) { (Object as any).assign(this, init); }
}

export class GetBrennstoffListResponse
{
    public brennstofflieferungen: Brennstofflieferung[];
    public brennstoffMedium: BrennstoffMedium[];
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<GetBrennstoffListResponse>) { (Object as any).assign(this, init); }
}

export class GetBrennstoffList implements IHasBearerToken
{
    // @ApiMember(IsRequired=true, ParameterType="query")
    public bearerToken: string;

    /** @description Optional! Follow the format : /api/v1/brennstofflieferung?filter[ObjektGuid]=* */
    // @DataMember(Name="filter[ObjektGuid]")
    // @ApiMember(Description="Optional! Follow the format : /api/v1/brennstofflieferung?filter[ObjektGuid]=*", ParameterType="query")
    public filter_ObjektGuid_: string;

    /** @description Optional! Follow the format : /api/v1/brennstofflieferung?filter[EnergieVerwerterGuid]=* */
    // @DataMember(Name="filter[EnergieVerwerterGuid]")
    // @ApiMember(Description="Optional! Follow the format : /api/v1/brennstofflieferung?filter[EnergieVerwerterGuid]=*", ParameterType="query")
    public filter_EnergieVerwerterGuid_: string;

    /** @description Optional! Follow the format : /api/v1/brennstofflieferung?filter[BillingInformationGuid]=* */
    // @DataMember(Name="filter[BillingInformationGuid]")
    // @ApiMember(Description="Optional! Follow the format : /api/v1/brennstofflieferung?filter[BillingInformationGuid]=*", ParameterType="query")
    public filter_BillingInformationGuid_: string;

    public constructor(init?: Partial<GetBrennstoffList>) { (Object as any).assign(this, init); }
}

TypeScript 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: messdienstservice-stadtwerke-peine-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
		}
	}
}